common.h 29.1 KB
Newer Older
W
wdenk 已提交
1
/*
2
 * (C) Copyright 2000-2009
W
wdenk 已提交
3 4
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
5
 * SPDX-License-Identifier:	GPL-2.0+
W
wdenk 已提交
6 7 8
 */

#ifndef __COMMON_H_
9
#define __COMMON_H_	1
W
wdenk 已提交
10 11

#undef	_LINUX_CONFIG_H
12
#define _LINUX_CONFIG_H 1	/* avoid reading Linux autoconf.h file	*/
W
wdenk 已提交
13

14 15
#ifndef __ASSEMBLY__		/* put C only stuff in this section */

W
wdenk 已提交
16 17
typedef unsigned char		uchar;
typedef volatile unsigned long	vu_long;
18
typedef volatile unsigned short vu_short;
W
wdenk 已提交
19 20 21
typedef volatile unsigned char	vu_char;

#include <config.h>
22
#include <asm-offsets.h>
W
wdenk 已提交
23 24 25
#include <linux/bitops.h>
#include <linux/types.h>
#include <linux/string.h>
M
Marek Vasut 已提交
26
#include <linux/stringify.h>
W
wdenk 已提交
27 28
#include <asm/ptrace.h>
#include <stdarg.h>
S
Stefan Roese 已提交
29
#if defined(CONFIG_PCI) && defined(CONFIG_4xx)
W
wdenk 已提交
30 31
#include <pci.h>
#endif
32
#if defined(CONFIG_8xx)
W
wdenk 已提交
33
#include <asm/8xx_immap.h>
W
wdenk 已提交
34 35 36 37 38
#if defined(CONFIG_MPC852)	|| defined(CONFIG_MPC852T)	|| \
    defined(CONFIG_MPC859)	|| defined(CONFIG_MPC859T)	|| \
    defined(CONFIG_MPC859DSL)	|| \
    defined(CONFIG_MPC866)	|| defined(CONFIG_MPC866T)	|| \
    defined(CONFIG_MPC866P)
39
# define CONFIG_MPC866_FAMILY 1
40 41 42 43
#elif defined(CONFIG_MPC870) \
   || defined(CONFIG_MPC875) \
   || defined(CONFIG_MPC880) \
   || defined(CONFIG_MPC885)
44
# define CONFIG_MPC885_FAMILY   1
45 46 47
#endif
#if   defined(CONFIG_MPC860)	   \
   || defined(CONFIG_MPC860T)	   \
W
wdenk 已提交
48 49
   || defined(CONFIG_MPC866_FAMILY) \
   || defined(CONFIG_MPC885_FAMILY)
50
# define CONFIG_MPC86x 1
W
wdenk 已提交
51
#endif
52 53
#elif defined(CONFIG_5xx)
#include <asm/5xx_immap.h>
W
wdenk 已提交
54 55
#elif defined(CONFIG_MPC5xxx)
#include <mpc5xxx.h>
56 57
#elif defined(CONFIG_MPC512X)
#include <asm/immap_512x.h>
W
wdenk 已提交
58
#elif defined(CONFIG_8260)
59 60 61 62
#if   defined(CONFIG_MPC8247) \
   || defined(CONFIG_MPC8248) \
   || defined(CONFIG_MPC8271) \
   || defined(CONFIG_MPC8272)
63
#define CONFIG_MPC8272_FAMILY	1
64 65
#endif
#if defined(CONFIG_MPC8272_FAMILY)
66
#define CONFIG_MPC8260	1
67
#endif
W
wdenk 已提交
68 69
#include <asm/immap_8260.h>
#endif
70 71 72 73
#ifdef CONFIG_MPC86xx
#include <mpc86xx.h>
#include <asm/immap_86xx.h>
#endif
W
wdenk 已提交
74 75 76 77
#ifdef CONFIG_MPC85xx
#include <mpc85xx.h>
#include <asm/immap_85xx.h>
#endif
78
#ifdef CONFIG_MPC83xx
E
Eran Liberty 已提交
79 80 81
#include <mpc83xx.h>
#include <asm/immap_83xx.h>
#endif
W
wdenk 已提交
82
#ifdef	CONFIG_4xx
83
#include <asm/ppc4xx.h>
W
wdenk 已提交
84 85
#endif
#ifdef CONFIG_HYMOD
W
wdenk 已提交
86
#include <board/hymod/hymod.h>
W
wdenk 已提交
87 88 89 90
#endif
#ifdef CONFIG_ARM
#define asmlinkage	/* nothing */
#endif
91 92 93
#ifdef CONFIG_BLACKFIN
#include <asm/blackfin.h>
#endif
94 95 96
#ifdef CONFIG_SOC_DA8XX
#include <asm/arch/hardware.h>
#endif
W
wdenk 已提交
97 98 99 100 101

#include <part.h>
#include <flash.h>
#include <image.h>

S
Simon Glass 已提交
102
#ifdef DEBUG
M
Marek Vasut 已提交
103
#define _DEBUG	1
S
Simon Glass 已提交
104
#else
M
Marek Vasut 已提交
105
#define _DEBUG	0
S
Simon Glass 已提交
106 107
#endif

M
Marek Vasut 已提交
108 109 110 111 112 113 114 115 116 117 118 119 120 121
/*
 * Output a debug text when condition "cond" is met. The "cond" should be
 * computed by a preprocessor in the best case, allowing for the best
 * optimization.
 */
