]> git.ipfire.org Git - people/ms/u-boot.git/blame - include/common.h
Kconfig: Finish migration of hashing commands
[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>
a821d08d 33#if defined(CONFIG_PCI) && defined(CONFIG_4xx)
e2211743
WD
34#include <pci.h>
35#endif
180d3f74 36#if defined(CONFIG_8xx)
e2211743 37#include <asm/8xx_immap.h>
03f9d7d1
MY
38#if defined(CONFIG_MPC859) || defined(CONFIG_MPC859T) || \
39 defined(CONFIG_MPC866) || \
d4ca31c4 40 defined(CONFIG_MPC866P)
d0b8feef 41# define CONFIG_MPC866_FAMILY 1
0ace4d9d 42#elif defined(CONFIG_MPC885)
d0b8feef 43# define CONFIG_MPC885_FAMILY 1
180d3f74
WD
44#endif
45#if defined(CONFIG_MPC860) \
46 || defined(CONFIG_MPC860T) \
1114257c
WD
47 || defined(CONFIG_MPC866_FAMILY) \
48 || defined(CONFIG_MPC885_FAMILY)
d0b8feef 49# define CONFIG_MPC86x 1
2535d602 50#endif
0db5bca8
WD
51#elif defined(CONFIG_5xx)
52#include <asm/5xx_immap.h>
7e6bf358
WD
53#elif defined(CONFIG_MPC5xxx)
54#include <mpc5xxx.h>
8993e54b 55#elif defined(CONFIG_MPC512X)
8993e54b 56#include <asm/immap_512x.h>
58dac327 57#elif defined(CONFIG_MPC8260)
04a85b3b 58#if defined(CONFIG_MPC8247) \
04a85b3b 59 || defined(CONFIG_MPC8272)
d0b8feef 60#define CONFIG_MPC8272_FAMILY 1
04a85b3b 61#endif
e2211743
WD
62#include <asm/immap_8260.h>
63#endif
debb7354
JL
64#ifdef CONFIG_MPC86xx
65#include <mpc86xx.h>
66#include <asm/immap_86xx.h>
67#endif
42d1f039
WD
68#ifdef CONFIG_MPC85xx
69#include <mpc85xx.h>
70#include <asm/immap_85xx.h>
71#endif
0f898604 72#ifdef CONFIG_MPC83xx
f046ccd1
EL
73#include <mpc83xx.h>
74#include <asm/immap_83xx.h>
75#endif
e2211743 76#ifdef CONFIG_4xx
b36df561 77#include <asm/ppc4xx.h>
e2211743 78#endif
2819e136
SN
79#ifdef CONFIG_SOC_DA8XX
80#include <asm/arch/hardware.h>
81#endif
9f3183d2
MH
82#ifdef CONFIG_FSL_LSCH3
83#include <asm/arch/immap_lsch3.h>
84#endif
8281c58f
MH
85#ifdef CONFIG_FSL_LSCH2
86#include <asm/arch/immap_lsch2.h>
87#endif
e2211743
WD
88
89#include <part.h>
90#include <flash.h>
91#include <image.h>
92
4166ecb2
GB
93/* Bring in printf format macros if inttypes.h is included */
94#define __STDC_FORMAT_MACROS
95
4d1fd7f1
YS
96#ifdef __LP64__
97#define CONFIG_SYS_SUPPORT_64BIT_DATA
98#endif
99
21726a7a 100#ifdef DEBUG
88a85fb9 101#define _DEBUG 1
21726a7a 102#else
88a85fb9 103#define _DEBUG 0
21726a7a
SG
104#endif
105
98286826
SG
106#ifdef CONFIG_SPL_BUILD
107#define _SPL_BUILD 1
108#else
109#define _SPL_BUILD 0
110#endif
111
5e7f7433 112/* Define this at the top of a file to add a prefix to debug messages */
be25d875
TR
113#ifndef pr_fmt
114#define pr_fmt(fmt) fmt
115#endif
116
88a85fb9
MV
117/*
118 * Output a debug text when condition "cond" is met. The "cond" should be
119 * computed by a preprocessor in the best case, allowing for the best
120 * optimization.
121 */
be25d875
TR
122#define debug_cond(cond, fmt, args...) \
123 do { \
124 if (cond) \
125 printf(pr_fmt(fmt), ##args); \
88a85fb9
MV
126 } while (0)
127
5e7f7433 128/* Show a message if DEBUG is defined in a file */
88a85fb9
MV
129#define debug(fmt, args...) \
130 debug_cond(_DEBUG, fmt, ##args)
131
98286826
SG
132/* Show a message if not in SPL */
133#define warn_non_spl(fmt, args...) \
134 debug_cond(!_SPL_BUILD, fmt, ##args)
135
21726a7a
SG
136/*
137 * An assertion is run-time check done in debug mode only. If DEBUG is not
138 * defined then it is skipped. If DEBUG is defined and the assertion fails,
139 * then it calls panic*( which may or may not reset/halt U-Boot (see
140 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
141 * before release, and after release it is hoped that they don't matter. But
142 * in any case these failing assertions cannot be fixed with a reset (which
143 * may just do the same assertion again).
144 */
145void __assert_fail(const char *assertion, const char *file, unsigned line,
146 const char *function);
147#define assert(x) \
148 ({ if (!(x) && _DEBUG) \
149 __assert_fail(#x, __FILE__, __LINE__, __func__); })
150
594d57d0 151#define error(fmt, args...) do { \
be25d875 152 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
594d57d0
MK
153 ##args, __FILE__, __LINE__, __func__); \
154} while (0)
155
cfa460ad 156#ifndef BUG
43835aac 157#define BUG() do { \
511d0c72 158 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
43835aac
DZ
159 panic("BUG!"); \
160} while (0)
161#define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
cfa460ad 162#endif /* BUG */
43835aac 163
c83bf6a2 164typedef void (interrupt_handler_t)(void *);
e2211743 165
c83bf6a2 166#include <asm/u-boot.h> /* boot information for Linux kernel */
e2211743
WD
167#include <asm/global_data.h> /* global data used for startup functions */
168
71f95118
WD
169/*
170 * enable common handling for all TQM8xxL/M boards:
11d9eec4 171 * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
71f95118 172 * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
11d9eec4 173 * and for the TQM885D board
71f95118
WD
174 */
175#if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
176 defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
11d9eec4 177 defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
71f95118
WD
178# ifndef CONFIG_TQM8xxM
179# define CONFIG_TQM8xxM
180# endif
181#endif
e2211743 182#if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
d126bfbd 183 defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
11d9eec4
MK
184 defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
185 defined(CONFIG_TQM885D)
e2211743
WD
186# ifndef CONFIG_TQM8xxL
187# define CONFIG_TQM8xxL
188# endif
189#endif
190
3fbeeea6
HS
191#if defined(CONFIG_ENV_IS_EMBEDDED)
192#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
193#elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
194 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
195 defined(CONFIG_ENV_IS_IN_NVRAM)
196#define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
197#else
198#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
199#endif
c7de829c 200
e2211743
WD
201/*
202 * Function Prototypes
203 */
0267ba5d 204int dram_init(void);
e2211743 205
5e924a13
SG
206/**
207 * dram_init_banksize() - Set up DRAM bank sizes
208 *
209 * This can be implemented by boards to set up the DRAM bank information in
210 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
211 * is called.
212 *
213 * If this is not provided, a default implementation will try to set up a
214 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
215 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
216 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
217 * get_effective_memsize().
218 *
219 * @return 0 if OK, -ve on error
220 */
221int dram_init_banksize(void);
222
c83bf6a2 223void hang (void) __attribute__ ((noreturn));
e2211743 224
f6c019c4
WD
225int timer_init(void);
226int cpu_init(void);
227
2ea09c83 228#include <display_options.h>
e2211743
WD
229
230/* common/main.c */
231void main_loop (void);
009dde19 232int run_command(const char *cmd, int flag);
1d43bfd2 233int run_command_repeatable(const char *cmd, int flag);
d51004a8
SG
234
235/**
236 * Run a list of commands separated by ; or even \0
237 *
238 * Note that if 'len' is not -1, then the command does not need to be nul
239 * terminated, Memory will be allocated for the command in that case.
240 *
241 * @param cmd List of commands to run, each separated bu semicolon
242 * @param len Length of commands excluding terminator if known (-1 if not)
243 * @param flag Execution flags (CMD_FLAG_...)
244 * @return 0 on success, or != 0 on error.
245 */
246int run_command_list(const char *cmd, int len, int flag);
e2211743 247
ea0364f1 248/* arch/$(ARCH)/lib/board.c */
0365ffcc
MY
249void board_init_f(ulong);
250void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
1fed87db
SG
251
252/**
ecc30663 253 * ulong board_init_f_alloc_reserve - allocate reserved area
1fed87db
SG
254 *
255 * This function is called by each architecture very early in the start-up
ecc30663
AA
256 * code to allow the C runtime to reserve space on the stack for writable
257 * 'globals' such as GD and the malloc arena.
1fed87db 258 *
ecc30663
AA
259 * @top: top of the reserve area, growing down.
260 * @return: bottom of reserved area
261 */
262ulong board_init_f_alloc_reserve(ulong top);
263
264/**
265 * board_init_f_init_reserve - initialize the reserved area(s)
1fed87db 266 *
ecc30663
AA
267 * This function is called once the C runtime has allocated the reserved
268 * area on the stack. It must initialize the GD at the base of that area.
1fed87db 269 *
ecc30663 270 * @base: top from which reservation was done
1fed87db 271 */
ecc30663 272void board_init_f_init_reserve(ulong base);
1fed87db
SG
273
274/**
275 * arch_setup_gd() - Set up the global_data pointer
276 *
277 * This pointer is special in some architectures and cannot easily be assigned
278 * to. For example on x86 it is implemented by adding a specific record to its
279 * Global Descriptor Table! So we we provide a function to carry out this task.
280 * For most architectures this can simply be:
281 *
282 * gd = gd_ptr;
283 *
284 * @gd_ptr: Pointer to global data
285 */
286void arch_setup_gd(gd_t *gd_ptr);
287
0365ffcc
MY
288int checkboard(void);
289int show_board_info(void);
290int checkflash(void);
291int checkdram(void);
292int last_stage_init(void);
3b57fe0a 293extern ulong monitor_flash_len;
bea3f28d 294int mac_read_from_eeprom(void);
6ab6b2af 295extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
8f5d4687 296int set_cpu_clk_info(void);
9272a9b4 297int mdm_init(void);
1938f4a5 298int print_cpuinfo(void);
c2240d4d 299int update_flash_size(int flash_size);
2c072c95 300int arch_early_init_r(void);
e2211743 301
e5fb573f
SG
302/*
303 * setup_board_extra() - Fill in extra details in the bd_t structure
304 *
305 * @return 0 if OK, -ve on error
306 */
307int setup_board_extra(void);
308
671549e5
SG
309/**
310 * arch_fsp_init() - perform firmware support package init
311 *
312 * Where U-Boot relies on binary blobs to handle part of the system init, this
313 * function can be used to set up the blobs. This is used on some Intel
314 * platforms.
315 */
316int arch_fsp_init(void);
317
d4c671cc
SG
318/**
319 * arch_cpu_init_dm() - init CPU after driver model is available
320 *
321 * This is called immediately after driver model is available before
322 * relocation. This is similar to arch_cpu_init() but is able to reference
323 * devices
324 *
325 * @return 0 if OK, -ve on error
326 */
327int arch_cpu_init_dm(void);
328
68145d4c
AB
329/**
330 * Reserve all necessary stacks
331 *
332 * This is used in generic board init sequence in common/board_f.c. Each
333 * architecture could provide this function to tailor the required stacks.
334 *
335 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
336 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
337 * require only this can leave it untouched.
338 *
339 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
340 * positions of the stack. The stack pointer(s) will be set to this later.
341 * gd->irq_sp is only required, if the architecture needs it.
342 *
343 * @return 0 if no error
344 */
345__weak int arch_reserve_stacks(void);
346
15a33e49
SG
347/**
348 * Show the DRAM size in a board-specific way
349 *
350 * This is used by boards to display DRAM information in their own way.
351 *
352 * @param size Size of DRAM (which should be displayed along with other info)
353 */
ea11b401 354void board_show_dram(phys_size_t size);
15a33e49 355
13d06981 356/**
e29607ed 357 * arch_fixup_fdt() - Write arch-specific information to fdt
13d06981 358 *
e29607ed 359 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
13d06981
SG
360 *
361 * @blob: FDT blob to write to
362 * @return 0 if ok, or -ve FDT_ERR_... on failure
363 */
e29607ed 364int arch_fixup_fdt(void *blob);
13d06981 365
e2211743
WD
366/* common/flash.c */
367void flash_perror (int);
368
74de7aef
WD
369/* common/cmd_source.c */
370int source (ulong addr, const char *fit_uname);
e2211743 371
c83bf6a2 372extern ulong load_addr; /* Default Load Address */
1aec244a
SG
373extern ulong save_addr; /* Default Save Address */
374extern ulong save_size; /* Default Save Size */
e2211743 375
06283a64
JH
376/* common/cmd_net.c */
377int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
378
669df7e4
RH
379/* common/cmd_fat.c */
380int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
381
382/* common/cmd_ext2.c */
383int do_ext2load(cmd_tbl_t *, int, int, char * const []);
384
e2211743
WD
385/* common/cmd_nvedit.c */
386int env_init (void);
387void env_relocate (void);
26a41790 388int envmatch (uchar *, int);
20f86a0a
SG
389
390/* Avoid unfortunate conflict with libc's getenv() */
391#ifdef CONFIG_SANDBOX
392#define getenv uboot_getenv
393#endif
84b5e802
WD
394char *getenv (const char *);
395int getenv_f (const char *name, char *buf, unsigned len);
4a9b4131 396ulong getenv_ulong(const char *name, int base, ulong default_val);
76b8f79c
SG
397
398/**
399 * getenv_hex() - Return an environment variable as a hex value
400 *
401 * Decode an environment as a hex number (it may or may not have a 0x
402 * prefix). If the environment variable cannot be found, or does not start
403 * with hex digits, the default value is returned.
404 *
405 * @varname: Variable to decode
406 * @default_val: Value to return on error
407 */
408ulong getenv_hex(const char *varname, ulong default_val);
409
ec8a252c
JH
410/*
411 * Read an environment variable as a boolean
412 * Return -1 if variable does not exist (default to true)
413 */
414int getenv_yesno(const char *var);
c83bf6a2 415int saveenv (void);
84b5e802 416int setenv (const char *, const char *);
d67f10ce 417int setenv_ulong(const char *varname, ulong value);
bfc59966
SG
418int setenv_hex(const char *varname, ulong value);
419/**
420 * setenv_addr - Set an environment variable to an address in hex
421 *
1bce2aeb 422 * @varname: Environment variable to set
bfc59966
SG
423 * @addr: Value to set it to
424 * @return 0 if ok, 1 on error
425 */
426static inline int setenv_addr(const char *varname, const void *addr)
427{
428 return setenv_hex(varname, (ulong)addr);
429}
430
e2211743 431#ifdef CONFIG_ARM
96085e34 432# include <asm/mach-types.h>
b6e4c403 433# include <asm/setup.h>
e2211743
WD
434# include <asm/u-boot-arm.h> /* ARM version to be fixed! */
435#endif /* CONFIG_ARM */
fea25720
GR
436#ifdef CONFIG_X86 /* x86 version to be fixed! */
437# include <asm/u-boot-x86.h>
438#endif /* CONFIG_X86 */
744d9859
SG
439#ifdef CONFIG_SANDBOX
440# include <asm/u-boot-sandbox.h> /* TODO(sjg) what needs to be fixed? */
441#endif
e7083844
ML
442#ifdef CONFIG_NDS32
443# include <asm/mach-types.h>
e3c58b02 444# include <asm/setup.h>
e7083844
ML
445# include <asm/u-boot-nds32.h>
446#endif /* CONFIG_NDS32 */
e034ea3b
DS
447#ifdef CONFIG_MIPS
448# include <asm/u-boot-mips.h>
449#endif /* CONFIG_MIPS */
bc5d5428
AB
450#ifdef CONFIG_ARC
451# include <asm/u-boot-arc.h>
452#endif /* CONFIG_ARC */
e2211743 453
04a85b3b
WD
454#ifdef CONFIG_AUTO_COMPLETE
455int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
456#endif
2f70c49e 457int get_env_id (void);
04a85b3b 458
c83bf6a2
WD
459void pci_init (void);
460void pci_init_board(void);
e2211743 461
a821d08d 462#if defined(CONFIG_PCI) && defined(CONFIG_4xx)
c71103f9
MF
463 int pci_pre_init (struct pci_controller *);
464 int is_pci_host (struct pci_controller *);
466fff1a
SR
465#endif
466
dbbd1257 467#if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
6d0f6bcf 468# if defined(CONFIG_SYS_PCI_TARGET_INIT)
c83bf6a2 469 void pci_target_init (struct pci_controller *);
e2211743 470# endif
6d0f6bcf 471# if defined(CONFIG_SYS_PCI_MASTER_INIT)
c83bf6a2 472 void pci_master_init (struct pci_controller *);
e2211743 473# endif
6f2eb3f3
SR
474#if defined(CONFIG_440SPE) || \
475 defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
476 defined(CONFIG_405EX)
7f191393 477 void pcie_setup_hoses(int busno);
692519b1 478#endif
e2211743
WD
479#endif
480
481int misc_init_f (void);
482int misc_init_r (void);
483
27b207fd
WD
484/* common/exports.c */
485void jumptable_init(void);
486
ecb1dc89
MF
487/* common/kallsysm.c */
488const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
489
500856eb
RJ
490/* api/api.c */
491void api_init (void);
492
c83bf6a2 493/* common/memsize.c */
a55d23cc 494long get_ram_size (long *, long);
e3866163 495phys_size_t get_effective_memsize(void);
c83bf6a2 496
e2211743
WD
497/* $(BOARD)/$(BOARD).c */
498void reset_phy (void);
c83bf6a2 499void fdc_hw_init (void);
e2211743
WD
500
501/* $(BOARD)/eeprom.c */
eb5ba3ae 502#ifdef CONFIG_CMD_EEPROM
354e3ed7 503void eeprom_init (int bus);
e2211743
WD
504int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
505int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
eb5ba3ae
SG
506#else
507/*
508 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
509 * some macros here so we don't have to touch every one of those uses
510 */
511#define eeprom_init(bus)
512#define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
513#define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
514#endif
e2211743
WD
515
516/*
517 * Set this up regardless of board
518 * type, to prevent errors.
519 */
6d0f6bcf
JCPV
520#if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
521# define CONFIG_SYS_DEF_EEPROM_ADDR 0
e2211743 522#else
548738b4 523#if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
6d0f6bcf 524# define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
548738b4 525#endif
6d0f6bcf 526#endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
e2211743 527
bdccc4fe 528#if defined(CONFIG_SPI)
e2211743
WD
529extern void spi_init_f (void);
530extern void spi_init_r (void);
c83bf6a2 531extern ssize_t spi_read (uchar *, int, uchar *, int);
e2211743
WD
532extern ssize_t spi_write (uchar *, int, uchar *, int);
533#endif
534
e2211743 535/* $(BOARD)/$(BOARD).c */
c837dcb1 536int board_early_init_f (void);
2a792753 537int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
c837dcb1 538int board_late_init (void);
e2211743 539int board_postclk_init (void); /* after clocks/timebase, before env/serial */
c837dcb1 540int board_early_init_r (void);
e2211743
WD
541void board_poweroff (void);
542
6d0f6bcf 543#if defined(CONFIG_SYS_DRAM_TEST)
e2211743 544int testdram(void);
6d0f6bcf 545#endif /* CONFIG_SYS_DRAM_TEST */
e2211743
WD
546
547/* $(CPU)/start.S */
c83bf6a2 548#if defined(CONFIG_5xx) || \
0db5bca8 549 defined(CONFIG_8xx)
e2211743
WD
550uint get_immr (uint);
551#endif
36c72877
WD
552#if defined(CONFIG_MPC5xxx)
553uint get_svr (void);
554#endif
e2211743 555uint get_pvr (void);
547b4cb2 556uint get_svr (void);
e2211743
WD
557uint rd_ic_cst (void);
558void wr_ic_cst (uint);
559void wr_ic_adr (uint);
560uint rd_dc_cst (void);
561void wr_dc_cst (uint);
562void wr_dc_adr (uint);
563int icache_status (void);
564void icache_enable (void);
565void icache_disable(void);
566int dcache_status (void);
567void dcache_enable (void);
568void dcache_disable(void);
2c451f78 569void mmu_disable(void);
5c6db120
BT
570#if defined(CONFIG_ARM)
571void relocate_code(ulong);
572#else
573void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
959eaa74 574#endif
e2211743
WD
575ulong get_endaddr (void);
576void trap_init (ulong);
577#if defined (CONFIG_4xx) || \
eeb1b77b 578 defined (CONFIG_MPC5xxx) || \
cd94ba39 579 defined (CONFIG_MPC85xx) || \
debb7354 580 defined (CONFIG_MPC86xx) || \
0f898604 581 defined (CONFIG_MPC83xx)
c83bf6a2
WD
582unsigned char in8(unsigned int);
583void out8(unsigned int, unsigned char);
584unsigned short in16(unsigned int);
585unsigned short in16r(unsigned int);
586void out16(unsigned int, unsigned short value);
587void out16r(unsigned int, unsigned short value);
588unsigned long in32(unsigned int);
589unsigned long in32r(unsigned int);
590void out32(unsigned int, unsigned long value);
591void out32r(unsigned int, unsigned long value);
592void ppcDcbf(unsigned long value);
593void ppcDcbi(unsigned long value);
594void ppcSync(void);
0ac6f8b7 595void ppcDcbz(unsigned long value);
e2211743 596#endif
0643631a
MS
597#if defined (CONFIG_MICROBLAZE)
598unsigned short in16(unsigned int);
599void out16(unsigned int, unsigned short value);
600#endif
e2211743 601
0f898604 602#if defined (CONFIG_MPC83xx)
90f30a71
DL
603void ppcDWload(unsigned int *addr, unsigned int *ret);
604void ppcDWstore(unsigned int *addr, unsigned int *value);
7c6db910
HS
605void disable_addr_trans(void);
606void enable_addr_trans(void);
607#if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
608void ddr_enable_ecc(unsigned int dram_size);
609#endif
90f30a71
DL
610#endif
611
e2211743 612/* $(CPU)/cpu.c */
fbb9ecf7
TT
613static inline int cpumask_next(int cpu, unsigned int mask)
614{
615 for (cpu++; !((1 << cpu) & mask); cpu++)
616 ;
617
618 return cpu;
619}
620
621#define for_each_cpu(iter, cpu, num_cpus, mask) \
622 for (iter = 0, cpu = cpumask_next(-1, mask); \
623 iter < num_cpus; \
624 iter++, cpu = cpumask_next(cpu, mask)) \
625
0e870980 626int cpu_numcores (void);
b8bf0adc 627int cpu_num_dspcores(void);
fbb9ecf7 628u32 cpu_mask (void);
b8bf0adc 629u32 cpu_dsp_mask(void);
fbb9ecf7 630int is_core_valid (unsigned int);
cbcbf71b
SG
631
632/**
633 * arch_cpu_init() - basic cpu-dependent setup for an architecture
634 *
635 * This is called after early malloc is available. It should handle any
636 * CPU- or SoC- specific init needed to continue the init sequence. See
637 * board_f.c for where it is called. If this is not provided, a default
638 * version (which does nothing) will be used.
639 */
640int arch_cpu_init(void);
641
e2211743
WD
642int checkcpu (void);
643int checkicache (void);
644int checkdcache (void);
645void upmconfig (unsigned int, unsigned int *, unsigned int);
646ulong get_tbclk (void);
1fb4dab2 647void reset_misc (void);
3ec924a3 648void reset_cpu (ulong addr);
6a16e0df 649void ft_cpu_setup(void *blob, bd_t *bd);
6a16e0df 650void ft_pci_setup(void *blob, bd_t *bd);
6a16e0df 651
ba6a1698
AP
652void smp_set_core_boot_addr(unsigned long addr, int corenr);
653void smp_kick_all_cpus(void);
e2211743
WD
654
655/* $(CPU)/serial.c */
656int serial_init (void);
657void serial_setbrg (void);
658void serial_putc (const char);
756f586a 659void serial_putc_raw(const char);
e2211743 660void serial_puts (const char *);
e2211743
WD
661int serial_getc (void);
662int serial_tstc (void);
663
709ea543
SG
664/* These versions take a stdio_dev pointer */
665struct stdio_dev;
666int serial_stub_getc(struct stdio_dev *sdev);
667int serial_stub_tstc(struct stdio_dev *sdev);
668
e2211743
WD
669/* $(CPU)/speed.c */
670int get_clocks (void);
8749fa6a 671#if defined(CONFIG_MPC5xxx)
945af8d7
WD
672int prt_mpc5xxx_clks (void);
673#endif
e2211743
WD
674#ifdef CONFIG_4xx
675ulong get_OPB_freq (void);
676ulong get_PCI_freq (void);
677#endif
ac67804f 678#if defined(CONFIG_S3C24X0) || \
679 defined(CONFIG_LH7A40X) || \
fcfb632b 680 defined(CONFIG_EP93XX)
e2211743
WD
681ulong get_FCLK (void);
682ulong get_HCLK (void);
683ulong get_PCLK (void);
684ulong get_UCLK (void);
685#endif
f39748ae
WD
686#if defined(CONFIG_LH7A40X)
687ulong get_PLLCLK (void);
688#endif
281e00a3
WD
689#if defined(CONFIG_IMX)
690ulong get_systemPLLCLK(void);
691ulong get_FCLK(void);
692ulong get_HCLK(void);
693ulong get_BCLK(void);
694ulong get_PERCLK1(void);
695ulong get_PERCLK2(void);
696ulong get_PERCLK3(void);
697#endif
e2211743 698ulong get_bus_freq (ulong);
550650dd 699int get_serial_clock(void);
e2211743 700
42d1f039
WD
701#if defined(CONFIG_MPC85xx)
702typedef MPC85xx_SYS_INFO sys_info_t;
c83bf6a2 703void get_sys_info ( sys_info_t * );
aa34fbc0
SG
704void ft_fixup_cpu(void *, u64);
705void ft_fixup_num_cores(void *);
42d1f039 706#endif
debb7354
JL
707#if defined(CONFIG_MPC86xx)
708typedef MPC86xx_SYS_INFO sys_info_t;
709void get_sys_info ( sys_info_t * );
5df4b0ad
KG
710static inline ulong get_ddr_freq(ulong dummy)
711{
712 return get_bus_freq(dummy);
713}
2f78eae5
YS
714#else
715ulong get_ddr_freq(ulong);
debb7354 716#endif
42d1f039 717
99bcad18 718#if defined(CONFIG_4xx)
e2211743 719# if defined(CONFIG_440)
6c5879f3
MB
720# if defined(CONFIG_440SPE)
721 unsigned long determine_sysper(void);
722 unsigned long determine_pci_clock_per(void);
723# endif
e2211743 724# endif
087dfdb7 725typedef PPC4xx_SYS_INFO sys_info_t;
f31d38b9 726int ppc440spe_revB(void);
c83bf6a2 727void get_sys_info ( sys_info_t * );
e2211743
WD
728#endif
729
730/* $(CPU)/cpu_init.c */
58dac327 731#if defined(CONFIG_8xx) || defined(CONFIG_MPC8260)
e2211743
WD
732void cpu_init_f (volatile immap_t *immr);
733#endif
701e6401 734#if defined(CONFIG_4xx) || defined(CONFIG_MCF52x2) || defined(CONFIG_MPC86xx)
e2211743
WD
735void cpu_init_f (void);
736#endif
701e6401
YS
737#ifdef CONFIG_MPC85xx
738ulong cpu_init_f(void);
739#endif
bf9e3b38 740
e2211743 741int cpu_init_r (void);
e2211743
WD
742
743/* $(CPU)/interrupts.c */
c83bf6a2
WD
744int interrupt_init (void);
745void timer_interrupt (struct pt_regs *);
e2211743
WD
746void external_interrupt (struct pt_regs *);
747void irq_install_handler(int, interrupt_handler_t *, void *);
748void irq_free_handler (int);
749void reset_timer (void);
b2e16a85
SG
750
751/* Return value of monotonic microsecond timer */
752unsigned long timer_get_us(void);
753
e2211743
WD
754void enable_interrupts (void);
755int disable_interrupts (void);
756
757/* $(CPU)/.../commproc.c */
758int dpram_init (void);
759uint dpram_base(void);
760uint dpram_base_align(uint align);
761uint dpram_alloc(uint size);
762uint dpram_alloc_align(uint size,uint align);
bdccc4fe
WD
763void bootcount_store (ulong);
764ulong bootcount_load (void);
765#define BOOTCOUNT_MAGIC 0xB001C041
e2211743
WD
766
767/* $(CPU)/.../<eth> */
c5bded3c 768void mii_init (void);
e2211743
WD
769
770/* $(CPU)/.../lcd.c */
771ulong lcd_setmem (ulong);
772
e2211743
WD
773/* $(CPU)/.../video.c */
774ulong video_setmem (ulong);
775
ea0364f1 776/* arch/$(ARCH)/lib/cache.c */
cba4b180 777void enable_caches(void);
e2211743 778void flush_cache (unsigned long, unsigned long);
2c451f78 779void flush_dcache_all(void);
03d3bfb0
SR
780void flush_dcache_range(unsigned long start, unsigned long stop);
781void invalidate_dcache_range(unsigned long start, unsigned long stop);
2c451f78
A
782void invalidate_dcache_all(void);
783void invalidate_icache_all(void);
0db5bca8 784
4d24a11e
SG
785enum {
786 /* Disable caches (else flush caches but leave them active) */
787 CBL_DISABLE_CACHES = 1 << 0,
788 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
789
790 CBL_ALL = 3,
791};
792
793/**
794 * Clean up ready for linux
795 *
796 * @param flags Flags to control what is done
797 */
798int cleanup_before_linux_select(int flags);
799
ea0364f1 800/* arch/$(ARCH)/lib/ticks.S */
19ea4678 801uint64_t get_ticks(void);
e2211743
WD
802void wait_ticks (unsigned long);
803
ea0364f1 804/* arch/$(ARCH)/lib/time.c */
e2211743
WD
805ulong usec2ticks (unsigned long usec);
806ulong ticks2usec (unsigned long ticks);
e2211743 807
78acc472 808/* lib/gunzip.c */
87d93a1b
WW
809int gunzip(void *, int, unsigned char *, unsigned long *);
810int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
811 int stoponerr, int offset);
812
918e9ebb
EN
813/**
814 * gzwrite progress indicators: defined weak to allow board-specific
815 * overrides:
816 *
817 * gzwrite_progress_init called on startup
818 * gzwrite_progress called during decompress/write loop
819 * gzwrite_progress_finish called at end of loop to
820 * indicate success (retcode=0) or failure
821 */
822void gzwrite_progress_init(u64 expected_size);
823
824void gzwrite_progress(int iteration,
825 u64 bytes_written,
826 u64 total_bytes);
827
828void gzwrite_progress_finish(int retcode,
829 u64 totalwritten,
830 u64 totalsize,
831 u32 expected_crc,
832 u32 calculated_crc);
833
834/**
835 * decompress and write gzipped image from memory to block device
836 *
837 * @param src compressed image address
838 * @param len compressed image length in bytes
839 * @param dev block device descriptor
840 * @param szwritebuf bytes per write (pad to erase size)
841 * @param startoffs offset in bytes of first write
842 * @param szexpected expected uncompressed length
843 * may be zero to use gzip trailer
844 * for files under 4GiB
845 */
846int gzwrite(unsigned char *src, int len,
4101f687 847 struct blk_desc *dev,
918e9ebb
EN
848 unsigned long szwritebuf,
849 u64 startoffs,
850 u64 szexpected);
851
027b728d
JW
852/* lib/lz4_wrapper.c */
853int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
854
54c6977e
WD
855/* lib/qsort.c */
856void qsort(void *base, size_t nmemb, size_t size,
857 int(*compar)(const void *, const void *));
560d424b 858int strcmp_compar(const void *, const void *);
54c6977e 859
e11938ea 860/* lib/uuid.c */
d718ded0 861#include <uuid.h>
e11938ea 862
78acc472 863/* lib/vsprintf.c */
9785c905 864#include <vsprintf.h>
e2211743 865
78acc472 866/* lib/strmhz.c */
55f7934d 867char * strmhz(char *buf, unsigned long hz);
0768b7a8 868
78acc472 869/* lib/crc32.c */
449609f5 870#include <u-boot/crc.h>
e2211743 871
9acf1ca5 872/* lib/rand.c */
9acf1ca5
MW
873#define RAND_MAX -1U
874void srand(unsigned int seed);
875unsigned int rand(void);
876unsigned int rand_r(unsigned int *seedp);
9acf1ca5 877
e2211743
WD
878/*
879 * STDIO based functions (can always be used)
880 */
e2211743 881/* serial stuff */
d9c27253 882int serial_printf (const char *fmt, ...)
dc4b0b38 883 __attribute__ ((format (__printf__, 1, 2)));
e2211743
WD
884/* stdin */
885int getc(void);
886int tstc(void);
887
888/* stdout */
76f1f388
SG
889#if !defined(CONFIG_SPL_BUILD) || \
890 (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
891 (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
892 defined(CONFIG_SPL_SERIAL_SUPPORT))
e2211743
WD
893void putc(const char c);
894void puts(const char *s);
d9c27253 895int printf(const char *fmt, ...)
dc4b0b38 896 __attribute__ ((format (__printf__, 1, 2)));
d9c27253 897int vprintf(const char *fmt, va_list args);
76f1f388
SG
898#else
899#define putc(...) do { } while (0)
900#define puts(...) do { } while (0)
901#define printf(...) do { } while (0)
902#define vprintf(...) do { } while (0)
80402f34 903#endif
e2211743
WD
904
905/* stderr */
906#define eputc(c) fputc(stderr, c)
907#define eputs(s) fputs(stderr, s)
908#define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
909
910/*
911 * FILE based functions (can only be used AFTER relocation!)
912 */
e2211743
WD
913#define stdin 0
914#define stdout 1
915#define stderr 2
916#define MAX_FILES 3
917
d9c27253 918int fprintf(int file, const char *fmt, ...)
dc4b0b38 919 __attribute__ ((format (__printf__, 2, 3)));
e2211743
WD
920void fputs(int file, const char *s);
921void fputc(int file, const char c);
922int ftstc(int file);
923int fgetc(int file);
924
88d52c6a
LW
925/* lib/gzip.c */
926int gzip(void *dst, unsigned long *lenp,
927 unsigned char *src, unsigned long srclen);
928int zzip(void *dst, unsigned long *lenp, unsigned char *src,
929 unsigned long srclen, int stoponerr,
930 int (*func)(unsigned long, unsigned long));
931
4ef8d53c
JH
932/* lib/net_utils.c */
933#include <net.h>
049a95a7 934static inline struct in_addr getenv_ip(char *var)
4ef8d53c
JH
935{
936 return string_to_ip(getenv(var));
937}
938
e2211743
WD
939int pcmcia_init (void);
940
2d8d190c 941#ifdef CONFIG_LED_STATUS
fb364bec
WD
942# include <status_led.h>
943#endif
097e1783
SG
944
945#include <bootstage.h>
e2211743 946
48522bb5
JH
947#ifdef CONFIG_SHOW_ACTIVITY
948void show_activity(int arg);
949#endif
950
fcd3c87e
WD
951/* Multicore arch functions */
952#ifdef CONFIG_MP
953int cpu_status(int nr);
954int cpu_reset(int nr);
4194b366 955int cpu_disable(int nr);
54841ab5 956int cpu_release(int nr, int argc, char * const argv[]);
fcd3c87e
WD
957#endif
958
2a6713b0
AP
959#else /* __ASSEMBLY__ */
960
961/* Drop a C type modifier (like in 3UL) for constants used in assembly. */
962#define _AC(X, Y) X
963
964#endif /* __ASSEMBLY__ */
fcd3c87e 965
13e95e42
SR
966#ifdef CONFIG_PPC
967/*
968 * Has to be included outside of the #ifndef __ASSEMBLY__ section.
969 * Otherwise might lead to compilation errors in assembler files.
970 */
971#include <asm/cache.h>
972#endif
973
fcd3c87e
WD
974/* Put only stuff here that the assembler can digest */
975
2a6713b0
AP
976/* Declare an unsigned long constant digestable both by C and an assembler. */
977#define UL(x) _AC(x, UL)
978
fcd3c87e
WD
979#ifdef CONFIG_POST
980#define CONFIG_HAS_POST
800eb096
MZ
981#ifndef CONFIG_POST_ALT_LIST
982#define CONFIG_POST_STD_LIST
983#endif
fcd3c87e
WD
984#endif
985
8aa1a2d1 986#ifdef CONFIG_INIT_CRITICAL
2f6fa46d 987#error CONFIG_INIT_CRITICAL is deprecated!
8aa1a2d1
WD
988#error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
989#endif
990
155cfb5e 991#define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
4b03ac8b 992
c9689ca3
SG
993/*
994 * check_member() - Check the offset of a structure member
995 *
996 * @structure: Name of structure (e.g. global_data)
997 * @member: Name of member (e.g. baudrate)
998 * @offset: Expected offset in bytes
999 */
1000#define check_member(structure, member, offset) _Static_assert( \
1001 offsetof(struct structure, member) == offset, \
1002 "`struct " #structure "` offset for `" #member "` is not " #offset)
1003
476476e7
SG
1004/* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
1005#ifdef CONFIG_EFI_STUB
1006#define ll_boot_init() false
1007#else
1008#define ll_boot_init() true
1009#endif
1010
c3eb3fe4
MF
1011/* Pull in stuff for the build system */
1012#ifdef DO_DEPS_ONLY
1013# include <environment.h>
1014#endif
1015
e2211743 1016#endif /* __COMMON_H_ */