common.h 15 KB

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