include/common.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
   7 #ifndef __COMMON_H_
   8 #define __COMMON_H_     1
   9
  10 #ifndef __ASSEMBLY__            /* put C only stuff in this section */
  11
  12 typedef unsigned char           uchar;
  13 typedef volatile unsigned long  vu_long;
  14 typedef volatile unsigned short vu_short;
  15 typedef volatile unsigned char  vu_char;
  16
  17 #include <config.h>
  18 #include <errno.h>
  19 #include <time.h>
  20 #include <asm-offsets.h>
  21 #include <linux/bitops.h>
  22 #include <linux/bug.h>
  23 #include <linux/delay.h>
  24 #include <linux/types.h>
  25 #include <linux/printk.h>
  26 #include <linux/string.h>
  27 #include <linux/stringify.h>
  28 #include <asm/ptrace.h>
  29 #include <stdarg.h>
  30 #include <stdio.h>
  31 #include <linux/kernel.h>
  32
  33 #include <part.h>
  34 #include <flash.h>
  35 #include <image.h>
  36
  37 #ifdef __LP64__
  38 #define CONFIG_SYS_SUPPORT_64BIT_DATA
  39 #endif
  40
  41 #include <log.h>
  42
  43 typedef void (interrupt_handler_t)(void *);
  44
  45 #include <asm/u-boot.h> /* boot information for Linux kernel */
  46 #include <asm/global_data.h>    /* global data used for startup functions */
  47
  48 /* startup functions, used in:
  49  * common/board_f.c
  50  * common/init/board_init.c
  51  * common/board_r.c
  52  * common/board_info.c
  53  */
  54 #include <init.h>
  55
  56 /*
  57  * Function Prototypes
  58  */
  59 void    hang            (void) __attribute__ ((noreturn));
  60
  61 int     cpu_init(void);
  62
  63 #include <display_options.h>
  64
  65 /* common/main.c */
  66 void    main_loop       (void);
  67 int run_command(const char *cmd, int flag);
  68 int run_command_repeatable(const char *cmd, int flag);
  69
  70 /**
  71  * Run a list of commands separated by ; or even \0
  72  *
  73  * Note that if 'len' is not -1, then the command does not need to be nul
  74  * terminated, Memory will be allocated for the command in that case.
  75  *
  76  * @param cmd   List of commands to run, each separated bu semicolon
  77  * @param len   Length of commands excluding terminator if known (-1 if not)
  78  * @param flag  Execution flags (CMD_FLAG_...)
  79  * @return 0 on success, or != 0 on error.
  80  */
  81 int run_command_list(const char *cmd, int len, int flag);
  82
  83 int checkflash(void);
  84 int checkdram(void);
  85 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
  86 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
  87 int mdm_init(void);
  88
  89 /**
  90  * Show the DRAM size in a board-specific way
  91  *
  92  * This is used by boards to display DRAM information in their own way.
  93  *
  94  * @param size  Size of DRAM (which should be displayed along with other info)
  95  */
  96 void board_show_dram(phys_size_t size);
  97
  98 /**
  99  * Get the uppermost pointer that is valid to access
 100  *
 101  * Some systems may not map all of their address space. This function allows
 102  * boards to indicate what their highest support pointer value is for DRAM
 103  * access.
 104  *
 105  * @param total_size    Size of U-Boot (unused?)
 106  */
 107 ulong board_get_usable_ram_top(ulong total_size);
 108
 109 /**
 110  * arch_fixup_fdt() - Write arch-specific information to fdt
 111  *
 112  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
 113  *
 114  * @blob:       FDT blob to write to
 115  * @return 0 if ok, or -ve FDT_ERR_... on failure
 116  */
 117 int arch_fixup_fdt(void *blob);
 118
 119 /* common/flash.c */
 120 void flash_perror (int);
 121
 122 /* common/cmd_source.c */
 123 int     source (ulong addr, const char *fit_uname);
 124
 125 extern ulong load_addr;         /* Default Load Address */
 126 extern ulong save_addr;         /* Default Save Address */
 127 extern ulong save_size;         /* Default Save Size */
 128
 129 /* common/cmd_net.c */
 130 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 131
 132 /* common/cmd_fat.c */
 133 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
 134
 135 /* common/cmd_ext2.c */
 136 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
 137
 138 void    pci_init_board(void);
 139
 140 /* common/exports.c */
 141 void    jumptable_init(void);
 142
 143 /* common/kallsysm.c */
 144 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
 145
 146 /* common/memsize.c */
 147 long    get_ram_size  (long *, long);
 148 phys_size_t get_effective_memsize(void);
 149
 150 /* $(BOARD)/$(BOARD).c */
 151 void    reset_phy     (void);
 152 void    fdc_hw_init   (void);
 153
 154 /* $(BOARD)/eeprom.c */
 155 #ifdef CONFIG_CMD_EEPROM
 156 void eeprom_init  (int bus);
 157 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 158 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
 159 #else
 160 /*
 161  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
 162  * some macros here so we don't have to touch every one of those uses
 163  */
 164 #define eeprom_init(bus)
 165 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 166 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
 167 #endif
 168
 169 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
 170 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
 171 #endif
 172
 173 /* $(BOARD)/$(BOARD).c */
 174 int board_early_init_f (void);
 175 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
 176 int board_late_init (void);
 177 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
 178 int board_early_init_r (void);
 179
 180 #if defined(CONFIG_SYS_DRAM_TEST)
 181 int testdram(void);
 182 #endif /* CONFIG_SYS_DRAM_TEST */
 183
 184 /* $(CPU)/start.S */
 185 int     icache_status (void);
 186 void    icache_enable (void);
 187 void    icache_disable(void);
 188 int     dcache_status (void);
 189 void    dcache_enable (void);
 190 void    dcache_disable(void);
 191 void    mmu_disable(void);
 192 #if defined(CONFIG_ARM)
 193 void    relocate_code(ulong);
 194 #else
 195 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
 196 #endif
 197 ulong   get_endaddr   (void);
 198 void    trap_init     (ulong);
 199
 200 /* $(CPU)/cpu.c */
 201 static inline int cpumask_next(int cpu, unsigned int mask)
 202 {
 203         for (cpu++; !((1 << cpu) & mask); cpu++)
 204                 ;
 205
 206         return cpu;
 207 }
 208
 209 #define for_each_cpu(iter, cpu, num_cpus, mask) \
 210         for (iter = 0, cpu = cpumask_next(-1, mask); \
 211                 iter < num_cpus; \
 212                 iter++, cpu = cpumask_next(cpu, mask)) \
 213
 214 int     cpu_numcores  (void);
 215 int     cpu_num_dspcores(void);
 216 u32     cpu_mask      (void);
 217 u32     cpu_dsp_mask(void);
 218 int     is_core_valid (unsigned int);
 219
 220 void s_init(void);
 221
 222 int     checkcpu      (void);
 223 int     checkicache   (void);
 224 int     checkdcache   (void);
 225 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
 226 ulong   get_tbclk     (void);
 227 void    reset_misc    (void);
 228 void    reset_cpu     (ulong addr);
 229 void ft_cpu_setup(void *blob, bd_t *bd);
 230 void ft_pci_setup(void *blob, bd_t *bd);
 231
 232 void smp_set_core_boot_addr(unsigned long addr, int corenr);
 233 void smp_kick_all_cpus(void);
 234
 235 /* $(CPU)/serial.c */
 236 int     serial_init   (void);
 237 void    serial_setbrg (void);
 238 void    serial_putc   (const char);
 239 void    serial_putc_raw(const char);
 240 void    serial_puts   (const char *);
 241 int     serial_getc   (void);
 242 int     serial_tstc   (void);
 243
 244 /* $(CPU)/speed.c */
 245 int     get_clocks (void);
 246 ulong   get_bus_freq  (ulong);
 247 int get_serial_clock(void);
 248
 249 /* $(CPU)/interrupts.c */
 250 int     interrupt_init     (void);
 251 void    timer_interrupt    (struct pt_regs *);
 252 void    external_interrupt (struct pt_regs *);
 253 void    irq_install_handler(int, interrupt_handler_t *, void *);
 254 void    irq_free_handler   (int);
 255 void    reset_timer        (void);
 256
 257 /* Return value of monotonic microsecond timer */
 258 unsigned long timer_get_us(void);
 259
 260 void    enable_interrupts  (void);
 261 int     disable_interrupts (void);
 262
 263 /* $(CPU)/.../commproc.c */
 264 void    bootcount_store (ulong);
 265 ulong   bootcount_load (void);
 266
 267 /* $(CPU)/.../<eth> */
 268 void mii_init (void);
 269
 270 /* arch/$(ARCH)/lib/cache.c */
 271 void    enable_caches(void);
 272 void    flush_cache   (unsigned long, unsigned long);
 273 void    flush_dcache_all(void);
 274 void    flush_dcache_range(unsigned long start, unsigned long stop);
 275 void    invalidate_dcache_range(unsigned long start, unsigned long stop);
 276 void    invalidate_dcache_all(void);
 277 void    invalidate_icache_all(void);
 278
 279 enum {
 280         /* Disable caches (else flush caches but leave them active) */
 281         CBL_DISABLE_CACHES              = 1 << 0,
 282         CBL_SHOW_BOOTSTAGE_REPORT       = 1 << 1,
 283
 284         CBL_ALL                         = 3,
 285 };
 286
 287 /**
 288  * Clean up ready for linux
 289  *
 290  * @param flags         Flags to control what is done
 291  */
 292 int cleanup_before_linux_select(int flags);
 293
 294 /* arch/$(ARCH)/lib/ticks.S */
 295 uint64_t get_ticks(void);
 296 void    wait_ticks    (unsigned long);
 297
 298 /* arch/$(ARCH)/lib/time.c */
 299 ulong   usec2ticks    (unsigned long usec);
 300 ulong   ticks2usec    (unsigned long ticks);
 301
 302 /* lib/lz4_wrapper.c */
 303 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
 304
 305 /* lib/qsort.c */
 306 void qsort(void *base, size_t nmemb, size_t size,
 307            int(*compar)(const void *, const void *));
 308 int strcmp_compar(const void *, const void *);
 309
 310 /* lib/uuid.c */
 311 #include <uuid.h>
 312
 313 /* lib/vsprintf.c */
 314 #include <vsprintf.h>
 315
 316 /* lib/strmhz.c */
 317 char *  strmhz(char *buf, unsigned long hz);
 318
 319 /* lib/crc32.c */
 320 #include <u-boot/crc.h>
 321
 322 /* lib/rand.c */
 323 #define RAND_MAX -1U
 324 void srand(unsigned int seed);
 325 unsigned int rand(void);
 326 unsigned int rand_r(unsigned int *seedp);
 327
 328 /*
 329  * STDIO based functions (can always be used)
 330  */
 331 /* serial stuff */
 332 int     serial_printf (const char *fmt, ...)
 333                 __attribute__ ((format (__printf__, 1, 2)));
 334
 335 /* lib/net_utils.c */
 336 #include <net.h>
 337 static inline struct in_addr env_get_ip(char *var)
 338 {
 339         return string_to_ip(env_get(var));
 340 }
 341
 342 #ifdef CONFIG_LED_STATUS
 343 # include <status_led.h>
 344 #endif
 345
 346 #include <bootstage.h>
 347
 348 #ifdef CONFIG_SHOW_ACTIVITY
 349 void show_activity(int arg);
 350 #endif
 351
 352 /* Multicore arch functions */
 353 #ifdef CONFIG_MP
 354 int cpu_status(u32 nr);
 355 int cpu_reset(u32 nr);
 356 int cpu_disable(u32 nr);
 357 int cpu_release(u32 nr, int argc, char * const argv[]);
 358 #endif
 359
 360 #else   /* __ASSEMBLY__ */
 361
 362 #endif  /* __ASSEMBLY__ */
 363
 364 /* Put only stuff here that the assembler can digest */
 365
 366 #ifdef CONFIG_POST
 367 #define CONFIG_HAS_POST
 368 #ifndef CONFIG_POST_ALT_LIST
 369 #define CONFIG_POST_STD_LIST
 370 #endif
 371 #endif
 372
 373 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
 374
 375 /*
 376  * check_member() - Check the offset of a structure member
 377  *
 378  * @structure:  Name of structure (e.g. global_data)
 379  * @member:     Name of member (e.g. baudrate)
 380  * @offset:     Expected offset in bytes
 381  */
 382 #define check_member(structure, member, offset) _Static_assert( \
 383         offsetof(struct structure, member) == offset, \
 384         "`struct " #structure "` offset for `" #member "` is not " #offset)
 385
 386 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
 387 #ifdef CONFIG_EFI_STUB
 388 #define ll_boot_init()  false
 389 #else
 390 #define ll_boot_init()  true
 391 #endif
 392
 393 /* Pull in stuff for the build system */
 394 #ifdef DO_DEPS_ONLY
 395 # include <env_internal.h>
 396 #endif
 397
 398 #endif  /* __COMMON_H_ */