#define debug_cond(cond, fmt, args...)		\
	do {					\
		if (cond)			\
			printf(fmt, ##args);	\
	} while (0)

#define debug(fmt, args...)			\
	debug_cond(_DEBUG, fmt, ##args)

S
Simon Glass 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
/*
 * An assertion is run-time check done in debug mode only. If DEBUG is not
 * defined then it is skipped. If DEBUG is defined and the assertion fails,
 * then it calls panic*( which may or may not reset/halt U-Boot (see
 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
 * before release, and after release it is hoped that they don't matter. But
 * in any case these failing assertions cannot be fixed with a reset (which
 * may just do the same assertion again).
 */
void __assert_fail(const char *assertion, const char *file, unsigned line,
		   const char *function);
#define assert(x) \
	({ if (!(x) && _DEBUG) \
		__assert_fail(#x, __FILE__, __LINE__, __func__); })

M
Matthias Kaehlcke 已提交
137 138 139 140 141
#define error(fmt, args...) do {					\
		printf("ERROR: " fmt "\nat %s:%d/%s()\n",		\
			##args, __FILE__, __LINE__, __func__);		\
} while (0)

142
#ifndef BUG
143
#define BUG() do { \
W
Wolfgang Denk 已提交
144
	printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
145 146 147
	panic("BUG!"); \
} while (0)
#define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
148
#endif /* BUG */
149

150 151 152
/* Force a compilation error if condition is true */
#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))

153
typedef void (interrupt_handler_t)(void *);
W
wdenk 已提交
154

155
#include <asm/u-boot.h> /* boot information for Linux kernel */
W
wdenk 已提交
156 157
#include <asm/global_data.h>	/* global data used for startup functions */

158 159
/*
 * enable common handling for all TQM8xxL/M boards:
160
 * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
161
 * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
162
 *                  and for the TQM885D board
163 164 165
 */
#if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
    defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
166
    defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
167 168 169 170
# ifndef CONFIG_TQM8xxM
#  define CONFIG_TQM8xxM
# endif
#endif
W
wdenk 已提交
171
#if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
W
wdenk 已提交
172
    defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
173 174
    defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
    defined(CONFIG_TQM885D)
W
wdenk 已提交
175 176 177 178 179
# ifndef CONFIG_TQM8xxL
#  define CONFIG_TQM8xxL
# endif
#endif

W
wdenk 已提交
180 181 182 183
/*
 * General Purpose Utilities
 */
#define min(X, Y)				\
184 185
	({ typeof(X) __x = (X);			\
		typeof(Y) __y = (Y);		\
W
wdenk 已提交
186 187 188
		(__x < __y) ? __x : __y; })

#define max(X, Y)				\
189 190
	({ typeof(X) __x = (X);			\
		typeof(Y) __y = (Y);		\
W
wdenk 已提交
191 192
		(__x > __y) ? __x : __y; })

A
Andy Fleming 已提交
193 194 195
#define MIN(x, y)  min(x, y)
#define MAX(x, y)  max(x, y)

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
#define min3(X, Y, Z)				\
	({ typeof(X) __x = (X);			\
		typeof(Y) __y = (Y);		\
		typeof(Z) __z = (Z);		\
		__x < __y ? (__x < __z ? __x : __z) :	\
		(__y < __z ? __y : __z); })

#define max3(X, Y, Z)				\
	({ typeof(X) __x = (X);			\
		typeof(Y) __y = (Y);		\
		typeof(Z) __z = (Z);		\
		__x > __y ? (__x > __z ? __x : __z) :	\
		(__y > __z ? __y : __z); })

#define MIN3(x, y, z)  min3(x, y, z)
#define MAX3(x, y, z)  max3(x, y, z)

213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
/*
 * Return the absolute value of a number.
 *
 * This handles unsigned and signed longs, ints, shorts and chars.  For all
 * input types abs() returns a signed long.
 *
 * For 64-bit types, use abs64()
 */
#define abs(x) ({						\
		long ret;					\
		if (sizeof(x) == sizeof(long)) {		\
			long __x = (x);				\
			ret = (__x < 0) ? -__x : __x;		\
		} else {					\
			int __x = (x);				\
			ret = (__x < 0) ? -__x : __x;		\
		}						\
		ret;						\
	})

#define abs64(x) ({				\
		s64 __x = (x);			\
		(__x < 0) ? -__x : __x;		\
	})

238 239 240 241 242 243 244 245 246
#if defined(CONFIG_ENV_IS_EMBEDDED)
#define TOTAL_MALLOC_LEN	CONFIG_SYS_MALLOC_LEN
#elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
	(CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
      defined(CONFIG_ENV_IS_IN_NVRAM)
#define	TOTAL_MALLOC_LEN	(CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
#else
#define	TOTAL_MALLOC_LEN	CONFIG_SYS_MALLOC_LEN
#endif
W
wdenk 已提交
247

248 249 250 251 252 253 254 255 256 257 258
/**
 * container_of - cast a member of a structure out to the containing structure
 * @ptr:	the pointer to the member.
 * @type:	the type of the container struct this is embedded in.
 * @member:	the name of the member within the struct.
 *
 */
#define container_of(ptr, type, member) ({			\
	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
	(type *)( (char *)__mptr - offsetof(type,member) );})

W
wdenk 已提交
259 260 261 262
/*
 * Function Prototypes
 */

263
void	hang		(void) __attribute__ ((noreturn));
W
wdenk 已提交
264

265 266 267
int	timer_init(void);
int	cpu_init(void);

W
wdenk 已提交
268
/* */
269
phys_size_t initdram (int);
270
int	display_options (void);
271
void	print_size(unsigned long long, const char *);
S
Simon Glass 已提交
272 273
int print_buffer(ulong addr, const void *data, uint width, uint count,
		 uint linelen);
