git.sur5r.net Git - u-boot/blob - include/common.h

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