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