W
wdenk 已提交
274 275 276

/* common/main.c */
void	main_loop	(void);
277
int run_command(const char *cmd, int flag);
278 279 280 281 282 283 284 285 286 287 288 289 290

/**
 * Run a list of commands separated by ; or even \0
 *
 * Note that if 'len' is not -1, then the command does not need to be nul
 * terminated, Memory will be allocated for the command in that case.
 *
 * @param cmd	List of commands to run, each separated bu semicolon
 * @param len	Length of commands excluding terminator if known (-1 if not)
 * @param flag	Execution flags (CMD_FLAG_...)
 * @return 0 on success, or != 0 on error.
 */
int run_command_list(const char *cmd, int len, int flag);
W
wdenk 已提交
291
int	readline	(const char *const prompt);
292 293
int	readline_into_buffer(const char *const prompt, char *buffer,
			int timeout);
J
James Yang 已提交
294
int	parse_line (char *, char *[]);
W
wdenk 已提交
295
void	init_cmd_timeout(void);
W
wdenk 已提交
296
void	reset_cmd_timeout(void);
297
extern char console_buffer[];
W
wdenk 已提交
298

299
/* arch/$(ARCH)/lib/board.c */
300
void	board_init_f(ulong);
301
void	board_init_r  (gd_t *, ulong) __attribute__ ((noreturn));
W
wdenk 已提交
302 303 304 305
int	checkboard    (void);
int	checkflash    (void);
int	checkdram     (void);
int	last_stage_init(void);
306
extern ulong monitor_flash_len;
307
int mac_read_from_eeprom(void);
308
extern u8 _binary_dt_dtb_start[];	/* embedded device tree blob */
309
int set_cpu_clk_info(void);
310
int print_cpuinfo(void);
S
Simon Glass 已提交
311
int update_flash_size(int flash_size);
W
wdenk 已提交
312

313 314 315 316 317 318 319 320 321
/**
 * Show the DRAM size in a board-specific way
 *
 * This is used by boards to display DRAM information in their own way.
 *
 * @param size	Size of DRAM (which should be displayed along with other info)
 */
void board_show_dram(ulong size);

322 323 324 325 326 327 328 329 330 331
/**
 * arch_fixup_memory_node() - Write arch-specific memory information to fdt
 *
 * Defined in arch/$(ARCH)/lib/bootm.c
 *
 * @blob:	FDT blob to write to
 * @return 0 if ok, or -ve FDT_ERR_... on failure
 */
int arch_fixup_memory_node(void *blob);

W
wdenk 已提交
332 333 334
/* common/flash.c */
void flash_perror (int);

335 336
/* common/cmd_source.c */
int	source (ulong addr, const char *fit_uname);
W
wdenk 已提交
337

338
extern ulong load_addr;		/* Default Load Address */
339 340
extern ulong save_addr;		/* Default Save Address */
extern ulong save_size;		/* Default Save Size */
W
wdenk 已提交
341

342 343 344
/* common/cmd_doc.c */
void	doc_probe(unsigned long physadr);

J
Jason Hobbs 已提交
345 346 347
/* common/cmd_net.c */
int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);

348 349 350 351 352 353
/* common/cmd_fat.c */
int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);

/* common/cmd_ext2.c */
int do_ext2load(cmd_tbl_t *, int, int, char * const []);

W
wdenk 已提交
354 355 356
/* common/cmd_nvedit.c */
int	env_init     (void);
void	env_relocate (void);
R
Rafal Jaworowski 已提交
357
int	envmatch     (uchar *, int);
358 359
char	*getenv	     (const char *);
int	getenv_f     (const char *name, char *buf, unsigned len);
360
ulong getenv_ulong(const char *name, int base, ulong default_val);
361 362 363 364 365 366 367 368 369 370 371 372 373

/**
 * getenv_hex() - Return an environment variable as a hex value
 *
 * Decode an environment as a hex number (it may or may not have a 0x
 * prefix). If the environment variable cannot be found, or does not start
 * with hex digits, the default value is returned.
 *
 * @varname:		Variable to decode
 * @default_val:	Value to return on error
 */
ulong getenv_hex(const char *varname, ulong default_val);

374 375 376 377 378
/*
 * Read an environment variable as a boolean
 * Return -1 if variable does not exist (default to true)
 */
int getenv_yesno(const char *var);
379
int	saveenv	     (void);
380
int	setenv	     (const char *, const char *);
S
Simon Glass 已提交
381
int setenv_ulong(const char *varname, ulong value);
382 383 384 385
int setenv_hex(const char *varname, ulong value);
/**
 * setenv_addr - Set an environment variable to an address in hex
 *
386
 * @varname:	Environment variable to set
387 388 389 390 391 392 393 394
 * @addr:	Value to set it to
 * @return 0 if ok, 1 on error
 */
static inline int setenv_addr(const char *varname, const void *addr)
{
	return setenv_hex(varname, (ulong)addr);
}

W
wdenk 已提交
395
#ifdef CONFIG_ARM
W
wdenk 已提交
396
# include <asm/mach-types.h>
W
wdenk 已提交
397
# include <asm/setup.h>
W
wdenk 已提交
398 399
# include <asm/u-boot-arm.h>	/* ARM version to be fixed! */
#endif /* CONFIG_ARM */
G
Graeme Russ 已提交
400 401 402
#ifdef CONFIG_X86		/* x86 version to be fixed! */
# include <asm/u-boot-x86.h>
#endif /* CONFIG_X86 */
403 404 405
#ifdef CONFIG_SANDBOX
# include <asm/u-boot-sandbox.h>	/* TODO(sjg) what needs to be fixed? */
#endif
406 407
#ifdef CONFIG_NDS32
# include <asm/mach-types.h>
408
# include <asm/setup.h>
409 410
# include <asm/u-boot-nds32.h>
#endif /* CONFIG_NDS32 */
411 412 413
#ifdef CONFIG_MIPS
# include <asm/u-boot-mips.h>
#endif /* CONFIG_MIPS */
W
wdenk 已提交
414

