]> git.ipfire.org Git - people/ms/u-boot.git/blame - include/common.h
common: arm: davinci: Move header file out of common
[people/ms/u-boot.git] / include / common.h
CommitLineData
e2211743 1/*
3b74e7ec 2 * (C) Copyright 2000-2009
e2211743
WD
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
3765b3e7 5 * SPDX-License-Identifier: GPL-2.0+
e2211743
WD
6 */
7
8#ifndef __COMMON_H_
d0b8feef 9#define __COMMON_H_ 1
e2211743 10
fcd3c87e
WD
11#ifndef __ASSEMBLY__ /* put C only stuff in this section */
12
e2211743
WD
13typedef unsigned char uchar;
14typedef volatile unsigned long vu_long;
180d3f74 15typedef volatile unsigned short vu_short;
e2211743
WD
16typedef volatile unsigned char vu_char;
17
2a6713b0
AP
18/* Allow sharing constants with type modifiers between C and assembly. */
19#define _AC(X, Y) (X##Y)
20
e2211743 21#include <config.h>
2307ea40 22#include <errno.h>
a7b81769 23#include <time.h>
25ddd1fb 24#include <asm-offsets.h>
e2211743 25#include <linux/bitops.h>
5bc516ed 26#include <linux/delay.h>
e2211743
WD
27#include <linux/types.h>
28#include <linux/string.h>
9aed5080 29#include <linux/stringify.h>
e2211743
WD
30#include <asm/ptrace.h>
31#include <stdarg.h>
cba1da49 32#include <linux/kernel.h>
85043159 33
9f3183d2
MH
34#ifdef CONFIG_FSL_LSCH3
35#include <asm/arch/immap_lsch3.h>
36#endif
8281c58f
MH
37#ifdef CONFIG_FSL_LSCH2
38#include <asm/arch/immap_lsch2.h>
39#endif
e2211743
WD
40
41#include <part.h>
42#include <flash.h>
43#include <image.h>
44
4166ecb2
GB
45/* Bring in printf format macros if inttypes.h is included */
46#define __STDC_FORMAT_MACROS
47
4d1fd7f1
YS
48#ifdef __LP64__
49#define CONFIG_SYS_SUPPORT_64BIT_DATA
50#endif
51
21726a7a 52#ifdef DEBUG
88a85fb9 53#define _DEBUG 1
21726a7a 54#else
88a85fb9 55#define _DEBUG 0
21726a7a
SG
56#endif
57
98286826
SG
58#ifdef CONFIG_SPL_BUILD
59#define _SPL_BUILD 1
60#else
61#define _SPL_BUILD 0
62#endif
63
5e7f7433 64/* Define this at the top of a file to add a prefix to debug messages */
be25d875
TR
65#ifndef pr_fmt
66#define pr_fmt(fmt) fmt
67#endif
68
88a85fb9
MV
69/*
70 * Output a debug text when condition "cond" is met. The "cond" should be
71 * computed by a preprocessor in the best case, allowing for the best
72 * optimization.
73 */
be25d875
TR
74#define debug_cond(cond, fmt, args...) \
75 do { \
76 if (cond) \
77 printf(pr_fmt(fmt), ##args); \
88a85fb9
MV
78 } while (0)
79
5e7f7433 80/* Show a message if DEBUG is defined in a file */
88a85fb9
MV
81#define debug(fmt, args...) \
82 debug_cond(_DEBUG, fmt, ##args)
83
98286826
SG
84/* Show a message if not in SPL */
85#define warn_non_spl(fmt, args...) \
86 debug_cond(!_SPL_BUILD, fmt, ##args)
87
21726a7a
SG
88/*
89 * An assertion is run-time check done in debug mode only. If DEBUG is not
90 * defined then it is skipped. If DEBUG is defined and the assertion fails,
91 * then it calls panic*( which may or may not reset/halt U-Boot (see
92 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
93 * before release, and after release it is hoped that they don't matter. But
94 * in any case these failing assertions cannot be fixed with a reset (which
95 * may just do the same assertion again).
96 */
97void __assert_fail(const char *assertion, const char *file, unsigned line,
98 const char *function);
99#define assert(x) \
100 ({ if (!(x) && _DEBUG) \
101 __assert_fail(#x, __FILE__, __LINE__, __func__); })
102
594d57d0 103#define error(fmt, args...) do { \
be25d875 104 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
594d57d0
MK
105 ##args, __FILE__, __LINE__, __func__); \
106} while (0)
107
cfa460ad 108#ifndef BUG
43835aac 109#define BUG() do { \
511d0c72 110 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
43835aac
DZ
111 panic("BUG!"); \
112} while (0)
113#define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
cfa460ad 114#endif /* BUG */
43835aac 115
c83bf6a2 116typedef void (interrupt_handler_t)(void *);
e2211743 117
c83bf6a2 118#include <asm/u-boot.h> /* boot information for Linux kernel */
e2211743
WD
119#include <asm/global_data.h> /* global data used for startup functions */
120
3fbeeea6
HS
121#if defined(CONFIG_ENV_IS_EMBEDDED)
122#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
123#elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
124 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
125 defined(CONFIG_ENV_IS_IN_NVRAM)
126#define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
127#else
128#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
129#endif
c7de829c 130
e2211743
WD
131/*
132 * Function Prototypes
133 */
0267ba5d 134int dram_init(void);
e2211743 135
5e924a13
SG
136/**
137 * dram_init_banksize() - Set up DRAM bank sizes
138 *
139 * This can be implemented by boards to set up the DRAM bank information in
140 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
141 * is called.
142 *
143 * If this is not provided, a default implementation will try to set up a
144 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
145 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
146 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
147 * get_effective_memsize().
148 *
149 * @return 0 if OK, -ve on error
150 */
151int dram_init_banksize(void);
152
c83bf6a2 153void hang (void) __attribute__ ((noreturn));
e2211743 154
f6c019c4
WD
155int timer_init(void);
156int cpu_init(void);
157
2ea09c83 158#include <display_options.h>
e2211743
WD
159
160/* common/main.c */
161void main_loop (void);
009dde19 162int run_command(const char *cmd, int flag);
1d43bfd2 163int run_command_repeatable(const char *cmd, int flag);
d51004a8
SG
164
165/**
166 * Run a list of commands separated by ; or even \0
167 *
168 * Note that if 'len' is not -1, then the command does not need to be nul
169 * terminated, Memory will be allocated for the command in that case.
170 *
171 * @param cmd List of commands to run, each separated bu semicolon
172 * @param len Length of commands excluding terminator if known (-1 if not)
173 * @param flag Execution flags (CMD_FLAG_...)
174 * @return 0 on success, or != 0 on error.
175 */
176int run_command_list(const char *cmd, int len, int flag);
e2211743 177
ea0364f1 178/* arch/$(ARCH)/lib/board.c */
0365ffcc
MY
179void board_init_f(ulong);
180void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
1fed87db
SG
181
182/**
ecc30663 183 * ulong board_init_f_alloc_reserve - allocate reserved area
1fed87db
SG
184 *
185 * This function is called by each architecture very early in the start-up
ecc30663
AA
186 * code to allow the C runtime to reserve space on the stack for writable
187 * 'globals' such as GD and the malloc arena.
1fed87db 188 *
ecc30663
AA
189 * @top: top of the reserve area, growing down.
190 * @return: bottom of reserved area
191 */
192ulong board_init_f_alloc_reserve(ulong top);
193
194/**
195 * board_init_f_init_reserve - initialize the reserved area(s)
1fed87db 196 *
ecc30663
AA
197 * This function is called once the C runtime has allocated the reserved
198 * area on the stack. It must initialize the GD at the base of that area.
1fed87db 199 *
ecc30663 200 * @base: top from which reservation was done
1fed87db 201 */
ecc30663 202void board_init_f_init_reserve(ulong base);
1fed87db
SG
203
204/**
205 * arch_setup_gd() - Set up the global_data pointer
206 *
207 * This pointer is special in some architectures and cannot easily be assigned
208 * to. For example on x86 it is implemented by adding a specific record to its
209 * Global Descriptor Table! So we we provide a function to carry out this task.
210 * For most architectures this can simply be:
211 *
212 * gd = gd_ptr;
213 *
214 * @gd_ptr: Pointer to global data
215 */
216void arch_setup_gd(gd_t *gd_ptr);
217
0365ffcc
MY
218int checkboard(void);
219int show_board_info(void);
220int checkflash(void);
221int checkdram(void);
222int last_stage_init(void);
3b57fe0a 223extern ulong monitor_flash_len;
bea3f28d 224int mac_read_from_eeprom(void);
6ab6b2af 225extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
8f5d4687 226int set_cpu_clk_info(void);
9272a9b4 227int mdm_init(void);
1938f4a5 228int print_cpuinfo(void);
c2240d4d 229int update_flash_size(int flash_size);
2c072c95 230int arch_early_init_r(void);
e2211743 231
e5fb573f
SG
232/*
233 * setup_board_extra() - Fill in extra details in the bd_t structure
234 *
235 * @return 0 if OK, -ve on error
236 */
237int setup_board_extra(void);
238
671549e5
SG
239/**
240 * arch_fsp_init() - perform firmware support package init
241 *
242 * Where U-Boot relies on binary blobs to handle part of the system init, this
243 * function can be used to set up the blobs. This is used on some Intel
244 * platforms.
245 */
246int arch_fsp_init(void);
247
d4c671cc
SG
248/**
249 * arch_cpu_init_dm() - init CPU after driver model is available
250 *
251 * This is called immediately after driver model is available before
252 * relocation. This is similar to arch_cpu_init() but is able to reference
253 * devices
254 *
255 * @return 0 if OK, -ve on error
256 */
257int arch_cpu_init_dm(void);
258
68145d4c
AB
259/**
260 * Reserve all necessary stacks
261 *
262 * This is used in generic board init sequence in common/board_f.c. Each
263 * architecture could provide this function to tailor the required stacks.
264 *
265 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
266 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
267 * require only this can leave it untouched.
268 *
269 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
270 * positions of the stack. The stack pointer(s) will be set to this later.
271 * gd->irq_sp is only required, if the architecture needs it.
272 *
273 * @return 0 if no error
274 */
275__weak int arch_reserve_stacks(void);
276
15a33e49
SG
277/**
278 * Show the DRAM size in a board-specific way
279 *
280 * This is used by boards to display DRAM information in their own way.
281 *
282 * @param size Size of DRAM (which should be displayed along with other info)
283 */
ea11b401 284void board_show_dram(phys_size_t size);
15a33e49 285
13d06981 286/**
e29607ed 287 * arch_fixup_fdt() - Write arch-specific information to fdt
13d06981 288 *
e29607ed 289 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
13d06981
SG
290 *
291 * @blob: FDT blob to write to
292 * @return 0 if ok, or -ve FDT_ERR_... on failure
293 */
e29607ed 294int arch_fixup_fdt(void *blob);
13d06981 295
e2211743
WD
296/* common/flash.c */
297void flash_perror (int);
298
74de7aef
WD
299/* common/cmd_source.c */
300int source (ulong addr, const char *fit_uname);
e2211743 301
c83bf6a2 302extern ulong load_addr; /* Default Load Address */
1aec244a
SG
303extern ulong save_addr; /* Default Save Address */
304extern ulong save_size; /* Default Save Size */
e2211743 305
06283a64
JH
306/* common/cmd_net.c */
307int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
308
669df7e4
RH
309/* common/cmd_fat.c */
310int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
311
312/* common/cmd_ext2.c */
313int do_ext2load(cmd_tbl_t *, int, int, char * const []);
314
e2211743
WD
315/* common/cmd_nvedit.c */
316int env_init (void);
317void env_relocate (void);
26a41790 318int envmatch (uchar *, int);
20f86a0a
SG
319
320/* Avoid unfortunate conflict with libc's getenv() */
321#ifdef CONFIG_SANDBOX
322#define getenv uboot_getenv
323#endif
84b5e802
WD
324char *getenv (const char *);
325int getenv_f (const char *name, char *buf, unsigned len);
4a9b4131 326ulong getenv_ulong(const char *name, int base, ulong default_val);
76b8f79c
SG
327
328/**
329 * getenv_hex() - Return an environment variable as a hex value
330 *
331 * Decode an environment as a hex number (it may or may not have a 0x
332 * prefix). If the environment variable cannot be found, or does not start
333 * with hex digits, the default value is returned.
334 *
335 * @varname: Variable to decode
336 * @default_val: Value to return on error
337 */
338ulong getenv_hex(const char *varname, ulong default_val);
339
ec8a252c
JH
340/*
341 * Read an environment variable as a boolean
342 * Return -1 if variable does not exist (default to true)
343 */
344int getenv_yesno(const char *var);
c83bf6a2 345int saveenv (void);
84b5e802 346int setenv (const char *, const char *);
d67f10ce 347int setenv_ulong(const char *varname, ulong value);
bfc59966
SG
348int setenv_hex(const char *varname, ulong value);
349/**
350 * setenv_addr - Set an environment variable to an address in hex
351 *
1bce2aeb 352 * @varname: Environment variable to set
bfc59966
SG
353 * @addr: Value to set it to
354 * @return 0 if ok, 1 on error
355 */
356static inline int setenv_addr(const char *varname, const void *addr)
357{
358 return setenv_hex(varname, (ulong)addr);
359}
360
04a85b3b
WD
361#ifdef CONFIG_AUTO_COMPLETE
362int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
363#endif
2f70c49e 364int get_env_id (void);
04a85b3b 365
c83bf6a2
WD
366void pci_init (void);
367void pci_init_board(void);
e2211743 368
e2211743
WD
369int misc_init_f (void);
370int misc_init_r (void);
371
27b207fd
WD
372/* common/exports.c */
373void jumptable_init(void);
374
ecb1dc89
MF
375/* common/kallsysm.c */
376const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
377
c83bf6a2 378/* common/memsize.c */
a55d23cc 379long get_ram_size (long *, long);
e3866163 380phys_size_t get_effective_memsize(void);
c83bf6a2 381
e2211743
WD
382/* $(BOARD)/$(BOARD).c */
383void reset_phy (void);
c83bf6a2 384void fdc_hw_init (void);
e2211743
WD
385
386/* $(BOARD)/eeprom.c */
eb5ba3ae 387#ifdef CONFIG_CMD_EEPROM
354e3ed7 388void eeprom_init (int bus);
e2211743
WD
389int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
390int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
eb5ba3ae
SG
391#else
392/*
393 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
394 * some macros here so we don't have to touch every one of those uses
395 */
396#define eeprom_init(bus)
397#define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
398#define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
399#endif
e2211743
WD
400
401/*
402 * Set this up regardless of board
403 * type, to prevent errors.
404 */
6d0f6bcf
JCPV
405#if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
406# define CONFIG_SYS_DEF_EEPROM_ADDR 0
e2211743 407#else
548738b4 408#if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
6d0f6bcf 409# define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
548738b4 410#endif
6d0f6bcf 411#endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
e2211743 412
bdccc4fe 413#if defined(CONFIG_SPI)
e2211743
WD
414extern void spi_init_f (void);
415extern void spi_init_r (void);
c83bf6a2 416extern ssize_t spi_read (uchar *, int, uchar *, int);
e2211743
WD
417extern ssize_t spi_write (uchar *, int, uchar *, int);
418#endif
419
e2211743 420/* $(BOARD)/$(BOARD).c */
c837dcb1 421int board_early_init_f (void);
2a792753 422int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
c837dcb1 423int board_late_init (void);
e2211743 424int board_postclk_init (void); /* after clocks/timebase, before env/serial */
c837dcb1 425int board_early_init_r (void);
e2211743
WD
426void board_poweroff (void);
427
6d0f6bcf 428#if defined(CONFIG_SYS_DRAM_TEST)
e2211743 429int testdram(void);
6d0f6bcf 430#endif /* CONFIG_SYS_DRAM_TEST */
e2211743
WD
431
432/* $(CPU)/start.S */
e2211743
WD
433int icache_status (void);
434void icache_enable (void);
435void icache_disable(void);
436int dcache_status (void);
437void dcache_enable (void);
438void dcache_disable(void);
2c451f78 439void mmu_disable(void);
5c6db120
BT
440#if defined(CONFIG_ARM)
441void relocate_code(ulong);
442#else
443void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
959eaa74 444#endif
e2211743
WD
445ulong get_endaddr (void);
446void trap_init (ulong);
6e2941d7 447
0643631a
MS
448#if defined (CONFIG_MICROBLAZE)
449unsigned short in16(unsigned int);
450void out16(unsigned int, unsigned short value);
451#endif
e2211743
WD
452
453/* $(CPU)/cpu.c */
fbb9ecf7
TT
454static inline int cpumask_next(int cpu, unsigned int mask)
455{
456 for (cpu++; !((1 << cpu) & mask); cpu++)
457 ;
458
459 return cpu;
460}
461
462#define for_each_cpu(iter, cpu, num_cpus, mask) \
463 for (iter = 0, cpu = cpumask_next(-1, mask); \
464 iter < num_cpus; \
465 iter++, cpu = cpumask_next(cpu, mask)) \
466
0e870980 467int cpu_numcores (void);
b8bf0adc 468int cpu_num_dspcores(void);
fbb9ecf7 469u32 cpu_mask (void);
b8bf0adc 470u32 cpu_dsp_mask(void);
fbb9ecf7 471int is_core_valid (unsigned int);
cbcbf71b
SG
472
473/**
474 * arch_cpu_init() - basic cpu-dependent setup for an architecture
475 *
476 * This is called after early malloc is available. It should handle any
477 * CPU- or SoC- specific init needed to continue the init sequence. See
478 * board_f.c for where it is called. If this is not provided, a default
479 * version (which does nothing) will be used.
480 */
481int arch_cpu_init(void);
482
e2211743
WD
483int checkcpu (void);
484int checkicache (void);
485int checkdcache (void);
486void upmconfig (unsigned int, unsigned int *, unsigned int);
487ulong get_tbclk (void);
1fb4dab2 488void reset_misc (void);
3ec924a3 489void reset_cpu (ulong addr);
6a16e0df 490void ft_cpu_setup(void *blob, bd_t *bd);
6a16e0df 491void ft_pci_setup(void *blob, bd_t *bd);
6a16e0df 492
ba6a1698
AP
493void smp_set_core_boot_addr(unsigned long addr, int corenr);
494void smp_kick_all_cpus(void);
e2211743
WD
495
496/* $(CPU)/serial.c */
497int serial_init (void);
498void serial_setbrg (void);
499void serial_putc (const char);
756f586a 500void serial_putc_raw(const char);
e2211743 501void serial_puts (const char *);
e2211743
WD
502int serial_getc (void);
503int serial_tstc (void);
504
709ea543
SG
505/* These versions take a stdio_dev pointer */
506struct stdio_dev;
507int serial_stub_getc(struct stdio_dev *sdev);
508int serial_stub_tstc(struct stdio_dev *sdev);
509
e2211743
WD
510/* $(CPU)/speed.c */
511int get_clocks (void);
e2211743 512ulong get_bus_freq (ulong);
550650dd 513int get_serial_clock(void);
e2211743 514
e2211743 515int cpu_init_r (void);
e2211743
WD
516
517/* $(CPU)/interrupts.c */
c83bf6a2
WD
518int interrupt_init (void);
519void timer_interrupt (struct pt_regs *);
e2211743
WD
520void external_interrupt (struct pt_regs *);
521void irq_install_handler(int, interrupt_handler_t *, void *);
522void irq_free_handler (int);
523void reset_timer (void);
b2e16a85
SG
524
525/* Return value of monotonic microsecond timer */
526unsigned long timer_get_us(void);
527
e2211743
WD
528void enable_interrupts (void);
529int disable_interrupts (void);
530
531/* $(CPU)/.../commproc.c */
532int dpram_init (void);
533uint dpram_base(void);
534uint dpram_base_align(uint align);
535uint dpram_alloc(uint size);
536uint dpram_alloc_align(uint size,uint align);
bdccc4fe
WD
537void bootcount_store (ulong);
538ulong bootcount_load (void);
539#define BOOTCOUNT_MAGIC 0xB001C041
e2211743
WD
540
541/* $(CPU)/.../<eth> */
c5bded3c 542void mii_init (void);
e2211743
WD
543
544/* $(CPU)/.../lcd.c */
545ulong lcd_setmem (ulong);
546
e2211743
WD
547/* $(CPU)/.../video.c */
548ulong video_setmem (ulong);
549
ea0364f1 550/* arch/$(ARCH)/lib/cache.c */
cba4b180 551void enable_caches(void);
e2211743 552void flush_cache (unsigned long, unsigned long);
2c451f78 553void flush_dcache_all(void);
03d3bfb0
SR
554void flush_dcache_range(unsigned long start, unsigned long stop);
555void invalidate_dcache_range(unsigned long start, unsigned long stop);
2c451f78
A
556void invalidate_dcache_all(void);
557void invalidate_icache_all(void);
0db5bca8 558
4d24a11e
SG
559enum {
560 /* Disable caches (else flush caches but leave them active) */
561 CBL_DISABLE_CACHES = 1 << 0,
562 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
563
564 CBL_ALL = 3,
565};
566
567/**
568 * Clean up ready for linux
569 *
570 * @param flags Flags to control what is done
571 */
572int cleanup_before_linux_select(int flags);
573
ea0364f1 574/* arch/$(ARCH)/lib/ticks.S */
19ea4678 575uint64_t get_ticks(void);
e2211743
WD
576void wait_ticks (unsigned long);
577
ea0364f1 578/* arch/$(ARCH)/lib/time.c */
e2211743
WD
579ulong usec2ticks (unsigned long usec);
580ulong ticks2usec (unsigned long ticks);
e2211743 581
78acc472 582/* lib/gunzip.c */
87d93a1b
WW
583int gunzip(void *, int, unsigned char *, unsigned long *);
584int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
585 int stoponerr, int offset);
586
918e9ebb
EN
587/**
588 * gzwrite progress indicators: defined weak to allow board-specific
589 * overrides:
590 *
591 * gzwrite_progress_init called on startup
592 * gzwrite_progress called during decompress/write loop
593 * gzwrite_progress_finish called at end of loop to
594 * indicate success (retcode=0) or failure
595 */
596void gzwrite_progress_init(u64 expected_size);
597
598void gzwrite_progress(int iteration,
599 u64 bytes_written,
600 u64 total_bytes);
601
602void gzwrite_progress_finish(int retcode,
603 u64 totalwritten,
604 u64 totalsize,
605 u32 expected_crc,
606 u32 calculated_crc);
607
608/**
609 * decompress and write gzipped image from memory to block device
610 *
611 * @param src compressed image address
612 * @param len compressed image length in bytes
613 * @param dev block device descriptor
614 * @param szwritebuf bytes per write (pad to erase size)
615 * @param startoffs offset in bytes of first write
616 * @param szexpected expected uncompressed length
617 * may be zero to use gzip trailer
618 * for files under 4GiB
619 */
620int gzwrite(unsigned char *src, int len,
4101f687 621 struct blk_desc *dev,
918e9ebb
EN
622 unsigned long szwritebuf,
623 u64 startoffs,
624 u64 szexpected);
625
027b728d
JW
626/* lib/lz4_wrapper.c */
627int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
628
54c6977e
WD
629/* lib/qsort.c */
630void qsort(void *base, size_t nmemb, size_t size,
631 int(*compar)(const void *, const void *));
560d424b 632int strcmp_compar(const void *, const void *);
54c6977e 633
e11938ea 634/* lib/uuid.c */
d718ded0 635#include <uuid.h>
e11938ea 636
78acc472 637/* lib/vsprintf.c */
9785c905 638#include <vsprintf.h>
e2211743 639
78acc472 640/* lib/strmhz.c */
55f7934d 641char * strmhz(char *buf, unsigned long hz);
0768b7a8 642
78acc472 643/* lib/crc32.c */
449609f5 644#include <u-boot/crc.h>
e2211743 645
9acf1ca5 646/* lib/rand.c */
9acf1ca5
MW
647#define RAND_MAX -1U
648void srand(unsigned int seed);
649unsigned int rand(void);
650unsigned int rand_r(unsigned int *seedp);
9acf1ca5 651
e2211743
WD
652/*
653 * STDIO based functions (can always be used)
654 */
e2211743 655/* serial stuff */
d9c27253 656int serial_printf (const char *fmt, ...)
dc4b0b38 657 __attribute__ ((format (__printf__, 1, 2)));
e2211743
WD
658/* stdin */
659int getc(void);
660int tstc(void);
661
662/* stdout */
76f1f388
SG
663#if !defined(CONFIG_SPL_BUILD) || \
664 (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
665 (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
666 defined(CONFIG_SPL_SERIAL_SUPPORT))
e2211743
WD
667void putc(const char c);
668void puts(const char *s);
d9c27253 669int printf(const char *fmt, ...)
dc4b0b38 670 __attribute__ ((format (__printf__, 1, 2)));
d9c27253 671int vprintf(const char *fmt, va_list args);
76f1f388
SG
672#else
673#define putc(...) do { } while (0)
674#define puts(...) do { } while (0)
675#define printf(...) do { } while (0)
676#define vprintf(...) do { } while (0)
80402f34 677#endif
e2211743
WD
678
679/* stderr */
680#define eputc(c) fputc(stderr, c)
681#define eputs(s) fputs(stderr, s)
682#define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
683
684/*
685 * FILE based functions (can only be used AFTER relocation!)
686 */
e2211743
WD
687#define stdin 0
688#define stdout 1
689#define stderr 2
690#define MAX_FILES 3
691
d9c27253 692int fprintf(int file, const char *fmt, ...)
dc4b0b38 693 __attribute__ ((format (__printf__, 2, 3)));
e2211743
WD
694void fputs(int file, const char *s);
695void fputc(int file, const char c);
696int ftstc(int file);
697int fgetc(int file);
698
88d52c6a
LW
699/* lib/gzip.c */
700int gzip(void *dst, unsigned long *lenp,
701 unsigned char *src, unsigned long srclen);
702int zzip(void *dst, unsigned long *lenp, unsigned char *src,
703 unsigned long srclen, int stoponerr,
704 int (*func)(unsigned long, unsigned long));
705
4ef8d53c
JH
706/* lib/net_utils.c */
707#include <net.h>
049a95a7 708static inline struct in_addr getenv_ip(char *var)
4ef8d53c
JH
709{
710 return string_to_ip(getenv(var));
711}
712
e2211743
WD
713int pcmcia_init (void);
714
2d8d190c 715#ifdef CONFIG_LED_STATUS
fb364bec
WD
716# include <status_led.h>
717#endif
097e1783
SG
718
719#include <bootstage.h>
e2211743 720
48522bb5
JH
721#ifdef CONFIG_SHOW_ACTIVITY
722void show_activity(int arg);
723#endif
724
fcd3c87e
WD
725/* Multicore arch functions */
726#ifdef CONFIG_MP
727int cpu_status(int nr);
728int cpu_reset(int nr);
4194b366 729int cpu_disable(int nr);
54841ab5 730int cpu_release(int nr, int argc, char * const argv[]);
fcd3c87e
WD
731#endif
732
2a6713b0
AP
733#else /* __ASSEMBLY__ */
734
735/* Drop a C type modifier (like in 3UL) for constants used in assembly. */
736#define _AC(X, Y) X
737
738#endif /* __ASSEMBLY__ */
fcd3c87e
WD
739
740/* Put only stuff here that the assembler can digest */
741
2a6713b0
AP
742/* Declare an unsigned long constant digestable both by C and an assembler. */
743#define UL(x) _AC(x, UL)
744
fcd3c87e
WD
745#ifdef CONFIG_POST
746#define CONFIG_HAS_POST
800eb096
MZ
747#ifndef CONFIG_POST_ALT_LIST
748#define CONFIG_POST_STD_LIST
749#endif
fcd3c87e
WD
750#endif
751
8aa1a2d1 752#ifdef CONFIG_INIT_CRITICAL
2f6fa46d 753#error CONFIG_INIT_CRITICAL is deprecated!
8aa1a2d1
WD
754#error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
755#endif
756
155cfb5e 757#define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
4b03ac8b 758
c9689ca3
SG
759/*
760 * check_member() - Check the offset of a structure member
761 *
762 * @structure: Name of structure (e.g. global_data)
763 * @member: Name of member (e.g. baudrate)
764 * @offset: Expected offset in bytes
765 */
766#define check_member(structure, member, offset) _Static_assert( \
767 offsetof(struct structure, member) == offset, \
768 "`struct " #structure "` offset for `" #member "` is not " #offset)
769
476476e7
SG
770/* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
771#ifdef CONFIG_EFI_STUB
772#define ll_boot_init() false
773#else
774#define ll_boot_init() true
775#endif
776
c3eb3fe4
MF
777/* Pull in stuff for the build system */
778#ifdef DO_DEPS_ONLY
779# include <environment.h>
780#endif
781
e2211743 782#endif /* __COMMON_H_ */