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 #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
  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 #endif
 172
 173 /**
 174  * 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  */
 185 int cpu_secondary_init_r(void);
 186
 187 /**
 188  * 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  */
 194 int pci_ep_init(void);
 195
 196 /**
 197  * 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  */
 206 int pci_init(void);
 207
 208 /**
 209  * init_cache_f_r() - Turn on the cache in preparation for relocation
 210  *
 211  * Return: 0 if OK, -ve on error
 212  */
 213 int init_cache_f_r(void);
 214
 215 #if !CONFIG_IS_ENABLED(CPU)
 216 /**
 217  * print_cpuinfo() - Display information about the CPU
 218  *
 219  * Return: 0 if OK, -ve on error
 220  */
 221 int print_cpuinfo(void);
 222 #endif
 223 int timer_init(void);
 224
 225 #if defined(CONFIG_DTB_RESELECT)
 226 int embedded_dtb_select(void);
 227 #endif
 228
 229 /* common/init/board_init.c */
 230 extern ulong monitor_flash_len;
 231
 232 /**
 233  * ulong board_init_f_alloc_reserve - allocate reserved area
 234  * @top: top of the reserve area, growing down.
 235  *
 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  *
 240  * Return: bottom of reserved area
 241  */
 242 ulong board_init_f_alloc_reserve(ulong top);
 243
 244 /**
 245  * board_init_f_init_reserve - initialize the reserved area(s)
 246  * @base:       top from which reservation was done
 247  *
 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.
 250  */
 251 void board_init_f_init_reserve(ulong base);
 252
 253 struct global_data;
 254
 255 /**
 256  * arch_setup_gd() - Set up the global_data pointer
 257  * @gd_ptr: Pointer to global data
 258  *
 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;
 265  */
 266 void arch_setup_gd(struct global_data *gd_ptr);
 267
 268 /* common/board_r.c */
 269 void board_init_r(struct global_data *id, ulong dest_addr)
 270         __attribute__ ((noreturn));
 271
 272 int cpu_init_r(void);
 273 int mac_read_from_eeprom(void);
 274
 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  */
 287 int serial_read_from_eeprom(int devnum);
 288 int set_cpu_clk_info(void);
 289 int update_flash_size(int flash_size);
 290 int arch_early_init_r(void);
 291 int misc_init_r(void);
 292
 293 /* common/board_info.c */
 294 int checkboard(void);
 295
 296 /**
 297  * show_board_info() - Show board information
 298  *
 299  * Check sysinfo for board information. Failing that if the root node of the DTB
 300  * has a "model" property, show it.
 301  *
 302  * Then call checkboard().
 303  *
 304  * Return 0 if OK, -ve on error
 305  */
 306 int show_board_info(void);
 307
 308 /**
 309  * board_get_usable_ram_top() - get uppermost address for U-Boot relocation
 310  *
 311  * Some systems have reserved memory areas in high memory. By implementing this
 312  * function boards can indicate the highest address value to be used when
 313  * relocating U-Boot. The returned address is exclusive (i.e. 1 byte above the
 314  * last usable address).
 315  *
 316  * Due to overflow on systems with 32bit phys_addr_t a value 0 is used instead
 317  * of 4GiB.
 318  *
 319  * @total_size: monitor length in bytes (size of U-Boot code)
 320  * Return:      uppermost address for U-Boot relocation
 321  */
 322 phys_addr_t board_get_usable_ram_top(phys_size_t total_size);
 323
 324 int board_early_init_f(void);
 325
 326 /* manipulate the U-Boot fdt before its relocation */
 327 int board_fix_fdt(void *rw_fdt_blob);
 328 int board_late_init(void);
 329 int board_postclk_init(void); /* after clocks/timebase, before env/serial */
 330 int board_early_init_r(void);
 331
 332 /**
 333  * arch_initr_trap() - Init traps
 334  *
 335  * Arch specific routine for initializing traps. It is called during the
 336  * generic board init sequence, after relocation.
 337  *
 338  * Return: 0 if OK
 339  */
 340 int arch_initr_trap(void);
 341
 342 /**
 343  * init_addr_map()
 344  *
 345  * Initialize non-identity virtual-physical memory mappings for 32bit CPUs.
 346  * It is called during the generic board init sequence, after relocation.
 347  *
 348  * Return: 0 if OK
 349  */
 350 int init_addr_map(void);
 351
 352 /**
 353  * main_loop() - Enter the main loop of U-Boot
 354  *
 355  * This normally runs the command line.
 356  */
 357 void main_loop(void);
 358
 359 #if defined(CONFIG_ARM)
 360 void relocate_code(ulong addr_moni);
 361 #else
 362 void relocate_code(ulong start_addr_sp, struct global_data *new_gd,
 363                    ulong relocaddr)
 364         __attribute__ ((noreturn));
 365 #endif
 366
 367 /* Print a numeric value (for use in arch_print_bdinfo()) */
 368 void bdinfo_print_num_l(const char *name, ulong value);
 369 void bdinfo_print_num_ll(const char *name, unsigned long long value);
 370
 371 /* Print a string value (for use in arch_print_bdinfo()) */
 372 void bdinfo_print_str(const char *name, const char *str);
 373
 374 /* Print a clock speed in MHz */
 375 void bdinfo_print_mhz(const char *name, unsigned long hz);
 376
 377 /**
 378  * bdinfo_print_size - print size variables in bdinfo format
 379  * @name:       string to print before the size
 380  * @size:       size to print
 381  *
 382  * Helper function for displaying size variables as properly formatted bdinfo
 383  * entries. The size is printed as "xxx Bytes", "xxx KiB", "xxx MiB",
 384  * "xxx GiB", etc. as needed;
 385  *
 386  * For use in arch_print_bdinfo().
 387  */
 388 void bdinfo_print_size(const char *name, uint64_t size);
 389
 390 /* Show arch-specific information for the 'bd' command */
 391 void arch_print_bdinfo(void);
 392
 393 int do_bdinfo(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
 394
 395 #endif  /* __ASSEMBLY__ */
 396 /* Put only stuff here that the assembler can digest */
 397
 398 #endif  /* __INIT_H_ */