415 416 417
#ifdef CONFIG_AUTO_COMPLETE
int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
#endif
H
Heiko Schocher 已提交
418
int get_env_id (void);
419

420 421 422
void	pci_init      (void);
void	pci_init_board(void);
void	pciinfo	      (int, int);
W
wdenk 已提交
423

S
Stefan Roese 已提交
424
#if defined(CONFIG_PCI) && defined(CONFIG_4xx)
425 426
    int	   pci_pre_init	       (struct pci_controller *);
    int	   is_pci_host	       (struct pci_controller *);
427 428
#endif

S
Stefan Roese 已提交
429
#if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
430
#   if defined(CONFIG_SYS_PCI_TARGET_INIT)
431
	void	pci_target_init	     (struct pci_controller *);
W
wdenk 已提交
432
#   endif
433
#   if defined(CONFIG_SYS_PCI_MASTER_INIT)
434
	void	pci_master_init	     (struct pci_controller *);
W
wdenk 已提交
435
#   endif
436 437 438
#if defined(CONFIG_440SPE) || \
    defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
    defined(CONFIG_405EX)
439
   void pcie_setup_hoses(int busno);
440
#endif
W
wdenk 已提交
441 442 443 444 445
#endif

int	misc_init_f   (void);
int	misc_init_r   (void);

446 447 448
/* common/exports.c */
void	jumptable_init(void);

449 450 451
/* common/kallsysm.c */
const char *symbol_lookup(unsigned long addr, unsigned long *caddr);

452 453 454
/* api/api.c */
void	api_init (void);

455
/* common/memsize.c */
456
long	get_ram_size  (long *, long);
457

W
wdenk 已提交
458 459
/* $(BOARD)/$(BOARD).c */
void	reset_phy     (void);
460
void	fdc_hw_init   (void);
W
wdenk 已提交
461 462 463

/* $(BOARD)/eeprom.c */
void eeprom_init  (void);
W
wdenk 已提交
464 465 466
#ifndef CONFIG_SPI
int  eeprom_probe (unsigned dev_addr, unsigned offset);
#endif
W
wdenk 已提交
467 468 469 470 471 472 473 474 475 476 477
int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
#ifdef CONFIG_LWMON
extern uchar pic_read  (uchar reg);
extern void  pic_write (uchar reg, uchar val);
#endif

/*
 * Set this up regardless of board
 * type, to prevent errors.
 */
478 479
#if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
# define CONFIG_SYS_DEF_EEPROM_ADDR 0
W
wdenk 已提交
480
#else
H
Heiko Schocher 已提交
481
#if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
482
# define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
H
Heiko Schocher 已提交
483
#endif
484
#endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
W
wdenk 已提交
485

486
#if defined(CONFIG_SPI)
W
wdenk 已提交
487 488
extern void spi_init_f (void);
extern void spi_init_r (void);
489
extern ssize_t spi_read	 (uchar *, int, uchar *, int);
W
wdenk 已提交
490 491 492 493 494 495 496
extern ssize_t spi_write (uchar *, int, uchar *, int);
#endif

#ifdef CONFIG_RPXCLASSIC
void rpxclassic_init (void);
#endif

W
wdenk 已提交
497 498
void rpxlite_init (void);

W
wdenk 已提交
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
#ifdef CONFIG_MBX
/* $(BOARD)/mbx8xx.c */
void	mbx_init (void);
void	board_serial_init (void);
void	board_ether_init (void);
#endif

#ifdef CONFIG_HERMES
/* $(BOARD)/hermes.c */
void hermes_start_lxt980 (int speed);
#endif

#ifdef CONFIG_EVB64260
void  evb64260_init(void);
void  debug_led(int, int);
void  display_mem_map(void);
void  perform_soft_reset(void);
#endif

/* $(BOARD)/$(BOARD).c */
519 520
int board_early_init_f (void);
int board_late_init (void);
W
wdenk 已提交
521
int board_postclk_init (void); /* after clocks/timebase, before env/serial */
522
int board_early_init_r (void);
W
wdenk 已提交
523 524
void board_poweroff (void);

525
#if defined(CONFIG_SYS_DRAM_TEST)
W
wdenk 已提交
526
int testdram(void);
527
#endif /* CONFIG_SYS_DRAM_TEST */
W
wdenk 已提交
528 529

/* $(CPU)/start.S */
530
#if defined(CONFIG_5xx) || \
531
    defined(CONFIG_8xx)
W
wdenk 已提交
532 533
uint	get_immr      (uint);
#endif
534
uint	get_pir	      (void);
W
wdenk 已提交
535 536 537
#if defined(CONFIG_MPC5xxx)
uint	get_svr       (void);
#endif
W
wdenk 已提交
538
uint	get_pvr	      (void);
W
wdenk 已提交
539
uint	get_svr	      (void);
W
wdenk 已提交
540 541 542 543 544 545 546 547 548 549 550 551
uint	rd_ic_cst     (void);
void	wr_ic_cst     (uint);
void	wr_ic_adr     (uint);
uint	rd_dc_cst     (void);
void	wr_dc_cst     (uint);
void	wr_dc_adr     (uint);
int	icache_status (void);
void	icache_enable (void);
void	icache_disable(void);
int	dcache_status (void);
void	dcache_enable (void);
void	dcache_disable(void);
552
void	mmu_disable(void);
553 554 555 556
#if defined(CONFIG_ARM)
void	relocate_code(ulong);
#else
void	relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
557
#endif
W
wdenk 已提交
558 559 560
ulong	get_endaddr   (void);
void	trap_init     (ulong);
#if defined (CONFIG_4xx)	|| \
W
wdenk 已提交
561
    defined (CONFIG_MPC5xxx)	|| \
