blob: d57a24fd00dd1072ba6f6dd5d5754a7e8ab76bbe [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Patrick Delaunaydafa84d2018-03-09 18:28:12 +01002/*
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
Patrick Delaunaydafa84d2018-03-09 18:28:12 +01008 */
9
10#ifndef __INIT_H_
11#define __INIT_H_ 1
12
13#ifndef __ASSEMBLY__ /* put C only stuff in this section */
14
Simon Glass401d1c42020-10-30 21:38:53 -060015#include <linux/types.h>
16
Simon Glass90794862021-12-29 11:57:43 -070017/*
18 * In case of the EFI app the UEFI firmware provides the low-level
19 * initialisation.
20 */
21#ifdef CONFIG_EFI
Simon Glass35a3f872019-12-28 10:44:56 -070022#define ll_boot_init() false
23#else
Simon Glass401d1c42020-10-30 21:38:53 -060024#include <asm/global_data.h>
25
Simon Glassba974a02020-04-26 09:12:57 -060026#define ll_boot_init() (!(gd->flags & GD_FLG_SKIP_LL_INIT))
Simon Glass35a3f872019-12-28 10:44:56 -070027#endif
28
Patrick Delaunaydafa84d2018-03-09 18:28:12 +010029/*
30 * Function Prototypes
31 */
32
33/* common/board_f.c */
Patrick Delaunayd6f87712018-03-13 13:57:00 +010034void board_init_f(ulong dummy);
Patrick Delaunaydafa84d2018-03-09 18:28:12 +010035
36/**
37 * arch_cpu_init() - basic cpu-dependent setup for an architecture
38 *
39 * This is called after early malloc is available. It should handle any
40 * CPU- or SoC- specific init needed to continue the init sequence. See
41 * board_f.c for where it is called. If this is not provided, a default
42 * version (which does nothing) will be used.
43 *
Mario Sixdc145a72018-08-06 10:23:40 +020044 * Return: 0 on success, otherwise error
Patrick Delaunaydafa84d2018-03-09 18:28:12 +010045 */
46int arch_cpu_init(void);
47
48/**
49 * mach_cpu_init() - SoC/machine dependent CPU setup
50 *
51 * This is called after arch_cpu_init(). It should handle any
52 * SoC or machine specific init needed to continue the init sequence. See
53 * board_f.c for where it is called. If this is not provided, a default
54 * version (which does nothing) will be used.
55 *
Mario Sixdc145a72018-08-06 10:23:40 +020056 * Return: 0 on success, otherwise error
Patrick Delaunaydafa84d2018-03-09 18:28:12 +010057 */
58int mach_cpu_init(void);
59
Patrick Delaunayd6f87712018-03-13 13:57:00 +010060/**
Simon Glassfe08d392019-12-06 21:42:20 -070061 * arch_fsp_init() - perform post-relocation firmware support package init
62 *
63 * Where U-Boot relies on binary blobs to handle part of the system init, this
64 * function can be used to set up the blobs. This is used on some Intel
65 * platforms.
66 *
67 * Return: 0
68 */
69int arch_fsp_init_r(void);
70
Patrick Delaunayd6f87712018-03-13 13:57:00 +010071int dram_init(void);
72
73/**
74 * dram_init_banksize() - Set up DRAM bank sizes
75 *
76 * This can be implemented by boards to set up the DRAM bank information in
77 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
78 * is called.
79 *
80 * If this is not provided, a default implementation will try to set up a
81 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
Tom Riniaa6e94d2022-11-16 13:10:37 -050082 * CFG_SYS_SDRAM_BASE are set. The bank will have a start address of
83 * CFG_SYS_SDRAM_BASE and the size will be determined by a call to
Patrick Delaunayd6f87712018-03-13 13:57:00 +010084 * get_effective_memsize().
85 *
Mario Sixdc145a72018-08-06 10:23:40 +020086 * Return: 0 if OK, -ve on error
Patrick Delaunayd6f87712018-03-13 13:57:00 +010087 */
88int dram_init_banksize(void);
89
Simon Glass9b4a2052019-12-28 10:45:05 -070090long get_ram_size(long *base, long size);
91phys_size_t get_effective_memsize(void);
92
Simon Glass49acd562019-12-28 10:45:06 -070093int testdram(void);
94
Patrick Delaunayd6f87712018-03-13 13:57:00 +010095/**
Ovidiu Panaitd63fc992022-09-13 21:31:28 +030096 * arch_setup_dest_addr() - Fix up initial reloc address
97 *
98 * This is called in generic board init sequence in common/board_f.c at the end
99 * of the setup_dest_addr() initcall. Each architecture could provide this
100 * function to make adjustments to the initial reloc address.
101 *
102 * If an implementation is not provided, it will just be a nop stub.
103 *
104 * Return: 0 if OK
105 */
106int arch_setup_dest_addr(void);
107
108/**
Mario Sixdc145a72018-08-06 10:23:40 +0200109 * arch_reserve_stacks() - Reserve all necessary stacks
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100110 *
111 * This is used in generic board init sequence in common/board_f.c. Each
112 * architecture could provide this function to tailor the required stacks.
113 *
114 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
115 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
116 * require only this can leave it untouched.
117 *
118 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
119 * positions of the stack. The stack pointer(s) will be set to this later.
120 * gd->irq_sp is only required, if the architecture needs it.
121 *
Mario Sixdc145a72018-08-06 10:23:40 +0200122 * Return: 0 if no error
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100123 */
124int arch_reserve_stacks(void);
125
Patrick Delaunayb8aa55c2018-03-13 13:57:04 +0100126/**
Ovidiu Panait79926e42020-03-29 20:57:41 +0300127 * arch_reserve_mmu() - Reserve memory for MMU TLB table
128 *
129 * Architecture-specific routine for reserving memory for the MMU TLB table.
130 * This is used in generic board init sequence in common/board_f.c.
131 *
132 * If an implementation is not provided, it will just be a nop stub.
133 *
134 * Return: 0 if OK
135 */
136int arch_reserve_mmu(void);
137
138/**
Ovidiu Panait81e7cb12020-07-24 14:12:15 +0300139 * arch_setup_bdinfo() - Architecture dependent boardinfo setup
140 *
141 * Architecture-specific routine for populating various boardinfo fields of
142 * gd->bd. It is called during the generic board init sequence.
143 *
144 * If an implementation is not provided, it will just be a nop stub.
145 *
146 * Return: 0 if OK
147 */
148int arch_setup_bdinfo(void);
149
150/**
Ovidiu Panaitba743102020-07-24 14:12:14 +0300151 * setup_bdinfo() - Generic boardinfo setup
152 *
153 * Routine for populating various generic boardinfo fields of
154 * gd->bd. It is called during the generic board init sequence.
155 *
156 * Return: 0 if OK
157 */
158int setup_bdinfo(void);
159
Dzmitry Sankouski12a3e1a2022-02-22 21:49:52 +0300160#if defined(CONFIG_SAVE_PREV_BL_INITRAMFS_START_ADDR) || \
161defined(CONFIG_SAVE_PREV_BL_FDT_ADDR)
162/**
163 * save_prev_bl_data - Save prev bl data in env vars.
164 *
165 * When u-boot is chain-loaded, save previous bootloader data,
166 * like initramfs address to environment variables.
167 *
168 * Return: 0 if ok; -ENODATA on error
169 */
170int save_prev_bl_data(void);
171#endif
172
Ovidiu Panaitba743102020-07-24 14:12:14 +0300173/**
Ovidiu Panaitfb504b22020-11-28 10:43:09 +0200174 * cpu_secondary_init_r() - CPU-specific secondary initialization
175 *
176 * After non-volatile devices, environment and cpu code are setup, have
177 * another round to deal with any initialization that might require
178 * full access to the environment or loading of some image (firmware)
179 * from a non-volatile device.
180 *
181 * It is called during the generic post-relocation init sequence.
182 *
183 * Return: 0 if OK
184 */
185int cpu_secondary_init_r(void);
186
187/**
Ovidiu Panaitc343e8c2020-11-28 10:43:11 +0200188 * pci_ep_init() - Initialize pci endpoint devices
189 *
190 * It is called during the generic post-relocation init sequence.
191 *
192 * Return: 0 if OK
193 */
194int pci_ep_init(void);
195
196/**
Ovidiu Panaitb9f6d0f2020-11-28 10:43:12 +0200197 * pci_init() - Enumerate pci devices
198 *
199 * It is called during the generic post-relocation init sequence to enumerate
200 * pci buses. This is needed, for instance, in the case of DM PCI-based
201 * Ethernet devices, which will not be detected without having the enumeration
202 * performed earlier.
203 *
204 * Return: 0 if OK
205 */
206int pci_init(void);
207
208/**
Patrick Delaunayb8aa55c2018-03-13 13:57:04 +0100209 * init_cache_f_r() - Turn on the cache in preparation for relocation
210 *
Mario Sixdc145a72018-08-06 10:23:40 +0200211 * Return: 0 if OK, -ve on error
Patrick Delaunayb8aa55c2018-03-13 13:57:04 +0100212 */
213int init_cache_f_r(void);
214
Mario Six5d6c61a2018-08-06 10:23:41 +0200215#if !CONFIG_IS_ENABLED(CPU)
216/**
217 * print_cpuinfo() - Display information about the CPU
218 *
219 * Return: 0 if OK, -ve on error
220 */
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100221int print_cpuinfo(void);
Mario Six5d6c61a2018-08-06 10:23:41 +0200222#endif
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100223int timer_init(void);
Mario Sixdc145a72018-08-06 10:23:40 +0200224
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100225#if defined(CONFIG_DTB_RESELECT)
226int embedded_dtb_select(void);
227#endif
228
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100229/* common/init/board_init.c */
230extern ulong monitor_flash_len;
231
232/**
233 * ulong board_init_f_alloc_reserve - allocate reserved area
Mario Sixdc145a72018-08-06 10:23:40 +0200234 * @top: top of the reserve area, growing down.
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100235 *
236 * This function is called by each architecture very early in the start-up
237 * code to allow the C runtime to reserve space on the stack for writable
238 * 'globals' such as GD and the malloc arena.
239 *
Mario Sixdc145a72018-08-06 10:23:40 +0200240 * Return: bottom of reserved area
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100241 */
242ulong board_init_f_alloc_reserve(ulong top);
243
244/**
245 * board_init_f_init_reserve - initialize the reserved area(s)
Mario Sixdc145a72018-08-06 10:23:40 +0200246 * @base: top from which reservation was done
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100247 *
248 * This function is called once the C runtime has allocated the reserved
249 * area on the stack. It must initialize the GD at the base of that area.
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100250 */
251void board_init_f_init_reserve(ulong base);
252
Simon Glass67c4e9f2019-11-14 12:57:45 -0700253struct global_data;
254
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100255/**
256 * arch_setup_gd() - Set up the global_data pointer
Mario Sixdc145a72018-08-06 10:23:40 +0200257 * @gd_ptr: Pointer to global data
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100258 *
259 * This pointer is special in some architectures and cannot easily be assigned
260 * to. For example on x86 it is implemented by adding a specific record to its
261 * Global Descriptor Table! So we we provide a function to carry out this task.
262 * For most architectures this can simply be:
263 *
264 * gd = gd_ptr;
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100265 */
Simon Glass67c4e9f2019-11-14 12:57:45 -0700266void arch_setup_gd(struct global_data *gd_ptr);
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100267
Patrick Delaunaydafa84d2018-03-09 18:28:12 +0100268/* common/board_r.c */
Simon Glass67c4e9f2019-11-14 12:57:45 -0700269void board_init_r(struct global_data *id, ulong dest_addr)
270 __attribute__ ((noreturn));
Patrick Delaunaye2c219c2018-03-13 13:57:02 +0100271
272int cpu_init_r(void);
Patrick Delaunaye2c219c2018-03-13 13:57:02 +0100273int mac_read_from_eeprom(void);
Artur Rojekcd3dbb52023-10-18 16:00:56 +0200274
275/**
276 * serial_read_from_eeprom - read the serial number from EEPROM
277 *
278 * This function reads the serial number from the EEPROM and sets the
279 * appropriate environment variable.
280 *
281 * The environment variable is only set if it has not been set
282 * already. This ensures that any user-saved variables are never
283 * overwritten.
284 *
285 * This function must be called after relocation.
286 */
287int serial_read_from_eeprom(int devnum);
Patrick Delaunaye2c219c2018-03-13 13:57:02 +0100288int set_cpu_clk_info(void);
289int update_flash_size(int flash_size);
290int arch_early_init_r(void);
Patrick Delaunaye2c219c2018-03-13 13:57:02 +0100291int misc_init_r(void);
Patrick Delaunaye2c219c2018-03-13 13:57:02 +0100292
Patrick Delaunayfc22ee22018-03-13 13:57:03 +0100293/* common/board_info.c */
294int checkboard(void);
295int show_board_info(void);
Patrick Delaunaydafa84d2018-03-09 18:28:12 +0100296
Simon Glass67c4e9f2019-11-14 12:57:45 -0700297/**
Heinrich Schuchardt289bd722023-08-14 08:44:26 +0200298 * board_get_usable_ram_top() - get uppermost address for U-Boot relocation
Simon Glass67c4e9f2019-11-14 12:57:45 -0700299 *
Heinrich Schuchardt289bd722023-08-14 08:44:26 +0200300 * Some systems have reserved memory areas in high memory. By implementing this
301 * function boards can indicate the highest address value to be used when
302 * relocating U-Boot. The returned address is exclusive (i.e. 1 byte above the
303 * last usable address).
Simon Glass67c4e9f2019-11-14 12:57:45 -0700304 *
Heinrich Schuchardt289bd722023-08-14 08:44:26 +0200305 * Due to overflow on systems with 32bit phys_addr_t a value 0 is used instead
306 * of 4GiB.
307 *
308 * @total_size: monitor length in bytes (size of U-Boot code)
309 * Return: uppermost address for U-Boot relocation
Simon Glass67c4e9f2019-11-14 12:57:45 -0700310 */
Heinrich Schuchardtd768dd82023-08-12 20:16:58 +0200311phys_addr_t board_get_usable_ram_top(phys_size_t total_size);
Simon Glass67c4e9f2019-11-14 12:57:45 -0700312
Simon Glass52559322019-11-14 12:57:46 -0700313int board_early_init_f(void);
314
315/* manipulate the U-Boot fdt before its relocation */
316int board_fix_fdt(void *rw_fdt_blob);
317int board_late_init(void);
318int board_postclk_init(void); /* after clocks/timebase, before env/serial */
319int board_early_init_r(void);
320
Ovidiu Panait130845b2020-11-28 10:43:18 +0200321/**
322 * arch_initr_trap() - Init traps
323 *
324 * Arch specific routine for initializing traps. It is called during the
325 * generic board init sequence, after relocation.
326 *
327 * Return: 0 if OK
328 */
329int arch_initr_trap(void);
Simon Glassd67bdaa2019-11-14 12:57:48 -0700330
Simon Glass6b8d3ce2019-12-28 10:44:39 -0700331/**
Ovidiu Panait2fd81be2022-01-01 19:13:29 +0200332 * init_addr_map()
333 *
334 * Initialize non-identity virtual-physical memory mappings for 32bit CPUs.
335 * It is called during the generic board init sequence, after relocation.
336 *
337 * Return: 0 if OK
338 */
339int init_addr_map(void);
340
341/**
Simon Glass6b8d3ce2019-12-28 10:44:39 -0700342 * main_loop() - Enter the main loop of U-Boot
343 *
344 * This normally runs the command line.
345 */
346void main_loop(void);
347
Simon Glass94133872019-12-28 10:44:45 -0700348#if defined(CONFIG_ARM)
349void relocate_code(ulong addr_moni);
350#else
351void relocate_code(ulong start_addr_sp, struct global_data *new_gd,
352 ulong relocaddr)
353 __attribute__ ((noreturn));
354#endif
355
Simon Glass655f17f2020-05-10 14:16:55 -0600356/* Print a numeric value (for use in arch_print_bdinfo()) */
Bin Meng98592c72021-01-31 20:36:05 +0800357void bdinfo_print_num_l(const char *name, ulong value);
358void bdinfo_print_num_ll(const char *name, unsigned long long value);
Simon Glass655f17f2020-05-10 14:16:55 -0600359
Simon Glass40b8afe2023-03-10 12:47:14 -0800360/* Print a string value (for use in arch_print_bdinfo()) */
361void bdinfo_print_str(const char *name, const char *str);
362
Simon Glass655f17f2020-05-10 14:16:55 -0600363/* Print a clock speed in MHz */
364void bdinfo_print_mhz(const char *name, unsigned long hz);
365
Ovidiu Panaitae90d162022-08-29 20:02:04 +0300366/**
367 * bdinfo_print_size - print size variables in bdinfo format
368 * @name: string to print before the size
369 * @size: size to print
370 *
371 * Helper function for displaying size variables as properly formatted bdinfo
372 * entries. The size is printed as "xxx Bytes", "xxx KiB", "xxx MiB",
373 * "xxx GiB", etc. as needed;
374 *
375 * For use in arch_print_bdinfo().
376 */
377void bdinfo_print_size(const char *name, uint64_t size);
378
Simon Glass59b0d7d2020-05-10 14:16:56 -0600379/* Show arch-specific information for the 'bd' command */
380void arch_print_bdinfo(void);
381
Andy Shevchenko4b325312021-11-08 21:03:38 +0300382int do_bdinfo(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
383
Patrick Delaunaydafa84d2018-03-09 18:28:12 +0100384#endif /* __ASSEMBLY__ */
385/* Put only stuff here that the assembler can digest */
386
387#endif /* __INIT_H_ */