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 #ifndef __ASSEMBLY__ /* put C only stuff in this section */ 14 15 #include <linux/types.h> 16 17 /* 18 * In case of the EFI app the UEFI firmware provides the low-level 19 * initialisation. 20 */ 21 #ifdef CONFIG_EFI_CLIENT 22 #define ll_boot_init() false 23 #else 24 #include <asm/global_data.h> 25 26 #define ll_boot_init() (!(gd->flags & GD_FLG_SKIP_LL_INIT)) 27 #endif 28 29 /* 30 * Function Prototypes 31 */ 32 33 /* common/board_f.c */ 34 void board_init_f(ulong dummy); 35 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 * 44 * Return: 0 on success, otherwise error 45 */ 46 int 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 * 56 * Return: 0 on success, otherwise error 57 */ 58 int mach_cpu_init(void); 59 60 /** 61 * 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 */ 69 int arch_fsp_init_r(void); 70 71 int 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 82 * 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 84 * get_effective_memsize(). 85 * 86 * Return: 0 if OK, -ve on error 87 */ 88 int dram_init_banksize(void); 89 90 long get_ram_size(long *base, long size); 91 phys_size_t get_effective_memsize(void); 92 93 int testdram(void); 94 95 /** 96 * 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 */ 106 int arch_setup_dest_addr(void); 107 108 /** 109 * arch_reserve_stacks() - Reserve all necessary stacks 110 * 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 * 122 * Return: 0 if no error 123 */ 124 int arch_reserve_stacks(void); 125 126 /** 127 * 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 */ 136 int arch_reserve_mmu(void); 137 138 /** 139 * 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 */ 148 int arch_setup_bdinfo(void); 149 150 /** 151 * 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 */ 158 int setup_bdinfo(void); 159 160 #if defined(CONFIG_SAVE_PREV_BL_INITRAMFS_START_ADDR) || \ 161 defined(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 */ 170 int save_prev_bl_data(void); 171 172 /** 173 * get_prev_bl_fdt_addr - When u-boot is chainloaded, get the address 174 * of the FDT passed by the previous bootloader. 175 * 176 * Return: the address of the FDT passed by the previous bootloader 177 * or 0 if not found. 178 */ 179 phys_addr_t get_prev_bl_fdt_addr(void); 180 #else 181 #define get_prev_bl_fdt_addr() 0LLU 182 #endif 183 184 /** 185 * 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 */ 196 int cpu_secondary_init_r(void); 197 198 /** 199 * 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 */ 205 int pci_ep_init(void); 206 207 /** 208 * 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 */ 217 int pci_init(void); 218 219 /** 220 * init_cache_f_r() - Turn on the cache in preparation for relocation 221 * 222 * Return: 0 if OK, -ve on error 223 */ 224 int init_cache_f_r(void); 225 226 #if !CONFIG_IS_ENABLED(CPU) 227 /** 228 * print_cpuinfo() - Display information about the CPU 229 * 230 * Return: 0 if OK, -ve on error 231 */ 232 int print_cpuinfo(void); 233 #endif 234 int timer_init(void); 235 236 #if defined(CONFIG_DTB_RESELECT) 237 int embedded_dtb_select(void); 238 #endif 239 240 /* common/init/board_init.c */ 241 extern ulong monitor_flash_len; 242 243 /** 244 * ulong board_init_f_alloc_reserve - allocate reserved area 245 * @top: top of the reserve area, growing down. 246 * 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 * 251 * Return: bottom of reserved area 252 */ 253 ulong board_init_f_alloc_reserve(ulong top); 254 255 /** 256 * board_init_f_init_reserve - initialize the reserved area(s) 257 * @base: top from which reservation was done 258 * 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. 261 */ 262 void board_init_f_init_reserve(ulong base); 263 264 struct global_data; 265 266 /** 267 * arch_setup_gd() - Set up the global_data pointer 268 * @gd_ptr: Pointer to global data 269 * 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; 276 */ 277 void arch_setup_gd(struct global_data *gd_ptr); 278 279 /* common/board_r.c */ 280 void board_init_r(struct global_data *id, ulong dest_addr) 281 __attribute__ ((noreturn)); 282 283 int cpu_init_r(void); 284 int mac_read_from_eeprom(void); 285 286 /** 287 * serial_read_from_eeprom - read the serial number from EEPROM 288 * 289 * This function reads the serial number from the EEPROM and sets the 290 * appropriate environment variable. 291 * 292 * The environment variable is only set if it has not been set 293 * already. This ensures that any user-saved variables are never 294 * overwritten. 295 * 296 * This function must be called after relocation. 297 */ 298 int serial_read_from_eeprom(int devnum); 299 int set_cpu_clk_info(void); 300 int update_flash_size(int flash_size); 301 int arch_early_init_r(void); 302 int misc_init_r(void); 303 304 /* common/board_info.c */ 305 int checkboard(void); 306 307 /** 308 * show_board_info() - Show board information 309 * 310 * Check sysinfo for board information. Failing that if the root node of the DTB 311 * has a "model" property, show it. 312 * 313 * Then call checkboard(). 314 * 315 * Return 0 if OK, -ve on error 316 */ 317 int show_board_info(void); 318 319 /** 320 * board_get_usable_ram_top() - get uppermost address for U-Boot relocation 321 * 322 * Some systems have reserved memory areas in high memory. By implementing this 323 * function boards can indicate the highest address value to be used when 324 * relocating U-Boot. The returned address is exclusive (i.e. 1 byte above the 325 * last usable address). 326 * 327 * Due to overflow on systems with 32bit phys_addr_t a value 0 is used instead 328 * of 4GiB. 329 * 330 * @total_size: monitor length in bytes (size of U-Boot code) 331 * Return: uppermost address for U-Boot relocation 332 */ 333 phys_addr_t board_get_usable_ram_top(phys_size_t total_size); 334 335 int board_early_init_f(void); 336 337 /* manipulate the U-Boot fdt before its relocation */ 338 int board_fix_fdt(void *rw_fdt_blob); 339 int board_late_init(void); 340 int board_postclk_init(void); /* after clocks/timebase, before env/serial */ 341 int board_early_init_r(void); 342 343 /** 344 * arch_initr_trap() - Init traps 345 * 346 * Arch specific routine for initializing traps. It is called during the 347 * generic board init sequence, after relocation. 348 * 349 * Return: 0 if OK 350 */ 351 int arch_initr_trap(void); 352 353 /** 354 * init_addr_map() 355 * 356 * Initialize non-identity virtual-physical memory mappings for 32bit CPUs. 357 * It is called during the generic board init sequence, after relocation. 358 * 359 * Return: 0 if OK 360 */ 361 int init_addr_map(void); 362 363 /** 364 * main_loop() - Enter the main loop of U-Boot 365 * 366 * This normally runs the command line. 367 */ 368 void main_loop(void); 369 370 #if defined(CONFIG_ARM) 371 void relocate_code(ulong addr_moni); 372 #else 373 void relocate_code(ulong start_addr_sp, struct global_data *new_gd, 374 ulong relocaddr) 375 __attribute__ ((noreturn)); 376 #endif 377 378 /* Print a numeric value (for use in arch_print_bdinfo()) */ 379 void bdinfo_print_num_l(const char *name, ulong value); 380 void bdinfo_print_num_ll(const char *name, unsigned long long value); 381 382 /* Print a string value (for use in arch_print_bdinfo()) */ 383 void bdinfo_print_str(const char *name, const char *str); 384 385 /* Print a clock speed in MHz */ 386 void bdinfo_print_mhz(const char *name, unsigned long hz); 387 388 /** 389 * bdinfo_print_size - print size variables in bdinfo format 390 * @name: string to print before the size 391 * @size: size to print 392 * 393 * Helper function for displaying size variables as properly formatted bdinfo 394 * entries. The size is printed as "xxx Bytes", "xxx KiB", "xxx MiB", 395 * "xxx GiB", etc. as needed; 396 * 397 * For use in arch_print_bdinfo(). 398 */ 399 void bdinfo_print_size(const char *name, uint64_t size); 400 401 /* Show arch-specific information for the 'bd' command */ 402 void arch_print_bdinfo(void); 403 404 struct cmd_tbl; 405 406 int do_bdinfo(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]); 407 408 #endif /* __ASSEMBLY__ */ 409 /* Put only stuff here that the assembler can digest */ 410 411 #endif /* __INIT_H_ */ 412