W
wdenk 已提交
562 563 564
    defined (CONFIG_74xx_7xx)	|| \
    defined (CONFIG_74x)	|| \
    defined (CONFIG_75x)	|| \
W
wdenk 已提交
565
    defined (CONFIG_74xx)	|| \
566
    defined (CONFIG_MPC85xx)	|| \
567
    defined (CONFIG_MPC86xx)	|| \
568
    defined (CONFIG_MPC83xx)
569 570 571 572 573 574 575 576 577 578 579 580 581
unsigned char	in8(unsigned int);
void		out8(unsigned int, unsigned char);
unsigned short	in16(unsigned int);
unsigned short	in16r(unsigned int);
void		out16(unsigned int, unsigned short value);
void		out16r(unsigned int, unsigned short value);
unsigned long	in32(unsigned int);
unsigned long	in32r(unsigned int);
void		out32(unsigned int, unsigned long value);
void		out32r(unsigned int, unsigned long value);
void		ppcDcbf(unsigned long value);
void		ppcDcbi(unsigned long value);
void		ppcSync(void);
W
wdenk 已提交
582
void		ppcDcbz(unsigned long value);
W
wdenk 已提交
583
#endif
M
Michal Simek 已提交
584 585 586 587
#if defined (CONFIG_MICROBLAZE)
unsigned short	in16(unsigned int);
void		out16(unsigned int, unsigned short value);
#endif
W
wdenk 已提交
588

589
#if defined (CONFIG_MPC83xx)
590 591
void		ppcDWload(unsigned int *addr, unsigned int *ret);
void		ppcDWstore(unsigned int *addr, unsigned int *value);
592 593 594 595 596
void disable_addr_trans(void);
void enable_addr_trans(void);
#if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
void ddr_enable_ecc(unsigned int dram_size);
#endif
597 598
#endif

599 600 601 602 603 604
/*
 * Return the current value of a monotonically increasing microsecond timer.
 * Granularity may be larger than 1us if hardware does not support this.
 */
ulong timer_get_us(void);

W
wdenk 已提交
605
/* $(CPU)/cpu.c */
606 607 608 609 610 611 612 613 614 615 616 617 618
static inline int cpumask_next(int cpu, unsigned int mask)
{
	for (cpu++; !((1 << cpu) & mask); cpu++)
		;

	return cpu;
}

#define for_each_cpu(iter, cpu, num_cpus, mask) \
	for (iter = 0, cpu = cpumask_next(-1, mask); \
		iter < num_cpus; \
		iter++, cpu = cpumask_next(cpu, mask)) \

619
int	cpu_numcores  (void);
620 621
u32	cpu_mask      (void);
int	is_core_valid (unsigned int);
622
int	probecpu      (void);
W
wdenk 已提交
623 624 625 626 627
int	checkcpu      (void);
int	checkicache   (void);
int	checkdcache   (void);
void	upmconfig     (unsigned int, unsigned int *, unsigned int);
ulong	get_tbclk     (void);
W
wdenk 已提交
628
void	reset_cpu     (ulong addr);
629 630 631 632 633 634 635
#if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
void ft_cpu_setup(void *blob, bd_t *bd);
#ifdef CONFIG_PCI
void ft_pci_setup(void *blob, bd_t *bd);
#endif
#endif

636 637
void smp_set_core_boot_addr(unsigned long addr, int corenr);
void smp_kick_all_cpus(void);
W
wdenk 已提交
638 639 640 641 642

/* $(CPU)/serial.c */
int	serial_init   (void);
void	serial_setbrg (void);
void	serial_putc   (const char);
W
wdenk 已提交
643
void	serial_putc_raw(const char);
W
wdenk 已提交
644 645 646 647
void	serial_puts   (const char *);
int	serial_getc   (void);
int	serial_tstc   (void);

W
wdenk 已提交
648 649 650 651 652 653 654
void	_serial_setbrg (const int);
void	_serial_putc   (const char, const int);
void	_serial_putc_raw(const char, const int);
void	_serial_puts   (const char *, const int);
int	_serial_getc   (const int);
int	_serial_tstc   (const int);

W
wdenk 已提交
655 656
/* $(CPU)/speed.c */
int	get_clocks (void);
657 658
int	get_clocks_866 (void);
int	sdram_adjust_866 (void);
659
int	adjust_sdram_tbs_8xx (void);
W
wdenk 已提交
660 661
#if defined(CONFIG_8260)
int	prt_8260_clks (void);
E
Eran Liberty 已提交
662
#elif defined(CONFIG_MPC5xxx)
663 664
int	prt_mpc5xxx_clks (void);
#endif
W
wdenk 已提交
665 666 667 668
#ifdef CONFIG_4xx
ulong	get_OPB_freq (void);
ulong	get_PCI_freq (void);
#endif
669 670
#if defined(CONFIG_S3C24X0) || \
    defined(CONFIG_LH7A40X) || \
671
    defined(CONFIG_EP93XX)
