xref: /rk3399_rockchip-uboot/include/common.h (revision 5821df21ae36d9ef252d346a5abb76be773c5d69)
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/delay.h>
27 #include <linux/types.h>
28 #include <linux/string.h>
29 #include <linux/stringify.h>
30 #include <asm/ptrace.h>
31 #include <stdarg.h>
32 #include <linux/kernel.h>
33 
34 #include <part.h>
35 #include <flash.h>
36 #include <image.h>
37 
38 /* Bring in printf format macros if inttypes.h is included */
39 #define __STDC_FORMAT_MACROS
40 
41 #ifdef __LP64__
42 #define CONFIG_SYS_SUPPORT_64BIT_DATA
43 #endif
44 
45 #ifdef DEBUG
46 #define _DEBUG	1
47 #else
48 #define _DEBUG	0
49 #endif
50 
51 #ifdef CONFIG_SPL_BUILD
52 #define _SPL_BUILD	1
53 #else
54 #define _SPL_BUILD	0
55 #endif
56 
57 /* Define this at the top of a file to add a prefix to debug messages */
58 #ifndef pr_fmt
59 #define pr_fmt(fmt) fmt
60 #endif
61 
62 /*
63  * Output a debug text when condition "cond" is met. The "cond" should be
64  * computed by a preprocessor in the best case, allowing for the best
65  * optimization.
66  */
67 #define debug_cond(cond, fmt, args...)			\
68 	do {						\
69 		if (cond)				\
70 			printf(pr_fmt(fmt), ##args);	\
71 	} while (0)
72 
73 /* Show a message if DEBUG is defined in a file */
74 #define debug(fmt, args...)			\
75 	debug_cond(_DEBUG, fmt, ##args)
76 
77 /* Show a message if not in SPL */
78 #define warn_non_spl(fmt, args...)			\
79 	debug_cond(!_SPL_BUILD, fmt, ##args)
80 
81 /*
82  * An assertion is run-time check done in debug mode only. If DEBUG is not
83  * defined then it is skipped. If DEBUG is defined and the assertion fails,
84  * then it calls panic*( which may or may not reset/halt U-Boot (see
85  * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
86  * before release, and after release it is hoped that they don't matter. But
87  * in any case these failing assertions cannot be fixed with a reset (which
88  * may just do the same assertion again).
89  */
90 void __assert_fail(const char *assertion, const char *file, unsigned line,
91 		   const char *function);
92 #define assert(x) \
93 	({ if (!(x) && _DEBUG) \
94 		__assert_fail(#x, __FILE__, __LINE__, __func__); })
95 
96 #define error(fmt, args...) do {					\
97 		printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n",	\
98 			##args, __FILE__, __LINE__, __func__);		\
99 } while (0)
100 
101 #if (__STDC_VERSION__ >= 201112L) || defined(__cplusplus)
102 # undef static_assert
103 # define static_assert _Static_assert
104 #endif
105 
106 #ifndef BUG
107 #define BUG() do { \
108 	printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
109 	panic("BUG!"); \
110 } while (0)
111 #define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
112 #endif /* BUG */
113 
114 #ifndef CONFIG_IRQ
115 typedef void (interrupt_handler_t)(void *);
116 #else
117 typedef void (interrupt_handler_t)(int, void *);
118 #endif
119 
120 #include <asm/u-boot.h> /* boot information for Linux kernel */
121 #include <asm/global_data.h>	/* global data used for startup functions */
122 
123 #if defined(CONFIG_ENV_IS_EMBEDDED)
124 #define TOTAL_MALLOC_LEN	CONFIG_SYS_MALLOC_LEN
125 #elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
126 	(CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
127       defined(CONFIG_ENV_IS_IN_NVRAM)
128 #define	TOTAL_MALLOC_LEN	(CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
129 #else
130 #define	TOTAL_MALLOC_LEN	CONFIG_SYS_MALLOC_LEN
131 #endif
132 
133 /*
134  * Function Prototypes
135  */
136 int dram_init(void);
137 
138 /**
139  * dram_init_banksize() - Set up DRAM bank sizes
140  *
141  * This can be implemented by boards to set up the DRAM bank information in
142  * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
143  * is called.
144  *
145  * If this is not provided, a default implementation will try to set up a
146  * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
147  * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
148  * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
149  * get_effective_memsize().
150  *
151  * @return 0 if OK, -ve on error
152  */
153 int dram_init_banksize(void);
154 
155 void	hang		(void) __attribute__ ((noreturn));
156 
157 int	timer_init(void);
158 int	cpu_init(void);
159 
160 #include <display_options.h>
161 
162 /* common/main.c */
163 void	main_loop	(void);
164 int run_command(const char *cmd, int flag);
165 int run_command_repeatable(const char *cmd, int flag);
166 
167 /**
168  * Run a list of commands separated by ; or even \0
169  *
170  * Note that if 'len' is not -1, then the command does not need to be nul
171  * terminated, Memory will be allocated for the command in that case.
172  *
173  * @param cmd	List of commands to run, each separated bu semicolon
174  * @param len	Length of commands excluding terminator if known (-1 if not)
175  * @param flag	Execution flags (CMD_FLAG_...)
176  * @return 0 on success, or != 0 on error.
177  */
178 int run_command_list(const char *cmd, int len, int flag);
179 
180 /* arch/$(ARCH)/lib/board.c */
181 void board_init_f(ulong);
182 void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
183 
184 /**
185  * ulong board_init_f_alloc_reserve - allocate reserved area
186  *
187  * This function is called by each architecture very early in the start-up
188  * code to allow the C runtime to reserve space on the stack for writable
189  * 'globals' such as GD and the malloc arena.
190  *
191  * @top:	top of the reserve area, growing down.
192  * @return:	bottom of reserved area
193  */
194 ulong board_init_f_alloc_reserve(ulong top);
195 
196 /**
197  * board_init_f_init_reserve - initialize the reserved area(s)
198  *
199  * This function is called once the C runtime has allocated the reserved
200  * area on the stack. It must initialize the GD at the base of that area.
201  *
202  * @base:	top from which reservation was done
203  */
204 void board_init_f_init_reserve(ulong base);
205 
206 /**
207  * arch_setup_gd() - Set up the global_data pointer
208  *
209  * This pointer is special in some architectures and cannot easily be assigned
210  * to. For example on x86 it is implemented by adding a specific record to its
211  * Global Descriptor Table! So we we provide a function to carry out this task.
212  * For most architectures this can simply be:
213  *
214  *    gd = gd_ptr;
215  *
216  * @gd_ptr:	Pointer to global data
217  */
218 void arch_setup_gd(gd_t *gd_ptr);
219 
220 int checkboard(void);
221 int show_board_info(void);
222 int checkflash(void);
223 int checkdram(void);
224 int last_stage_init(void);
225 extern ulong monitor_flash_len;
226 int mac_read_from_eeprom(void);
227 extern u8 __dtb_dt_begin[];	/* embedded device tree blob */
228 int set_cpu_clk_info(void);
229 int mdm_init(void);
230 int print_cpuinfo(void);
231 int update_flash_size(int flash_size);
232 int arch_early_init_r(void);
233 
234 /*
235  * setup_board_extra() - Fill in extra details in the bd_t structure
236  *
237  * @return 0 if OK, -ve on error
238  */
239 int setup_board_extra(void);
240 
241 /**
242  * arch_fsp_init() - perform firmware support package init
243  *
244  * Where U-Boot relies on binary blobs to handle part of the system init, this
245  * function can be used to set up the blobs. This is used on some Intel
246  * platforms.
247  */
248 int arch_fsp_init(void);
249 
250 /**
251  * arch_cpu_init_dm() - init CPU after driver model is available
252  *
253  * This is called immediately after driver model is available before
254  * relocation. This is similar to arch_cpu_init() but is able to reference
255  * devices
256  *
257  * @return 0 if OK, -ve on error
258  */
259 int arch_cpu_init_dm(void);
260 
261 /**
262  * Reserve all necessary stacks
263  *
264  * This is used in generic board init sequence in common/board_f.c. Each
265  * architecture could provide this function to tailor the required stacks.
266  *
267  * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
268  * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
269  * require only this can leave it untouched.
270  *
271  * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
272  * positions of the stack. The stack pointer(s) will be set to this later.
273  * gd->irq_sp is only required, if the architecture needs it.
274  *
275  * @return 0 if no error
276  */
277 __weak int arch_reserve_stacks(void);
278 
279 /**
280  * Show the DRAM size in a board-specific way
281  *
282  * This is used by boards to display DRAM information in their own way.
283  *
284  * @param size	Size of DRAM (which should be displayed along with other info)
285  */
286 void board_show_dram(phys_size_t size);
287 
288 /**
289  * arch_fixup_fdt() - Write arch-specific information to fdt
290  *
291  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
292  *
293  * @blob:	FDT blob to write to
294  * @return 0 if ok, or -ve FDT_ERR_... on failure
295  */
296 int arch_fixup_fdt(void *blob);
297 
298 int reserve_mmu(void);
299 /* common/flash.c */
300 void flash_perror (int);
301 
302 /* common/cmd_source.c */
303 int	source (ulong addr, const char *fit_uname);
304 
305 extern ulong load_addr;		/* Default Load Address */
306 extern ulong save_addr;		/* Default Save Address */
307 extern ulong save_size;		/* Default Save Size */
308 
309 /* common/cmd_net.c */
310 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
311 
312 /* common/cmd_fat.c */
313 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
314 
315 /* common/cmd_ext2.c */
316 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
317 
318 /* common/cmd_nvedit.c */
319 int	env_init     (void);
320 void	env_relocate (void);
321 int	envmatch     (uchar *, int);
322 
323 /**
324  * env_get() - Look up the value of an environment variable
325  *
326  * In U-Boot proper this can be called before relocation (which is when the
327  * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
328  * case this function calls env_get_f().
329  *
330  * @varname:	Variable to look up
331  * @return value of variable, or NULL if not found
332  */
333 char *env_get(const char *varname);
334 
335 /**
336  * env_get_f() - Look up the value of an environment variable (early)
337  *
338  * This function is called from env_get() if the environment has not been
339  * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
340  * support reading the value (slowly) and some will not.
341  *
342  * @varname:	Variable to look up
343  * @return value of variable, or NULL if not found
344  */
345 int env_get_f(const char *name, char *buf, unsigned len);
346 
347 /**
348  * env_get_ulong() - Return an environment variable as an integer value
349  *
350  * Most U-Boot environment variables store hex values. For those which store
351  * (e.g.) base-10 integers, this function can be used to read the value.
352  *
353  * @name:	Variable to look up
354  * @base:	Base to use (e.g. 10 for base 10, 2 for binary)
355  * @default_val: Default value to return if no value is found
356  * @return the value found, or @default_val if none
357  */
358 ulong env_get_ulong(const char *name, int base, ulong default_val);
359 
360 /**
361  * env_get_hex() - Return an environment variable as a hex value
362  *
363  * Decode an environment as a hex number (it may or may not have a 0x
364  * prefix). If the environment variable cannot be found, or does not start
365  * with hex digits, the default value is returned.
366  *
367  * @varname:		Variable to decode
368  * @default_val:	Value to return on error
369  */
370 ulong env_get_hex(const char *varname, ulong default_val);
371 
372 /*
373  * Read an environment variable as a boolean
374  * Return -1 if variable does not exist (default to true)
375  */
376 int env_get_yesno(const char *var);
377 
378 /**
379  * env_set() - set an environment variable
380  *
381  * This sets or deletes the value of an environment variable. For setting the
382  * value the variable is created if it does not already exist.
383  *
384  * @varname: Variable to adjust
385  * @value: Value to set for the variable, or NULL or "" to delete the variable
386  * @return 0 if OK, 1 on error
387  */
388 int env_set(const char *varname, const char *value);
389 
390 /**
391  * env_update() - update sub value of an environment variable
392  *
393  * This add/append/replace the sub value of an environment variable.
394  *
395  * @varname: Variable to adjust
396  * @valude: Value to append/replace
397  * @return 0 if OK, 1 on error
398  */
399 int env_update(const char *varname, const char *varvalue);
400 
401 /**
402  * env_set_ulong() - set an environment variable to an integer
403  *
404  * @varname: Variable to adjust
405  * @value: Value to set for the variable (will be converted to a string)
406  * @return 0 if OK, 1 on error
407  */
408 int env_set_ulong(const char *varname, ulong value);
409 
410 /**
411  * env_set_hex() - set an environment variable to a hex value
412  *
413  * @varname: Variable to adjust
414  * @value: Value to set for the variable (will be converted to a hex string)
415  * @return 0 if OK, 1 on error
416  */
417 int env_set_hex(const char *varname, ulong value);
418 
419 /**
420  * env_set_addr - Set an environment variable to an address in hex
421  *
422  * @varname:	Environment variable to set
423  * @addr:	Value to set it to
424  * @return 0 if ok, 1 on error
425  */
426 static inline int env_set_addr(const char *varname, const void *addr)
427 {
428 	return env_set_hex(varname, (ulong)addr);
429 }
430 
431 #ifdef CONFIG_AUTO_COMPLETE
432 int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
433 #endif
434 int get_env_id (void);
435 
436 void	pci_init      (void);
437 void	pci_init_board(void);
438 
439 #if defined(CONFIG_DTB_RESELECT)
440 int	embedded_dtb_select(void);
441 #endif
442 
443 int	misc_init_f   (void);
444 int	misc_init_r   (void);
445 
446 /* common/exports.c */
447 void	jumptable_init(void);
448 
449 /* common/kallsysm.c */
450 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
451 
452 /* common/memsize.c */
453 long	get_ram_size  (long *, long);
454 phys_size_t get_effective_memsize(void);
455 
456 /* $(BOARD)/$(BOARD).c */
457 void	reset_phy     (void);
458 void	fdc_hw_init   (void);
459 
460 /* $(BOARD)/eeprom.c */
461 #ifdef CONFIG_CMD_EEPROM
462 void eeprom_init  (int bus);
463 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
464 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
465 #else
466 /*
467  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
468  * some macros here so we don't have to touch every one of those uses
469  */
470 #define eeprom_init(bus)
471 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
472 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
473 #endif
474 
475 /*
476  * Set this up regardless of board
477  * type, to prevent errors.
478  */
479 #if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
480 # define CONFIG_SYS_DEF_EEPROM_ADDR 0
481 #else
482 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
483 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
484 #endif
485 #endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
486 
487 #if defined(CONFIG_SPI)
488 extern void spi_init_f (void);
489 extern void spi_init_r (void);
490 extern ssize_t spi_read	 (uchar *, int, uchar *, int);
491 extern ssize_t spi_write (uchar *, int, uchar *, int);
492 #endif
493 
494 /* $(BOARD)/$(BOARD).c */
495 int board_early_init_f (void);
496 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
497 int board_late_init (void);
498 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
499 int board_early_init_r (void);
500 void board_poweroff (void);
501 
502 #if defined(CONFIG_SYS_DRAM_TEST)
503 int testdram(void);
504 #endif /* CONFIG_SYS_DRAM_TEST */
505 
506 /* $(CPU)/start.S */
507 int	icache_status (void);
508 void	icache_enable (void);
509 void	icache_disable(void);
510 int	dcache_status (void);
511 void	dcache_enable (void);
512 void	dcache_disable(void);
513 void	mmu_disable(void);
514 #if defined(CONFIG_ARM)
515 void	relocate_code(ulong);
516 #else
517 void	relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
518 #endif
519 ulong	get_endaddr   (void);
520 void	trap_init     (ulong);
521 
522 /* $(CPU)/cpu.c */
523 static inline int cpumask_next(int cpu, unsigned int mask)
524 {
525 	for (cpu++; !((1 << cpu) & mask); cpu++)
526 		;
527 
528 	return cpu;
529 }
530 
531 #define for_each_cpu(iter, cpu, num_cpus, mask) \
532 	for (iter = 0, cpu = cpumask_next(-1, mask); \
533 		iter < num_cpus; \
534 		iter++, cpu = cpumask_next(cpu, mask)) \
535 
536 int	cpu_numcores  (void);
537 int	cpu_num_dspcores(void);
538 u32	cpu_mask      (void);
539 u32	cpu_dsp_mask(void);
540 int	is_core_valid (unsigned int);
541 
542 /**
543  * arch_cpu_init() - basic cpu-dependent setup for an architecture
544  *
545  * This is called after early malloc is available. It should handle any
546  * CPU- or SoC- specific init needed to continue the init sequence. See
547  * board_f.c for where it is called. If this is not provided, a default
548  * version (which does nothing) will be used.
549  */
550 int arch_cpu_init(void);
551 
552 int	checkcpu      (void);
553 int	checkicache   (void);
554 int	checkdcache   (void);
555 void	upmconfig     (unsigned int, unsigned int *, unsigned int);
556 ulong	get_tbclk     (void);
557 void	reset_misc    (void);
558 void	reset_cpu     (ulong addr);
559 void ft_cpu_setup(void *blob, bd_t *bd);
560 void ft_pci_setup(void *blob, bd_t *bd);
561 
562 void smp_set_core_boot_addr(unsigned long addr, int corenr);
563 void smp_kick_all_cpus(void);
564 
565 /* $(CPU)/serial.c */
566 int	serial_init   (void);
567 void	serial_setbrg (void);
568 void	serial_putc   (const char);
569 void	serial_putc_raw(const char);
570 void	serial_puts   (const char *);
571 int	serial_getc   (void);
572 int	serial_tstc   (void);
573 
574 /* $(CPU)/speed.c */
575 int	get_clocks (void);
576 ulong	get_bus_freq  (ulong);
577 int get_serial_clock(void);
578 
579 int	cpu_init_r    (void);
580 
581 /* $(CPU)/interrupts.c */
582 int	interrupt_init	   (void);
583 void	timer_interrupt	   (struct pt_regs *);
584 void	external_interrupt (struct pt_regs *);
585 void	irq_install_handler(int, interrupt_handler_t *, void *);
586 void	irq_free_handler   (int);
587 void	reset_timer	   (void);
588 
589 /* Return value of monotonic microsecond timer */
590 unsigned long timer_get_us(void);
591 
592 void	enable_interrupts  (void);
593 int	disable_interrupts (void);
594 
595 /* $(CPU)/.../commproc.c */
596 int	dpram_init (void);
597 uint	dpram_base(void);
598 uint	dpram_base_align(uint align);
599 uint	dpram_alloc(uint size);
600 uint	dpram_alloc_align(uint size,uint align);
601 void	bootcount_store (ulong);
602 ulong	bootcount_load (void);
603 #define BOOTCOUNT_MAGIC		0xB001C041
604 
605 /* $(CPU)/.../<eth> */
606 void mii_init (void);
607 
608 /* $(CPU)/.../lcd.c */
609 ulong	lcd_setmem (ulong);
610 
611 /* $(CPU)/.../video.c */
612 ulong	video_setmem (ulong);
613 
614 /* arch/$(ARCH)/lib/cache.c */
615 void	enable_caches(void);
616 void	flush_cache   (unsigned long, unsigned long);
617 void	flush_dcache_all(void);
618 void	flush_dcache_range(unsigned long start, unsigned long stop);
619 void	invalidate_dcache_range(unsigned long start, unsigned long stop);
620 void	invalidate_dcache_all(void);
621 void	invalidate_icache_all(void);
622 
623 enum {
624 	/* Disable caches (else flush caches but leave them active) */
625 	CBL_DISABLE_CACHES		= 1 << 0,
626 	CBL_SHOW_BOOTSTAGE_REPORT	= 1 << 1,
627 
628 	CBL_ALL				= 3,
629 };
630 
631 /**
632  * Clean up ready for linux
633  *
634  * @param flags		Flags to control what is done
635  */
636 int cleanup_before_linux_select(int flags);
637 
638 /* arch/$(ARCH)/lib/ticks.S */
639 uint64_t get_ticks(void);
640 void	wait_ticks    (unsigned long);
641 
642 /* arch/$(ARCH)/lib/time.c */
643 ulong	usec2ticks    (unsigned long usec);
644 ulong	ticks2usec    (unsigned long ticks);
645 
646 /* lib/gunzip.c */
647 int gunzip(void *, int, unsigned char *, unsigned long *);
648 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
649 						int stoponerr, int offset);
650 
651 /**
652  * gzwrite progress indicators: defined weak to allow board-specific
653  * overrides:
654  *
655  *	gzwrite_progress_init called on startup
656  *	gzwrite_progress called during decompress/write loop
657  *	gzwrite_progress_finish called at end of loop to
658  *		indicate success (retcode=0) or failure
659  */
660 void gzwrite_progress_init(u64 expected_size);
661 
662 void gzwrite_progress(int iteration,
663 		     u64 bytes_written,
664 		     u64 total_bytes);
665 
666 void gzwrite_progress_finish(int retcode,
667 			     u64 totalwritten,
668 			     u64 totalsize,
669 			     u32 expected_crc,
670 			     u32 calculated_crc);
671 
672 /**
673  * decompress and write gzipped image from memory to block device
674  *
675  * @param	src		compressed image address
676  * @param	len		compressed image length in bytes
677  * @param	dev		block device descriptor
678  * @param	szwritebuf	bytes per write (pad to erase size)
679  * @param	startoffs	offset in bytes of first write
680  * @param	szexpected	expected uncompressed length
681  *				may be zero to use gzip trailer
682  *				for files under 4GiB
683  */
684 int gzwrite(unsigned char *src, int len,
685 	    struct blk_desc *dev,
686 	    unsigned long szwritebuf,
687 	    u64 startoffs,
688 	    u64 szexpected);
689 
690 /* lib/lz4_wrapper.c */
691 int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
692 
693 /* lib/qsort.c */
694 void qsort(void *base, size_t nmemb, size_t size,
695 	   int(*compar)(const void *, const void *));
696 int strcmp_compar(const void *, const void *);
697 
698 /* lib/uuid.c */
699 #include <uuid.h>
700 
701 /* lib/vsprintf.c */
702 #include <vsprintf.h>
703 
704 /* lib/strmhz.c */
705 char *	strmhz(char *buf, unsigned long hz);
706 
707 /* lib/crc32.c */
708 #include <u-boot/crc.h>
709 
710 /* lib/rand.c */
711 #define RAND_MAX -1U
712 void srand(unsigned int seed);
713 unsigned int rand(void);
714 unsigned int rand_r(unsigned int *seedp);
715 
716 /*
717  * STDIO based functions (can always be used)
718  */
719 /* serial stuff */
720 int	serial_printf (const char *fmt, ...)
721 		__attribute__ ((format (__printf__, 1, 2)));
722 /* stdin */
723 int	getc(void);
724 int	tstc(void);
725 
726 /* stdout */
727 #if !defined(CONFIG_SPL_BUILD) || \
728 	(defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
729 	(defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
730 		defined(CONFIG_SPL_SERIAL_SUPPORT))
731 void	putc(const char c);
732 void	puts(const char *s);
733 int	printf(const char *fmt, ...)
734 		__attribute__ ((format (__printf__, 1, 2)));
735 int	vprintf(const char *fmt, va_list args);
736 #else
737 #define	putc(...) do { } while (0)
738 #define puts(...) do { } while (0)
739 #define printf(...) do { } while (0)
740 #define vprintf(...) do { } while (0)
741 #endif
742 
743 /* stderr */
744 #define eputc(c)		fputc(stderr, c)
745 #define eputs(s)		fputs(stderr, s)
746 #define eprintf(fmt,args...)	fprintf(stderr,fmt ,##args)
747 
748 /*
749  * FILE based functions (can only be used AFTER relocation!)
750  */
751 #define stdin		0
752 #define stdout		1
753 #define stderr		2
754 #define MAX_FILES	3
755 
756 int	fprintf(int file, const char *fmt, ...)
757 		__attribute__ ((format (__printf__, 2, 3)));
758 void	fputs(int file, const char *s);
759 void	fputc(int file, const char c);
760 int	ftstc(int file);
761 int	fgetc(int file);
762 
763 /* lib/gzip.c */
764 int gzip(void *dst, unsigned long *lenp,
765 		unsigned char *src, unsigned long srclen);
766 int zzip(void *dst, unsigned long *lenp, unsigned char *src,
767 		unsigned long srclen, int stoponerr,
768 		int (*func)(unsigned long, unsigned long));
769 
770 /* lib/net_utils.c */
771 #include <net.h>
772 static inline struct in_addr env_get_ip(char *var)
773 {
774 	return string_to_ip(env_get(var));
775 }
776 
777 int	pcmcia_init (void);
778 
779 #ifdef CONFIG_LED_STATUS
780 # include <status_led.h>
781 #endif
782 
783 #include <bootstage.h>
784 
785 #ifdef CONFIG_SHOW_ACTIVITY
786 void show_activity(int arg);
787 #endif
788 
789 /* Multicore arch functions */
790 #ifdef CONFIG_MP
791 int cpu_status(int nr);
792 int cpu_reset(int nr);
793 int cpu_disable(int nr);
794 int cpu_release(int nr, int argc, char * const argv[]);
795 #endif
796 
797 #else	/* __ASSEMBLY__ */
798 
799 /* Drop a C type modifier (like in 3UL) for constants used in assembly. */
800 #define _AC(X, Y)       X
801 
802 #endif	/* __ASSEMBLY__ */
803 
804 /* Put only stuff here that the assembler can digest */
805 
806 /* Declare an unsigned long constant digestable both by C and an assembler. */
807 #define UL(x)           _AC(x, UL)
808 
809 #ifdef CONFIG_POST
810 #define CONFIG_HAS_POST
811 #ifndef CONFIG_POST_ALT_LIST
812 #define CONFIG_POST_STD_LIST
813 #endif
814 #endif
815 
816 #ifdef CONFIG_INIT_CRITICAL
817 #error CONFIG_INIT_CRITICAL is deprecated!
818 #error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
819 #endif
820 
821 #define ROUND(a,b)		(((a) + (b) - 1) & ~((b) - 1))
822 
823 /*
824  * check_member() - Check the offset of a structure member
825  *
826  * @structure:	Name of structure (e.g. global_data)
827  * @member:	Name of member (e.g. baudrate)
828  * @offset:	Expected offset in bytes
829  */
830 #define check_member(structure, member, offset) _Static_assert( \
831 	offsetof(struct structure, member) == offset, \
832 	"`struct " #structure "` offset for `" #member "` is not " #offset)
833 
834 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
835 #ifdef CONFIG_EFI_STUB
836 #define ll_boot_init()	false
837 #else
838 #define ll_boot_init()	true
839 #endif
840 
841 /* Pull in stuff for the build system */
842 #ifdef DO_DEPS_ONLY
843 # include <environment.h>
844 #endif
845 
846 #endif	/* __COMMON_H_ */
847