blob: 638c45b954d22a2df3e704e010ee8c90dd20a90e [file] [log] [blame]
wdenke2211742002-11-02 23:30:20 +00001/*
Wolfgang Denkf342f862009-05-16 10:47:45 +02002 * (C) Copyright 2000-2009
wdenke2211742002-11-02 23:30:20 +00003 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
Wolfgang Denkbd8ec7e2013-10-07 13:07:26 +02005 * SPDX-License-Identifier: GPL-2.0+
wdenke2211742002-11-02 23:30:20 +00006 */
7
8#ifndef __COMMON_H_
Wolfgang Denkbcbd5212012-01-06 07:36:44 +01009#define __COMMON_H_ 1
wdenke2211742002-11-02 23:30:20 +000010
Wolfgang Denk66e8d442009-07-24 00:17:48 +020011#ifndef __ASSEMBLY__ /* put C only stuff in this section */
12
wdenke2211742002-11-02 23:30:20 +000013typedef unsigned char uchar;
14typedef volatile unsigned long vu_long;
wdenkad276f22004-01-04 16:28:35 +000015typedef volatile unsigned short vu_short;
wdenke2211742002-11-02 23:30:20 +000016typedef volatile unsigned char vu_char;
17
Andre Przywara9fcee532017-01-02 11:48:30 +000018/* Allow sharing constants with type modifiers between C and assembly. */
19#define _AC(X, Y) (X##Y)
20
wdenke2211742002-11-02 23:30:20 +000021#include <config.h>
Joe Hershbergercbf1a932016-04-04 04:07:33 -050022#include <errno.h>
Masahiro Yamadaa4f0b8e2016-12-28 00:36:00 +090023#include <time.h>
Wolfgang Denk0191e472010-10-26 14:34:52 +020024#include <asm-offsets.h>
wdenke2211742002-11-02 23:30:20 +000025#include <linux/bitops.h>
Masahiro Yamada29d2a622016-12-28 00:35:59 +090026#include <linux/delay.h>
wdenke2211742002-11-02 23:30:20 +000027#include <linux/types.h>
28#include <linux/string.h>
Marek Vasuta3f16342012-09-27 17:08:15 +020029#include <linux/stringify.h>
wdenke2211742002-11-02 23:30:20 +000030#include <asm/ptrace.h>
31#include <stdarg.h>
Masahiro Yamadabd426622014-11-07 03:03:28 +090032#include <linux/kernel.h>
Simon Glass76135792017-05-17 08:23:05 -060033
wdenke2211742002-11-02 23:30:20 +000034#include <part.h>
35#include <flash.h>
36#include <image.h>
37
Gabe Black690fb812014-10-15 04:38:31 -060038/* Bring in printf format macros if inttypes.h is included */
39#define __STDC_FORMAT_MACROS
40
York Sun6c480012014-02-26 17:03:19 -080041#ifdef __LP64__
42#define CONFIG_SYS_SUPPORT_64BIT_DATA
43#endif
44
Simon Glass02aa9e62011-06-29 09:49:34 +000045#ifdef DEBUG
Marek Vasut2c5910c2011-10-24 23:41:42 +000046#define _DEBUG 1
Simon Glass02aa9e62011-06-29 09:49:34 +000047#else
Marek Vasut2c5910c2011-10-24 23:41:42 +000048#define _DEBUG 0
Simon Glass02aa9e62011-06-29 09:49:34 +000049#endif
50
Simon Glasse558f6a2016-06-19 19:43:04 -060051#ifdef CONFIG_SPL_BUILD
52#define _SPL_BUILD 1
53#else
54#define _SPL_BUILD 0
55#endif
56
Simon Glass1ec1c3a2016-06-19 19:43:03 -060057/* Define this at the top of a file to add a prefix to debug messages */
Thierry Reding09cf4cd2014-11-12 18:26:50 -070058#ifndef pr_fmt
59#define pr_fmt(fmt) fmt
60#endif
61
Simon Glass02aa9e62011-06-29 09:49:34 +000062/*
Marek Vasut2c5910c2011-10-24 23:41:42 +000063 * Output a debug text when condition "cond" is met. The "cond" should be
64 * computed by a preprocessor in the best case, allowing for the best
65 * optimization.
66 */
Thierry Reding09cf4cd2014-11-12 18:26:50 -070067#define debug_cond(cond, fmt, args...) \
68 do { \
69 if (cond) \
70 printf(pr_fmt(fmt), ##args); \
Marek Vasut2c5910c2011-10-24 23:41:42 +000071 } while (0)
72
Simon Glass1ec1c3a2016-06-19 19:43:03 -060073/* Show a message if DEBUG is defined in a file */
Marek Vasut2c5910c2011-10-24 23:41:42 +000074#define debug(fmt, args...) \
75 debug_cond(_DEBUG, fmt, ##args)
76
Simon Glasse558f6a2016-06-19 19:43:04 -060077/* Show a message if not in SPL */
78#define warn_non_spl(fmt, args...) \
79 debug_cond(!_SPL_BUILD, fmt, ##args)
80
Marek Vasut2c5910c2011-10-24 23:41:42 +000081/*
Simon Glass02aa9e62011-06-29 09:49:34 +000082 * An assertion is run-time check done in debug mode only. If DEBUG is not
83 * defined then it is skipped. If DEBUG is defined and the assertion fails,
84 * then it calls panic*( which may or may not reset/halt U-Boot (see
85 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
86 * before release, and after release it is hoped that they don't matter. But
87 * in any case these failing assertions cannot be fixed with a reset (which
88 * may just do the same assertion again).
89 */
90void __assert_fail(const char *assertion, const char *file, unsigned line,
91 const char *function);
92#define assert(x) \
93 ({ if (!(x) && _DEBUG) \
94 __assert_fail(#x, __FILE__, __LINE__, __func__); })
95
Matthias Kaehlcke3b8d1a42010-01-31 17:39:49 +010096#define error(fmt, args...) do { \
Thierry Reding09cf4cd2014-11-12 18:26:50 -070097 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
Matthias Kaehlcke3b8d1a42010-01-31 17:39:49 +010098 ##args, __FILE__, __LINE__, __func__); \
99} while (0)
100
William Juul52c07962007-10-31 13:53:06 +0100101#ifndef BUG
Detlev Zundel1d75a772006-09-01 11:59:23 +0200102#define BUG() do { \
Wolfgang Denk4df0da52006-10-09 00:42:01 +0200103 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
Detlev Zundel1d75a772006-09-01 11:59:23 +0200104 panic("BUG!"); \
105} while (0)
106#define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
William Juul52c07962007-10-31 13:53:06 +0100107#endif /* BUG */
Detlev Zundel1d75a772006-09-01 11:59:23 +0200108
wdenk87249ba2004-01-06 22:38:14 +0000109typedef void (interrupt_handler_t)(void *);
wdenke2211742002-11-02 23:30:20 +0000110
wdenk87249ba2004-01-06 22:38:14 +0000111#include <asm/u-boot.h> /* boot information for Linux kernel */
wdenke2211742002-11-02 23:30:20 +0000112#include <asm/global_data.h> /* global data used for startup functions */
113
Heiko Schochereeedb862010-09-17 13:10:34 +0200114#if defined(CONFIG_ENV_IS_EMBEDDED)
115#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
116#elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
117 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
118 defined(CONFIG_ENV_IS_IN_NVRAM)
119#define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
120#else
121#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
122#endif
wdenk452cfd62002-11-19 11:04:11 +0000123
124/*
wdenke2211742002-11-02 23:30:20 +0000125 * Function Prototypes
126 */
Michal Simekef932b02015-01-30 10:51:46 +0100127int dram_init(void);
wdenke2211742002-11-02 23:30:20 +0000128
Simon Glass4096e3a2017-03-31 08:40:33 -0600129/**
130 * dram_init_banksize() - Set up DRAM bank sizes
131 *
132 * This can be implemented by boards to set up the DRAM bank information in
133 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
134 * is called.
135 *
136 * If this is not provided, a default implementation will try to set up a
137 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
138 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
139 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
140 * get_effective_memsize().
141 *
142 * @return 0 if OK, -ve on error
143 */
144int dram_init_banksize(void);
145
wdenk87249ba2004-01-06 22:38:14 +0000146void hang (void) __attribute__ ((noreturn));
wdenke2211742002-11-02 23:30:20 +0000147
Wolfgang Denk75fc4342011-07-30 12:32:45 +0000148int timer_init(void);
149int cpu_init(void);
150
Simon Glass7da617c2015-04-28 20:25:07 -0600151#include <display_options.h>
wdenke2211742002-11-02 23:30:20 +0000152
153/* common/main.c */
154void main_loop (void);
Simon Glass8161d042012-02-14 19:59:20 +0000155int run_command(const char *cmd, int flag);
Thomas Betkerbe6346b2014-06-05 20:07:57 +0200156int run_command_repeatable(const char *cmd, int flag);
Simon Glassa6642e02012-03-30 21:30:55 +0000157
158/**
159 * Run a list of commands separated by ; or even \0
160 *
161 * Note that if 'len' is not -1, then the command does not need to be nul
162 * terminated, Memory will be allocated for the command in that case.
163 *
164 * @param cmd List of commands to run, each separated bu semicolon
165 * @param len Length of commands excluding terminator if known (-1 if not)
166 * @param flag Execution flags (CMD_FLAG_...)
167 * @return 0 on success, or != 0 on error.
168 */
169int run_command_list(const char *cmd, int len, int flag);
wdenke2211742002-11-02 23:30:20 +0000170
Peter Tysercede5d82010-04-12 22:28:04 -0500171/* arch/$(ARCH)/lib/board.c */
Masahiro Yamada9607f7a2015-01-14 17:07:05 +0900172void board_init_f(ulong);
173void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
Simon Glass08ef3052015-08-10 20:44:30 -0600174
175/**
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100176 * ulong board_init_f_alloc_reserve - allocate reserved area
Simon Glass08ef3052015-08-10 20:44:30 -0600177 *
178 * This function is called by each architecture very early in the start-up
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100179 * code to allow the C runtime to reserve space on the stack for writable
180 * 'globals' such as GD and the malloc arena.
Simon Glass08ef3052015-08-10 20:44:30 -0600181 *
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100182 * @top: top of the reserve area, growing down.
183 * @return: bottom of reserved area
184 */
185ulong board_init_f_alloc_reserve(ulong top);
186
187/**
188 * board_init_f_init_reserve - initialize the reserved area(s)
Simon Glass08ef3052015-08-10 20:44:30 -0600189 *
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100190 * This function is called once the C runtime has allocated the reserved
191 * area on the stack. It must initialize the GD at the base of that area.
Simon Glass08ef3052015-08-10 20:44:30 -0600192 *
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100193 * @base: top from which reservation was done
Simon Glass08ef3052015-08-10 20:44:30 -0600194 */
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100195void board_init_f_init_reserve(ulong base);
Simon Glass08ef3052015-08-10 20:44:30 -0600196
197/**
198 * arch_setup_gd() - Set up the global_data pointer
199 *
200 * This pointer is special in some architectures and cannot easily be assigned
201 * to. For example on x86 it is implemented by adding a specific record to its
202 * Global Descriptor Table! So we we provide a function to carry out this task.
203 * For most architectures this can simply be:
204 *
205 * gd = gd_ptr;
206 *
207 * @gd_ptr: Pointer to global data
208 */
209void arch_setup_gd(gd_t *gd_ptr);
210
Masahiro Yamada9607f7a2015-01-14 17:07:05 +0900211int checkboard(void);
212int show_board_info(void);
213int checkflash(void);
214int checkdram(void);
215int last_stage_init(void);
wdenkb9a83a92003-05-30 12:48:29 +0000216extern ulong monitor_flash_len;
Haiying Wang34c68782006-07-12 10:48:05 -0400217int mac_read_from_eeprom(void);
Masahiro Yamada43c08932014-02-05 11:28:25 +0900218extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
Hadli, Manjunath0dfccbe2012-02-06 00:30:44 +0000219int set_cpu_clk_info(void);
Simon Glasse3a762c2014-04-10 20:01:32 -0600220int mdm_init(void);
Simon Glassc45e3592013-03-11 06:49:53 +0000221int print_cpuinfo(void);
Simon Glass5af29bd2013-03-14 07:20:12 +0000222int update_flash_size(int flash_size);
Simon Glass84640e82014-02-27 13:26:25 -0700223int arch_early_init_r(void);
wdenke2211742002-11-02 23:30:20 +0000224
Simon Glassbbf26ab2017-03-31 08:40:36 -0600225/*
226 * setup_board_extra() - Fill in extra details in the bd_t structure
227 *
228 * @return 0 if OK, -ve on error
229 */
230int setup_board_extra(void);
231
Simon Glasseacd14f2012-11-30 13:01:20 +0000232/**
Simon Glass295c4232017-03-28 10:27:18 -0600233 * arch_fsp_init() - perform firmware support package init
234 *
235 * Where U-Boot relies on binary blobs to handle part of the system init, this
236 * function can be used to set up the blobs. This is used on some Intel
237 * platforms.
238 */
239int arch_fsp_init(void);
240
241/**
Simon Glass7af8d052015-03-05 12:25:16 -0700242 * arch_cpu_init_dm() - init CPU after driver model is available
243 *
244 * This is called immediately after driver model is available before
245 * relocation. This is similar to arch_cpu_init() but is able to reference
246 * devices
247 *
248 * @return 0 if OK, -ve on error
249 */
250int arch_cpu_init_dm(void);
251
252/**
Andreas Bießmann25429862015-02-06 23:06:45 +0100253 * Reserve all necessary stacks
254 *
255 * This is used in generic board init sequence in common/board_f.c. Each
256 * architecture could provide this function to tailor the required stacks.
257 *
258 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
259 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
260 * require only this can leave it untouched.
261 *
262 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
263 * positions of the stack. The stack pointer(s) will be set to this later.
264 * gd->irq_sp is only required, if the architecture needs it.
265 *
266 * @return 0 if no error
267 */
268__weak int arch_reserve_stacks(void);
269
270/**
Simon Glasseacd14f2012-11-30 13:01:20 +0000271 * Show the DRAM size in a board-specific way
272 *
273 * This is used by boards to display DRAM information in their own way.
274 *
275 * @param size Size of DRAM (which should be displayed along with other info)
276 */
Andrew Bradfordec9dbc92015-05-22 08:30:14 -0400277void board_show_dram(phys_size_t size);
Simon Glasseacd14f2012-11-30 13:01:20 +0000278
Simon Glass9ca37422013-05-08 08:06:01 +0000279/**
Ma Haijun62358242014-07-12 14:24:06 +0100280 * arch_fixup_fdt() - Write arch-specific information to fdt
Simon Glass9ca37422013-05-08 08:06:01 +0000281 *
Ma Haijun62358242014-07-12 14:24:06 +0100282 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
Simon Glass9ca37422013-05-08 08:06:01 +0000283 *
284 * @blob: FDT blob to write to
285 * @return 0 if ok, or -ve FDT_ERR_... on failure
286 */
Ma Haijun62358242014-07-12 14:24:06 +0100287int arch_fixup_fdt(void *blob);
Simon Glass9ca37422013-05-08 08:06:01 +0000288
wdenke2211742002-11-02 23:30:20 +0000289/* common/flash.c */
290void flash_perror (int);
291
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200292/* common/cmd_source.c */
293int source (ulong addr, const char *fit_uname);
wdenke2211742002-11-02 23:30:20 +0000294
wdenk87249ba2004-01-06 22:38:14 +0000295extern ulong load_addr; /* Default Load Address */
Simon Glass34f52292011-10-21 18:51:38 +0000296extern ulong save_addr; /* Default Save Address */
297extern ulong save_size; /* Default Save Size */
wdenke2211742002-11-02 23:30:20 +0000298
Jason Hobbs0e3a5932011-08-31 10:37:30 -0500299/* common/cmd_net.c */
300int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
301
Rob Herringeee675f2012-05-25 10:47:39 +0000302/* common/cmd_fat.c */
303int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
304
305/* common/cmd_ext2.c */
306int do_ext2load(cmd_tbl_t *, int, int, char * const []);
307
wdenke2211742002-11-02 23:30:20 +0000308/* common/cmd_nvedit.c */
309int env_init (void);
310void env_relocate (void);
Rafal Jaworowski75b54422008-01-09 18:05:27 +0100311int envmatch (uchar *, int);
Simon Glasse128a4e2014-02-27 13:26:21 -0700312
313/* Avoid unfortunate conflict with libc's getenv() */
314#ifdef CONFIG_SANDBOX
315#define getenv uboot_getenv
316#endif
Wolfgang Denkd67abff2011-07-29 14:42:18 +0200317char *getenv (const char *);
318int getenv_f (const char *name, char *buf, unsigned len);
Simon Glassbf690f82011-10-14 13:25:18 +0000319ulong getenv_ulong(const char *name, int base, ulong default_val);
Simon Glassabbd5122013-04-20 08:42:43 +0000320
321/**
322 * getenv_hex() - Return an environment variable as a hex value
323 *
324 * Decode an environment as a hex number (it may or may not have a 0x
325 * prefix). If the environment variable cannot be found, or does not start
326 * with hex digits, the default value is returned.
327 *
328 * @varname: Variable to decode
329 * @default_val: Value to return on error
330 */
331ulong getenv_hex(const char *varname, ulong default_val);
332
Joe Hershberger864ec562012-12-11 22:16:22 -0600333/*
334 * Read an environment variable as a boolean
335 * Return -1 if variable does not exist (default to true)
336 */
337int getenv_yesno(const char *var);
wdenk87249ba2004-01-06 22:38:14 +0000338int saveenv (void);
Wolfgang Denkd67abff2011-07-29 14:42:18 +0200339int setenv (const char *, const char *);
Simon Glassb8e926e2011-10-24 17:59:59 +0000340int setenv_ulong(const char *varname, ulong value);
Simon Glass044dc9e2013-02-24 17:33:21 +0000341int setenv_hex(const char *varname, ulong value);
342/**
343 * setenv_addr - Set an environment variable to an address in hex
344 *
Robert P. J. Day832d36e2013-09-16 07:15:45 -0400345 * @varname: Environment variable to set
Simon Glass044dc9e2013-02-24 17:33:21 +0000346 * @addr: Value to set it to
347 * @return 0 if ok, 1 on error
348 */
349static inline int setenv_addr(const char *varname, const void *addr)
350{
351 return setenv_hex(varname, (ulong)addr);
352}
353
wdenk3902d702004-04-15 18:22:41 +0000354#ifdef CONFIG_AUTO_COMPLETE
355int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
356#endif
Heiko Schocher0c303fa2009-02-10 09:38:52 +0100357int get_env_id (void);
wdenk3902d702004-04-15 18:22:41 +0000358
wdenk87249ba2004-01-06 22:38:14 +0000359void pci_init (void);
360void pci_init_board(void);
wdenke2211742002-11-02 23:30:20 +0000361
wdenke2211742002-11-02 23:30:20 +0000362int misc_init_f (void);
363int misc_init_r (void);
364
wdenk874ac262003-07-24 23:38:38 +0000365/* common/exports.c */
366void jumptable_init(void);
367
Mike Frysingera46fbba2009-05-20 04:35:14 -0400368/* common/kallsysm.c */
369const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
370
wdenk87249ba2004-01-06 22:38:14 +0000371/* common/memsize.c */
Albert ARIBAUDa9606732011-07-03 05:55:33 +0000372long get_ram_size (long *, long);
York Sun863e8d82014-02-11 11:57:26 -0800373phys_size_t get_effective_memsize(void);
wdenk87249ba2004-01-06 22:38:14 +0000374
wdenke2211742002-11-02 23:30:20 +0000375/* $(BOARD)/$(BOARD).c */
376void reset_phy (void);
wdenk87249ba2004-01-06 22:38:14 +0000377void fdc_hw_init (void);
wdenke2211742002-11-02 23:30:20 +0000378
379/* $(BOARD)/eeprom.c */
Simon Glass7c5ad8b2017-05-12 21:09:49 -0600380#ifdef CONFIG_CMD_EEPROM
Marek Vasutf422ae72015-11-10 20:53:31 +0100381void eeprom_init (int bus);
wdenke2211742002-11-02 23:30:20 +0000382int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
383int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
Simon Glass7c5ad8b2017-05-12 21:09:49 -0600384#else
385/*
386 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
387 * some macros here so we don't have to touch every one of those uses
388 */
389#define eeprom_init(bus)
390#define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
391#define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
392#endif
wdenke2211742002-11-02 23:30:20 +0000393
394/*
395 * Set this up regardless of board
396 * type, to prevent errors.
397 */
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200398#if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
399# define CONFIG_SYS_DEF_EEPROM_ADDR 0
wdenke2211742002-11-02 23:30:20 +0000400#else
Heiko Schocher9bb0dd52010-01-07 08:55:40 +0100401#if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200402# define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
Heiko Schocher9bb0dd52010-01-07 08:55:40 +0100403#endif
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200404#endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
wdenke2211742002-11-02 23:30:20 +0000405
wdenk0a658552003-08-05 17:43:17 +0000406#if defined(CONFIG_SPI)
wdenke2211742002-11-02 23:30:20 +0000407extern void spi_init_f (void);
408extern void spi_init_r (void);
wdenk87249ba2004-01-06 22:38:14 +0000409extern ssize_t spi_read (uchar *, int, uchar *, int);
wdenke2211742002-11-02 23:30:20 +0000410extern ssize_t spi_write (uchar *, int, uchar *, int);
411#endif
412
wdenke2211742002-11-02 23:30:20 +0000413/* $(BOARD)/$(BOARD).c */
wdenkda55c6e2004-01-20 23:12:12 +0000414int board_early_init_f (void);
mario.six@gdsys.cc7e9b9d62017-02-22 16:07:22 +0100415int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
wdenkda55c6e2004-01-20 23:12:12 +0000416int board_late_init (void);
wdenke2211742002-11-02 23:30:20 +0000417int board_postclk_init (void); /* after clocks/timebase, before env/serial */
wdenkda55c6e2004-01-20 23:12:12 +0000418int board_early_init_r (void);
wdenke2211742002-11-02 23:30:20 +0000419void board_poweroff (void);
420
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200421#if defined(CONFIG_SYS_DRAM_TEST)
wdenke2211742002-11-02 23:30:20 +0000422int testdram(void);
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200423#endif /* CONFIG_SYS_DRAM_TEST */
wdenke2211742002-11-02 23:30:20 +0000424
425/* $(CPU)/start.S */
wdenke2211742002-11-02 23:30:20 +0000426int icache_status (void);
427void icache_enable (void);
428void icache_disable(void);
429int dcache_status (void);
430void dcache_enable (void);
431void dcache_disable(void);
Aneesh V960f5c02011-06-16 23:30:47 +0000432void mmu_disable(void);
Benoît Thébaudeaua0436612013-04-11 09:35:53 +0000433#if defined(CONFIG_ARM)
434void relocate_code(ulong);
435#else
436void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
Benoît Thébaudeau9039c102013-04-11 09:35:43 +0000437#endif
wdenke2211742002-11-02 23:30:20 +0000438ulong get_endaddr (void);
439void trap_init (ulong);
Simon Glass243182c2017-05-17 08:23:06 -0600440
wdenke2211742002-11-02 23:30:20 +0000441/* $(CPU)/cpu.c */
Timur Tabi47289422011-08-05 16:15:24 -0500442static inline int cpumask_next(int cpu, unsigned int mask)
443{
444 for (cpu++; !((1 << cpu) & mask); cpu++)
445 ;
446
447 return cpu;
448}
449
450#define for_each_cpu(iter, cpu, num_cpus, mask) \
451 for (iter = 0, cpu = cpumask_next(-1, mask); \
452 iter < num_cpus; \
453 iter++, cpu = cpumask_next(cpu, mask)) \
454
Poonam Aggrwal4baef822009-07-31 12:08:14 +0530455int cpu_numcores (void);
Shaveta Leekhadbf0bc82015-01-19 12:46:54 +0530456int cpu_num_dspcores(void);
Timur Tabi47289422011-08-05 16:15:24 -0500457u32 cpu_mask (void);
Shaveta Leekhadbf0bc82015-01-19 12:46:54 +0530458u32 cpu_dsp_mask(void);
Timur Tabi47289422011-08-05 16:15:24 -0500459int is_core_valid (unsigned int);
Simon Glass302445a2017-01-23 13:31:22 -0700460
461/**
462 * arch_cpu_init() - basic cpu-dependent setup for an architecture
463 *
464 * This is called after early malloc is available. It should handle any
465 * CPU- or SoC- specific init needed to continue the init sequence. See
466 * board_f.c for where it is called. If this is not provided, a default
467 * version (which does nothing) will be used.
468 */
469int arch_cpu_init(void);
470
wdenke2211742002-11-02 23:30:20 +0000471int checkcpu (void);
472int checkicache (void);
473int checkdcache (void);
474void upmconfig (unsigned int, unsigned int *, unsigned int);
475ulong get_tbclk (void);
Przemyslaw Marczakec1c1222014-09-01 13:50:48 +0200476void reset_misc (void);
wdenk1e8d0c52005-04-03 17:23:39 +0000477void reset_cpu (ulong addr);
Kim Phillipsdc0b59d2007-08-15 22:30:26 -0500478void ft_cpu_setup(void *blob, bd_t *bd);
Kim Phillipsdc0b59d2007-08-15 22:30:26 -0500479void ft_pci_setup(void *blob, bd_t *bd);
Kim Phillipsdc0b59d2007-08-15 22:30:26 -0500480
Andre Przywaradbbe1962013-09-19 18:06:44 +0200481void smp_set_core_boot_addr(unsigned long addr, int corenr);
482void smp_kick_all_cpus(void);
wdenke2211742002-11-02 23:30:20 +0000483
484/* $(CPU)/serial.c */
485int serial_init (void);
486void serial_setbrg (void);
487void serial_putc (const char);
wdenke0c812a2005-04-03 15:51:42 +0000488void serial_putc_raw(const char);
wdenke2211742002-11-02 23:30:20 +0000489void serial_puts (const char *);
wdenke2211742002-11-02 23:30:20 +0000490int serial_getc (void);
491int serial_tstc (void);
492
Simon Glass0d1e1f72014-07-23 06:54:59 -0600493/* These versions take a stdio_dev pointer */
494struct stdio_dev;
495int serial_stub_getc(struct stdio_dev *sdev);
496int serial_stub_tstc(struct stdio_dev *sdev);
497
wdenke2211742002-11-02 23:30:20 +0000498/* $(CPU)/speed.c */
499int get_clocks (void);
wdenke2211742002-11-02 23:30:20 +0000500ulong get_bus_freq (ulong);
Stefan Roese3ddce572010-09-20 16:05:31 +0200501int get_serial_clock(void);
wdenke2211742002-11-02 23:30:20 +0000502
wdenke2211742002-11-02 23:30:20 +0000503int cpu_init_r (void);
wdenke2211742002-11-02 23:30:20 +0000504
505/* $(CPU)/interrupts.c */
wdenk87249ba2004-01-06 22:38:14 +0000506int interrupt_init (void);
507void timer_interrupt (struct pt_regs *);
wdenke2211742002-11-02 23:30:20 +0000508void external_interrupt (struct pt_regs *);
509void irq_install_handler(int, interrupt_handler_t *, void *);
510void irq_free_handler (int);
511void reset_timer (void);
Simon Glassc44b8002013-06-11 11:14:39 -0700512
513/* Return value of monotonic microsecond timer */
514unsigned long timer_get_us(void);
515
wdenke2211742002-11-02 23:30:20 +0000516void enable_interrupts (void);
517int disable_interrupts (void);
518
519/* $(CPU)/.../commproc.c */
520int dpram_init (void);
521uint dpram_base(void);
522uint dpram_base_align(uint align);
523uint dpram_alloc(uint size);
524uint dpram_alloc_align(uint size,uint align);
wdenk0a658552003-08-05 17:43:17 +0000525void bootcount_store (ulong);
526ulong bootcount_load (void);
527#define BOOTCOUNT_MAGIC 0xB001C041
wdenke2211742002-11-02 23:30:20 +0000528
529/* $(CPU)/.../<eth> */
Wolfgang Denk0769f192007-08-29 14:05:30 +0200530void mii_init (void);
wdenke2211742002-11-02 23:30:20 +0000531
532/* $(CPU)/.../lcd.c */
533ulong lcd_setmem (ulong);
534
wdenke2211742002-11-02 23:30:20 +0000535/* $(CPU)/.../video.c */
536ulong video_setmem (ulong);
537
Peter Tysercede5d82010-04-12 22:28:04 -0500538/* arch/$(ARCH)/lib/cache.c */
Aneesh Vfffbb972011-08-16 04:33:05 +0000539void enable_caches(void);
wdenke2211742002-11-02 23:30:20 +0000540void flush_cache (unsigned long, unsigned long);
Aneesh V960f5c02011-06-16 23:30:47 +0000541void flush_dcache_all(void);
Stefan Roese9bf63bf2009-01-21 17:20:20 +0100542void flush_dcache_range(unsigned long start, unsigned long stop);
543void invalidate_dcache_range(unsigned long start, unsigned long stop);
Aneesh V960f5c02011-06-16 23:30:47 +0000544void invalidate_dcache_all(void);
545void invalidate_icache_all(void);
wdenk359733b2003-03-31 17:27:09 +0000546
Simon Glass442e5d72015-05-13 07:02:25 -0600547enum {
548 /* Disable caches (else flush caches but leave them active) */
549 CBL_DISABLE_CACHES = 1 << 0,
550 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
551
552 CBL_ALL = 3,
553};
554
555/**
556 * Clean up ready for linux
557 *
558 * @param flags Flags to control what is done
559 */
560int cleanup_before_linux_select(int flags);
561
Peter Tysercede5d82010-04-12 22:28:04 -0500562/* arch/$(ARCH)/lib/ticks.S */
Simon Glass0e103162014-10-15 04:38:33 -0600563uint64_t get_ticks(void);
wdenke2211742002-11-02 23:30:20 +0000564void wait_ticks (unsigned long);
565
Peter Tysercede5d82010-04-12 22:28:04 -0500566/* arch/$(ARCH)/lib/time.c */
wdenke2211742002-11-02 23:30:20 +0000567ulong usec2ticks (unsigned long usec);
568ulong ticks2usec (unsigned long ticks);
wdenke2211742002-11-02 23:30:20 +0000569
Peter Tyser685b7f52010-04-12 22:28:05 -0500570/* lib/gunzip.c */
Wolfgang Wegner32d15b92009-12-09 15:16:47 +0100571int gunzip(void *, int, unsigned char *, unsigned long *);
572int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
573 int stoponerr, int offset);
574
Eric Nelson5441b042015-02-17 11:30:30 -0700575/**
576 * gzwrite progress indicators: defined weak to allow board-specific
577 * overrides:
578 *
579 * gzwrite_progress_init called on startup
580 * gzwrite_progress called during decompress/write loop
581 * gzwrite_progress_finish called at end of loop to
582 * indicate success (retcode=0) or failure
583 */
584void gzwrite_progress_init(u64 expected_size);
585
586void gzwrite_progress(int iteration,
587 u64 bytes_written,
588 u64 total_bytes);
589
590void gzwrite_progress_finish(int retcode,
591 u64 totalwritten,
592 u64 totalsize,
593 u32 expected_crc,
594 u32 calculated_crc);
595
596/**
597 * decompress and write gzipped image from memory to block device
598 *
599 * @param src compressed image address
600 * @param len compressed image length in bytes
601 * @param dev block device descriptor
602 * @param szwritebuf bytes per write (pad to erase size)
603 * @param startoffs offset in bytes of first write
604 * @param szexpected expected uncompressed length
605 * may be zero to use gzip trailer
606 * for files under 4GiB
607 */
608int gzwrite(unsigned char *src, int len,
Simon Glasse3394752016-02-29 15:25:34 -0700609 struct blk_desc *dev,
Eric Nelson5441b042015-02-17 11:30:30 -0700610 unsigned long szwritebuf,
611 u64 startoffs,
612 u64 szexpected);
613
Julius Wernerf41a3ca2015-10-06 20:03:53 -0700614/* lib/lz4_wrapper.c */
615int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
616
Wolfgang Denk90699222010-06-13 01:45:10 +0200617/* lib/qsort.c */
618void qsort(void *base, size_t nmemb, size_t size,
619 int(*compar)(const void *, const void *));
Mike Frysinger8d882322010-12-17 16:51:59 -0500620int strcmp_compar(const void *, const void *);
Wolfgang Denk90699222010-06-13 01:45:10 +0200621
Jason Hobbs6e39cce2011-08-23 11:06:56 +0000622/* lib/uuid.c */
Przemyslaw Marczak0c813362014-04-02 10:20:03 +0200623#include <uuid.h>
Jason Hobbs6e39cce2011-08-23 11:06:56 +0000624
Peter Tyser685b7f52010-04-12 22:28:05 -0500625/* lib/vsprintf.c */
Simon Glassf7ae68062011-11-02 09:52:07 +0000626#include <vsprintf.h>
wdenke2211742002-11-02 23:30:20 +0000627
Peter Tyser685b7f52010-04-12 22:28:05 -0500628/* lib/strmhz.c */
Ed Swarthoutd065acb2011-03-05 10:28:17 -0600629char * strmhz(char *buf, unsigned long hz);
Haavard Skinnemoenb644d6b2008-08-18 13:41:27 +0200630
Peter Tyser685b7f52010-04-12 22:28:05 -0500631/* lib/crc32.c */
Prafulla Wadaskar4d4d67d2009-08-16 05:28:19 +0530632#include <u-boot/crc.h>
wdenke2211742002-11-02 23:30:20 +0000633
Michael Walled96bd012012-06-05 11:33:14 +0000634/* lib/rand.c */
Michael Walled96bd012012-06-05 11:33:14 +0000635#define RAND_MAX -1U
636void srand(unsigned int seed);
637unsigned int rand(void);
638unsigned int rand_r(unsigned int *seedp);
Michael Walled96bd012012-06-05 11:33:14 +0000639
wdenke2211742002-11-02 23:30:20 +0000640/*
641 * STDIO based functions (can always be used)
642 */
wdenke2211742002-11-02 23:30:20 +0000643/* serial stuff */
Wolfgang Denk318ef5c2010-06-20 17:14:14 +0200644int serial_printf (const char *fmt, ...)
Andrew Klossnere4ad4542008-07-07 06:41:14 -0700645 __attribute__ ((format (__printf__, 1, 2)));
wdenke2211742002-11-02 23:30:20 +0000646/* stdin */
647int getc(void);
648int tstc(void);
649
650/* stdout */
Simon Glass98b685d2016-09-12 23:18:25 -0600651#if !defined(CONFIG_SPL_BUILD) || \
652 (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
653 (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
654 defined(CONFIG_SPL_SERIAL_SUPPORT))
wdenke2211742002-11-02 23:30:20 +0000655void putc(const char c);
656void puts(const char *s);
Wolfgang Denk318ef5c2010-06-20 17:14:14 +0200657int printf(const char *fmt, ...)
Andrew Klossnere4ad4542008-07-07 06:41:14 -0700658 __attribute__ ((format (__printf__, 1, 2)));
Wolfgang Denk318ef5c2010-06-20 17:14:14 +0200659int vprintf(const char *fmt, va_list args);
Simon Glass98b685d2016-09-12 23:18:25 -0600660#else
661#define putc(...) do { } while (0)
662#define puts(...) do { } while (0)
663#define printf(...) do { } while (0)
664#define vprintf(...) do { } while (0)
Heiko Schocher62cb1562015-06-29 09:10:46 +0200665#endif
wdenke2211742002-11-02 23:30:20 +0000666
667/* stderr */
668#define eputc(c) fputc(stderr, c)
669#define eputs(s) fputs(stderr, s)
670#define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
671
672/*
673 * FILE based functions (can only be used AFTER relocation!)
674 */
wdenke2211742002-11-02 23:30:20 +0000675#define stdin 0
676#define stdout 1
677#define stderr 2
678#define MAX_FILES 3
679
Wolfgang Denk318ef5c2010-06-20 17:14:14 +0200680int fprintf(int file, const char *fmt, ...)
Andrew Klossnere4ad4542008-07-07 06:41:14 -0700681 __attribute__ ((format (__printf__, 2, 3)));
wdenke2211742002-11-02 23:30:20 +0000682void fputs(int file, const char *s);
683void fputc(int file, const char c);
684int ftstc(int file);
685int fgetc(int file);
686
Lei Wen7592d1b2012-09-28 04:26:46 +0000687/* lib/gzip.c */
688int gzip(void *dst, unsigned long *lenp,
689 unsigned char *src, unsigned long srclen);
690int zzip(void *dst, unsigned long *lenp, unsigned char *src,
691 unsigned long srclen, int stoponerr,
692 int (*func)(unsigned long, unsigned long));
693
Joe Hershberger05a377b2012-05-23 08:01:04 +0000694/* lib/net_utils.c */
695#include <net.h>
Joe Hershberger5874dec2015-04-08 01:41:01 -0500696static inline struct in_addr getenv_ip(char *var)
Joe Hershberger05a377b2012-05-23 08:01:04 +0000697{
698 return string_to_ip(getenv(var));
699}
700
wdenke2211742002-11-02 23:30:20 +0000701int pcmcia_init (void);
702
Uri Mashiach4892d392017-01-19 10:51:45 +0200703#ifdef CONFIG_LED_STATUS
Wolfgang Denkdf8e2142009-07-27 09:58:14 +0200704# include <status_led.h>
705#endif
Simon Glass8445d002012-01-14 15:24:44 +0000706
707#include <bootstage.h>
wdenke2211742002-11-02 23:30:20 +0000708
Joe Hershberger77001b432012-05-15 08:59:08 +0000709#ifdef CONFIG_SHOW_ACTIVITY
710void show_activity(int arg);
711#endif
712
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200713/* Multicore arch functions */
714#ifdef CONFIG_MP
715int cpu_status(int nr);
716int cpu_reset(int nr);
Kumar Gala006e2c82010-01-12 11:42:43 -0600717int cpu_disable(int nr);
Wolfgang Denk6262d0212010-06-28 22:00:46 +0200718int cpu_release(int nr, int argc, char * const argv[]);
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200719#endif
720
Andre Przywara9fcee532017-01-02 11:48:30 +0000721#else /* __ASSEMBLY__ */
722
723/* Drop a C type modifier (like in 3UL) for constants used in assembly. */
724#define _AC(X, Y) X
725
726#endif /* __ASSEMBLY__ */
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200727
728/* Put only stuff here that the assembler can digest */
729
Andre Przywara9fcee532017-01-02 11:48:30 +0000730/* Declare an unsigned long constant digestable both by C and an assembler. */
731#define UL(x) _AC(x, UL)
732
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200733#ifdef CONFIG_POST
734#define CONFIG_HAS_POST
Michael Zaidmanf969a682010-09-20 08:51:53 +0200735#ifndef CONFIG_POST_ALT_LIST
736#define CONFIG_POST_STD_LIST
737#endif
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200738#endif
739
wdenk3d3d99f2005-04-04 12:44:11 +0000740#ifdef CONFIG_INIT_CRITICAL
Wolfgang Denk5e3a8732006-08-14 23:17:47 +0200741#error CONFIG_INIT_CRITICAL is deprecated!
wdenk3d3d99f2005-04-04 12:44:11 +0000742#error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
743#endif
744
Anton Staaf07a036a2011-09-02 13:45:28 +0000745#define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
Andy Fleming2ef5ed02008-06-16 13:58:53 -0500746
Anton Staafcda2e482011-10-17 16:46:13 -0700747/*
Simon Glassd61718b2015-06-23 15:38:31 -0600748 * check_member() - Check the offset of a structure member
749 *
750 * @structure: Name of structure (e.g. global_data)
751 * @member: Name of member (e.g. baudrate)
752 * @offset: Expected offset in bytes
753 */
754#define check_member(structure, member, offset) _Static_assert( \
755 offsetof(struct structure, member) == offset, \
756 "`struct " #structure "` offset for `" #member "` is not " #offset)
757
Simon Glass63f581f2015-08-04 12:33:52 -0600758/* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
759#ifdef CONFIG_EFI_STUB
760#define ll_boot_init() false
761#else
762#define ll_boot_init() true
763#endif
764
Mike Frysinger63b8f122011-07-08 10:44:25 +0000765/* Pull in stuff for the build system */
766#ifdef DO_DEPS_ONLY
767# include <environment.h>
768#endif
769
wdenke2211742002-11-02 23:30:20 +0000770#endif /* __COMMON_H_ */