W
wdenk 已提交
672 673 674 675 676
ulong	get_FCLK (void);
ulong	get_HCLK (void);
ulong	get_PCLK (void);
ulong	get_UCLK (void);
#endif
W
wdenk 已提交
677 678 679
#if defined(CONFIG_LH7A40X)
ulong	get_PLLCLK (void);
#endif
680
#if defined CONFIG_INCA_IP
681
uint	incaip_get_cpuclk (void);
682
#endif
W
wdenk 已提交
683 684 685 686 687 688 689 690 691
#if defined(CONFIG_IMX)
ulong get_systemPLLCLK(void);
ulong get_FCLK(void);
ulong get_HCLK(void);
ulong get_BCLK(void);
ulong get_PERCLK1(void);
ulong get_PERCLK2(void);
ulong get_PERCLK3(void);
#endif
W
wdenk 已提交
692
ulong	get_bus_freq  (ulong);
693
int get_serial_clock(void);
W
wdenk 已提交
694

695 696 697
#if defined(CONFIG_MPC83xx) || defined(CONFIG_MPC85xx)
ulong get_ddr_freq(ulong);
#endif
W
wdenk 已提交
698 699
#if defined(CONFIG_MPC85xx)
typedef MPC85xx_SYS_INFO sys_info_t;
700
void	get_sys_info  ( sys_info_t * );
W
wdenk 已提交
701
#endif
702 703 704
#if defined(CONFIG_MPC86xx)
typedef MPC86xx_SYS_INFO sys_info_t;
void   get_sys_info  ( sys_info_t * );
705 706 707 708
static inline ulong get_ddr_freq(ulong dummy)
{
	return get_bus_freq(dummy);
}
709
#endif
W
wdenk 已提交
710

S
Stefan Roese 已提交
711
#if defined(CONFIG_4xx)
W
wdenk 已提交
712
#  if defined(CONFIG_440)
713 714 715 716
#	if defined(CONFIG_440SPE)
	 unsigned long determine_sysper(void);
	 unsigned long determine_pci_clock_per(void);
#	endif
W
wdenk 已提交
717
#  endif
718
typedef PPC4xx_SYS_INFO sys_info_t;
719
int	ppc440spe_revB(void);
720
void	get_sys_info  ( sys_info_t * );
W
wdenk 已提交
721 722 723 724 725 726
#endif

/* $(CPU)/cpu_init.c */
#if defined(CONFIG_8xx) || defined(CONFIG_8260)
void	cpu_init_f    (volatile immap_t *immr);
#endif
727
#if defined(CONFIG_4xx) || defined(CONFIG_MPC85xx) || defined(CONFIG_MCF52x2) ||defined(CONFIG_MPC86xx)
W
wdenk 已提交
728 729
void	cpu_init_f    (void);
#endif
W
wdenk 已提交
730

W
wdenk 已提交
731 732 733
int	cpu_init_r    (void);
#if defined(CONFIG_8260)
int	prt_8260_rsr  (void);
734
#elif defined(CONFIG_MPC83xx)
735
int	prt_83xx_rsr  (void);
W
wdenk 已提交
736 737 738
#endif

/* $(CPU)/interrupts.c */
739 740
int	interrupt_init	   (void);
void	timer_interrupt	   (struct pt_regs *);
W
wdenk 已提交
741 742 743 744 745
void	external_interrupt (struct pt_regs *);
void	irq_install_handler(int, interrupt_handler_t *, void *);
void	irq_free_handler   (int);
void	reset_timer	   (void);
ulong	get_timer	   (ulong base);
S
Simon Glass 已提交
746 747 748 749

/* Return value of monotonic microsecond timer */
unsigned long timer_get_us(void);

W
wdenk 已提交
750 751 752 753 754 755 756 757 758
void	enable_interrupts  (void);
int	disable_interrupts (void);

/* $(CPU)/.../commproc.c */
int	dpram_init (void);
uint	dpram_base(void);
uint	dpram_base_align(uint align);
uint	dpram_alloc(uint size);
uint	dpram_alloc_align(uint size,uint align);
759 760 761
void	bootcount_store (ulong);
ulong	bootcount_load (void);
#define BOOTCOUNT_MAGIC		0xB001C041
W
wdenk 已提交
762 763

/* $(CPU)/.../<eth> */
W
Wolfgang Denk 已提交
764
void mii_init (void);
W
wdenk 已提交
765 766 767 768 769 770 771

/* $(CPU)/.../lcd.c */
ulong	lcd_setmem (ulong);

/* $(CPU)/.../video.c */
ulong	video_setmem (ulong);

772
/* arch/$(ARCH)/lib/cache.c */
773
void	enable_caches(void);
W
wdenk 已提交
774
void	flush_cache   (unsigned long, unsigned long);
775
void	flush_dcache_all(void);
776 777
void	flush_dcache_range(unsigned long start, unsigned long stop);
void	invalidate_dcache_range(unsigned long start, unsigned long stop);
778 779
void	invalidate_dcache_all(void);
void	invalidate_icache_all(void);
780

781
/* arch/$(ARCH)/lib/ticks.S */
W
wdenk 已提交
782 783 784
unsigned long long get_ticks(void);
void	wait_ticks    (unsigned long);

785
/* arch/$(ARCH)/lib/time.c */
786
void	__udelay      (unsigned long);
W
wdenk 已提交
787 788 789 790
ulong	usec2ticks    (unsigned long usec);
ulong	ticks2usec    (unsigned long ticks);
int	init_timebase (void);

P
Peter Tyser 已提交
791
/* lib/gunzip.c */
792 793 794 795
int gunzip(void *, int, unsigned char *, unsigned long *);
int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
						int stoponerr, int offset);

