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