]> git.ipfire.org Git - people/ms/u-boot.git/blame - include/common.h
ns16550: move CONFIG_SYS_NS16550 to Kconfig
[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>
cba1da49 26#include <linux/kernel.h>
a821d08d 27#if defined(CONFIG_PCI) && defined(CONFIG_4xx)
e2211743
WD
28#include <pci.h>
29#endif
180d3f74 30#if defined(CONFIG_8xx)
e2211743 31#include <asm/8xx_immap.h>
03f9d7d1
MY
32#if defined(CONFIG_MPC859) || defined(CONFIG_MPC859T) || \
33 defined(CONFIG_MPC866) || \
d4ca31c4 34 defined(CONFIG_MPC866P)
d0b8feef 35# define CONFIG_MPC866_FAMILY 1
0ace4d9d 36#elif defined(CONFIG_MPC885)
d0b8feef 37# define CONFIG_MPC885_FAMILY 1
180d3f74
WD
38#endif
39#if defined(CONFIG_MPC860) \
40 || defined(CONFIG_MPC860T) \
1114257c
WD
41 || defined(CONFIG_MPC866_FAMILY) \
42 || defined(CONFIG_MPC885_FAMILY)
d0b8feef 43# define CONFIG_MPC86x 1
2535d602 44#endif
0db5bca8
WD
45#elif defined(CONFIG_5xx)
46#include <asm/5xx_immap.h>
7e6bf358
WD
47#elif defined(CONFIG_MPC5xxx)
48#include <mpc5xxx.h>
8993e54b 49#elif defined(CONFIG_MPC512X)
8993e54b 50#include <asm/immap_512x.h>
58dac327 51#elif defined(CONFIG_MPC8260)
04a85b3b 52#if defined(CONFIG_MPC8247) \
04a85b3b 53 || defined(CONFIG_MPC8272)
d0b8feef 54#define CONFIG_MPC8272_FAMILY 1
04a85b3b 55#endif
e2211743
WD
56#include <asm/immap_8260.h>
57#endif
debb7354
JL
58#ifdef CONFIG_MPC86xx
59#include <mpc86xx.h>
60#include <asm/immap_86xx.h>
61#endif
42d1f039
WD
62#ifdef CONFIG_MPC85xx
63#include <mpc85xx.h>
64#include <asm/immap_85xx.h>
65#endif
0f898604 66#ifdef CONFIG_MPC83xx
f046ccd1
EL
67#include <mpc83xx.h>
68#include <asm/immap_83xx.h>
69#endif
e2211743 70#ifdef CONFIG_4xx
b36df561 71#include <asm/ppc4xx.h>
e2211743 72#endif
6cfcce67
MF
73#ifdef CONFIG_BLACKFIN
74#include <asm/blackfin.h>
75#endif
2819e136
SN
76#ifdef CONFIG_SOC_DA8XX
77#include <asm/arch/hardware.h>
78#endif
9f3183d2
MH
79#ifdef CONFIG_FSL_LSCH3
80#include <asm/arch/immap_lsch3.h>
81#endif
8281c58f
MH
82#ifdef CONFIG_FSL_LSCH2
83#include <asm/arch/immap_lsch2.h>
84#endif
e2211743
WD
85
86#include <part.h>
87#include <flash.h>
88#include <image.h>
89
4166ecb2
GB
90/* Bring in printf format macros if inttypes.h is included */
91#define __STDC_FORMAT_MACROS
92
4d1fd7f1
YS
93#ifdef __LP64__
94#define CONFIG_SYS_SUPPORT_64BIT_DATA
95#endif
96
21726a7a 97#ifdef DEBUG
88a85fb9 98#define _DEBUG 1
21726a7a 99#else
88a85fb9 100#define _DEBUG 0
21726a7a
SG
101#endif
102
be25d875
TR
103#ifndef pr_fmt
104#define pr_fmt(fmt) fmt
105#endif
106
88a85fb9
MV
107/*
108 * Output a debug text when condition "cond" is met. The "cond" should be
109 * computed by a preprocessor in the best case, allowing for the best
110 * optimization.
111 */
be25d875
TR
112#define debug_cond(cond, fmt, args...) \
113 do { \
114 if (cond) \
115 printf(pr_fmt(fmt), ##args); \
88a85fb9
MV
116 } while (0)
117
118#define debug(fmt, args...) \
119 debug_cond(_DEBUG, fmt, ##args)
120
21726a7a
SG
121/*
122 * An assertion is run-time check done in debug mode only. If DEBUG is not
123 * defined then it is skipped. If DEBUG is defined and the assertion fails,
124 * then it calls panic*( which may or may not reset/halt U-Boot (see
125 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
126 * before release, and after release it is hoped that they don't matter. But
127 * in any case these failing assertions cannot be fixed with a reset (which
128 * may just do the same assertion again).
129 */
130void __assert_fail(const char *assertion, const char *file, unsigned line,
131 const char *function);
132#define assert(x) \
133 ({ if (!(x) && _DEBUG) \
134 __assert_fail(#x, __FILE__, __LINE__, __func__); })
135
594d57d0 136#define error(fmt, args...) do { \
be25d875 137 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
594d57d0
MK
138 ##args, __FILE__, __LINE__, __func__); \
139} while (0)
140
cfa460ad 141#ifndef BUG
43835aac 142#define BUG() do { \
511d0c72 143 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
43835aac
DZ
144 panic("BUG!"); \
145} while (0)
146#define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
cfa460ad 147#endif /* BUG */
43835aac 148
c00e17c7
HS
149/* Force a compilation error if condition is true */
150#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
151
c83bf6a2 152typedef void (interrupt_handler_t)(void *);
e2211743 153
c83bf6a2 154#include <asm/u-boot.h> /* boot information for Linux kernel */
e2211743
WD
155#include <asm/global_data.h> /* global data used for startup functions */
156
71f95118
WD
157/*
158 * enable common handling for all TQM8xxL/M boards:
11d9eec4 159 * - CONFIG_TQM8xxM will be defined for all TQM8xxM boards
71f95118 160 * - CONFIG_TQM8xxL will be defined for all TQM8xxL _and_ TQM8xxM boards
11d9eec4 161 * and for the TQM885D board
71f95118
WD
162 */
163#if defined(CONFIG_TQM823M) || defined(CONFIG_TQM850M) || \
164 defined(CONFIG_TQM855M) || defined(CONFIG_TQM860M) || \
11d9eec4 165 defined(CONFIG_TQM862M) || defined(CONFIG_TQM866M)
71f95118
WD
166# ifndef CONFIG_TQM8xxM
167# define CONFIG_TQM8xxM
168# endif
169#endif
e2211743 170#if defined(CONFIG_TQM823L) || defined(CONFIG_TQM850L) || \
d126bfbd 171 defined(CONFIG_TQM855L) || defined(CONFIG_TQM860L) || \
11d9eec4
MK
172 defined(CONFIG_TQM862L) || defined(CONFIG_TQM8xxM) || \
173 defined(CONFIG_TQM885D)
e2211743
WD
174# ifndef CONFIG_TQM8xxL
175# define CONFIG_TQM8xxL
176# endif
177#endif
178
3fbeeea6
HS
179#if defined(CONFIG_ENV_IS_EMBEDDED)
180#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
181#elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
182 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
183 defined(CONFIG_ENV_IS_IN_NVRAM)
184#define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
185#else
186#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
187#endif
c7de829c 188
e2211743
WD
189/*
190 * Function Prototypes
191 */
0267ba5d 192int dram_init(void);
e2211743 193
c83bf6a2 194void hang (void) __attribute__ ((noreturn));
e2211743 195
f6c019c4
WD
196int timer_init(void);
197int cpu_init(void);
198
e2211743 199/* */
9973e3c6 200phys_size_t initdram (int);
c6da9ae8 201
2ea09c83 202#include <display_options.h>
e2211743
WD
203
204/* common/main.c */
205void main_loop (void);
009dde19 206int run_command(const char *cmd, int flag);
1d43bfd2 207int run_command_repeatable(const char *cmd, int flag);
d51004a8
SG
208
209/**
210 * Run a list of commands separated by ; or even \0
211 *
212 * Note that if 'len' is not -1, then the command does not need to be nul
213 * terminated, Memory will be allocated for the command in that case.
214 *
215 * @param cmd List of commands to run, each separated bu semicolon
216 * @param len Length of commands excluding terminator if known (-1 if not)
217 * @param flag Execution flags (CMD_FLAG_...)
218 * @return 0 on success, or != 0 on error.
219 */
220int run_command_list(const char *cmd, int len, int flag);
e2211743 221
ea0364f1 222/* arch/$(ARCH)/lib/board.c */
0365ffcc
MY
223void board_init_f(ulong);
224void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
1fed87db
SG
225
226/**
227 * board_init_f_mem() - Allocate global data and set stack position
228 *
229 * This function is called by each architecture very early in the start-up
230 * code to set up the environment for board_init_f(). It allocates space for
231 * global_data (see include/asm-generic/global_data.h) and places the stack
232 * below this.
233 *
234 * This function requires a stack[1] Normally this is at @top. The function
235 * starts allocating space from 64 bytes below @top. First it creates space
236 * for global_data. Then it calls arch_setup_gd() which sets gd to point to
237 * the global_data space and can reserve additional bytes of space if
238 * required). Finally it allocates early malloc() memory
239 * (CONFIG_SYS_MALLOC_F_LEN). The new top of the stack is just below this,
240 * and it returned by this function.
241 *
242 * [1] Strictly speaking it would be possible to implement this function
243 * in C on many archs such that it does not require a stack. However this
244 * does not seem hugely important as only 64 byte are wasted. The 64 bytes
245 * are used to handle the calling standard which generally requires pushing
246 * addresses or registers onto the stack. We should be able to get away with
247 * less if this becomes important.
248 *
249 * @top: Top of available memory, also normally the top of the stack
250 * @return: New stack location
251 */
252ulong board_init_f_mem(ulong top);
253
254/**
255 * arch_setup_gd() - Set up the global_data pointer
256 *
257 * This pointer is special in some architectures and cannot easily be assigned
258 * to. For example on x86 it is implemented by adding a specific record to its
259 * Global Descriptor Table! So we we provide a function to carry out this task.
260 * For most architectures this can simply be:
261 *
262 * gd = gd_ptr;
263 *
264 * @gd_ptr: Pointer to global data
265 */
266void arch_setup_gd(gd_t *gd_ptr);
267
0365ffcc
MY
268int checkboard(void);
269int show_board_info(void);
270int checkflash(void);
271int checkdram(void);
272int last_stage_init(void);
3b57fe0a 273extern ulong monitor_flash_len;
bea3f28d 274int mac_read_from_eeprom(void);
6ab6b2af 275extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
8f5d4687 276int set_cpu_clk_info(void);
9272a9b4 277int mdm_init(void);
365475e6 278#if defined(CONFIG_DISPLAY_CPUINFO)
1938f4a5 279int print_cpuinfo(void);
365475e6
MY
280#else
281static inline int print_cpuinfo(void)
282{
283 return 0;
284}
285#endif
c2240d4d 286int update_flash_size(int flash_size);
2c072c95 287int arch_early_init_r(void);
e2211743 288
d4c671cc
SG
289/**
290 * arch_cpu_init_dm() - init CPU after driver model is available
291 *
292 * This is called immediately after driver model is available before
293 * relocation. This is similar to arch_cpu_init() but is able to reference
294 * devices
295 *
296 * @return 0 if OK, -ve on error
297 */
298int arch_cpu_init_dm(void);
299
68145d4c
AB
300/**
301 * Reserve all necessary stacks
302 *
303 * This is used in generic board init sequence in common/board_f.c. Each
304 * architecture could provide this function to tailor the required stacks.
305 *
306 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
307 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
308 * require only this can leave it untouched.
309 *
310 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
311 * positions of the stack. The stack pointer(s) will be set to this later.
312 * gd->irq_sp is only required, if the architecture needs it.
313 *
314 * @return 0 if no error
315 */
316__weak int arch_reserve_stacks(void);
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 */
ea11b401 325void board_show_dram(phys_size_t size);
15a33e49 326
13d06981 327/**
e29607ed 328 * arch_fixup_fdt() - Write arch-specific information to fdt
13d06981 329 *
e29607ed 330 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
13d06981
SG
331 *
332 * @blob: FDT blob to write to
333 * @return 0 if ok, or -ve FDT_ERR_... on failure
334 */
e29607ed 335int arch_fixup_fdt(void *blob);
13d06981 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);
20f86a0a
SG
363
364/* Avoid unfortunate conflict with libc's getenv() */
365#ifdef CONFIG_SANDBOX
366#define getenv uboot_getenv
367#endif
84b5e802
WD
368char *getenv (const char *);
369int getenv_f (const char *name, char *buf, unsigned len);
4a9b4131 370ulong getenv_ulong(const char *name, int base, ulong default_val);
76b8f79c
SG
371
372/**
373 * getenv_hex() - Return an environment variable as a hex value
374 *
375 * Decode an environment as a hex number (it may or may not have a 0x
376 * prefix). If the environment variable cannot be found, or does not start
377 * with hex digits, the default value is returned.
378 *
379 * @varname: Variable to decode
380 * @default_val: Value to return on error
381 */
382ulong getenv_hex(const char *varname, ulong default_val);
383
ec8a252c
JH
384/*
385 * Read an environment variable as a boolean
386 * Return -1 if variable does not exist (default to true)
387 */
388int getenv_yesno(const char *var);
c83bf6a2 389int saveenv (void);
84b5e802 390int setenv (const char *, const char *);
d67f10ce 391int setenv_ulong(const char *varname, ulong value);
bfc59966
SG
392int setenv_hex(const char *varname, ulong value);
393/**
394 * setenv_addr - Set an environment variable to an address in hex
395 *
1bce2aeb 396 * @varname: Environment variable to set
bfc59966
SG
397 * @addr: Value to set it to
398 * @return 0 if ok, 1 on error
399 */
400static inline int setenv_addr(const char *varname, const void *addr)
401{
402 return setenv_hex(varname, (ulong)addr);
403}
404
e2211743 405#ifdef CONFIG_ARM
96085e34 406# include <asm/mach-types.h>
b6e4c403 407# include <asm/setup.h>
e2211743
WD
408# include <asm/u-boot-arm.h> /* ARM version to be fixed! */
409#endif /* CONFIG_ARM */
fea25720
GR
410#ifdef CONFIG_X86 /* x86 version to be fixed! */
411# include <asm/u-boot-x86.h>
412#endif /* CONFIG_X86 */
744d9859
SG
413#ifdef CONFIG_SANDBOX
414# include <asm/u-boot-sandbox.h> /* TODO(sjg) what needs to be fixed? */
415#endif
e7083844
ML
416#ifdef CONFIG_NDS32
417# include <asm/mach-types.h>
e3c58b02 418# include <asm/setup.h>
e7083844
ML
419# include <asm/u-boot-nds32.h>
420#endif /* CONFIG_NDS32 */
e034ea3b
DS
421#ifdef CONFIG_MIPS
422# include <asm/u-boot-mips.h>
423#endif /* CONFIG_MIPS */
bc5d5428
AB
424#ifdef CONFIG_ARC
425# include <asm/u-boot-arc.h>
426#endif /* CONFIG_ARC */
e2211743 427
04a85b3b
WD
428#ifdef CONFIG_AUTO_COMPLETE
429int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
430#endif
2f70c49e 431int get_env_id (void);
04a85b3b 432
c83bf6a2
WD
433void pci_init (void);
434void pci_init_board(void);
435void pciinfo (int, int);
e2211743 436
a821d08d 437#if defined(CONFIG_PCI) && defined(CONFIG_4xx)
c71103f9
MF
438 int pci_pre_init (struct pci_controller *);
439 int is_pci_host (struct pci_controller *);
466fff1a
SR
440#endif
441
dbbd1257 442#if defined(CONFIG_PCI) && (defined(CONFIG_440) || defined(CONFIG_405EX))
6d0f6bcf 443# if defined(CONFIG_SYS_PCI_TARGET_INIT)
c83bf6a2 444 void pci_target_init (struct pci_controller *);
e2211743 445# endif
6d0f6bcf 446# if defined(CONFIG_SYS_PCI_MASTER_INIT)
c83bf6a2 447 void pci_master_init (struct pci_controller *);
e2211743 448# endif
6f2eb3f3
SR
449#if defined(CONFIG_440SPE) || \
450 defined(CONFIG_460EX) || defined(CONFIG_460GT) || \
451 defined(CONFIG_405EX)
7f191393 452 void pcie_setup_hoses(int busno);
692519b1 453#endif
e2211743
WD
454#endif
455
456int misc_init_f (void);
457int misc_init_r (void);
458
27b207fd
WD
459/* common/exports.c */
460void jumptable_init(void);
461
ecb1dc89
MF
462/* common/kallsysm.c */
463const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
464
500856eb
RJ
465/* api/api.c */
466void api_init (void);
467
c83bf6a2 468/* common/memsize.c */
a55d23cc 469long get_ram_size (long *, long);
e3866163 470phys_size_t get_effective_memsize(void);
c83bf6a2 471
e2211743
WD
472/* $(BOARD)/$(BOARD).c */
473void reset_phy (void);
c83bf6a2 474void fdc_hw_init (void);
e2211743
WD
475
476/* $(BOARD)/eeprom.c */
477void eeprom_init (void);
6dd652fa
WD
478#ifndef CONFIG_SPI
479int eeprom_probe (unsigned dev_addr, unsigned offset);
480#endif
e2211743
WD
481int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
482int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
e2211743
WD
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 503/* $(BOARD)/$(BOARD).c */
c837dcb1
WD
504int board_early_init_f (void);
505int board_late_init (void);
e2211743 506int board_postclk_init (void); /* after clocks/timebase, before env/serial */
c837dcb1 507int board_early_init_r (void);
e2211743
WD
508void board_poweroff (void);
509
6d0f6bcf 510#if defined(CONFIG_SYS_DRAM_TEST)
e2211743 511int testdram(void);
6d0f6bcf 512#endif /* CONFIG_SYS_DRAM_TEST */
e2211743
WD
513
514/* $(CPU)/start.S */
c83bf6a2 515#if defined(CONFIG_5xx) || \
0db5bca8 516 defined(CONFIG_8xx)
e2211743
WD
517uint get_immr (uint);
518#endif
36c72877
WD
519#if defined(CONFIG_MPC5xxx)
520uint get_svr (void);
521#endif
e2211743 522uint get_pvr (void);
547b4cb2 523uint get_svr (void);
e2211743
WD
524uint rd_ic_cst (void);
525void wr_ic_cst (uint);
526void wr_ic_adr (uint);
527uint rd_dc_cst (void);
528void wr_dc_cst (uint);
529void wr_dc_adr (uint);
530int icache_status (void);
531void icache_enable (void);
532void icache_disable(void);
533int dcache_status (void);
534void dcache_enable (void);
535void dcache_disable(void);
2c451f78 536void mmu_disable(void);
5c6db120
BT
537#if defined(CONFIG_ARM)
538void relocate_code(ulong);
539#else
540void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
959eaa74 541#endif
e2211743
WD
542ulong get_endaddr (void);
543void trap_init (ulong);
544#if defined (CONFIG_4xx) || \
eeb1b77b 545 defined (CONFIG_MPC5xxx) || \
cd94ba39 546 defined (CONFIG_MPC85xx) || \
debb7354 547 defined (CONFIG_MPC86xx) || \
0f898604 548 defined (CONFIG_MPC83xx)
c83bf6a2
WD
549unsigned char in8(unsigned int);
550void out8(unsigned int, unsigned char);
551unsigned short in16(unsigned int);
552unsigned short in16r(unsigned int);
553void out16(unsigned int, unsigned short value);
554void out16r(unsigned int, unsigned short value);
555unsigned long in32(unsigned int);
556unsigned long in32r(unsigned int);
557void out32(unsigned int, unsigned long value);
558void out32r(unsigned int, unsigned long value);
559void ppcDcbf(unsigned long value);
560void ppcDcbi(unsigned long value);
561void ppcSync(void);
0ac6f8b7 562void ppcDcbz(unsigned long value);
e2211743 563#endif
0643631a
MS
564#if defined (CONFIG_MICROBLAZE)
565unsigned short in16(unsigned int);
566void out16(unsigned int, unsigned short value);
567#endif
e2211743 568
0f898604 569#if defined (CONFIG_MPC83xx)
90f30a71
DL
570void ppcDWload(unsigned int *addr, unsigned int *ret);
571void ppcDWstore(unsigned int *addr, unsigned int *value);
7c6db910
HS
572void disable_addr_trans(void);
573void enable_addr_trans(void);
574#if defined(CONFIG_DDR_ECC) && !defined(CONFIG_ECC_INIT_VIA_DDRCONTROLLER)
575void ddr_enable_ecc(unsigned int dram_size);
576#endif
90f30a71
DL
577#endif
578
fc9ae1ba
RS
579/*
580 * Return the current value of a monotonically increasing microsecond timer.
581 * Granularity may be larger than 1us if hardware does not support this.
582 */
583ulong timer_get_us(void);
584
e2211743 585/* $(CPU)/cpu.c */
fbb9ecf7
TT
586static inline int cpumask_next(int cpu, unsigned int mask)
587{
588 for (cpu++; !((1 << cpu) & mask); cpu++)
589 ;
590
591 return cpu;
592}
593
594#define for_each_cpu(iter, cpu, num_cpus, mask) \
595 for (iter = 0, cpu = cpumask_next(-1, mask); \
596 iter < num_cpus; \
597 iter++, cpu = cpumask_next(cpu, mask)) \
598
0e870980 599int cpu_numcores (void);
b8bf0adc 600int cpu_num_dspcores(void);
fbb9ecf7 601u32 cpu_mask (void);
b8bf0adc 602u32 cpu_dsp_mask(void);
fbb9ecf7 603int is_core_valid (unsigned int);
0e870980 604int probecpu (void);
e2211743
WD
605int checkcpu (void);
606int checkicache (void);
607int checkdcache (void);
608void upmconfig (unsigned int, unsigned int *, unsigned int);
609ulong get_tbclk (void);
1fb4dab2 610void reset_misc (void);
3ec924a3 611void reset_cpu (ulong addr);
6a16e0df
KP
612#if defined (CONFIG_OF_LIBFDT) && defined (CONFIG_OF_BOARD_SETUP)
613void ft_cpu_setup(void *blob, bd_t *bd);
614#ifdef CONFIG_PCI
615void ft_pci_setup(void *blob, bd_t *bd);
616#endif
617#endif
618
ba6a1698
AP
619void smp_set_core_boot_addr(unsigned long addr, int corenr);
620void smp_kick_all_cpus(void);
e2211743
WD
621
622/* $(CPU)/serial.c */
623int serial_init (void);
624void serial_setbrg (void);
625void serial_putc (const char);
756f586a 626void serial_putc_raw(const char);
e2211743 627void serial_puts (const char *);
e2211743
WD
628int serial_getc (void);
629int serial_tstc (void);
630
709ea543
SG
631/* These versions take a stdio_dev pointer */
632struct stdio_dev;
633int serial_stub_getc(struct stdio_dev *sdev);
634int serial_stub_tstc(struct stdio_dev *sdev);
635
e2211743
WD
636/* $(CPU)/speed.c */
637int get_clocks (void);
c178d3da
WD
638int get_clocks_866 (void);
639int sdram_adjust_866 (void);
e9132ea9 640int adjust_sdram_tbs_8xx (void);
58dac327 641#if defined(CONFIG_MPC8260)
e2211743 642int prt_8260_clks (void);
f046ccd1 643#elif defined(CONFIG_MPC5xxx)
945af8d7
WD
644int prt_mpc5xxx_clks (void);
645#endif
e2211743
WD
646#ifdef CONFIG_4xx
647ulong get_OPB_freq (void);
648ulong get_PCI_freq (void);
649#endif
ac67804f 650#if defined(CONFIG_S3C24X0) || \
651 defined(CONFIG_LH7A40X) || \
fcfb632b 652 defined(CONFIG_EP93XX)
e2211743
WD
653ulong get_FCLK (void);
654ulong get_HCLK (void);
655ulong get_PCLK (void);
656ulong get_UCLK (void);
657#endif
f39748ae
WD
658#if defined(CONFIG_LH7A40X)
659ulong get_PLLCLK (void);
660#endif
281e00a3
WD
661#if defined(CONFIG_IMX)
662ulong get_systemPLLCLK(void);
663ulong get_FCLK(void);
664ulong get_HCLK(void);
665ulong get_BCLK(void);
666ulong get_PERCLK1(void);
667ulong get_PERCLK2(void);
668ulong get_PERCLK3(void);
669#endif
e2211743 670ulong get_bus_freq (ulong);
550650dd 671int get_serial_clock(void);
e2211743 672
42d1f039
WD
673#if defined(CONFIG_MPC85xx)
674typedef MPC85xx_SYS_INFO sys_info_t;
c83bf6a2 675void get_sys_info ( sys_info_t * );
871a57bb
MY
676# if defined(CONFIG_OF_LIBFDT)
677 void ft_fixup_cpu(void *, u64);
678 void ft_fixup_num_cores(void *);
679# endif
42d1f039 680#endif
debb7354
JL
681#if defined(CONFIG_MPC86xx)
682typedef MPC86xx_SYS_INFO sys_info_t;
683void get_sys_info ( sys_info_t * );
5df4b0ad
KG
684static inline ulong get_ddr_freq(ulong dummy)
685{
686 return get_bus_freq(dummy);
687}
2f78eae5
YS
688#else
689ulong get_ddr_freq(ulong);
debb7354 690#endif
42d1f039 691
99bcad18 692#if defined(CONFIG_4xx)
e2211743 693# if defined(CONFIG_440)
6c5879f3
MB
694# if defined(CONFIG_440SPE)
695 unsigned long determine_sysper(void);
696 unsigned long determine_pci_clock_per(void);
697# endif
e2211743 698# endif
087dfdb7 699typedef PPC4xx_SYS_INFO sys_info_t;
f31d38b9 700int ppc440spe_revB(void);
c83bf6a2 701void get_sys_info ( sys_info_t * );
e2211743
WD
702#endif
703
704/* $(CPU)/cpu_init.c */
58dac327 705#if defined(CONFIG_8xx) || defined(CONFIG_MPC8260)
e2211743
WD
706void cpu_init_f (volatile immap_t *immr);
707#endif
701e6401 708#if defined(CONFIG_4xx) || defined(CONFIG_MCF52x2) || defined(CONFIG_MPC86xx)
e2211743
WD
709void cpu_init_f (void);
710#endif
701e6401
YS
711#ifdef CONFIG_MPC85xx
712ulong cpu_init_f(void);
713#endif
bf9e3b38 714
e2211743 715int cpu_init_r (void);
58dac327 716#if defined(CONFIG_MPC8260)
e2211743 717int prt_8260_rsr (void);
0f898604 718#elif defined(CONFIG_MPC83xx)
9be39a67 719int prt_83xx_rsr (void);
e2211743
WD
720#endif
721
722/* $(CPU)/interrupts.c */
c83bf6a2
WD
723int interrupt_init (void);
724void timer_interrupt (struct pt_regs *);
e2211743
WD
725void external_interrupt (struct pt_regs *);
726void irq_install_handler(int, interrupt_handler_t *, void *);
727void irq_free_handler (int);
728void reset_timer (void);
729ulong get_timer (ulong base);
b2e16a85
SG
730
731/* Return value of monotonic microsecond timer */
732unsigned long timer_get_us(void);
733
e2211743
WD
734void enable_interrupts (void);
735int disable_interrupts (void);
736
737/* $(CPU)/.../commproc.c */
738int dpram_init (void);
739uint dpram_base(void);
740uint dpram_base_align(uint align);
741uint dpram_alloc(uint size);
742uint dpram_alloc_align(uint size,uint align);
bdccc4fe
WD
743void bootcount_store (ulong);
744ulong bootcount_load (void);
745#define BOOTCOUNT_MAGIC 0xB001C041
e2211743
WD
746
747/* $(CPU)/.../<eth> */
c5bded3c 748void mii_init (void);
e2211743
WD
749
750/* $(CPU)/.../lcd.c */
751ulong lcd_setmem (ulong);
752
e2211743
WD
753/* $(CPU)/.../video.c */
754ulong video_setmem (ulong);
755
ea0364f1 756/* arch/$(ARCH)/lib/cache.c */
cba4b180 757void enable_caches(void);
e2211743 758void flush_cache (unsigned long, unsigned long);
2c451f78 759void flush_dcache_all(void);
03d3bfb0
SR
760void flush_dcache_range(unsigned long start, unsigned long stop);
761void invalidate_dcache_range(unsigned long start, unsigned long stop);
2c451f78
A
762void invalidate_dcache_all(void);
763void invalidate_icache_all(void);
0db5bca8 764
4d24a11e
SG
765enum {
766 /* Disable caches (else flush caches but leave them active) */
767 CBL_DISABLE_CACHES = 1 << 0,
768 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
769
770 CBL_ALL = 3,
771};
772
773/**
774 * Clean up ready for linux
775 *
776 * @param flags Flags to control what is done
777 */
778int cleanup_before_linux_select(int flags);
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
918e9ebb
EN
795/**
796 * gzwrite progress indicators: defined weak to allow board-specific
797 * overrides:
798 *
799 * gzwrite_progress_init called on startup
800 * gzwrite_progress called during decompress/write loop
801 * gzwrite_progress_finish called at end of loop to
802 * indicate success (retcode=0) or failure
803 */
804void gzwrite_progress_init(u64 expected_size);
805
806void gzwrite_progress(int iteration,
807 u64 bytes_written,
808 u64 total_bytes);
809
810void gzwrite_progress_finish(int retcode,
811 u64 totalwritten,
812 u64 totalsize,
813 u32 expected_crc,
814 u32 calculated_crc);
815
816/**
817 * decompress and write gzipped image from memory to block device
818 *
819 * @param src compressed image address
820 * @param len compressed image length in bytes
821 * @param dev block device descriptor
822 * @param szwritebuf bytes per write (pad to erase size)
823 * @param startoffs offset in bytes of first write
824 * @param szexpected expected uncompressed length
825 * may be zero to use gzip trailer
826 * for files under 4GiB
827 */
828int gzwrite(unsigned char *src, int len,
829 struct block_dev_desc *dev,
830 unsigned long szwritebuf,
831 u64 startoffs,
832 u64 szexpected);
833
027b728d
JW
834/* lib/lz4_wrapper.c */
835int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
836
54c6977e
WD
837/* lib/qsort.c */
838void qsort(void *base, size_t nmemb, size_t size,
839 int(*compar)(const void *, const void *));
560d424b 840int strcmp_compar(const void *, const void *);
54c6977e 841
78acc472 842/* lib/time.c */
3eb90bad 843void udelay (unsigned long);
c4c9fbeb 844void mdelay(unsigned long);
3eb90bad 845
e11938ea 846/* lib/uuid.c */
d718ded0 847#include <uuid.h>
e11938ea 848
78acc472 849/* lib/vsprintf.c */
9785c905 850#include <vsprintf.h>
e2211743 851
78acc472 852/* lib/strmhz.c */
55f7934d 853char * strmhz(char *buf, unsigned long hz);
0768b7a8 854
78acc472 855/* lib/crc32.c */
449609f5 856#include <u-boot/crc.h>
e2211743 857
9acf1ca5 858/* lib/rand.c */
9acf1ca5
MW
859#define RAND_MAX -1U
860void srand(unsigned int seed);
861unsigned int rand(void);
862unsigned int rand_r(unsigned int *seedp);
9acf1ca5 863
e2211743
WD
864/*
865 * STDIO based functions (can always be used)
866 */
e2211743 867/* serial stuff */
d9c27253 868int serial_printf (const char *fmt, ...)
dc4b0b38 869 __attribute__ ((format (__printf__, 1, 2)));
e2211743
WD
870/* stdin */
871int getc(void);
872int tstc(void);
873
874/* stdout */
80402f34
HS
875#if defined(CONFIG_SPL_BUILD) && !defined(CONFIG_SPL_SERIAL_SUPPORT)
876#define putc(...) do { } while (0)
877#define puts(...) do { } while (0)
878#define printf(...) do { } while (0)
879#define vprintf(...) do { } while (0)
880#else
e2211743
WD
881void putc(const char c);
882void puts(const char *s);
d9c27253 883int printf(const char *fmt, ...)
dc4b0b38 884 __attribute__ ((format (__printf__, 1, 2)));
d9c27253 885int vprintf(const char *fmt, va_list args);
80402f34 886#endif
e2211743
WD
887
888/* stderr */
889#define eputc(c) fputc(stderr, c)
890#define eputs(s) fputs(stderr, s)
891#define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
892
893/*
894 * FILE based functions (can only be used AFTER relocation!)
895 */
e2211743
WD
896#define stdin 0
897#define stdout 1
898#define stderr 2
899#define MAX_FILES 3
900
d9c27253 901int fprintf(int file, const char *fmt, ...)
dc4b0b38 902 __attribute__ ((format (__printf__, 2, 3)));
e2211743
WD
903void fputs(int file, const char *s);
904void fputc(int file, const char c);
905int ftstc(int file);
906int fgetc(int file);
907
88d52c6a
LW
908/* lib/gzip.c */
909int gzip(void *dst, unsigned long *lenp,
910 unsigned char *src, unsigned long srclen);
911int zzip(void *dst, unsigned long *lenp, unsigned char *src,
912 unsigned long srclen, int stoponerr,
913 int (*func)(unsigned long, unsigned long));
914
4ef8d53c
JH
915/* lib/net_utils.c */
916#include <net.h>
049a95a7 917static inline struct in_addr getenv_ip(char *var)
4ef8d53c
JH
918{
919 return string_to_ip(getenv(var));
920}
921
e2211743
WD
922int pcmcia_init (void);
923
fb364bec
WD
924#ifdef CONFIG_STATUS_LED
925# include <status_led.h>
926#endif
097e1783
SG
927
928#include <bootstage.h>
e2211743 929
48522bb5
JH
930#ifdef CONFIG_SHOW_ACTIVITY
931void show_activity(int arg);
932#endif
933
fcd3c87e
WD
934/* Multicore arch functions */
935#ifdef CONFIG_MP
936int cpu_status(int nr);
937int cpu_reset(int nr);
4194b366 938int cpu_disable(int nr);
54841ab5 939int cpu_release(int nr, int argc, char * const argv[]);
fcd3c87e
WD
940#endif
941
942#endif /* __ASSEMBLY__ */
943
13e95e42
SR
944#ifdef CONFIG_PPC
945/*
946 * Has to be included outside of the #ifndef __ASSEMBLY__ section.
947 * Otherwise might lead to compilation errors in assembler files.
948 */
949#include <asm/cache.h>
950#endif
951
fcd3c87e
WD
952/* Put only stuff here that the assembler can digest */
953
954#ifdef CONFIG_POST
955#define CONFIG_HAS_POST
800eb096
MZ
956#ifndef CONFIG_POST_ALT_LIST
957#define CONFIG_POST_STD_LIST
958#endif
fcd3c87e
WD
959#endif
960
8aa1a2d1 961#ifdef CONFIG_INIT_CRITICAL
2f6fa46d 962#error CONFIG_INIT_CRITICAL is deprecated!
8aa1a2d1
WD
963#error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
964#endif
965
155cfb5e 966#define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
4b03ac8b 967
c9689ca3
SG
968/*
969 * check_member() - Check the offset of a structure member
970 *
971 * @structure: Name of structure (e.g. global_data)
972 * @member: Name of member (e.g. baudrate)
973 * @offset: Expected offset in bytes
974 */
975#define check_member(structure, member, offset) _Static_assert( \
976 offsetof(struct structure, member) == offset, \
977 "`struct " #structure "` offset for `" #member "` is not " #offset)
978
476476e7
SG
979/* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
980#ifdef CONFIG_EFI_STUB
981#define ll_boot_init() false
982#else
983#define ll_boot_init() true
984#endif
985
c3eb3fe4
MF
986/* Pull in stuff for the build system */
987#ifdef DO_DEPS_ONLY
988# include <environment.h>
989#endif
990
e2211743 991#endif /* __COMMON_H_ */