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