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