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 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(void);
  70
  71 /**
  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  */
  80 int arch_fsp_init_r(void);
  81
  82 int 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
  93  * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
  94  * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
  95  * get_effective_memsize().
  96  *
  97  * Return: 0 if OK, -ve on error
  98  */
  99 int dram_init_banksize(void);
 100
 101 long get_ram_size(long *base, long size);
 102 phys_size_t get_effective_memsize(void);
 103
 104 int testdram(void);
 105
 106 /**
 107  * arch_reserve_stacks() - Reserve all necessary stacks
 108  *
 109  * This is used in generic board init sequence in common/board_f.c. Each
 110  * architecture could provide this function to tailor the required stacks.
 111  *
 112  * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
 113  * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
 114  * require only this can leave it untouched.
 115  *
 116  * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
 117  * positions of the stack. The stack pointer(s) will be set to this later.
 118  * gd->irq_sp is only required, if the architecture needs it.
 119  *
 120  * Return: 0 if no error
 121  */
 122 int arch_reserve_stacks(void);
 123
 124 /**
 125  * arch_reserve_mmu() - Reserve memory for MMU TLB table
 126  *
 127  * Architecture-specific routine for reserving memory for the MMU TLB table.
 128  * This is used in generic board init sequence in common/board_f.c.
 129  *
 130  * If an implementation is not provided, it will just be a nop stub.
 131  *
 132  * Return: 0 if OK
 133  */
 134 int arch_reserve_mmu(void);
 135
 136 /**
 137  * arch_setup_bdinfo() - Architecture dependent boardinfo setup
 138  *
 139  * Architecture-specific routine for populating various boardinfo fields of
 140  * gd->bd. It is called during the generic board init sequence.
 141  *
 142  * If an implementation is not provided, it will just be a nop stub.
 143  *
 144  * Return: 0 if OK
 145  */
 146 int arch_setup_bdinfo(void);
 147
 148 /**
 149  * setup_bdinfo() - Generic boardinfo setup
 150  *
 151  * Routine for populating various generic boardinfo fields of
 152  * gd->bd. It is called during the generic board init sequence.
 153  *
 154  * Return: 0 if OK
 155  */
 156 int setup_bdinfo(void);
 157
 158 #if defined(CONFIG_SAVE_PREV_BL_INITRAMFS_START_ADDR) || \
 159 defined(CONFIG_SAVE_PREV_BL_FDT_ADDR)
 160 /**
 161  * save_prev_bl_data - Save prev bl data in env vars.
 162  *
 163  * When u-boot is chain-loaded, save previous bootloader data,
 164  * like initramfs address to environment variables.
 165  *
 166  * Return: 0 if ok; -ENODATA on error
 167  */
 168 int save_prev_bl_data(void);
 169 #endif
 170
 171 /**
 172  * cpu_secondary_init_r() - CPU-specific secondary initialization
 173  *
 174  * After non-volatile devices, environment and cpu code are setup, have
 175  * another round to deal with any initialization that might require
 176  * full access to the environment or loading of some image (firmware)
 177  * from a non-volatile device.
 178  *
 179  * It is called during the generic post-relocation init sequence.
 180  *
 181  * Return: 0 if OK
 182  */
 183 int cpu_secondary_init_r(void);
 184
 185 /**
 186  * pci_ep_init() - Initialize pci endpoint devices
 187  *
 188  * It is called during the generic post-relocation init sequence.
 189  *
 190  * Return: 0 if OK
 191  */
 192 int pci_ep_init(void);
 193
 194 /**
 195  * pci_init() - Enumerate pci devices
 196  *
 197  * It is called during the generic post-relocation init sequence to enumerate
 198  * pci buses. This is needed, for instance, in the case of DM PCI-based
 199  * Ethernet devices, which will not be detected without having the enumeration
 200  * performed earlier.
 201  *
 202  * Return: 0 if OK
 203  */
 204 int pci_init(void);
 205
 206 /**
 207  * init_cache_f_r() - Turn on the cache in preparation for relocation
 208  *
 209  * Return: 0 if OK, -ve on error
 210  */
 211 int init_cache_f_r(void);
 212
 213 #if !CONFIG_IS_ENABLED(CPU)
 214 /**
 215  * print_cpuinfo() - Display information about the CPU
 216  *
 217  * Return: 0 if OK, -ve on error
 218  */
 219 int print_cpuinfo(void);
 220 #endif
 221 int timer_init(void);
 222
 223 #if defined(CONFIG_DTB_RESELECT)
 224 int embedded_dtb_select(void);
 225 #endif
 226
 227 /* common/init/board_init.c */
 228 extern ulong monitor_flash_len;
 229
 230 /**
 231  * ulong board_init_f_alloc_reserve - allocate reserved area
 232  * @top: top of the reserve area, growing down.
 233  *
 234  * This function is called by each architecture very early in the start-up
 235  * code to allow the C runtime to reserve space on the stack for writable
 236  * 'globals' such as GD and the malloc arena.
 237  *
 238  * Return: bottom of reserved area
 239  */
 240 ulong board_init_f_alloc_reserve(ulong top);
 241
 242 /**
 243  * board_init_f_init_reserve - initialize the reserved area(s)
 244  * @base:       top from which reservation was done
 245  *
 246  * This function is called once the C runtime has allocated the reserved
 247  * area on the stack. It must initialize the GD at the base of that area.
 248  */
 249 void board_init_f_init_reserve(ulong base);
 250
 251 struct global_data;
 252
 253 /**
 254  * arch_setup_gd() - Set up the global_data pointer
 255  * @gd_ptr: Pointer to global data
 256  *
 257  * This pointer is special in some architectures and cannot easily be assigned
 258  * to. For example on x86 it is implemented by adding a specific record to its
 259  * Global Descriptor Table! So we we provide a function to carry out this task.
 260  * For most architectures this can simply be:
 261  *
 262  *    gd = gd_ptr;
 263  */
 264 void arch_setup_gd(struct global_data *gd_ptr);
 265
 266 /* common/board_r.c */
 267 void board_init_r(struct global_data *id, ulong dest_addr)
 268         __attribute__ ((noreturn));
 269
 270 int cpu_init_r(void);
 271 int last_stage_init(void);
 272 int mac_read_from_eeprom(void);
 273 int set_cpu_clk_info(void);
 274 int update_flash_size(int flash_size);
 275 int arch_early_init_r(void);
 276 int misc_init_r(void);
 277 #if defined(CONFIG_VID)
 278 int init_func_vid(void);
 279 #endif
 280
 281 /* common/board_info.c */
 282 int checkboard(void);
 283 int show_board_info(void);
 284
 285 /**
 286  * Get the uppermost pointer that is valid to access
 287  *
 288  * Some systems may not map all of their address space. This function allows
 289  * boards to indicate what their highest support pointer value is for DRAM
 290  * access.
 291  *
 292  * @param total_size    Size of U-Boot (unused?)
 293  */
 294 ulong board_get_usable_ram_top(ulong total_size);
 295
 296 int board_early_init_f(void);
 297
 298 /* manipulate the U-Boot fdt before its relocation */
 299 int board_fix_fdt(void *rw_fdt_blob);
 300 int board_late_init(void);
 301 int board_postclk_init(void); /* after clocks/timebase, before env/serial */
 302 int board_early_init_r(void);
 303
 304 /**
 305  * arch_initr_trap() - Init traps
 306  *
 307  * Arch specific routine for initializing traps. It is called during the
 308  * generic board init sequence, after relocation.
 309  *
 310  * Return: 0 if OK
 311  */
 312 int arch_initr_trap(void);
 313
 314 /**
 315  * init_addr_map()
 316  *
 317  * Initialize non-identity virtual-physical memory mappings for 32bit CPUs.
 318  * It is called during the generic board init sequence, after relocation.
 319  *
 320  * Return: 0 if OK
 321  */
 322 int init_addr_map(void);
 323
 324 /**
 325  * main_loop() - Enter the main loop of U-Boot
 326  *
 327  * This normally runs the command line.
 328  */
 329 void main_loop(void);
 330
 331 #if defined(CONFIG_ARM)
 332 void relocate_code(ulong addr_moni);
 333 #else
 334 void relocate_code(ulong start_addr_sp, struct global_data *new_gd,
 335                    ulong relocaddr)
 336         __attribute__ ((noreturn));
 337 #endif
 338
 339 /* Print a numeric value (for use in arch_print_bdinfo()) */
 340 void bdinfo_print_num_l(const char *name, ulong value);
 341 void bdinfo_print_num_ll(const char *name, unsigned long long value);
 342
 343 /* Print a clock speed in MHz */
 344 void bdinfo_print_mhz(const char *name, unsigned long hz);
 345
 346 /* Show arch-specific information for the 'bd' command */
 347 void arch_print_bdinfo(void);
 348
 349 int do_bdinfo(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
 350
 351 #endif  /* __ASSEMBLY__ */
 352 /* Put only stuff here that the assembler can digest */
 353
 354 #endif  /* __INIT_H_ */