]> git.ipfire.org Git - thirdparty/u-boot.git/blame - include/common.h
Merge branch 'master' of git://git.denx.de/u-boot-arm
[thirdparty/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 *
1a459660 5 * SPDX-License-Identifier: GPL-2.0+
e2211743
WD
6 */
7
8#ifndef __COMMON_H_
d0b8feef 9#define __COMMON_H_ 1
e2211743
WD
10
11#undef _LINUX_CONFIG_H
d0b8feef 12#define _LINUX_CONFIG_H 1 /* avoid reading Linux autoconf.h file */
e2211743 13
fcd3c87e
WD
14#ifndef __ASSEMBLY__ /* put C only stuff in this section */
15
e2211743
WD
16typedef unsigned char uchar;
17typedef volatile unsigned long vu_long;
180d3f74 18typedef volatile unsigned short vu_short;
e2211743
WD
19typedef volatile unsigned char vu_char;
20
21#include <config.h>
25ddd1fb 22#include <asm-offsets.h>
e2211743
WD
23#include <linux/bitops.h>
24#include <linux/types.h>
25#include <linux/string.h>
9aed5080 26#include <linux/stringify.h>
e2211743
WD
27#include <asm/ptrace.h>
28#include <stdarg.h>
a821d08d 29#if defined(CONFIG_PCI) && defined(CONFIG_4xx)
e2211743
WD
30#include <pci.h>
31#endif
180d3f74 32#if defined(CONFIG_8xx)
e2211743 33#include <asm/8xx_immap.h>
d4ca31c4
WD
34#if defined(CONFIG_MPC852) || defined(CONFIG_MPC852T) || \
35 defined(CONFIG_MPC859) || defined(CONFIG_MPC859T) || \
36 defined(CONFIG_MPC859DSL) || \
37 defined(CONFIG_MPC866) || defined(CONFIG_MPC866T) || \
38 defined(CONFIG_MPC866P)
d0b8feef 39# define CONFIG_MPC866_FAMILY 1
180d3f74
WD
40#elif defined(CONFIG_MPC870) \
41 || defined(CONFIG_MPC875) \
42 || defined(CONFIG_MPC880) \
43 || defined(CONFIG_MPC885)
d0b8feef 44# define CONFIG_MPC885_FAMILY 1
180d3f74
WD
45#endif
46#if defined(CONFIG_MPC860) \
47 || defined(CONFIG_MPC860T) \
1114257c
WD
48 || defined(CONFIG_MPC866_FAMILY) \
49 || defined(CONFIG_MPC885_FAMILY)
d0b8feef 50# define CONFIG_MPC86x 1
2535d602 51#endif
0db5bca8
WD
52#elif defined(CONFIG_5xx)
53#include <asm/5xx_immap.h>
7e6bf358
WD
54#elif defined(CONFIG_MPC5xxx)
55#include <mpc5xxx.h>
8993e54b 56#elif defined(CONFIG_MPC512X)
8993e54b 57#include <asm/immap_512x.h>
e2211743 58#elif defined(CONFIG_8260)
04a85b3b
WD
59#if defined(CONFIG_MPC8247) \
60 || defined(CONFIG_MPC8248) \
61 || defined(CONFIG_MPC8271) \
62 || defined(CONFIG_MPC8272)
d0b8feef 63#define CONFIG_MPC8272_FAMILY 1
04a85b3b
WD
64#endif
65#if defined(CONFIG_MPC8272_FAMILY)
d0b8feef 66#define CONFIG_MPC8260 1
04a85b3b 67#endif
e2211743
WD
68#include <asm/immap_8260.h>
69#endif
debb7354
JL
70#ifdef CONFIG_MPC86xx
71#include <mpc86xx.h>
72#include <asm/immap_86xx.h>
73#endif
42d1f039
WD
74#ifdef CONFIG_MPC85xx
75#include <mpc85xx.h>
76#include <asm/immap_85xx.h>
77#endif
0f898604 78#ifdef CONFIG_MPC83xx
f046ccd1
EL
79#include <mpc83xx.h>
80#include <asm/immap_83xx.h>
81#endif
e2211743 82#ifdef CONFIG_4xx
b36df561 83#include <asm/ppc4xx.h>
e2211743
WD
84#endif
85#ifdef CONFIG_HYMOD
6dd652fa 86#include <board/hymod/hymod.h>
e2211743
WD
87#endif
88#ifdef CONFIG_ARM
89#define asmlinkage /* nothing */
90#endif
6cfcce67
MF
91#ifdef CONFIG_BLACKFIN
92#include <asm/blackfin.h>
93#endif
2819e136
SN
94#ifdef CONFIG_SOC_DA8XX
95#include <asm/arch/hardware.h>
96#endif
e2211743
WD
97
98#include <part.h>
99#include <flash.h>
100#include <image.h>
101
21726a7a 102#ifdef DEBUG
88a85fb9 103#define _DEBUG 1
21726a7a 104#else
88a85fb9 105#define _DEBUG 0
21726a7a
SG
106#endif
107
88a85fb9
MV
108/*
109 * Output a debug text when condition "cond" is met. The "cond" should be
110 * computed by a preprocessor in the best case, allowing for the best
111 * optimization.
112 */
113#define debug_cond(cond, fmt, args...) \
114 do { \
115 if (cond) \
116 printf(fmt, ##args); \
117 } while (0)
118
119#define debug(fmt, args...) \
120 debug_cond(_DEBUG, fmt, ##args)
121
21726a7a
SG
122/*
123 * An assertion is run-time check done in debug mode only. If DEBUG is not
124 * defined then it is skipped. If DEBUG is defined and the assertion fails,
125 * then it calls panic*( which may or may not reset/halt U-Boot (see
126 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
127 * before release, and after release it is hoped that they don't matter. But
128 * in any case these failing assertions cannot be fixed with a reset (which
129 * may just do the same assertion again).
130 */
131void __assert_fail(const char *assertion, const char *file, unsigned line,
132 const char *function);
133#define assert(x) \
134 ({ if (!(x) && _DEBUG) \
135 __assert_fail(#x, __FILE__, __LINE__, __func__); })
136
594d57d0
MK
137#define error(fmt, args...) do { \
138 printf("ERROR: " fmt "\nat %s:%d/%s()\n", \
139 ##args, __FILE__, __LINE__, __func__); \
140} while (0)
141
cfa460ad 142#ifndef BUG
43835aac 143#define BUG() do { \
511d0c72 144 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
43835aac
DZ
145 panic("BUG!"); \
146} while (0)
147#define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
cfa460ad 148#endif /* BUG */
43835aac 149
c00e17c7
HS
150/* Force a compilation error if condition is true */
151#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
152
c83bf6a2 153typedef void (interrupt_handler_t)(void *);
e2211743 154
c83bf6a2 155#include <asm/u-boot.h> /* boot information for Linux kernel */
e2211743
WD
156#include <asm/global_data.h> /* global data used for startup functions */
157
71f95118
WD
158/*
159 * enable common handling for all TQM8xxL/M boards:
11d9eec4 160 * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
71f95118 161 * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
11d9eec4 162 * and for the TQM885D board
71f95118
WD
163 */
164#if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
165 defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
11d9eec4 166 defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
71f95118
WD
167# ifndef CONFIG_TQM8xxM
168# define CONFIG_TQM8xxM
169# endif
170#endif
e2211743 171#if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
d126bfbd 172 defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
11d9eec4
MK
173 defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
174 defined(CONFIG_TQM885D)
e2211743
WD
175# ifndef CONFIG_TQM8xxL
176# define CONFIG_TQM8xxL
177# endif
178#endif
179
c7de829c
WD
180/*
181 * General Purpose Utilities
182 */
183#define min(X, Y) \
4f4eab4d
VG
184 ({ typeof(X) __x = (X); \
185 typeof(Y) __y = (Y); \
c7de829c
WD
186 (__x < __y) ? __x : __y; })
187
188#define max(X, Y) \
4f4eab4d
VG
189 ({ typeof(X) __x = (X); \
190 typeof(Y) __y = (Y); \
c7de829c
WD
191 (__x > __y) ? __x : __y; })
192
20d04774
AF
193#define MIN(x, y) min(x, y)
194#define MAX(x, y) max(x, y)
195
4f4eab4d
VG
196#define min3(X, Y, Z) \
197 ({ typeof(X) __x = (X); \
198 typeof(Y) __y = (Y); \
199 typeof(Z) __z = (Z); \
200 __x < __y ? (__x < __z ? __x : __z) : \
201 (__y < __z ? __y : __z); })
202
203#define max3(X, Y, Z) \
204 ({ typeof(X) __x = (X); \
205 typeof(Y) __y = (Y); \
206 typeof(Z) __z = (Z); \
207 __x > __y ? (__x > __z ? __x : __z) : \
208 (__y > __z ? __y : __z); })
209
210#define MIN3(x, y, z) min3(x, y, z)
211#define MAX3(x, y, z) max3(x, y, z)
212
a35925b8
SG
213/*
214 * Return the absolute value of a number.
215 *
216 * This handles unsigned and signed longs, ints, shorts and chars. For all
217 * input types abs() returns a signed long.
218 *
219 * For 64-bit types, use abs64()
220 */
221#define abs(x) ({ \
222 long ret; \
223 if (sizeof(x) == sizeof(long)) { \
224 long __x = (x); \
225 ret = (__x < 0) ? -__x : __x; \
226 } else { \
227 int __x = (x); \
228 ret = (__x < 0) ? -__x : __x; \
229 } \
230 ret; \
231 })
232
233#define abs64(x) ({ \
234 s64 __x = (x); \
235 (__x < 0) ? -__x : __x; \
236 })
237
3fbeeea6
HS
238#if defined(CONFIG_ENV_IS_EMBEDDED)
239#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
240#elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
241 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
242 defined(CONFIG_ENV_IS_IN_NVRAM)
243#define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
244#else
245#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
246#endif
c7de829c 247
28901120
HS
248/**
249 * container_of - cast a member of a structure out to the containing structure
250 * @ptr: the pointer to the member.
251 * @type: the type of the container struct this is embedded in.
252 * @member: the name of the member within the struct.
253 *
254 */
255#define container_of(ptr, type, member) ({ \
256 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
257 (type *)( (char *)__mptr - offsetof(type,member) );})
258
e2211743
WD
259/*
260 * Function Prototypes
261 */
262
c83bf6a2 263void hang (void) __attribute__ ((noreturn));
e2211743 264
f6c019c4
WD
265int timer_init(void);
266int cpu_init(void);
267
e2211743 268/* */
9973e3c6 269phys_size_t initdram (int);
c83bf6a2 270int display_options (void);
4b42c905 271void print_size(unsigned long long, const char *);
bda32ffc
SG
272int print_buffer(ulong addr, const void *data, uint width, uint count,
273 uint linelen);
e2211743
WD
274
275/* common/main.c */
276void main_loop (void);
009dde19 277int run_command(const char *cmd, int flag);
d51004a8
SG
278
279/**
280 * Run a list of commands separated by ; or even \0
281 *
282 * Note that if 'len' is not -1, then the command does not need to be nul
283 * terminated, Memory will be allocated for the command in that case.
284 *
285 * @param cmd List of commands to run, each separated bu semicolon
286 * @param len Length of commands excluding terminator if known (-1 if not)
287 * @param flag Execution flags (CMD_FLAG_...)
288 * @return 0 on success, or != 0 on error.
289 */
290int run_command_list(const char *cmd, int len, int flag);
e2211743 291int readline (const char *const prompt);
9c348311
HS
292int readline_into_buffer(const char *const prompt, char *buffer,
293 int timeout);
6636b62a 294int parse_line (char *, char *[]);
6dd652fa 295void init_cmd_timeout(void);
e2211743 296void reset_cmd_timeout(void);
e3150460 297extern char console_buffer[];
e2211743 298
ea0364f1 299/* arch/$(ARCH)/lib/board.c */
e05e5de7 300void board_init_f(ulong);
6d1b6f9f 301void board_init_r (gd_t *, ulong) __attribute__ ((noreturn));
e2211743
WD
302int checkboard (void);
303int checkflash (void);
304int checkdram (void);
e2211743 305int last_stage_init(void);
3b57fe0a 306extern ulong monitor_flash_len;
bea3f28d 307int mac_read_from_eeprom(void);
bbb0b128 308extern u8 _binary_dt_dtb_start[]; /* embedded device tree blob */
8f5d4687 309int set_cpu_clk_info(void);
1938f4a5 310int print_cpuinfo(void);
c2240d4d 311int update_flash_size(int flash_size);
e2211743 312
15a33e49
SG
313/**
314 * Show the DRAM size in a board-specific way
315 *
316 * This is used by boards to display DRAM information in their own way.
317 *
318 * @param size Size of DRAM (which should be displayed along with other info)
319 */
320void board_show_dram(ulong size);
321
13d06981
SG
322/**
323 * arch_fixup_memory_node() - Write arch-specific memory information to fdt
324 *
325 * Defined in arch/$(ARCH)/lib/bootm.c
326 *
327 * @blob: FDT blob to write to
328 * @return 0 if ok, or -ve FDT_ERR_... on failure
329 */
330int arch_fixup_memory_node(void *blob);
331
e2211743
WD
332/* common/flash.c */
333void flash_perror (int);
334
74de7aef
WD
335/* common/cmd_source.c */
336int source (ulong addr, const char *fit_uname);
e2211743 337
c83bf6a2 338extern ulong load_addr; /* Default Load Address */
1aec244a
SG
339extern ulong save_addr; /* Default Save Address */
340extern ulong save_size; /* Default Save Size */
e2211743 341
4394f9a8
WD
342/* common/cmd_doc.c */
343void doc_probe(unsigned long physadr);
344
06283a64
JH
345/* common/cmd_net.c */
346int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
347
669df7e4
RH
348/* common/cmd_fat.c */
349int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
350
351/* common/cmd_ext2.c */
352int do_ext2load(cmd_tbl_t *, int, int, char * const []);
353
e2211743
WD
354/* common/cmd_nvedit.c */
355int env_init (void);
356void env_relocate (void);
26a41790 357int envmatch (uchar *, int);
84b5e802
WD
358char *getenv (const char *);
359int getenv_f (const char *name, char *buf, unsigned len);
4a9b4131 360ulong getenv_ulong(const char *name, int base, ulong default_val);
76b8f79c
SG
361
362/**
363 * getenv_hex() - Return an environment variable as a hex value
364 *
365 * Decode an environment as a hex number (it may or may not have a 0x
366 * prefix). If the environment variable cannot be found, or does not start
367 * with hex digits, the default value is returned.
368 *
369 * @varname: Variable to decode
370 * @default_val: Value to return on error
371 */
372ulong getenv_hex(const char *varname, ulong default_val);
373
ec8a252c
JH
374/*
375 * Read an environment variable as a boolean
376 * Return -1 if variable does not exist (default to true)
377 */
378int getenv_yesno(const char *var);
c83bf6a2 379int saveenv (void);
84b5e802 380int setenv (const char *, const char *);
d67f10ce 381int setenv_ulong(const char *varname, ulong value);
bfc59966
SG
382int setenv_hex(const char *varname, ulong value);
383/**
384 * setenv_addr - Set an environment variable to an address in hex
385 *
1bce2aeb 386 * @varname: Environment variable to set
bfc59966
SG
387 * @addr: Value to set it to
388 * @return 0 if ok, 1 on error
389 */
390static inline int setenv_addr(const char *varname, const void *addr)
391{
392 return setenv_hex(varname, (ulong)addr);
393}
394
e2211743 395#ifdef CONFIG_ARM
96085e34 396# include <asm/mach-types.h>
b6e4c403 397# include <asm/setup.h>
e2211743
WD
398# include <asm/u-boot-arm.h> /* ARM version to be fixed! */
399#endif /* CONFIG_ARM */
fea25720
GR
400#ifdef CONFIG_X86 /* x86 version to be fixed! */
401# include <asm/u-boot-x86.h>
402#endif /* CONFIG_X86 */
744d9859
SG
403#ifdef CONFIG_SANDBOX
404# include <asm/u-boot-sandbox.h> /* TODO(sjg) what needs to be fixed? */
405#endif
e7083844
ML
406#ifdef CONFIG_NDS32
407# include <asm/mach-types.h>
e3c58b02 408# include <asm/setup.h>
e7083844
ML
409# include <asm/u-boot-nds32.h>
410#endif /* CONFIG_NDS32 */
e034ea3b
DS
411#ifdef CONFIG_MIPS
412# include <asm/u-boot-mips.h>
413#endif /* CONFIG_MIPS */
e2211743 414
04a85b3b
WD
415#ifdef CONFIG_AUTO_COMPLETE
416int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
417#endif
2f70c49e 418int get_env_id (void);
04a85b3b 419
c83bf6a2
WD
420void pci_init (void);
421void pci_init_board(void);
422void pciinfo (int, int);
e2211743 423
a821d08d 424#if defined(CONFIG_PCI) && defined(CONFIG_4xx)
c71103f9
MF
425 int pci_pre_init (struct pci_controller *);
426 int is_pci_host (struct pci_controller *);
466fff1a
SR
427#endif
428
dbbd1257 429#if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
6d0f6bcf 430# if defined(CONFIG_SYS_PCI_TARGET_INIT)
c83bf6a2 431 void pci_target_init (struct pci_controller *);
e2211743 432# endif
6d0f6bcf 433# if defined(CONFIG_SYS_PCI_MASTER_INIT)
c83bf6a2 434 void pci_master_init (struct pci_controller *);
e2211743 435# endif
6f2eb3f3
SR
436#if defined(CONFIG_440SPE) || \
437 defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
438 defined(CONFIG_405EX)
7f191393 439 void pcie_setup_hoses(int busno);
692519b1 440#endif
e2211743
WD
441#endif
442
443int misc_init_f (void);
444int misc_init_r (void);
445
27b207fd
WD
446/* common/exports.c */
447void jumptable_init(void);
448
ecb1dc89
MF
449/* common/kallsysm.c */
450const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
451
500856eb
RJ
452/* api/api.c */
453void api_init (void);
454
c83bf6a2 455/* common/memsize.c */
a55d23cc 456long get_ram_size (long *, long);
c83bf6a2 457
e2211743
WD
458/* $(BOARD)/$(BOARD).c */
459void reset_phy (void);
c83bf6a2 460void fdc_hw_init (void);
e2211743
WD
461
462/* $(BOARD)/eeprom.c */
463void eeprom_init (void);
6dd652fa
WD
464#ifndef CONFIG_SPI
465int eeprom_probe (unsigned dev_addr, unsigned offset);
466#endif
e2211743
WD
467int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
468int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
469#ifdef CONFIG_LWMON
470extern uchar pic_read (uchar reg);
471extern void pic_write (uchar reg, uchar val);
472#endif
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
493#ifdef CONFIG_RPXCLASSIC
494void rpxclassic_init (void);
495#endif
496
e63c8ee3
WD
497void rpxlite_init (void);
498
e2211743
WD
499#ifdef CONFIG_MBX
500/* $(BOARD)/mbx8xx.c */
501void mbx_init (void);
502void board_serial_init (void);
503void board_ether_init (void);
504#endif
505
e2211743
WD
506#ifdef CONFIG_HERMES
507/* $(BOARD)/hermes.c */
508void hermes_start_lxt980 (int speed);
509#endif
510
511#ifdef CONFIG_EVB64260
512void evb64260_init(void);
513void debug_led(int, int);
514void display_mem_map(void);
515void perform_soft_reset(void);
516#endif
517
e2211743 518/* $(BOARD)/$(BOARD).c */
c837dcb1
WD
519int board_early_init_f (void);
520int board_late_init (void);
e2211743 521int board_postclk_init (void); /* after clocks/timebase, before env/serial */
c837dcb1 522int board_early_init_r (void);
e2211743
WD
523void board_poweroff (void);
524
6d0f6bcf 525#if defined(CONFIG_SYS_DRAM_TEST)
e2211743 526int testdram(void);
6d0f6bcf 527#endif /* CONFIG_SYS_DRAM_TEST */
e2211743
WD
528
529/* $(CPU)/start.S */
c83bf6a2 530#if defined(CONFIG_5xx) || \
0db5bca8 531 defined(CONFIG_8xx)
e2211743
WD
532uint get_immr (uint);
533#endif
c83bf6a2 534uint get_pir (void);
36c72877
WD
535#if defined(CONFIG_MPC5xxx)
536uint get_svr (void);
537#endif
e2211743 538uint get_pvr (void);
547b4cb2 539uint get_svr (void);
e2211743
WD
540uint rd_ic_cst (void);
541void wr_ic_cst (uint);
542void wr_ic_adr (uint);
543uint rd_dc_cst (void);
544void wr_dc_cst (uint);
545void wr_dc_adr (uint);
546int icache_status (void);
547void icache_enable (void);
548void icache_disable(void);
549int dcache_status (void);
550void dcache_enable (void);
551void dcache_disable(void);
2c451f78 552void mmu_disable(void);
5c6db120
BT
553#if defined(CONFIG_ARM)
554void relocate_code(ulong);
555#else
556void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
959eaa74 557#endif
e2211743
WD
558ulong get_endaddr (void);
559void trap_init (ulong);
560#if defined (CONFIG_4xx) || \
eeb1b77b 561 defined (CONFIG_MPC5xxx) || \
e2211743
WD
562 defined (CONFIG_74xx_7xx) || \
563 defined (CONFIG_74x) || \
564 defined (CONFIG_75x) || \
0ac6f8b7 565 defined (CONFIG_74xx) || \
cd94ba39 566 defined (CONFIG_MPC85xx) || \
debb7354 567 defined (CONFIG_MPC86xx) || \
0f898604 568 defined (CONFIG_MPC83xx)
c83bf6a2
WD
569unsigned char in8(unsigned int);
570void out8(unsigned int, unsigned char);
571unsigned short in16(unsigned int);
572unsigned short in16r(unsigned int);
573void out16(unsigned int, unsigned short value);
574void out16r(unsigned int, unsigned short value);
575unsigned long in32(unsigned int);
576unsigned long in32r(unsigned int);
577void out32(unsigned int, unsigned long value);
578void out32r(unsigned int, unsigned long value);
579void ppcDcbf(unsigned long value);
580void ppcDcbi(unsigned long value);
581void ppcSync(void);
0ac6f8b7 582void ppcDcbz(unsigned long value);
e2211743 583#endif
0643631a
MS
584#if defined (CONFIG_MICROBLAZE)
585unsigned short in16(unsigned int);
586void out16(unsigned int, unsigned short value);
587#endif
e2211743 588
0f898604 589#if defined (CONFIG_MPC83xx)
90f30a71
DL
590void ppcDWload(unsigned int *addr, unsigned int *ret);
591void ppcDWstore(unsigned int *addr, unsigned int *value);
7c6db910
HS
592void disable_addr_trans(void);
593void enable_addr_trans(void);
594#if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
595void ddr_enable_ecc(unsigned int dram_size);
596#endif
90f30a71
DL
597#endif
598
e2211743 599/* $(CPU)/cpu.c */
fbb9ecf7
TT
600static inline int cpumask_next(int cpu, unsigned int mask)
601{
602 for (cpu++; !((1 << cpu) & mask); cpu++)
603 ;
604
605 return cpu;
606}
607
608#define for_each_cpu(iter, cpu, num_cpus, mask) \
609 for (iter = 0, cpu = cpumask_next(-1, mask); \
610 iter < num_cpus; \
611 iter++, cpu = cpumask_next(cpu, mask)) \
612
0e870980 613int cpu_numcores (void);
fbb9ecf7
TT
614u32 cpu_mask (void);
615int is_core_valid (unsigned int);
0e870980 616int probecpu (void);
e2211743
WD
617int checkcpu (void);
618int checkicache (void);
619int checkdcache (void);
620void upmconfig (unsigned int, unsigned int *, unsigned int);
621ulong get_tbclk (void);
3ec924a3 622void reset_cpu (ulong addr);
6a16e0df
KP
623#if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
624void ft_cpu_setup(void *blob, bd_t *bd);
625#ifdef CONFIG_PCI
626void ft_pci_setup(void *blob, bd_t *bd);
627#endif
628#endif
629
ba6a1698
AP
630void smp_set_core_boot_addr(unsigned long addr, int corenr);
631void smp_kick_all_cpus(void);
e2211743
WD
632
633/* $(CPU)/serial.c */
634int serial_init (void);
635void serial_setbrg (void);
636void serial_putc (const char);
756f586a 637void serial_putc_raw(const char);
e2211743 638void serial_puts (const char *);
e2211743
WD
639int serial_getc (void);
640int serial_tstc (void);
641
756f586a
WD
642void _serial_setbrg (const int);
643void _serial_putc (const char, const int);
644void _serial_putc_raw(const char, const int);
645void _serial_puts (const char *, const int);
646int _serial_getc (const int);
647int _serial_tstc (const int);
648
e2211743
WD
649/* $(CPU)/speed.c */
650int get_clocks (void);
c178d3da
WD
651int get_clocks_866 (void);
652int sdram_adjust_866 (void);
e9132ea9 653int adjust_sdram_tbs_8xx (void);
e2211743
WD
654#if defined(CONFIG_8260)
655int prt_8260_clks (void);
f046ccd1 656#elif defined(CONFIG_MPC5xxx)
945af8d7
WD
657int prt_mpc5xxx_clks (void);
658#endif
e2211743
WD
659#ifdef CONFIG_4xx
660ulong get_OPB_freq (void);
661ulong get_PCI_freq (void);
662#endif
ac67804f 663#if defined(CONFIG_S3C24X0) || \
664 defined(CONFIG_LH7A40X) || \
fcfb632b 665 defined(CONFIG_EP93XX)
e2211743
WD
666ulong get_FCLK (void);
667ulong get_HCLK (void);
668ulong get_PCLK (void);
669ulong get_UCLK (void);
670#endif
f39748ae
WD
671#if defined(CONFIG_LH7A40X)
672ulong get_PLLCLK (void);
673#endif
7cb22f97 674#if defined CONFIG_INCA_IP
c83bf6a2 675uint incaip_get_cpuclk (void);
7cb22f97 676#endif
281e00a3
WD
677#if defined(CONFIG_IMX)
678ulong get_systemPLLCLK(void);
679ulong get_FCLK(void);
680ulong get_HCLK(void);
681ulong get_BCLK(void);
682ulong get_PERCLK1(void);
683ulong get_PERCLK2(void);
684ulong get_PERCLK3(void);
685#endif
e2211743 686ulong get_bus_freq (ulong);
550650dd 687int get_serial_clock(void);
e2211743 688
d29d17d7
YS
689#if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx)
690ulong get_ddr_freq(ulong);
691#endif
42d1f039
WD
692#if defined(CONFIG_MPC85xx)
693typedef MPC85xx_SYS_INFO sys_info_t;
c83bf6a2 694void get_sys_info ( sys_info_t * );
42d1f039 695#endif
debb7354
JL
696#if defined(CONFIG_MPC86xx)
697typedef MPC86xx_SYS_INFO sys_info_t;
698void get_sys_info ( sys_info_t * );
5df4b0ad
KG
699static inline ulong get_ddr_freq(ulong dummy)
700{
701 return get_bus_freq(dummy);
702}
debb7354 703#endif
42d1f039 704
99bcad18 705#if defined(CONFIG_4xx)
e2211743 706# if defined(CONFIG_440)
6c5879f3
MB
707# if defined(CONFIG_440SPE)
708 unsigned long determine_sysper(void);
709 unsigned long determine_pci_clock_per(void);
710# endif
e2211743 711# endif
087dfdb7 712typedef PPC4xx_SYS_INFO sys_info_t;
f31d38b9 713int ppc440spe_revB(void);
c83bf6a2 714void get_sys_info ( sys_info_t * );
e2211743
WD
715#endif
716
717/* $(CPU)/cpu_init.c */
718#if defined(CONFIG_8xx) || defined(CONFIG_8260)
719void cpu_init_f (volatile immap_t *immr);
720#endif
debb7354 721#if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2) ||defined(CONFIG_MPC86xx)
e2211743
WD
722void cpu_init_f (void);
723#endif
bf9e3b38 724
e2211743
WD
725int cpu_init_r (void);
726#if defined(CONFIG_8260)
727int prt_8260_rsr (void);
0f898604 728#elif defined(CONFIG_MPC83xx)
9be39a67 729int prt_83xx_rsr (void);
e2211743
WD
730#endif
731
732/* $(CPU)/interrupts.c */
c83bf6a2
WD
733int interrupt_init (void);
734void timer_interrupt (struct pt_regs *);
e2211743
WD
735void external_interrupt (struct pt_regs *);
736void irq_install_handler(int, interrupt_handler_t *, void *);
737void irq_free_handler (int);
738void reset_timer (void);
739ulong get_timer (ulong base);
b2e16a85
SG
740
741/* Return value of monotonic microsecond timer */
742unsigned long timer_get_us(void);
743
e2211743
WD
744void enable_interrupts (void);
745int disable_interrupts (void);
746
747/* $(CPU)/.../commproc.c */
748int dpram_init (void);
749uint dpram_base(void);
750uint dpram_base_align(uint align);
751uint dpram_alloc(uint size);
752uint dpram_alloc_align(uint size,uint align);
bdccc4fe
WD
753void bootcount_store (ulong);
754ulong bootcount_load (void);
755#define BOOTCOUNT_MAGIC 0xB001C041
e2211743
WD
756
757/* $(CPU)/.../<eth> */
c5bded3c 758void mii_init (void);
e2211743
WD
759
760/* $(CPU)/.../lcd.c */
761ulong lcd_setmem (ulong);
762
e2211743
WD
763/* $(CPU)/.../video.c */
764ulong video_setmem (ulong);
765
ea0364f1 766/* arch/$(ARCH)/lib/cache.c */
cba4b180 767void enable_caches(void);
e2211743 768void flush_cache (unsigned long, unsigned long);
2c451f78 769void flush_dcache_all(void);
03d3bfb0
SR
770void flush_dcache_range(unsigned long start, unsigned long stop);
771void invalidate_dcache_range(unsigned long start, unsigned long stop);
2c451f78
A
772void invalidate_dcache_all(void);
773void invalidate_icache_all(void);
0db5bca8 774
ea0364f1 775/* arch/$(ARCH)/lib/ticks.S */
e2211743
WD
776unsigned long long get_ticks(void);
777void wait_ticks (unsigned long);
778
ea0364f1 779/* arch/$(ARCH)/lib/time.c */
3eb90bad 780void __udelay (unsigned long);
e2211743
WD
781ulong usec2ticks (unsigned long usec);
782ulong ticks2usec (unsigned long ticks);
783int init_timebase (void);
784
78acc472 785/* lib/gunzip.c */
87d93a1b
WW
786int gunzip(void *, int, unsigned char *, unsigned long *);
787int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
788 int stoponerr, int offset);
789
54c6977e
WD
790/* lib/qsort.c */
791void qsort(void *base, size_t nmemb, size_t size,
792 int(*compar)(const void *, const void *));
560d424b 793int strcmp_compar(const void *, const void *);
54c6977e 794
78acc472 795/* lib/time.c */
3eb90bad 796void udelay (unsigned long);
c4c9fbeb 797void mdelay(unsigned long);
3eb90bad 798
e11938ea
JH
799/* lib/uuid.c */
800void uuid_str_to_bin(const char *uuid, unsigned char *out);
801int uuid_str_valid(const char *uuid);
802
78acc472 803/* lib/vsprintf.c */
9785c905 804#include <vsprintf.h>
e2211743 805
78acc472 806/* lib/strmhz.c */
55f7934d 807char * strmhz(char *buf, unsigned long hz);
0768b7a8 808
78acc472 809/* lib/crc32.c */
449609f5 810#include <u-boot/crc.h>
e2211743 811
9acf1ca5 812/* lib/rand.c */
99e139d5
MW
813#if defined(CONFIG_RANDOM_MACADDR) || \
814 defined(CONFIG_BOOTP_RANDOM_DELAY) || \
815 defined(CONFIG_CMD_LINK_LOCAL)
9acf1ca5
MW
816#define RAND_MAX -1U
817void srand(unsigned int seed);
818unsigned int rand(void);
819unsigned int rand_r(unsigned int *seedp);
820#endif
821
e2211743 822/* common/console.c */
e2211743
WD
823int console_init_f(void); /* Before relocation; uses the serial stuff */
824int console_init_r(void); /* After relocation; uses the console stuff */
d7be3056 825int console_assign(int file, const char *devname); /* Assign the console */
e2211743
WD
826int ctrlc (void);
827int had_ctrlc (void); /* have we had a Control-C since last clear? */
828void clear_ctrlc (void); /* clear the Control-C condition */
829int disable_ctrlc (int); /* 1 to disable, 0 to enable Control-C detect */
830
831/*
832 * STDIO based functions (can always be used)
833 */
e2211743 834/* serial stuff */
d9c27253 835int serial_printf (const char *fmt, ...)
dc4b0b38 836 __attribute__ ((format (__printf__, 1, 2)));
e2211743
WD
837/* stdin */
838int getc(void);
839int tstc(void);
840
841/* stdout */
842void putc(const char c);
843void puts(const char *s);
d9c27253 844int printf(const char *fmt, ...)
dc4b0b38 845 __attribute__ ((format (__printf__, 1, 2)));
d9c27253 846int vprintf(const char *fmt, va_list args);
e2211743
WD
847
848/* stderr */
849#define eputc(c) fputc(stderr, c)
850#define eputs(s) fputs(stderr, s)
851#define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
852
853/*
854 * FILE based functions (can only be used AFTER relocation!)
855 */
e2211743
WD
856#define stdin 0
857#define stdout 1
858#define stderr 2
859#define MAX_FILES 3
860
d9c27253 861int fprintf(int file, const char *fmt, ...)
dc4b0b38 862 __attribute__ ((format (__printf__, 2, 3)));
e2211743
WD
863void fputs(int file, const char *s);
864void fputc(int file, const char c);
865int ftstc(int file);
866int fgetc(int file);
867
88d52c6a
LW
868/* lib/gzip.c */
869int gzip(void *dst, unsigned long *lenp,
870 unsigned char *src, unsigned long srclen);
871int zzip(void *dst, unsigned long *lenp, unsigned char *src,
872 unsigned long srclen, int stoponerr,
873 int (*func)(unsigned long, unsigned long));
874
4ef8d53c
JH
875/* lib/net_utils.c */
876#include <net.h>
877static inline IPaddr_t getenv_IPaddr(char *var)
878{
879 return string_to_ip(getenv(var));
880}
881
16a28ef2
GJ
882/*
883 * CONSOLE multiplexing.
884 */
885#ifdef CONFIG_CONSOLE_MUX
886#include <iomux.h>
887#endif
888
e2211743
WD
889int pcmcia_init (void);
890
fb364bec
WD
891#ifdef CONFIG_STATUS_LED
892# include <status_led.h>
893#endif
097e1783
SG
894
895#include <bootstage.h>
e2211743 896
48522bb5
JH
897#ifdef CONFIG_SHOW_ACTIVITY
898void show_activity(int arg);
899#endif
900
fcd3c87e
WD
901/* Multicore arch functions */
902#ifdef CONFIG_MP
903int cpu_status(int nr);
904int cpu_reset(int nr);
4194b366 905int cpu_disable(int nr);
54841ab5 906int cpu_release(int nr, int argc, char * const argv[]);
fcd3c87e
WD
907#endif
908
4213fc29
SG
909/* Define a null map_sysmem() if the architecture doesn't use it */
910# ifndef CONFIG_ARCH_MAP_SYSMEM
911static inline void *map_sysmem(phys_addr_t paddr, unsigned long len)
912{
913 return (void *)(uintptr_t)paddr;
914}
915
916static inline void unmap_sysmem(const void *vaddr)
917{
918}
781adb57
SG
919
920static inline phys_addr_t map_to_sysmem(void *ptr)
921{
922 return (phys_addr_t)(uintptr_t)ptr;
923}
4213fc29
SG
924# endif
925
fcd3c87e
WD
926#endif /* __ASSEMBLY__ */
927
13e95e42
SR
928#ifdef CONFIG_PPC
929/*
930 * Has to be included outside of the #ifndef __ASSEMBLY__ section.
931 * Otherwise might lead to compilation errors in assembler files.
932 */
933#include <asm/cache.h>
934#endif
935
fcd3c87e
WD
936/* Put only stuff here that the assembler can digest */
937
938#ifdef CONFIG_POST
939#define CONFIG_HAS_POST
800eb096
MZ
940#ifndef CONFIG_POST_ALT_LIST
941#define CONFIG_POST_STD_LIST
942#endif
fcd3c87e
WD
943#endif
944
8aa1a2d1 945#ifdef CONFIG_INIT_CRITICAL
2f6fa46d 946#error CONFIG_INIT_CRITICAL is deprecated!
8aa1a2d1
WD
947#error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
948#endif
949
3cfb0c51
KG
950#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
951
155cfb5e 952#define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
d50c7d4b
WD
953#define DIV_ROUND(n,d) (((n) + ((d)/2)) / (d))
954#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
955#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
022f1216 956
4b03ac8b
AF
957#define ALIGN(x,a) __ALIGN_MASK((x),(typeof(x))(a)-1)
958#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
959
1e41f5ad
AS
960/*
961 * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture. It
962 * is used to align DMA buffers.
963 */
964#ifndef __ASSEMBLY__
965#include <asm/cache.h>
966#endif
967
46a6d51c
A
968/*
969 * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the
970 * stack that meets the minimum architecture alignment requirements for DMA.
971 * Such a buffer is useful for DMA operations where flushing and invalidating
972 * the cache before and after a read and/or write operation is required for
973 * correct operations.
974 *
975 * When called the macro creates an array on the stack that is sized such
976 * that:
977 *
978 * 1) The beginning of the array can be advanced enough to be aligned.
979 *
980 * 2) The size of the aligned portion of the array is a multiple of the minimum
981 * architecture alignment required for DMA.
982 *
983 * 3) The aligned portion contains enough space for the original number of
984 * elements requested.
985 *
986 * The macro then creates a pointer to the aligned portion of this array and
987 * assigns to the pointer the address of the first element in the aligned
988 * portion of the array.
989 *
990 * Calling the macro as:
991 *
992 * ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024);
993 *
994 * Will result in something similar to saying:
995 *
996 * uint32_t buffer[1024];
997 *
998 * The following differences exist:
999 *
1000 * 1) The resulting buffer is guaranteed to be aligned to the value of
1001 * ARCH_DMA_MINALIGN.
1002 *
1003 * 2) The buffer variable created by the macro is a pointer to the specified
1004 * type, and NOT an array of the specified type. This can be very important
1005 * if you want the address of the buffer, which you probably do, to pass it
1006 * to the DMA hardware. The value of &buffer is different in the two cases.
1007 * In the macro case it will be the address of the pointer, not the address
1008 * of the space reserved for the buffer. However, in the second case it
1009 * would be the address of the buffer. So if you are replacing hard coded
1010 * stack buffers with this macro you need to make sure you remove the & from
1011 * the locations where you are taking the address of the buffer.
1012 *
1013 * Note that the size parameter is the number of array elements to allocate,
1014 * not the number of bytes.
1015 *
1016 * This macro can not be used outside of function scope, or for the creation
1017 * of a function scoped static buffer. It can not be used to create a cache
1018 * line aligned global buffer.
1019 */
e8232fea 1020#define PAD_COUNT(s, pad) (((s) - 1) / (pad) + 1)
ae1768a7
EE
1021#define PAD_SIZE(s, pad) (PAD_COUNT(s, pad) * pad)
1022#define ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, pad) \
e8232fea 1023 char __##name[ROUND(PAD_SIZE((size) * sizeof(type), pad), align) \
ae1768a7 1024 + (align - 1)]; \
de4d1135
MV
1025 \
1026 type *name = (type *) ALIGN((uintptr_t)__##name, align)
ae1768a7
EE
1027#define ALLOC_ALIGN_BUFFER(type, name, size, align) \
1028 ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, 1)
1029#define ALLOC_CACHE_ALIGN_BUFFER_PAD(type, name, size, pad) \
1030 ALLOC_ALIGN_BUFFER_PAD(type, name, size, ARCH_DMA_MINALIGN, pad)
46a6d51c 1031#define ALLOC_CACHE_ALIGN_BUFFER(type, name, size) \
de4d1135
MV
1032 ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
1033
1034/*
1035 * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
1036 * purpose is to allow allocating aligned buffers outside of function scope.
1037 * Usage of this macro shall be avoided or used with extreme care!
1038 */
1039#define DEFINE_ALIGN_BUFFER(type, name, size, align) \
1040 static char __##name[roundup(size * sizeof(type), align)] \
d7ea4d4d 1041 __aligned(align); \
46a6d51c 1042 \
de4d1135
MV
1043 static type *name = (type *)__##name
1044#define DEFINE_CACHE_ALIGN_BUFFER(type, name, size) \
1045 DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
46a6d51c 1046
c3eb3fe4
MF
1047/* Pull in stuff for the build system */
1048#ifdef DO_DEPS_ONLY
1049# include <environment.h>
1050#endif
1051
e2211743 1052#endif /* __COMMON_H_ */