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 /**
 159  * cpu_secondary_init_r() - CPU-specific secondary initialization
 160  *
 161  * After non-volatile devices, environment and cpu code are setup, have
 162  * another round to deal with any initialization that might require
 163  * full access to the environment or loading of some image (firmware)
 164  * from a non-volatile device.
 165  *
 166  * It is called during the generic post-relocation init sequence.
 167  *
 168  * Return: 0 if OK
 169  */
 170 int cpu_secondary_init_r(void);
 171
 172 /**
 173  * pci_ep_init() - Initialize pci endpoint devices
 174  *
 175  * It is called during the generic post-relocation init sequence.
 176  *
 177  * Return: 0 if OK
 178  */
 179 int pci_ep_init(void);
 180
 181 /**
 182  * pci_init() - Enumerate pci devices
 183  *
 184  * It is called during the generic post-relocation init sequence to enumerate
 185  * pci buses. This is needed, for instance, in the case of DM PCI-based
 186  * Ethernet devices, which will not be detected without having the enumeration
 187  * performed earlier.
 188  *
 189  * Return: 0 if OK
 190  */
 191 int pci_init(void);
 192
 193 /**
 194  * init_cache_f_r() - Turn on the cache in preparation for relocation
 195  *
 196  * Return: 0 if OK, -ve on error
 197  */
 198 int init_cache_f_r(void);
 199
 200 #if !CONFIG_IS_ENABLED(CPU)
 201 /**
 202  * print_cpuinfo() - Display information about the CPU
 203  *
 204  * Return: 0 if OK, -ve on error
 205  */
 206 int print_cpuinfo(void);
 207 #endif
 208 int timer_init(void);
 209
 210 #if defined(CONFIG_DTB_RESELECT)
 211 int embedded_dtb_select(void);
 212 #endif
 213
 214 /* common/init/board_init.c */
 215 extern ulong monitor_flash_len;
 216
 217 /**
 218  * ulong board_init_f_alloc_reserve - allocate reserved area
 219  * @top: top of the reserve area, growing down.
 220  *
 221  * This function is called by each architecture very early in the start-up
 222  * code to allow the C runtime to reserve space on the stack for writable
 223  * 'globals' such as GD and the malloc arena.
 224  *
 225  * Return: bottom of reserved area
 226  */
 227 ulong board_init_f_alloc_reserve(ulong top);
 228
 229 /**
 230  * board_init_f_init_reserve - initialize the reserved area(s)
 231  * @base:       top from which reservation was done
 232  *
 233  * This function is called once the C runtime has allocated the reserved
 234  * area on the stack. It must initialize the GD at the base of that area.
 235  */
 236 void board_init_f_init_reserve(ulong base);
 237
 238 struct global_data;
 239
 240 /**
 241  * arch_setup_gd() - Set up the global_data pointer
 242  * @gd_ptr: Pointer to global data
 243  *
 244  * This pointer is special in some architectures and cannot easily be assigned
 245  * to. For example on x86 it is implemented by adding a specific record to its
 246  * Global Descriptor Table! So we we provide a function to carry out this task.
 247  * For most architectures this can simply be:
 248  *
 249  *    gd = gd_ptr;
 250  */
 251 void arch_setup_gd(struct global_data *gd_ptr);
 252
 253 /* common/board_r.c */
 254 void board_init_r(struct global_data *id, ulong dest_addr)
 255         __attribute__ ((noreturn));
 256
 257 int cpu_init_r(void);
 258 int last_stage_init(void);
 259 int mac_read_from_eeprom(void);
 260 int set_cpu_clk_info(void);
 261 int update_flash_size(int flash_size);
 262 int arch_early_init_r(void);
 263 int misc_init_r(void);
 264 #if defined(CONFIG_VID)
 265 int init_func_vid(void);
 266 #endif
 267
 268 /* common/board_info.c */
 269 int checkboard(void);
 270 int show_board_info(void);
 271
 272 /**
 273  * Get the uppermost pointer that is valid to access
 274  *
 275  * Some systems may not map all of their address space. This function allows
 276  * boards to indicate what their highest support pointer value is for DRAM
 277  * access.
 278  *
 279  * @param total_size    Size of U-Boot (unused?)
 280  */
 281 ulong board_get_usable_ram_top(ulong total_size);
 282
 283 int board_early_init_f(void);
 284
 285 /* manipulate the U-Boot fdt before its relocation */
 286 int board_fix_fdt(void *rw_fdt_blob);
 287 int board_late_init(void);
 288 int board_postclk_init(void); /* after clocks/timebase, before env/serial */
 289 int board_early_init_r(void);
 290
 291 /**
 292  * arch_initr_trap() - Init traps
 293  *
 294  * Arch specific routine for initializing traps. It is called during the
 295  * generic board init sequence, after relocation.
 296  *
 297  * Return: 0 if OK
 298  */
 299 int arch_initr_trap(void);
 300
 301 /**
 302  * init_addr_map()
 303  *
 304  * Initialize non-identity virtual-physical memory mappings for 32bit CPUs.
 305  * It is called during the generic board init sequence, after relocation.
 306  *
 307  * Return: 0 if OK
 308  */
 309 int init_addr_map(void);
 310
 311 /**
 312  * main_loop() - Enter the main loop of U-Boot
 313  *
 314  * This normally runs the command line.
 315  */
 316 void main_loop(void);
 317
 318 #if defined(CONFIG_ARM)
 319 void relocate_code(ulong addr_moni);
 320 #else
 321 void relocate_code(ulong start_addr_sp, struct global_data *new_gd,
 322                    ulong relocaddr)
 323         __attribute__ ((noreturn));
 324 #endif
 325
 326 /* Print a numeric value (for use in arch_print_bdinfo()) */
 327 void bdinfo_print_num_l(const char *name, ulong value);
 328 void bdinfo_print_num_ll(const char *name, unsigned long long value);
 329
 330 /* Print a clock speed in MHz */
 331 void bdinfo_print_mhz(const char *name, unsigned long hz);
 332
 333 /* Show arch-specific information for the 'bd' command */
 334 void arch_print_bdinfo(void);
 335
 336 int do_bdinfo(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
 337
 338 #endif  /* __ASSEMBLY__ */
 339 /* Put only stuff here that the assembler can digest */
 340
 341 #endif  /* __INIT_H_ */