common.h 16 KB

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