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 #include <linux/types.h>
  14
  15 struct global_data;
  16
  17 #ifndef __ASSEMBLY__            /* put C only stuff in this section */
  18
  19 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
  20 #ifdef CONFIG_EFI_STUB
  21 #define ll_boot_init()  false
  22 #else
  23 #define ll_boot_init()  true
  24 #endif
  25
  26 /*
  27  * Function Prototypes
  28  */
  29
  30 /* common/board_f.c */
  31 void board_init_f(ulong dummy);
  32
  33 /**
  34  * arch_cpu_init() - basic cpu-dependent setup for an architecture
  35  *
  36  * This is called after early malloc is available. It should handle any
  37  * CPU- or SoC- specific init needed to continue the init sequence. See
  38  * board_f.c for where it is called. If this is not provided, a default
  39  * version (which does nothing) will be used.
  40  *
  41  * Return: 0 on success, otherwise error
  42  */
  43 int arch_cpu_init(void);
  44
  45 /**
  46  * arch_cpu_init_dm() - init CPU after driver model is available
  47  *
  48  * This is called immediately after driver model is available before
  49  * relocation. This is similar to arch_cpu_init() but is able to reference
  50  * devices
  51  *
  52  * Return: 0 if OK, -ve on error
  53  */
  54 int arch_cpu_init_dm(void);
  55
  56 /**
  57  * mach_cpu_init() - SoC/machine dependent CPU setup
  58  *
  59  * This is called after arch_cpu_init(). It should handle any
  60  * SoC or machine specific init needed to continue the init sequence. See
  61  * board_f.c for where it is called. If this is not provided, a default
  62  * version (which does nothing) will be used.
  63  *
  64  * Return: 0 on success, otherwise error
  65  */
  66 int mach_cpu_init(void);
  67
  68 /**
  69  * arch_fsp_init() - perform firmware support package init
  70  *
  71  * Where U-Boot relies on binary blobs to handle part of the system init, this
  72  * function can be used to set up the blobs. This is used on some Intel
  73  * platforms.
  74  *
  75  * Return: 0
  76  */
  77 int arch_fsp_init(void);
  78
  79 /**
  80  * arch_fsp_init() - perform post-relocation firmware support package init
  81  *
  82  * Where U-Boot relies on binary blobs to handle part of the system init, this
  83  * function can be used to set up the blobs. This is used on some Intel
  84  * platforms.
  85  *
  86  * Return: 0
  87  */
  88 int arch_fsp_init_r(void);
  89
  90 int dram_init(void);
  91
  92 /**
  93  * dram_init_banksize() - Set up DRAM bank sizes
  94  *
  95  * This can be implemented by boards to set up the DRAM bank information in
  96  * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
  97  * is called.
  98  *
  99  * If this is not provided, a default implementation will try to set up a
 100  * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
 101  * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
 102  * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
 103  * get_effective_memsize().
 104  *
 105  * Return: 0 if OK, -ve on error
 106  */
 107 int dram_init_banksize(void);
 108
 109 long get_ram_size(long *base, long size);
 110 phys_size_t get_effective_memsize(void);
 111
 112 /**
 113  * arch_reserve_stacks() - Reserve all necessary stacks
 114  *
 115  * This is used in generic board init sequence in common/board_f.c. Each
 116  * architecture could provide this function to tailor the required stacks.
 117  *
 118  * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
 119  * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
 120  * require only this can leave it untouched.
 121  *
 122  * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
 123  * positions of the stack. The stack pointer(s) will be set to this later.
 124  * gd->irq_sp is only required, if the architecture needs it.
 125  *
 126  * Return: 0 if no error
 127  */
 128 int arch_reserve_stacks(void);
 129
 130 /**
 131  * init_cache_f_r() - Turn on the cache in preparation for relocation
 132  *
 133  * Return: 0 if OK, -ve on error
 134  */
 135 int init_cache_f_r(void);
 136
 137 #if !CONFIG_IS_ENABLED(CPU)
 138 /**
 139  * print_cpuinfo() - Display information about the CPU
 140  *
 141  * Return: 0 if OK, -ve on error
 142  */
 143 int print_cpuinfo(void);
 144 #endif
 145 int timer_init(void);
 146 int reserve_mmu(void);
 147 int misc_init_f(void);
 148
 149 #if defined(CONFIG_DTB_RESELECT)
 150 int embedded_dtb_select(void);
 151 #endif
 152
 153 /* common/init/board_init.c */
 154 extern ulong monitor_flash_len;
 155
 156 /**
 157  * ulong board_init_f_alloc_reserve - allocate reserved area
 158  * @top: top of the reserve area, growing down.
 159  *
 160  * This function is called by each architecture very early in the start-up
 161  * code to allow the C runtime to reserve space on the stack for writable
 162  * 'globals' such as GD and the malloc arena.
 163  *
 164  * Return: bottom of reserved area
 165  */
 166 ulong board_init_f_alloc_reserve(ulong top);
 167
 168 /**
 169  * board_init_f_init_reserve - initialize the reserved area(s)
 170  * @base:       top from which reservation was done
 171  *
 172  * This function is called once the C runtime has allocated the reserved
 173  * area on the stack. It must initialize the GD at the base of that area.
 174  */
 175 void board_init_f_init_reserve(ulong base);
 176
 177 struct global_data;
 178
 179 /**
 180  * arch_setup_gd() - Set up the global_data pointer
 181  * @gd_ptr: Pointer to global data
 182  *
 183  * This pointer is special in some architectures and cannot easily be assigned
 184  * to. For example on x86 it is implemented by adding a specific record to its
 185  * Global Descriptor Table! So we we provide a function to carry out this task.
 186  * For most architectures this can simply be:
 187  *
 188  *    gd = gd_ptr;
 189  */
 190 void arch_setup_gd(struct global_data *gd_ptr);
 191
 192 /* common/board_r.c */
 193 void board_init_r(struct global_data *id, ulong dest_addr)
 194         __attribute__ ((noreturn));
 195
 196 int cpu_init_r(void);
 197 int last_stage_init(void);
 198 int mac_read_from_eeprom(void);
 199 int set_cpu_clk_info(void);
 200 int update_flash_size(int flash_size);
 201 int arch_early_init_r(void);
 202 void pci_init(void);
 203 int misc_init_r(void);
 204 #if defined(CONFIG_VID)
 205 int init_func_vid(void);
 206 #endif
 207
 208 /* common/board_info.c */
 209 int checkboard(void);
 210 int show_board_info(void);
 211
 212 /**
 213  * Get the uppermost pointer that is valid to access
 214  *
 215  * Some systems may not map all of their address space. This function allows
 216  * boards to indicate what their highest support pointer value is for DRAM
 217  * access.
 218  *
 219  * @param total_size    Size of U-Boot (unused?)
 220  */
 221 ulong board_get_usable_ram_top(ulong total_size);
 222
 223 int board_early_init_f(void);
 224
 225 /* manipulate the U-Boot fdt before its relocation */
 226 int board_fix_fdt(void *rw_fdt_blob);
 227 int board_late_init(void);
 228 int board_postclk_init(void); /* after clocks/timebase, before env/serial */
 229 int board_early_init_r(void);
 230
 231 /* TODO(sjg@chromium.org): Drop this when DM_PCI migration is completed */
 232 void pci_init_board(void);
 233
 234 void trap_init(unsigned long reloc_addr);
 235
 236 /**
 237  * main_loop() - Enter the main loop of U-Boot
 238  *
 239  * This normally runs the command line.
 240  */
 241 void main_loop(void);
 242
 243 #if defined(CONFIG_ARM)
 244 void relocate_code(ulong addr_moni);
 245 #else
 246 void relocate_code(ulong start_addr_sp, struct global_data *new_gd,
 247                    ulong relocaddr)
 248         __attribute__ ((noreturn));
 249 #endif
 250
 251 #endif  /* __ASSEMBLY__ */
 252 /* Put only stuff here that the assembler can digest */
 253
 254 #endif  /* __INIT_H_ */