blob: 88730816851c5c1a7cfeaa49f0e49299ea6e6121 [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/**
61 * arch_fsp_init() - perform 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.
Mario Sixdc145a72018-08-06 10:23:40 +020066 *
67 * Return: 0
Patrick Delaunayd6f87712018-03-13 13:57:00 +010068 */
69int arch_fsp_init(void);
70
Simon Glassfe08d392019-12-06 21:42:20 -070071/**
72 * arch_fsp_init() - perform post-relocation firmware support package init
73 *
74 * Where U-Boot relies on binary blobs to handle part of the system init, this
75 * function can be used to set up the blobs. This is used on some Intel
76 * platforms.
77 *
78 * Return: 0
79 */
80int arch_fsp_init_r(void);
81
Patrick Delaunayd6f87712018-03-13 13:57:00 +010082int dram_init(void);
83
84/**
85 * dram_init_banksize() - Set up DRAM bank sizes
86 *
87 * This can be implemented by boards to set up the DRAM bank information in
88 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
89 * is called.
90 *
91 * If this is not provided, a default implementation will try to set up a
92 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
Tom Riniaa6e94d2022-11-16 13:10:37 -050093 * CFG_SYS_SDRAM_BASE are set. The bank will have a start address of
94 * CFG_SYS_SDRAM_BASE and the size will be determined by a call to
Patrick Delaunayd6f87712018-03-13 13:57:00 +010095 * get_effective_memsize().
96 *
Mario Sixdc145a72018-08-06 10:23:40 +020097 * Return: 0 if OK, -ve on error
Patrick Delaunayd6f87712018-03-13 13:57:00 +010098 */
99int dram_init_banksize(void);
100
Simon Glass9b4a2052019-12-28 10:45:05 -0700101long get_ram_size(long *base, long size);
102phys_size_t get_effective_memsize(void);
103
Simon Glass49acd562019-12-28 10:45:06 -0700104int testdram(void);
105
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100106/**
Ovidiu Panaitd63fc992022-09-13 21:31:28 +0300107 * arch_setup_dest_addr() - Fix up initial reloc address
108 *
109 * This is called in generic board init sequence in common/board_f.c at the end
110 * of the setup_dest_addr() initcall. Each architecture could provide this
111 * function to make adjustments to the initial reloc address.
112 *
113 * If an implementation is not provided, it will just be a nop stub.
114 *
115 * Return: 0 if OK
116 */
117int arch_setup_dest_addr(void);
118
119/**
Mario Sixdc145a72018-08-06 10:23:40 +0200120 * arch_reserve_stacks() - Reserve all necessary stacks
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100121 *
122 * This is used in generic board init sequence in common/board_f.c. Each
123 * architecture could provide this function to tailor the required stacks.
124 *
125 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
126 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
127 * require only this can leave it untouched.
128 *
129 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
130 * positions of the stack. The stack pointer(s) will be set to this later.
131 * gd->irq_sp is only required, if the architecture needs it.
132 *
Mario Sixdc145a72018-08-06 10:23:40 +0200133 * Return: 0 if no error
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100134 */
135int arch_reserve_stacks(void);
136
Patrick Delaunayb8aa55c2018-03-13 13:57:04 +0100137/**
Ovidiu Panait79926e42020-03-29 20:57:41 +0300138 * arch_reserve_mmu() - Reserve memory for MMU TLB table
139 *
140 * Architecture-specific routine for reserving memory for the MMU TLB table.
141 * This is used in generic board init sequence in common/board_f.c.
142 *
143 * If an implementation is not provided, it will just be a nop stub.
144 *
145 * Return: 0 if OK
146 */
147int arch_reserve_mmu(void);
148
149/**
Ovidiu Panait81e7cb12020-07-24 14:12:15 +0300150 * arch_setup_bdinfo() - Architecture dependent boardinfo setup
151 *
152 * Architecture-specific routine for populating various boardinfo fields of
153 * gd->bd. It is called during the generic board init sequence.
154 *
155 * If an implementation is not provided, it will just be a nop stub.
156 *
157 * Return: 0 if OK
158 */
159int arch_setup_bdinfo(void);
160
161/**
Ovidiu Panaitba743102020-07-24 14:12:14 +0300162 * setup_bdinfo() - Generic boardinfo setup
163 *
164 * Routine for populating various generic boardinfo fields of
165 * gd->bd. It is called during the generic board init sequence.
166 *
167 * Return: 0 if OK
168 */
169int setup_bdinfo(void);
170
Dzmitry Sankouski12a3e1a2022-02-22 21:49:52 +0300171#if defined(CONFIG_SAVE_PREV_BL_INITRAMFS_START_ADDR) || \
172defined(CONFIG_SAVE_PREV_BL_FDT_ADDR)
173/**
174 * save_prev_bl_data - Save prev bl data in env vars.
175 *
176 * When u-boot is chain-loaded, save previous bootloader data,
177 * like initramfs address to environment variables.
178 *
179 * Return: 0 if ok; -ENODATA on error
180 */
181int save_prev_bl_data(void);
182#endif
183
Ovidiu Panaitba743102020-07-24 14:12:14 +0300184/**
Ovidiu Panaitfb504b22020-11-28 10:43:09 +0200185 * cpu_secondary_init_r() - CPU-specific secondary initialization
186 *
187 * After non-volatile devices, environment and cpu code are setup, have
188 * another round to deal with any initialization that might require
189 * full access to the environment or loading of some image (firmware)
190 * from a non-volatile device.
191 *
192 * It is called during the generic post-relocation init sequence.
193 *
194 * Return: 0 if OK
195 */
196int cpu_secondary_init_r(void);
197
198/**
Ovidiu Panaitc343e8c2020-11-28 10:43:11 +0200199 * pci_ep_init() - Initialize pci endpoint devices
200 *
201 * It is called during the generic post-relocation init sequence.
202 *
203 * Return: 0 if OK
204 */
205int pci_ep_init(void);
206
207/**
Ovidiu Panaitb9f6d0f2020-11-28 10:43:12 +0200208 * pci_init() - Enumerate pci devices
209 *
210 * It is called during the generic post-relocation init sequence to enumerate
211 * pci buses. This is needed, for instance, in the case of DM PCI-based
212 * Ethernet devices, which will not be detected without having the enumeration
213 * performed earlier.
214 *
215 * Return: 0 if OK
216 */
217int pci_init(void);
218
219/**
Patrick Delaunayb8aa55c2018-03-13 13:57:04 +0100220 * init_cache_f_r() - Turn on the cache in preparation for relocation
221 *
Mario Sixdc145a72018-08-06 10:23:40 +0200222 * Return: 0 if OK, -ve on error
Patrick Delaunayb8aa55c2018-03-13 13:57:04 +0100223 */
224int init_cache_f_r(void);
225
Mario Six5d6c61a2018-08-06 10:23:41 +0200226#if !CONFIG_IS_ENABLED(CPU)
227/**
228 * print_cpuinfo() - Display information about the CPU
229 *
230 * Return: 0 if OK, -ve on error
231 */
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100232int print_cpuinfo(void);
Mario Six5d6c61a2018-08-06 10:23:41 +0200233#endif
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100234int timer_init(void);
Mario Sixdc145a72018-08-06 10:23:40 +0200235
Patrick Delaunayd6f87712018-03-13 13:57:00 +0100236#if defined(CONFIG_DTB_RESELECT)
237int embedded_dtb_select(void);
238#endif
239
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100240/* common/init/board_init.c */
241extern ulong monitor_flash_len;
242
243/**
244 * ulong board_init_f_alloc_reserve - allocate reserved area
Mario Sixdc145a72018-08-06 10:23:40 +0200245 * @top: top of the reserve area, growing down.
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100246 *
247 * This function is called by each architecture very early in the start-up
248 * code to allow the C runtime to reserve space on the stack for writable
249 * 'globals' such as GD and the malloc arena.
250 *
Mario Sixdc145a72018-08-06 10:23:40 +0200251 * Return: bottom of reserved area
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100252 */
253ulong board_init_f_alloc_reserve(ulong top);
254
255/**
256 * board_init_f_init_reserve - initialize the reserved area(s)
Mario Sixdc145a72018-08-06 10:23:40 +0200257 * @base: top from which reservation was done
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100258 *
259 * This function is called once the C runtime has allocated the reserved
260 * area on the stack. It must initialize the GD at the base of that area.
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100261 */
262void board_init_f_init_reserve(ulong base);
263
Simon Glass67c4e9f2019-11-14 12:57:45 -0700264struct global_data;
265
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100266/**
267 * arch_setup_gd() - Set up the global_data pointer
Mario Sixdc145a72018-08-06 10:23:40 +0200268 * @gd_ptr: Pointer to global data
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100269 *
270 * This pointer is special in some architectures and cannot easily be assigned
271 * to. For example on x86 it is implemented by adding a specific record to its
272 * Global Descriptor Table! So we we provide a function to carry out this task.
273 * For most architectures this can simply be:
274 *
275 * gd = gd_ptr;
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100276 */
Simon Glass67c4e9f2019-11-14 12:57:45 -0700277void arch_setup_gd(struct global_data *gd_ptr);
Patrick Delaunay11f86cb2018-03-13 13:57:01 +0100278
Patrick Delaunaydafa84d2018-03-09 18:28:12 +0100279/* common/board_r.c */
Simon Glass67c4e9f2019-11-14 12:57:45 -0700280void board_init_r(struct global_data *id, ulong dest_addr)
281 __attribute__ ((noreturn));
Patrick Delaunaye2c219c2018-03-13 13:57:02 +0100282
283int cpu_init_r(void);
284int last_stage_init(void);
285int mac_read_from_eeprom(void);
286int set_cpu_clk_info(void);
287int update_flash_size(int flash_size);
288int arch_early_init_r(void);
Patrick Delaunaye2c219c2018-03-13 13:57:02 +0100289int misc_init_r(void);
290#if defined(CONFIG_VID)
291int init_func_vid(void);
292#endif
293
Patrick Delaunayfc22ee22018-03-13 13:57:03 +0100294/* common/board_info.c */
295int checkboard(void);
296int show_board_info(void);
Patrick Delaunaydafa84d2018-03-09 18:28:12 +0100297
Simon Glass67c4e9f2019-11-14 12:57:45 -0700298/**
299 * Get the uppermost pointer that is valid to access
300 *
301 * Some systems may not map all of their address space. This function allows
302 * boards to indicate what their highest support pointer value is for DRAM
303 * access.
304 *
305 * @param total_size Size of U-Boot (unused?)
306 */
Pali Rohár049704f2022-09-09 17:32:40 +0200307phys_size_t board_get_usable_ram_top(phys_size_t total_size);
Simon Glass67c4e9f2019-11-14 12:57:45 -0700308
Simon Glass52559322019-11-14 12:57:46 -0700309int board_early_init_f(void);
310
311/* manipulate the U-Boot fdt before its relocation */
312int board_fix_fdt(void *rw_fdt_blob);
313int board_late_init(void);
314int board_postclk_init(void); /* after clocks/timebase, before env/serial */
315int board_early_init_r(void);
316
Ovidiu Panait130845b2020-11-28 10:43:18 +0200317/**
318 * arch_initr_trap() - Init traps
319 *
320 * Arch specific routine for initializing traps. It is called during the
321 * generic board init sequence, after relocation.
322 *
323 * Return: 0 if OK
324 */
325int arch_initr_trap(void);
Simon Glassd67bdaa2019-11-14 12:57:48 -0700326
Simon Glass6b8d3ce2019-12-28 10:44:39 -0700327/**
Ovidiu Panait2fd81be2022-01-01 19:13:29 +0200328 * init_addr_map()
329 *
330 * Initialize non-identity virtual-physical memory mappings for 32bit CPUs.
331 * It is called during the generic board init sequence, after relocation.
332 *
333 * Return: 0 if OK
334 */
335int init_addr_map(void);
336
337/**
Simon Glass6b8d3ce2019-12-28 10:44:39 -0700338 * main_loop() - Enter the main loop of U-Boot
339 *
340 * This normally runs the command line.
341 */
342void main_loop(void);
343
Simon Glass94133872019-12-28 10:44:45 -0700344#if defined(CONFIG_ARM)
345void relocate_code(ulong addr_moni);
346#else
347void relocate_code(ulong start_addr_sp, struct global_data *new_gd,
348 ulong relocaddr)
349 __attribute__ ((noreturn));
350#endif
351
Simon Glass655f17f2020-05-10 14:16:55 -0600352/* Print a numeric value (for use in arch_print_bdinfo()) */
Bin Meng98592c72021-01-31 20:36:05 +0800353void bdinfo_print_num_l(const char *name, ulong value);
354void bdinfo_print_num_ll(const char *name, unsigned long long value);
Simon Glass655f17f2020-05-10 14:16:55 -0600355
Simon Glass40b8afe2023-03-10 12:47:14 -0800356/* Print a string value (for use in arch_print_bdinfo()) */
357void bdinfo_print_str(const char *name, const char *str);
358
Simon Glass655f17f2020-05-10 14:16:55 -0600359/* Print a clock speed in MHz */
360void bdinfo_print_mhz(const char *name, unsigned long hz);
361
Ovidiu Panaitae90d162022-08-29 20:02:04 +0300362/**
363 * bdinfo_print_size - print size variables in bdinfo format
364 * @name: string to print before the size
365 * @size: size to print
366 *
367 * Helper function for displaying size variables as properly formatted bdinfo
368 * entries. The size is printed as "xxx Bytes", "xxx KiB", "xxx MiB",
369 * "xxx GiB", etc. as needed;
370 *
371 * For use in arch_print_bdinfo().
372 */
373void bdinfo_print_size(const char *name, uint64_t size);
374
Simon Glass59b0d7d2020-05-10 14:16:56 -0600375/* Show arch-specific information for the 'bd' command */
376void arch_print_bdinfo(void);
377
Andy Shevchenko4b325312021-11-08 21:03:38 +0300378int do_bdinfo(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
379
Patrick Delaunaydafa84d2018-03-09 18:28:12 +0100380#endif /* __ASSEMBLY__ */
381/* Put only stuff here that the assembler can digest */
382
383#endif /* __INIT_H_ */