796 797 798
/* lib/qsort.c */
void qsort(void *base, size_t nmemb, size_t size,
	   int(*compar)(const void *, const void *));
799
int strcmp_compar(const void *, const void *);
800

P
Peter Tyser 已提交
801
/* lib/time.c */
802
void	udelay        (unsigned long);
803
void mdelay(unsigned long);
804

805 806 807 808
/* lib/uuid.c */
void uuid_str_to_bin(const char *uuid, unsigned char *out);
int uuid_str_valid(const char *uuid);

P
Peter Tyser 已提交
809
/* lib/vsprintf.c */
810
#include <vsprintf.h>
W
wdenk 已提交
811

P
Peter Tyser 已提交
812
/* lib/strmhz.c */
813
char *	strmhz(char *buf, unsigned long hz);
814

P
Peter Tyser 已提交
815
/* lib/crc32.c */
816
#include <u-boot/crc.h>
W
wdenk 已提交
817

M
Michael Walle 已提交
818
/* lib/rand.c */
819 820 821
#if defined(CONFIG_RANDOM_MACADDR) || \
	defined(CONFIG_BOOTP_RANDOM_DELAY) || \
	defined(CONFIG_CMD_LINK_LOCAL)
M
Michael Walle 已提交
822 823 824 825 826 827
#define RAND_MAX -1U
void srand(unsigned int seed);
unsigned int rand(void);
unsigned int rand_r(unsigned int *seedp);
#endif

W
wdenk 已提交
828 829 830
/* common/console.c */
int	console_init_f(void);	/* Before relocation; uses the serial  stuff	*/
int	console_init_r(void);	/* After  relocation; uses the console stuff	*/
831
int	console_assign(int file, const char *devname);	/* Assign the console	*/
W
wdenk 已提交
832 833 834 835 836 837 838 839 840
int	ctrlc (void);
int	had_ctrlc (void);	/* have we had a Control-C since last clear? */
void	clear_ctrlc (void);	/* clear the Control-C condition */
int	disable_ctrlc (int);	/* 1 to disable, 0 to enable Control-C detect */

/*
 * STDIO based functions (can always be used)
 */
/* serial stuff */
841
int	serial_printf (const char *fmt, ...)
A
Andrew Klossner 已提交
842
		__attribute__ ((format (__printf__, 1, 2)));
W
wdenk 已提交
843 844 845 846 847 848 849
/* stdin */
int	getc(void);
int	tstc(void);

/* stdout */
void	putc(const char c);
void	puts(const char *s);
850
int	printf(const char *fmt, ...)
A
Andrew Klossner 已提交
851
		__attribute__ ((format (__printf__, 1, 2)));
852
int	vprintf(const char *fmt, va_list args);
W
wdenk 已提交
853 854 855 856 857 858 859 860 861 862 863 864 865 866

/* stderr */
#define eputc(c)		fputc(stderr, c)
#define eputs(s)		fputs(stderr, s)
#define eprintf(fmt,args...)	fprintf(stderr,fmt ,##args)

/*
 * FILE based functions (can only be used AFTER relocation!)
 */
#define stdin		0
#define stdout		1
#define stderr		2
#define MAX_FILES	3

867
int	fprintf(int file, const char *fmt, ...)
A
Andrew Klossner 已提交
868
		__attribute__ ((format (__printf__, 2, 3)));
W
wdenk 已提交
869 870 871 872 873
void	fputs(int file, const char *s);
void	fputc(int file, const char c);
int	ftstc(int file);
int	fgetc(int file);

L
Lei Wen 已提交
874 875 876 877 878 879 880
/* lib/gzip.c */
int gzip(void *dst, unsigned long *lenp,
		unsigned char *src, unsigned long srclen);
int zzip(void *dst, unsigned long *lenp, unsigned char *src,
		unsigned long srclen, int stoponerr,
		int (*func)(unsigned long, unsigned long));

881 882 883 884 885 886 887
/* lib/net_utils.c */
#include <net.h>
static inline IPaddr_t getenv_IPaddr(char *var)
{
	return string_to_ip(getenv(var));
}

888 889 890 891 892 893 894
/*
 * CONSOLE multiplexing.
 */
#ifdef CONFIG_CONSOLE_MUX
#include <iomux.h>
#endif

W
wdenk 已提交
895 896
int	pcmcia_init (void);

897 898 899
#ifdef CONFIG_STATUS_LED
# include <status_led.h>
#endif
900 901

#include <bootstage.h>
W
wdenk 已提交
902

903 904 905 906
#ifdef CONFIG_SHOW_ACTIVITY
void show_activity(int arg);
#endif

907 908 909 910
/* Multicore arch functions */
#ifdef CONFIG_MP
int cpu_status(int nr);
int cpu_reset(int nr);
911
int cpu_disable(int nr);
912
int cpu_release(int nr, int argc, char * const argv[]);
913 914
#endif

915 916 917 918 919 920 921 922 923 924
/* Define a null map_sysmem() if the architecture doesn't use it */
# ifndef CONFIG_ARCH_MAP_SYSMEM
static inline void *map_sysmem(phys_addr_t paddr, unsigned long len)
{
	return (void *)(uintptr_t)paddr;
}

static inline void unmap_sysmem(const void *vaddr)
{
}
925 926 927 928 929

static inline phys_addr_t map_to_sysmem(void *ptr)
{
	return (phys_addr_t)(uintptr_t)ptr;
}
930 931
# endif

932 933
#endif /* __ASSEMBLY__ */

934 935 936 937 938 939 940 941
#ifdef CONFIG_PPC
/*
 * Has to be included outside of the #ifndef __ASSEMBLY__ section.
 * Otherwise might lead to compilation errors in assembler files.
 */
