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 #if defined(CONFIG_ENV_IS_EMBEDDED) 49 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN 50 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \ 51 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \ 52 defined(CONFIG_ENV_IS_IN_NVRAM) 53 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE) 54 #else 55 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN 56 #endif 57 58 /* startup functions, used in: 59 * common/board_f.c 60 * common/init/board_init.c 61 * common/board_r.c 62 * common/board_info.c 63 */ 64 #include <init.h> 65 66 /* 67 * Function Prototypes 68 */ 69 void hang (void) __attribute__ ((noreturn)); 70 71 int cpu_init(void); 72 73 #include <display_options.h> 74 75 /* common/main.c */ 76 void main_loop (void); 77 int run_command(const char *cmd, int flag); 78 int run_command_repeatable(const char *cmd, int flag); 79 80 /** 81 * Run a list of commands separated by ; or even \0 82 * 83 * Note that if 'len' is not -1, then the command does not need to be nul 84 * terminated, Memory will be allocated for the command in that case. 85 * 86 * @param cmd List of commands to run, each separated bu semicolon 87 * @param len Length of commands excluding terminator if known (-1 if not) 88 * @param flag Execution flags (CMD_FLAG_...) 89 * @return 0 on success, or != 0 on error. 90 */ 91 int run_command_list(const char *cmd, int len, int flag); 92 93 int checkflash(void); 94 int checkdram(void); 95 extern u8 __dtb_dt_begin[]; /* embedded device tree blob */ 96 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */ 97 int mdm_init(void); 98 99 /** 100 * Show the DRAM size in a board-specific way 101 * 102 * This is used by boards to display DRAM information in their own way. 103 * 104 * @param size Size of DRAM (which should be displayed along with other info) 105 */ 106 void board_show_dram(phys_size_t size); 107 108 /** 109 * Get the uppermost pointer that is valid to access 110 * 111 * Some systems may not map all of their address space. This function allows 112 * boards to indicate what their highest support pointer value is for DRAM 113 * access. 114 * 115 * @param total_size Size of U-Boot (unused?) 116 */ 117 ulong board_get_usable_ram_top(ulong total_size); 118 119 /** 120 * arch_fixup_fdt() - Write arch-specific information to fdt 121 * 122 * Defined in arch/$(ARCH)/lib/bootm-fdt.c 123 * 124 * @blob: FDT blob to write to 125 * @return 0 if ok, or -ve FDT_ERR_... on failure 126 */ 127 int arch_fixup_fdt(void *blob); 128 129 /* common/flash.c */ 130 void flash_perror (int); 131 132 /* common/cmd_source.c */ 133 int source (ulong addr, const char *fit_uname); 134 135 extern ulong load_addr; /* Default Load Address */ 136 extern ulong save_addr; /* Default Save Address */ 137 extern ulong save_size; /* Default Save Size */ 138 139 /* common/cmd_net.c */ 140 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); 141 142 /* common/cmd_fat.c */ 143 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []); 144 145 /* common/cmd_ext2.c */ 146 int do_ext2load(cmd_tbl_t *, int, int, char * const []); 147 148 /* common/cmd_nvedit.c */ 149 int env_init (void); 150 void env_relocate (void); 151 int envmatch (uchar *, int); 152 153 /** 154 * env_get() - Look up the value of an environment variable 155 * 156 * In U-Boot proper this can be called before relocation (which is when the 157 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that 158 * case this function calls env_get_f(). 159 * 160 * @varname: Variable to look up 161 * @return value of variable, or NULL if not found 162 */ 163 char *env_get(const char *varname); 164 165 /** 166 * env_get_f() - Look up the value of an environment variable (early) 167 * 168 * This function is called from env_get() if the environment has not been 169 * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will 170 * support reading the value (slowly) and some will not. 171 * 172 * @varname: Variable to look up 173 * @return value of variable, or NULL if not found 174 */ 175 int env_get_f(const char *name, char *buf, unsigned len); 176 177 /** 178 * env_get_ulong() - Return an environment variable as an integer value 179 * 180 * Most U-Boot environment variables store hex values. For those which store 181 * (e.g.) base-10 integers, this function can be used to read the value. 182 * 183 * @name: Variable to look up 184 * @base: Base to use (e.g. 10 for base 10, 2 for binary) 185 * @default_val: Default value to return if no value is found 186 * @return the value found, or @default_val if none 187 */ 188 ulong env_get_ulong(const char *name, int base, ulong default_val); 189 190 /** 191 * env_get_hex() - Return an environment variable as a hex value 192 * 193 * Decode an environment as a hex number (it may or may not have a 0x 194 * prefix). If the environment variable cannot be found, or does not start 195 * with hex digits, the default value is returned. 196 * 197 * @varname: Variable to decode 198 * @default_val: Value to return on error 199 */ 200 ulong env_get_hex(const char *varname, ulong default_val); 201 202 /* 203 * Read an environment variable as a boolean 204 * Return -1 if variable does not exist (default to true) 205 */ 206 int env_get_yesno(const char *var); 207 208 /** 209 * env_set() - set an environment variable 210 * 211 * This sets or deletes the value of an environment variable. For setting the 212 * value the variable is created if it does not already exist. 213 * 214 * @varname: Variable to adjust 215 * @value: Value to set for the variable, or NULL or "" to delete the variable 216 * @return 0 if OK, 1 on error 217 */ 218 int env_set(const char *varname, const char *value); 219 220 /** 221 * env_set_ulong() - set an environment variable to an integer 222 * 223 * @varname: Variable to adjust 224 * @value: Value to set for the variable (will be converted to a string) 225 * @return 0 if OK, 1 on error 226 */ 227 int env_set_ulong(const char *varname, ulong value); 228 229 /** 230 * env_set_hex() - set an environment variable to a hex value 231 * 232 * @varname: Variable to adjust 233 * @value: Value to set for the variable (will be converted to a hex string) 234 * @return 0 if OK, 1 on error 235 */ 236 int env_set_hex(const char *varname, ulong value); 237 238 /** 239 * env_set_addr - Set an environment variable to an address in hex 240 * 241 * @varname: Environment variable to set 242 * @addr: Value to set it to 243 * @return 0 if ok, 1 on error 244 */ 245 static inline int env_set_addr(const char *varname, const void *addr) 246 { 247 return env_set_hex(varname, (ulong)addr); 248 } 249 250 #ifdef CONFIG_AUTO_COMPLETE 251 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf); 252 #endif 253 int get_env_id (void); 254 255 void pci_init_board(void); 256 257 /* common/exports.c */ 258 void jumptable_init(void); 259 260 /* common/kallsysm.c */ 261 const char *symbol_lookup(unsigned long addr, unsigned long *caddr); 262 263 /* common/memsize.c */ 264 long get_ram_size (long *, long); 265 phys_size_t get_effective_memsize(void); 266 267 /* $(BOARD)/$(BOARD).c */ 268 void reset_phy (void); 269 void fdc_hw_init (void); 270 271 /* $(BOARD)/eeprom.c */ 272 #ifdef CONFIG_CMD_EEPROM 273 void eeprom_init (int bus); 274 int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt); 275 int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt); 276 #else 277 /* 278 * Some EEPROM code is depecated because it used the legacy I2C interface. Add 279 * some macros here so we don't have to touch every one of those uses 280 */ 281 #define eeprom_init(bus) 282 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS) 283 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS) 284 #endif 285 286 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR) 287 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR 288 #endif 289 290 #if defined(CONFIG_MPC8XX_SPI) 291 extern void spi_init_f (void); 292 extern void spi_init_r (void); 293 extern ssize_t spi_read (uchar *, int, uchar *, int); 294 extern ssize_t spi_write (uchar *, int, uchar *, int); 295 #endif 296 297 /* $(BOARD)/$(BOARD).c */ 298 int board_early_init_f (void); 299 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */ 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 #if defined(CONFIG_SYS_DRAM_TEST) 305 int testdram(void); 306 #endif /* CONFIG_SYS_DRAM_TEST */ 307 308 /* $(CPU)/start.S */ 309 int icache_status (void); 310 void icache_enable (void); 311 void icache_disable(void); 312 int dcache_status (void); 313 void dcache_enable (void); 314 void dcache_disable(void); 315 void mmu_disable(void); 316 #if defined(CONFIG_ARM) 317 void relocate_code(ulong); 318 #else 319 void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn)); 320 #endif 321 ulong get_endaddr (void); 322 void trap_init (ulong); 323 324 /* $(CPU)/cpu.c */ 325 static inline int cpumask_next(int cpu, unsigned int mask) 326 { 327 for (cpu++; !((1 << cpu) & mask); cpu++) 328 ; 329 330 return cpu; 331 } 332 333 #define for_each_cpu(iter, cpu, num_cpus, mask) \ 334 for (iter = 0, cpu = cpumask_next(-1, mask); \ 335 iter < num_cpus; \ 336 iter++, cpu = cpumask_next(cpu, mask)) \ 337 338 int cpu_numcores (void); 339 int cpu_num_dspcores(void); 340 u32 cpu_mask (void); 341 u32 cpu_dsp_mask(void); 342 int is_core_valid (unsigned int); 343 344 void s_init(void); 345 346 int checkcpu (void); 347 int checkicache (void); 348 int checkdcache (void); 349 void upmconfig (unsigned int, unsigned int *, unsigned int); 350 ulong get_tbclk (void); 351 void reset_misc (void); 352 void reset_cpu (ulong addr); 353 void ft_cpu_setup(void *blob, bd_t *bd); 354 void ft_pci_setup(void *blob, bd_t *bd); 355 356 void smp_set_core_boot_addr(unsigned long addr, int corenr); 357 void smp_kick_all_cpus(void); 358 359 /* $(CPU)/serial.c */ 360 int serial_init (void); 361 void serial_setbrg (void); 362 void serial_putc (const char); 363 void serial_putc_raw(const char); 364 void serial_puts (const char *); 365 int serial_getc (void); 366 int serial_tstc (void); 367 int serial_setconfig(uint config); 368 369 /* $(CPU)/speed.c */ 370 int get_clocks (void); 371 ulong get_bus_freq (ulong); 372 int get_serial_clock(void); 373 374 /* $(CPU)/interrupts.c */ 375 int interrupt_init (void); 376 void timer_interrupt (struct pt_regs *); 377 void external_interrupt (struct pt_regs *); 378 void irq_install_handler(int, interrupt_handler_t *, void *); 379 void irq_free_handler (int); 380 void reset_timer (void); 381 382 /* Return value of monotonic microsecond timer */ 383 unsigned long timer_get_us(void); 384 385 void enable_interrupts (void); 386 int disable_interrupts (void); 387 388 /* $(CPU)/.../commproc.c */ 389 int dpram_init (void); 390 uint dpram_base(void); 391 uint dpram_base_align(uint align); 392 uint dpram_alloc(uint size); 393 uint dpram_alloc_align(uint size,uint align); 394 void bootcount_store (ulong); 395 ulong bootcount_load (void); 396 397 /* $(CPU)/.../<eth> */ 398 void mii_init (void); 399 400 /* $(CPU)/.../lcd.c */ 401 ulong lcd_setmem (ulong); 402 403 /* $(CPU)/.../video.c */ 404 ulong video_setmem (ulong); 405 406 /* arch/$(ARCH)/lib/cache.c */ 407 void enable_caches(void); 408 void flush_cache (unsigned long, unsigned long); 409 void flush_dcache_all(void); 410 void flush_dcache_range(unsigned long start, unsigned long stop); 411 void invalidate_dcache_range(unsigned long start, unsigned long stop); 412 void invalidate_dcache_all(void); 413 void invalidate_icache_all(void); 414 415 enum { 416 /* Disable caches (else flush caches but leave them active) */ 417 CBL_DISABLE_CACHES = 1 << 0, 418 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1, 419 420 CBL_ALL = 3, 421 }; 422 423 /** 424 * Clean up ready for linux 425 * 426 * @param flags Flags to control what is done 427 */ 428 int cleanup_before_linux_select(int flags); 429 430 /* arch/$(ARCH)/lib/ticks.S */ 431 uint64_t get_ticks(void); 432 void wait_ticks (unsigned long); 433 434 /* arch/$(ARCH)/lib/time.c */ 435 ulong usec2ticks (unsigned long usec); 436 ulong ticks2usec (unsigned long ticks); 437 438 /* lib/gunzip.c */ 439 int gzip_parse_header(const unsigned char *src, unsigned long len); 440 int gunzip(void *, int, unsigned char *, unsigned long *); 441 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp, 442 int stoponerr, int offset); 443 444 /** 445 * gzwrite progress indicators: defined weak to allow board-specific 446 * overrides: 447 * 448 * gzwrite_progress_init called on startup 449 * gzwrite_progress called during decompress/write loop 450 * gzwrite_progress_finish called at end of loop to 451 * indicate success (retcode=0) or failure 452 */ 453 void gzwrite_progress_init(u64 expected_size); 454 455 void gzwrite_progress(int iteration, 456 u64 bytes_written, 457 u64 total_bytes); 458 459 void gzwrite_progress_finish(int retcode, 460 u64 totalwritten, 461 u64 totalsize, 462 u32 expected_crc, 463 u32 calculated_crc); 464 465 /** 466 * decompress and write gzipped image from memory to block device 467 * 468 * @param src compressed image address 469 * @param len compressed image length in bytes 470 * @param dev block device descriptor 471 * @param szwritebuf bytes per write (pad to erase size) 472 * @param startoffs offset in bytes of first write 473 * @param szexpected expected uncompressed length 474 * may be zero to use gzip trailer 475 * for files under 4GiB 476 */ 477 int gzwrite(unsigned char *src, int len, 478 struct blk_desc *dev, 479 unsigned long szwritebuf, 480 u64 startoffs, 481 u64 szexpected); 482 483 /* lib/lz4_wrapper.c */ 484 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn); 485 486 /* lib/qsort.c */ 487 void qsort(void *base, size_t nmemb, size_t size, 488 int(*compar)(const void *, const void *)); 489 int strcmp_compar(const void *, const void *); 490 491 /* lib/uuid.c */ 492 #include <uuid.h> 493 494 /* lib/vsprintf.c */ 495 #include <vsprintf.h> 496 497 /* lib/strmhz.c */ 498 char * strmhz(char *buf, unsigned long hz); 499 500 /* lib/crc32.c */ 501 #include <u-boot/crc.h> 502 503 /* lib/rand.c */ 504 #define RAND_MAX -1U 505 void srand(unsigned int seed); 506 unsigned int rand(void); 507 unsigned int rand_r(unsigned int *seedp); 508 509 /* 510 * STDIO based functions (can always be used) 511 */ 512 /* serial stuff */ 513 int serial_printf (const char *fmt, ...) 514 __attribute__ ((format (__printf__, 1, 2))); 515 516 /* lib/gzip.c */ 517 int gzip(void *dst, unsigned long *lenp, 518 unsigned char *src, unsigned long srclen); 519 int zzip(void *dst, unsigned long *lenp, unsigned char *src, 520 unsigned long srclen, int stoponerr, 521 int (*func)(unsigned long, unsigned long)); 522 523 /* lib/net_utils.c */ 524 #include <net.h> 525 static inline struct in_addr env_get_ip(char *var) 526 { 527 return string_to_ip(env_get(var)); 528 } 529 530 int pcmcia_init (void); 531 532 #ifdef CONFIG_LED_STATUS 533 # include <status_led.h> 534 #endif 535 536 #include <bootstage.h> 537 538 #ifdef CONFIG_SHOW_ACTIVITY 539 void show_activity(int arg); 540 #endif 541 542 /* Multicore arch functions */ 543 #ifdef CONFIG_MP 544 int cpu_status(u32 nr); 545 int cpu_reset(u32 nr); 546 int cpu_disable(u32 nr); 547 int cpu_release(u32 nr, int argc, char * const argv[]); 548 #endif 549 550 #else /* __ASSEMBLY__ */ 551 552 #endif /* __ASSEMBLY__ */ 553 554 /* Put only stuff here that the assembler can digest */ 555 556 #ifdef CONFIG_POST 557 #define CONFIG_HAS_POST 558 #ifndef CONFIG_POST_ALT_LIST 559 #define CONFIG_POST_STD_LIST 560 #endif 561 #endif 562 563 #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1)) 564 565 /* 566 * check_member() - Check the offset of a structure member 567 * 568 * @structure: Name of structure (e.g. global_data) 569 * @member: Name of member (e.g. baudrate) 570 * @offset: Expected offset in bytes 571 */ 572 #define check_member(structure, member, offset) _Static_assert( \ 573 offsetof(struct structure, member) == offset, \ 574 "`struct " #structure "` offset for `" #member "` is not " #offset) 575 576 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */ 577 #ifdef CONFIG_EFI_STUB 578 #define ll_boot_init() false 579 #else 580 #define ll_boot_init() true 581 #endif 582 583 /* Pull in stuff for the build system */ 584 #ifdef DO_DEPS_ONLY 585 # include <environment.h> 586 #endif 587 588 #endif /* __COMMON_H_ */ 589