0f48ccb57ad274417fbffca66ce20392d23de531
[platform/kernel/u-boot.git] / include / init.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2000-2009
4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5  *
6  * Copy the startup prototype, previously defined in common.h
7  * Copyright (C) 2018, STMicroelectronics - All Rights Reserved
8  */
9
10 #ifndef __INIT_H_
11 #define __INIT_H_       1
12
13 #include <linux/types.h>
14
15 struct global_data;
16
17 #ifndef __ASSEMBLY__            /* put C only stuff in this section */
18
19 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
20 #ifdef CONFIG_EFI_STUB
21 #define ll_boot_init()  false
22 #else
23 #define ll_boot_init()  (!(gd->flags & GD_FLG_SKIP_LL_INIT))
24 #endif
25
26 /*
27  * Function Prototypes
28  */
29
30 /* common/board_f.c */
31 void board_init_f(ulong dummy);
32
33 /**
34  * arch_cpu_init() - basic cpu-dependent setup for an architecture
35  *
36  * This is called after early malloc is available. It should handle any
37  * CPU- or SoC- specific init needed to continue the init sequence. See
38  * board_f.c for where it is called. If this is not provided, a default
39  * version (which does nothing) will be used.
40  *
41  * Return: 0 on success, otherwise error
42  */
43 int arch_cpu_init(void);
44
45 /**
46  * arch_cpu_init_dm() - init CPU after driver model is available
47  *
48  * This is called immediately after driver model is available before
49  * relocation. This is similar to arch_cpu_init() but is able to reference
50  * devices
51  *
52  * Return: 0 if OK, -ve on error
53  */
54 int arch_cpu_init_dm(void);
55
56 /**
57  * mach_cpu_init() - SoC/machine dependent CPU setup
58  *
59  * This is called after arch_cpu_init(). It should handle any
60  * SoC or machine specific init needed to continue the init sequence. See
61  * board_f.c for where it is called. If this is not provided, a default
62  * version (which does nothing) will be used.
63  *
64  * Return: 0 on success, otherwise error
65  */
66 int mach_cpu_init(void);
67
68 /**
69  * arch_fsp_init() - perform firmware support package init
70  *
71  * Where U-Boot relies on binary blobs to handle part of the system init, this
72  * function can be used to set up the blobs. This is used on some Intel
73  * platforms.
74  *
75  * Return: 0
76  */
77 int arch_fsp_init(void);
78
79 /**
80  * arch_fsp_init() - perform post-relocation firmware support package init
81  *
82  * Where U-Boot relies on binary blobs to handle part of the system init, this
83  * function can be used to set up the blobs. This is used on some Intel
84  * platforms.
85  *
86  * Return: 0
87  */
88 int arch_fsp_init_r(void);
89
90 int dram_init(void);
91
92 /**
93  * dram_init_banksize() - Set up DRAM bank sizes
94  *
95  * This can be implemented by boards to set up the DRAM bank information in
96  * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
97  * is called.
98  *
99  * If this is not provided, a default implementation will try to set up a
100  * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
101  * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
102  * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
103  * get_effective_memsize().
104  *
105  * Return: 0 if OK, -ve on error
106  */
107 int dram_init_banksize(void);
108
109 long get_ram_size(long *base, long size);
110 phys_size_t get_effective_memsize(void);
111
112 int testdram(void);
113
114 /**
115  * arch_reserve_stacks() - Reserve all necessary stacks
116  *
117  * This is used in generic board init sequence in common/board_f.c. Each
118  * architecture could provide this function to tailor the required stacks.
119  *
120  * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
121  * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
122  * require only this can leave it untouched.
123  *
124  * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
125  * positions of the stack. The stack pointer(s) will be set to this later.
126  * gd->irq_sp is only required, if the architecture needs it.
127  *
128  * Return: 0 if no error
129  */
130 int arch_reserve_stacks(void);
131
132 /**
133  * arch_reserve_mmu() - Reserve memory for MMU TLB table
134  *
135  * Architecture-specific routine for reserving memory for the MMU TLB table.
136  * This is used in generic board init sequence in common/board_f.c.
137  *
138  * If an implementation is not provided, it will just be a nop stub.
139  *
140  * Return: 0 if OK
141  */
142 int arch_reserve_mmu(void);
143
144 /**
145  * arch_setup_bdinfo() - Architecture dependent boardinfo setup
146  *
147  * Architecture-specific routine for populating various boardinfo fields of
148  * gd->bd. It is called during the generic board init sequence.
149  *
150  * If an implementation is not provided, it will just be a nop stub.
151  *
152  * Return: 0 if OK
153  */
154 int arch_setup_bdinfo(void);
155
156 /**
157  * setup_bdinfo() - Generic boardinfo setup
158  *
159  * Routine for populating various generic boardinfo fields of
160  * gd->bd. It is called during the generic board init sequence.
161  *
162  * Return: 0 if OK
163  */
164 int setup_bdinfo(void);
165
166 /**
167  * init_cache_f_r() - Turn on the cache in preparation for relocation
168  *
169  * Return: 0 if OK, -ve on error
170  */
171 int init_cache_f_r(void);
172
173 #if !CONFIG_IS_ENABLED(CPU)
174 /**
175  * print_cpuinfo() - Display information about the CPU
176  *
177  * Return: 0 if OK, -ve on error
178  */
179 int print_cpuinfo(void);
180 #endif
181 int timer_init(void);
182 int misc_init_f(void);
183
184 #if defined(CONFIG_DTB_RESELECT)
185 int embedded_dtb_select(void);
186 #endif
187
188 /* common/init/board_init.c */
189 extern ulong monitor_flash_len;
190
191 /**
192  * ulong board_init_f_alloc_reserve - allocate reserved area
193  * @top: top of the reserve area, growing down.
194  *
195  * This function is called by each architecture very early in the start-up
196  * code to allow the C runtime to reserve space on the stack for writable
197  * 'globals' such as GD and the malloc arena.
198  *
199  * Return: bottom of reserved area
200  */
201 ulong board_init_f_alloc_reserve(ulong top);
202
203 /**
204  * board_init_f_init_reserve - initialize the reserved area(s)
205  * @base:       top from which reservation was done
206  *
207  * This function is called once the C runtime has allocated the reserved
208  * area on the stack. It must initialize the GD at the base of that area.
209  */
210 void board_init_f_init_reserve(ulong base);
211
212 struct global_data;
213
214 /**
215  * arch_setup_gd() - Set up the global_data pointer
216  * @gd_ptr: Pointer to global data
217  *
218  * This pointer is special in some architectures and cannot easily be assigned
219  * to. For example on x86 it is implemented by adding a specific record to its
220  * Global Descriptor Table! So we we provide a function to carry out this task.
221  * For most architectures this can simply be:
222  *
223  *    gd = gd_ptr;
224  */
225 void arch_setup_gd(struct global_data *gd_ptr);
226
227 /* common/board_r.c */
228 void board_init_r(struct global_data *id, ulong dest_addr)
229         __attribute__ ((noreturn));
230
231 int cpu_init_r(void);
232 int last_stage_init(void);
233 int mac_read_from_eeprom(void);
234 int set_cpu_clk_info(void);
235 int update_flash_size(int flash_size);
236 int arch_early_init_r(void);
237 void pci_init(void);
238 void pci_ep_init(void);
239 int misc_init_r(void);
240 #if defined(CONFIG_VID)
241 int init_func_vid(void);
242 #endif
243
244 /* common/board_info.c */
245 int checkboard(void);
246 int show_board_info(void);
247
248 /**
249  * Get the uppermost pointer that is valid to access
250  *
251  * Some systems may not map all of their address space. This function allows
252  * boards to indicate what their highest support pointer value is for DRAM
253  * access.
254  *
255  * @param total_size    Size of U-Boot (unused?)
256  */
257 ulong board_get_usable_ram_top(ulong total_size);
258
259 int board_early_init_f(void);
260
261 /* manipulate the U-Boot fdt before its relocation */
262 int board_fix_fdt(void *rw_fdt_blob);
263 int board_late_init(void);
264 int board_postclk_init(void); /* after clocks/timebase, before env/serial */
265 int board_early_init_r(void);
266
267 /* TODO(sjg@chromium.org): Drop this when DM_PCI migration is completed */
268 void pci_init_board(void);
269
270 void trap_init(unsigned long reloc_addr);
271
272 /**
273  * main_loop() - Enter the main loop of U-Boot
274  *
275  * This normally runs the command line.
276  */
277 void main_loop(void);
278
279 #if defined(CONFIG_ARM)
280 void relocate_code(ulong addr_moni);
281 #else
282 void relocate_code(ulong start_addr_sp, struct global_data *new_gd,
283                    ulong relocaddr)
284         __attribute__ ((noreturn));
285 #endif
286
287 /* Print a numeric value (for use in arch_print_bdinfo()) */
288 void bdinfo_print_num(const char *name, ulong value);
289
290 /* Print a clock speed in MHz */
291 void bdinfo_print_mhz(const char *name, unsigned long hz);
292
293 /* Show arch-specific information for the 'bd' command */
294 void arch_print_bdinfo(void);
295
296 #endif  /* __ASSEMBLY__ */
297 /* Put only stuff here that the assembler can digest */
298
299 #endif  /* __INIT_H_ */