#include <asm/cache.h>
#endif

942 943 944 945
/* Put only stuff here that the assembler can digest */

#ifdef CONFIG_POST
#define CONFIG_HAS_POST
M
Michael Zaidman 已提交
946 947 948
#ifndef CONFIG_POST_ALT_LIST
#define CONFIG_POST_STD_LIST
#endif
949 950
#endif

W
wdenk 已提交
951
#ifdef CONFIG_INIT_CRITICAL
W
Wolfgang Denk 已提交
952
#error CONFIG_INIT_CRITICAL is deprecated!
W
wdenk 已提交
953 954 955
#error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
#endif

956 957
#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))

958
#define ROUND(a,b)		(((a) + (b) - 1) & ~((b) - 1))
959 960 961
#define DIV_ROUND(n,d)		(((n) + ((d)/2)) / (d))
#define DIV_ROUND_UP(n,d)	(((n) + (d) - 1) / (d))
#define roundup(x, y)		((((x) + ((y) - 1)) / (y)) * (y))
962

A
Andy Fleming 已提交
963 964 965
#define ALIGN(x,a)		__ALIGN_MASK((x),(typeof(x))(a)-1)
#define __ALIGN_MASK(x,mask)	(((x)+(mask))&~(mask))

966 967 968 969 970 971 972 973
/*
 * ARCH_DMA_MINALIGN is defined in asm/cache.h for each architecture.  It
 * is used to align DMA buffers.
 */
#ifndef __ASSEMBLY__
#include <asm/cache.h>
#endif

974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
/*
 * The ALLOC_CACHE_ALIGN_BUFFER macro is used to allocate a buffer on the
 * stack that meets the minimum architecture alignment requirements for DMA.
 * Such a buffer is useful for DMA operations where flushing and invalidating
 * the cache before and after a read and/or write operation is required for
 * correct operations.
 *
 * When called the macro creates an array on the stack that is sized such
 * that:
 *
 * 1) The beginning of the array can be advanced enough to be aligned.
 *
 * 2) The size of the aligned portion of the array is a multiple of the minimum
 *    architecture alignment required for DMA.
 *
 * 3) The aligned portion contains enough space for the original number of
 *    elements requested.
 *
 * The macro then creates a pointer to the aligned portion of this array and
 * assigns to the pointer the address of the first element in the aligned
 * portion of the array.
 *
 * Calling the macro as:
 *
 *     ALLOC_CACHE_ALIGN_BUFFER(uint32_t, buffer, 1024);
 *
 * Will result in something similar to saying:
 *
 *     uint32_t    buffer[1024];
 *
 * The following differences exist:
 *
 * 1) The resulting buffer is guaranteed to be aligned to the value of
 *    ARCH_DMA_MINALIGN.
 *
 * 2) The buffer variable created by the macro is a pointer to the specified
 *    type, and NOT an array of the specified type.  This can be very important
 *    if you want the address of the buffer, which you probably do, to pass it
 *    to the DMA hardware.  The value of &buffer is different in the two cases.
 *    In the macro case it will be the address of the pointer, not the address
 *    of the space reserved for the buffer.  However, in the second case it
 *    would be the address of the buffer.  So if you are replacing hard coded
 *    stack buffers with this macro you need to make sure you remove the & from
 *    the locations where you are taking the address of the buffer.
 *
 * Note that the size parameter is the number of array elements to allocate,
 * not the number of bytes.
 *
 * This macro can not be used outside of function scope, or for the creation
 * of a function scoped static buffer.  It can not be used to create a cache
 * line aligned global buffer.
 */
1026
#define PAD_COUNT(s, pad) (((s) - 1) / (pad) + 1)
1027 1028
#define PAD_SIZE(s, pad) (PAD_COUNT(s, pad) * pad)
#define ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, pad)		\
1029
	char __##name[ROUND(PAD_SIZE((size) * sizeof(type), pad), align)  \
1030
		      + (align - 1)];					\
1031 1032
									\
	type *name = (type *) ALIGN((uintptr_t)__##name, align)
1033 1034 1035 1036
#define ALLOC_ALIGN_BUFFER(type, name, size, align)		\
	ALLOC_ALIGN_BUFFER_PAD(type, name, size, align, 1)
#define ALLOC_CACHE_ALIGN_BUFFER_PAD(type, name, size, pad)		\
	ALLOC_ALIGN_BUFFER_PAD(type, name, size, ARCH_DMA_MINALIGN, pad)
1037
#define ALLOC_CACHE_ALIGN_BUFFER(type, name, size)			\
1038 1039 1040 1041 1042 1043 1044 1045 1046
	ALLOC_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)

/*
 * DEFINE_CACHE_ALIGN_BUFFER() is similar to ALLOC_CACHE_ALIGN_BUFFER, but it's
 * purpose is to allow allocating aligned buffers outside of function scope.
 * Usage of this macro shall be avoided or used with extreme care!
 */
#define DEFINE_ALIGN_BUFFER(type, name, size, align)			\
	static char __##name[roundup(size * sizeof(type), align)]	\
1047
			__aligned(align);				\
1048
									\
1049 1050 1051
	static type *name = (type *)__##name
#define DEFINE_CACHE_ALIGN_BUFFER(type, name, size)			\
	DEFINE_ALIGN_BUFFER(type, name, size, ARCH_DMA_MINALIGN)
1052

1053 1054 1055 1056 1057
/* Pull in stuff for the build system */
#ifdef DO_DEPS_ONLY
# include <environment.h>
#endif

W
wdenk 已提交
1058
#endif	/* __COMMON_H_ */