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