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