common.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521
  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. * Get the uppermost pointer that is valid to access
  91. *
  92. * Some systems may not map all of their address space. This function allows
  93. * boards to indicate what their highest support pointer value is for DRAM
  94. * access.
  95. *
  96. * @param total_size Size of U-Boot (unused?)
  97. */
  98. ulong board_get_usable_ram_top(ulong total_size);
  99. /**
  100. * arch_fixup_fdt() - Write arch-specific information to fdt
  101. *
  102. * Defined in arch/$(ARCH)/lib/bootm-fdt.c
  103. *
  104. * @blob: FDT blob to write to
  105. * @return 0 if ok, or -ve FDT_ERR_... on failure
  106. */
  107. int arch_fixup_fdt(void *blob);
  108. /* common/flash.c */
  109. void flash_perror (int);
  110. /* common/cmd_source.c */
  111. int source (ulong addr, const char *fit_uname);
  112. extern ulong load_addr; /* Default Load Address */
  113. extern ulong save_addr; /* Default Save Address */
  114. extern ulong save_size; /* Default Save Size */
  115. /* common/cmd_net.c */
  116. int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  117. /* common/cmd_fat.c */
  118. int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
  119. /* common/cmd_ext2.c */
  120. int do_ext2load(cmd_tbl_t *, int, int, char * const []);
  121. /* common/cmd_nvedit.c */
  122. int env_init (void);
  123. void env_relocate (void);
  124. int envmatch (uchar *, int);
  125. /**
  126. * env_get() - Look up the value of an environment variable
  127. *
  128. * In U-Boot proper this can be called before relocation (which is when the
  129. * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
  130. * case this function calls env_get_f().
  131. *
  132. * @varname: Variable to look up
  133. * @return value of variable, or NULL if not found
  134. */
  135. char *env_get(const char *varname);
  136. /**
  137. * env_get_f() - Look up the value of an environment variable (early)
  138. *
  139. * This function is called from env_get() if the environment has not been
  140. * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
  141. * support reading the value (slowly) and some will not.
  142. *
  143. * @varname: Variable to look up
  144. * @return value of variable, or NULL if not found
  145. */
  146. int env_get_f(const char *name, char *buf, unsigned len);
  147. /**
  148. * env_get_ulong() - Return an environment variable as an integer value
  149. *
  150. * Most U-Boot environment variables store hex values. For those which store
  151. * (e.g.) base-10 integers, this function can be used to read the value.
  152. *
  153. * @name: Variable to look up
  154. * @base: Base to use (e.g. 10 for base 10, 2 for binary)
  155. * @default_val: Default value to return if no value is found
  156. * @return the value found, or @default_val if none
  157. */
  158. ulong env_get_ulong(const char *name, int base, ulong default_val);
  159. /**
  160. * env_get_hex() - Return an environment variable as a hex value
  161. *
  162. * Decode an environment as a hex number (it may or may not have a 0x
  163. * prefix). If the environment variable cannot be found, or does not start
  164. * with hex digits, the default value is returned.
  165. *
  166. * @varname: Variable to decode
  167. * @default_val: Value to return on error
  168. */
  169. ulong env_get_hex(const char *varname, ulong default_val);
  170. /*
  171. * Read an environment variable as a boolean
  172. * Return -1 if variable does not exist (default to true)
  173. */
  174. int env_get_yesno(const char *var);
  175. /**
  176. * env_set() - set an environment variable
  177. *
  178. * This sets or deletes the value of an environment variable. For setting the
  179. * value the variable is created if it does not already exist.
  180. *
  181. * @varname: Variable to adjust
  182. * @value: Value to set for the variable, or NULL or "" to delete the variable
  183. * @return 0 if OK, 1 on error
  184. */
  185. int env_set(const char *varname, const char *value);
  186. /**
  187. * env_set_ulong() - set an environment variable to an integer
  188. *
  189. * @varname: Variable to adjust
  190. * @value: Value to set for the variable (will be converted to a string)
  191. * @return 0 if OK, 1 on error
  192. */
  193. int env_set_ulong(const char *varname, ulong value);
  194. /**
  195. * env_set_hex() - set an environment variable to a hex value
  196. *
  197. * @varname: Variable to adjust
  198. * @value: Value to set for the variable (will be converted to a hex string)
  199. * @return 0 if OK, 1 on error
  200. */
  201. int env_set_hex(const char *varname, ulong value);
  202. /**
  203. * env_set_addr - Set an environment variable to an address in hex
  204. *
  205. * @varname: Environment variable to set
  206. * @addr: Value to set it to
  207. * @return 0 if ok, 1 on error
  208. */
  209. static inline int env_set_addr(const char *varname, const void *addr)
  210. {
  211. return env_set_hex(varname, (ulong)addr);
  212. }
  213. #ifdef CONFIG_AUTO_COMPLETE
  214. int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf,
  215. bool dollar_comp);
  216. #endif
  217. int get_env_id (void);
  218. void pci_init_board(void);
  219. /* common/exports.c */
  220. void jumptable_init(void);
  221. /* common/kallsysm.c */
  222. const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
  223. /* common/memsize.c */
  224. long get_ram_size (long *, long);
  225. phys_size_t get_effective_memsize(void);
  226. /* $(BOARD)/$(BOARD).c */
  227. void reset_phy (void);
  228. void fdc_hw_init (void);
  229. /* $(BOARD)/eeprom.c */
  230. #ifdef CONFIG_CMD_EEPROM
  231. void eeprom_init (int bus);
  232. int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
  233. int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
  234. #else
  235. /*
  236. * Some EEPROM code is depecated because it used the legacy I2C interface. Add
  237. * some macros here so we don't have to touch every one of those uses
  238. */
  239. #define eeprom_init(bus)
  240. #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
  241. #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
  242. #endif
  243. #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
  244. # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
  245. #endif
  246. /* $(BOARD)/$(BOARD).c */
  247. int board_early_init_f (void);
  248. int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
  249. int board_late_init (void);
  250. int board_postclk_init (void); /* after clocks/timebase, before env/serial */
  251. int board_early_init_r (void);
  252. #if defined(CONFIG_SYS_DRAM_TEST)
  253. int testdram(void);
  254. #endif /* CONFIG_SYS_DRAM_TEST */
  255. /* $(CPU)/start.S */
  256. int icache_status (void);
  257. void icache_enable (void);
  258. void icache_disable(void);
  259. int dcache_status (void);
  260. void dcache_enable (void);
  261. void dcache_disable(void);
  262. void mmu_disable(void);
  263. #if defined(CONFIG_ARM)
  264. void relocate_code(ulong);
  265. #else
  266. void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
  267. #endif
  268. ulong get_endaddr (void);
  269. void trap_init (ulong);
  270. /* $(CPU)/cpu.c */
  271. static inline int cpumask_next(int cpu, unsigned int mask)
  272. {
  273. for (cpu++; !((1 << cpu) & mask); cpu++)
  274. ;
  275. return cpu;
  276. }
  277. #define for_each_cpu(iter, cpu, num_cpus, mask) \
  278. for (iter = 0, cpu = cpumask_next(-1, mask); \
  279. iter < num_cpus; \
  280. iter++, cpu = cpumask_next(cpu, mask)) \
  281. int cpu_numcores (void);
  282. int cpu_num_dspcores(void);
  283. u32 cpu_mask (void);
  284. u32 cpu_dsp_mask(void);
  285. int is_core_valid (unsigned int);
  286. void s_init(void);
  287. int checkcpu (void);
  288. int checkicache (void);
  289. int checkdcache (void);
  290. void upmconfig (unsigned int, unsigned int *, unsigned int);
  291. ulong get_tbclk (void);
  292. void reset_misc (void);
  293. void reset_cpu (ulong addr);
  294. void ft_cpu_setup(void *blob, bd_t *bd);
  295. void ft_pci_setup(void *blob, bd_t *bd);
  296. void smp_set_core_boot_addr(unsigned long addr, int corenr);
  297. void smp_kick_all_cpus(void);
  298. /* $(CPU)/serial.c */
  299. int serial_init (void);
  300. void serial_setbrg (void);
  301. void serial_putc (const char);
  302. void serial_putc_raw(const char);
  303. void serial_puts (const char *);
  304. int serial_getc (void);
  305. int serial_tstc (void);
  306. /* $(CPU)/speed.c */
  307. int get_clocks (void);
  308. ulong get_bus_freq (ulong);
  309. int get_serial_clock(void);
  310. /* $(CPU)/interrupts.c */
  311. int interrupt_init (void);
  312. void timer_interrupt (struct pt_regs *);
  313. void external_interrupt (struct pt_regs *);
  314. void irq_install_handler(int, interrupt_handler_t *, void *);
  315. void irq_free_handler (int);
  316. void reset_timer (void);
  317. /* Return value of monotonic microsecond timer */
  318. unsigned long timer_get_us(void);
  319. void enable_interrupts (void);
  320. int disable_interrupts (void);
  321. /* $(CPU)/.../commproc.c */
  322. void bootcount_store (ulong);
  323. ulong bootcount_load (void);
  324. /* $(CPU)/.../<eth> */
  325. void mii_init (void);
  326. /* $(CPU)/.../video.c */
  327. ulong video_setmem (ulong);
  328. /* arch/$(ARCH)/lib/cache.c */
  329. void enable_caches(void);
  330. void flush_cache (unsigned long, unsigned long);
  331. void flush_dcache_all(void);
  332. void flush_dcache_range(unsigned long start, unsigned long stop);
  333. void invalidate_dcache_range(unsigned long start, unsigned long stop);
  334. void invalidate_dcache_all(void);
  335. void invalidate_icache_all(void);
  336. enum {
  337. /* Disable caches (else flush caches but leave them active) */
  338. CBL_DISABLE_CACHES = 1 << 0,
  339. CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
  340. CBL_ALL = 3,
  341. };
  342. /**
  343. * Clean up ready for linux
  344. *
  345. * @param flags Flags to control what is done
  346. */
  347. int cleanup_before_linux_select(int flags);
  348. /* arch/$(ARCH)/lib/ticks.S */
  349. uint64_t get_ticks(void);
  350. void wait_ticks (unsigned long);
  351. /* arch/$(ARCH)/lib/time.c */
  352. ulong usec2ticks (unsigned long usec);
  353. ulong ticks2usec (unsigned long ticks);
  354. /* lib/lz4_wrapper.c */
  355. int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
  356. /* lib/qsort.c */
  357. void qsort(void *base, size_t nmemb, size_t size,
  358. int(*compar)(const void *, const void *));
  359. int strcmp_compar(const void *, const void *);
  360. /* lib/uuid.c */
  361. #include <uuid.h>
  362. /* lib/vsprintf.c */
  363. #include <vsprintf.h>
  364. /* lib/strmhz.c */
  365. char * strmhz(char *buf, unsigned long hz);
  366. /* lib/crc32.c */
  367. #include <u-boot/crc.h>
  368. /* lib/rand.c */
  369. #define RAND_MAX -1U
  370. void srand(unsigned int seed);
  371. unsigned int rand(void);
  372. unsigned int rand_r(unsigned int *seedp);
  373. /*
  374. * STDIO based functions (can always be used)
  375. */
  376. /* serial stuff */
  377. int serial_printf (const char *fmt, ...)
  378. __attribute__ ((format (__printf__, 1, 2)));
  379. /* lib/net_utils.c */
  380. #include <net.h>
  381. static inline struct in_addr env_get_ip(char *var)
  382. {
  383. return string_to_ip(env_get(var));
  384. }
  385. int pcmcia_init (void);
  386. #ifdef CONFIG_LED_STATUS
  387. # include <status_led.h>
  388. #endif
  389. #include <bootstage.h>
  390. #ifdef CONFIG_SHOW_ACTIVITY
  391. void show_activity(int arg);
  392. #endif
  393. /* Multicore arch functions */
  394. #ifdef CONFIG_MP
  395. int cpu_status(u32 nr);
  396. int cpu_reset(u32 nr);
  397. int cpu_disable(u32 nr);
  398. int cpu_release(u32 nr, int argc, char * const argv[]);
  399. #endif
  400. #else /* __ASSEMBLY__ */
  401. #endif /* __ASSEMBLY__ */
  402. /* Put only stuff here that the assembler can digest */
  403. #ifdef CONFIG_POST
  404. #define CONFIG_HAS_POST
  405. #ifndef CONFIG_POST_ALT_LIST
  406. #define CONFIG_POST_STD_LIST
  407. #endif
  408. #endif
  409. #define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
  410. /*
  411. * check_member() - Check the offset of a structure member
  412. *
  413. * @structure: Name of structure (e.g. global_data)
  414. * @member: Name of member (e.g. baudrate)
  415. * @offset: Expected offset in bytes
  416. */
  417. #define check_member(structure, member, offset) _Static_assert( \
  418. offsetof(struct structure, member) == offset, \
  419. "`struct " #structure "` offset for `" #member "` is not " #offset)
  420. /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
  421. #ifdef CONFIG_EFI_STUB
  422. #define ll_boot_init() false
  423. #else
  424. #define ll_boot_init() true
  425. #endif
  426. /* Pull in stuff for the build system */
  427. #ifdef DO_DEPS_ONLY
  428. # include <environment.h>
  429. #endif
  430. #endif /* __COMMON_H_ */