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