blob: ba31727a7979e4fbe5b4b566b8ecf8ca0ec6ccad [file] [log] [blame]
wdenke2211742002-11-02 23:30:20 +00001/*
Wolfgang Denk3b74e7e2009-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 Denk3765b3e2013-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 Denkd0b8fee2012-01-06 07:36:44 +01009#define __COMMON_H_ 1
wdenke2211742002-11-02 23:30:20 +000010
Wolfgang Denkfcd3c872009-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;
wdenk180d3f72004-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 Przywara2a6713b2017-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 Hershberger2307ea42016-04-04 04:07:33 -050022#include <errno.h>
Masahiro Yamadaa7b81762016-12-28 00:36:00 +090023#include <time.h>
Wolfgang Denk25ddd1f2010-10-26 14:34:52 +020024#include <asm-offsets.h>
wdenke2211742002-11-02 23:30:20 +000025#include <linux/bitops.h>
Masahiro Yamada5bc516e2016-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 Vasut9aed5082012-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 Yamadacba1da42014-11-07 03:03:28 +090032#include <linux/kernel.h>
Simon Glass85043152017-05-17 08:23:05 -060033
Sekhar Nori2819e132009-11-12 11:09:25 -050034#ifdef CONFIG_SOC_DA8XX
35#include <asm/arch/hardware.h>
36#endif
Mingkai Hu9f3183d2015-10-26 19:47:50 +080037#ifdef CONFIG_FSL_LSCH3
38#include <asm/arch/immap_lsch3.h>
39#endif
Mingkai Hu8281c582015-10-26 19:47:51 +080040#ifdef CONFIG_FSL_LSCH2
41#include <asm/arch/immap_lsch2.h>
42#endif
wdenke2211742002-11-02 23:30:20 +000043
44#include <part.h>
45#include <flash.h>
46#include <image.h>
47
Gabe Black4166ecb2014-10-15 04:38:31 -060048/* Bring in printf format macros if inttypes.h is included */
49#define __STDC_FORMAT_MACROS
50
York Sun4d1fd7f2014-02-26 17:03:19 -080051#ifdef __LP64__
52#define CONFIG_SYS_SUPPORT_64BIT_DATA
53#endif
54
Simon Glass21726a72011-06-29 09:49:34 +000055#ifdef DEBUG
Marek Vasut88a85fb2011-10-24 23:41:42 +000056#define _DEBUG 1
Simon Glass21726a72011-06-29 09:49:34 +000057#else
Marek Vasut88a85fb2011-10-24 23:41:42 +000058#define _DEBUG 0
Simon Glass21726a72011-06-29 09:49:34 +000059#endif
60
Simon Glass98286822016-06-19 19:43:04 -060061#ifdef CONFIG_SPL_BUILD
62#define _SPL_BUILD 1
63#else
64#define _SPL_BUILD 0
65#endif
66
Simon Glass5e7f7432016-06-19 19:43:03 -060067/* Define this at the top of a file to add a prefix to debug messages */
Thierry Redingbe25d872014-11-12 18:26:50 -070068#ifndef pr_fmt
69#define pr_fmt(fmt) fmt
70#endif
71
Simon Glass21726a72011-06-29 09:49:34 +000072/*
Marek Vasut88a85fb2011-10-24 23:41:42 +000073 * Output a debug text when condition "cond" is met. The "cond" should be
74 * computed by a preprocessor in the best case, allowing for the best
75 * optimization.
76 */
Thierry Redingbe25d872014-11-12 18:26:50 -070077#define debug_cond(cond, fmt, args...) \
78 do { \
79 if (cond) \
80 printf(pr_fmt(fmt), ##args); \
Marek Vasut88a85fb2011-10-24 23:41:42 +000081 } while (0)
82
Simon Glass5e7f7432016-06-19 19:43:03 -060083/* Show a message if DEBUG is defined in a file */
Marek Vasut88a85fb2011-10-24 23:41:42 +000084#define debug(fmt, args...) \
85 debug_cond(_DEBUG, fmt, ##args)
86
Simon Glass98286822016-06-19 19:43:04 -060087/* Show a message if not in SPL */
88#define warn_non_spl(fmt, args...) \
89 debug_cond(!_SPL_BUILD, fmt, ##args)
90
Marek Vasut88a85fb2011-10-24 23:41:42 +000091/*
Simon Glass21726a72011-06-29 09:49:34 +000092 * An assertion is run-time check done in debug mode only. If DEBUG is not
93 * defined then it is skipped. If DEBUG is defined and the assertion fails,
94 * then it calls panic*( which may or may not reset/halt U-Boot (see
95 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
96 * before release, and after release it is hoped that they don't matter. But
97 * in any case these failing assertions cannot be fixed with a reset (which
98 * may just do the same assertion again).
99 */
100void __assert_fail(const char *assertion, const char *file, unsigned line,
101 const char *function);
102#define assert(x) \
103 ({ if (!(x) && _DEBUG) \
104 __assert_fail(#x, __FILE__, __LINE__, __func__); })
105
Matthias Kaehlcke594d57d2010-01-31 17:39:49 +0100106#define error(fmt, args...) do { \
Thierry Redingbe25d872014-11-12 18:26:50 -0700107 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
Matthias Kaehlcke594d57d2010-01-31 17:39:49 +0100108 ##args, __FILE__, __LINE__, __func__); \
109} while (0)
110
William Juulcfa460a2007-10-31 13:53:06 +0100111#ifndef BUG
Detlev Zundel43835aa2006-09-01 11:59:23 +0200112#define BUG() do { \
Wolfgang Denk511d0c72006-10-09 00:42:01 +0200113 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
Detlev Zundel43835aa2006-09-01 11:59:23 +0200114 panic("BUG!"); \
115} while (0)
116#define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
William Juulcfa460a2007-10-31 13:53:06 +0100117#endif /* BUG */
Detlev Zundel43835aa2006-09-01 11:59:23 +0200118
wdenkc83bf6a2004-01-06 22:38:14 +0000119typedef void (interrupt_handler_t)(void *);
wdenke2211742002-11-02 23:30:20 +0000120
wdenkc83bf6a2004-01-06 22:38:14 +0000121#include <asm/u-boot.h> /* boot information for Linux kernel */
wdenke2211742002-11-02 23:30:20 +0000122#include <asm/global_data.h> /* global data used for startup functions */
123
Heiko Schocher3fbeeea2010-09-17 13:10:34 +0200124#if defined(CONFIG_ENV_IS_EMBEDDED)
125#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
126#elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
127 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
128 defined(CONFIG_ENV_IS_IN_NVRAM)
129#define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
130#else
131#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
132#endif
wdenkc7de8292002-11-19 11:04:11 +0000133
134/*
wdenke2211742002-11-02 23:30:20 +0000135 * Function Prototypes
136 */
Michal Simek0267ba52015-01-30 10:51:46 +0100137int dram_init(void);
wdenke2211742002-11-02 23:30:20 +0000138
Simon Glass5e924a12017-03-31 08:40:33 -0600139/**
140 * dram_init_banksize() - Set up DRAM bank sizes
141 *
142 * This can be implemented by boards to set up the DRAM bank information in
143 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
144 * is called.
145 *
146 * If this is not provided, a default implementation will try to set up a
147 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
148 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
149 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
150 * get_effective_memsize().
151 *
152 * @return 0 if OK, -ve on error
153 */
154int dram_init_banksize(void);
155
wdenkc83bf6a2004-01-06 22:38:14 +0000156void hang (void) __attribute__ ((noreturn));
wdenke2211742002-11-02 23:30:20 +0000157
Wolfgang Denkf6c019c2011-07-30 12:32:45 +0000158int timer_init(void);
159int cpu_init(void);
160
Simon Glass2ea09c82015-04-28 20:25:07 -0600161#include <display_options.h>
wdenke2211742002-11-02 23:30:20 +0000162
163/* common/main.c */
164void main_loop (void);
Simon Glass009dde12012-02-14 19:59:20 +0000165int run_command(const char *cmd, int flag);
Thomas Betker1d43bfd2014-06-05 20:07:57 +0200166int run_command_repeatable(const char *cmd, int flag);
Simon Glassd51004a2012-03-30 21:30:55 +0000167
168/**
169 * Run a list of commands separated by ; or even \0
170 *
171 * Note that if 'len' is not -1, then the command does not need to be nul
172 * terminated, Memory will be allocated for the command in that case.
173 *
174 * @param cmd List of commands to run, each separated bu semicolon
175 * @param len Length of commands excluding terminator if known (-1 if not)
176 * @param flag Execution flags (CMD_FLAG_...)
177 * @return 0 on success, or != 0 on error.
178 */
179int run_command_list(const char *cmd, int len, int flag);
wdenke2211742002-11-02 23:30:20 +0000180
Peter Tyserea0364f2010-04-12 22:28:04 -0500181/* arch/$(ARCH)/lib/board.c */
Masahiro Yamada0365ffc2015-01-14 17:07:05 +0900182void board_init_f(ulong);
183void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
Simon Glass1fed87d2015-08-10 20:44:30 -0600184
185/**
Albert ARIBAUDecc30662015-11-25 17:56:32 +0100186 * ulong board_init_f_alloc_reserve - allocate reserved area
Simon Glass1fed87d2015-08-10 20:44:30 -0600187 *
188 * This function is called by each architecture very early in the start-up
Albert ARIBAUDecc30662015-11-25 17:56:32 +0100189 * code to allow the C runtime to reserve space on the stack for writable
190 * 'globals' such as GD and the malloc arena.
Simon Glass1fed87d2015-08-10 20:44:30 -0600191 *
Albert ARIBAUDecc30662015-11-25 17:56:32 +0100192 * @top: top of the reserve area, growing down.
193 * @return: bottom of reserved area
Simon Glass1fed87d2015-08-10 20:44:30 -0600194 */
Albert ARIBAUDecc30662015-11-25 17:56:32 +0100195ulong board_init_f_alloc_reserve(ulong top);
196
197/**
198 * board_init_f_init_reserve - initialize the reserved area(s)
199 *
200 * This function is called once the C runtime has allocated the reserved
201 * area on the stack. It must initialize the GD at the base of that area.
202 *
203 * @base: top from which reservation was done
204 */
205void board_init_f_init_reserve(ulong base);
Simon Glass1fed87d2015-08-10 20:44:30 -0600206
207/**
208 * arch_setup_gd() - Set up the global_data pointer
209 *
210 * This pointer is special in some architectures and cannot easily be assigned
211 * to. For example on x86 it is implemented by adding a specific record to its
212 * Global Descriptor Table! So we we provide a function to carry out this task.
213 * For most architectures this can simply be:
214 *
215 * gd = gd_ptr;
216 *
217 * @gd_ptr: Pointer to global data
218 */
219void arch_setup_gd(gd_t *gd_ptr);
220
Masahiro Yamada0365ffc2015-01-14 17:07:05 +0900221int checkboard(void);
222int show_board_info(void);
223int checkflash(void);
224int checkdram(void);
225int last_stage_init(void);
wdenk3b57fe02003-05-30 12:48:29 +0000226extern ulong monitor_flash_len;
Haiying Wangbea3f282006-07-12 10:48:05 -0400227int mac_read_from_eeprom(void);
Masahiro Yamada6ab6b2a2014-02-05 11:28:25 +0900228extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
Hadli, Manjunath8f5d4682012-02-06 00:30:44 +0000229int set_cpu_clk_info(void);
Simon Glass9272a9b2014-04-10 20:01:32 -0600230int mdm_init(void);
Simon Glass1938f4a2013-03-11 06:49:53 +0000231int print_cpuinfo(void);
Simon Glassc2240d42013-03-14 07:20:12 +0000232int update_flash_size(int flash_size);
Simon Glass2c072c92014-02-27 13:26:25 -0700233int arch_early_init_r(void);
wdenke2211742002-11-02 23:30:20 +0000234
Simon Glasse5fb5732017-03-31 08:40:36 -0600235/*
236 * setup_board_extra() - Fill in extra details in the bd_t structure
237 *
238 * @return 0 if OK, -ve on error
239 */
240int setup_board_extra(void);
241
Simon Glass15a33e42012-11-30 13:01:20 +0000242/**
Simon Glass671549e2017-03-28 10:27:18 -0600243 * arch_fsp_init() - perform firmware support package init
244 *
245 * Where U-Boot relies on binary blobs to handle part of the system init, this
246 * function can be used to set up the blobs. This is used on some Intel
247 * platforms.
248 */
249int arch_fsp_init(void);
250
251/**
Simon Glassd4c671c2015-03-05 12:25:16 -0700252 * arch_cpu_init_dm() - init CPU after driver model is available
253 *
254 * This is called immediately after driver model is available before
255 * relocation. This is similar to arch_cpu_init() but is able to reference
256 * devices
257 *
258 * @return 0 if OK, -ve on error
259 */
260int arch_cpu_init_dm(void);
261
262/**
Andreas Bießmann68145d42015-02-06 23:06:45 +0100263 * Reserve all necessary stacks
264 *
265 * This is used in generic board init sequence in common/board_f.c. Each
266 * architecture could provide this function to tailor the required stacks.
267 *
268 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
269 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
270 * require only this can leave it untouched.
271 *
272 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
273 * positions of the stack. The stack pointer(s) will be set to this later.
274 * gd->irq_sp is only required, if the architecture needs it.
275 *
276 * @return 0 if no error
277 */
278__weak int arch_reserve_stacks(void);
279
280/**
Simon Glass15a33e42012-11-30 13:01:20 +0000281 * Show the DRAM size in a board-specific way
282 *
283 * This is used by boards to display DRAM information in their own way.
284 *
285 * @param size Size of DRAM (which should be displayed along with other info)
286 */
Andrew Bradfordea11b402015-05-22 08:30:14 -0400287void board_show_dram(phys_size_t size);
Simon Glass15a33e42012-11-30 13:01:20 +0000288
Simon Glass13d06982013-05-08 08:06:01 +0000289/**
Ma Haijune29607e2014-07-12 14:24:06 +0100290 * arch_fixup_fdt() - Write arch-specific information to fdt
Simon Glass13d06982013-05-08 08:06:01 +0000291 *
Ma Haijune29607e2014-07-12 14:24:06 +0100292 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
Simon Glass13d06982013-05-08 08:06:01 +0000293 *
294 * @blob: FDT blob to write to
295 * @return 0 if ok, or -ve FDT_ERR_... on failure
296 */
Ma Haijune29607e2014-07-12 14:24:06 +0100297int arch_fixup_fdt(void *blob);
Simon Glass13d06982013-05-08 08:06:01 +0000298
wdenke2211742002-11-02 23:30:20 +0000299/* common/flash.c */
300void flash_perror (int);
301
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200302/* common/cmd_source.c */
303int source (ulong addr, const char *fit_uname);
wdenke2211742002-11-02 23:30:20 +0000304
wdenkc83bf6a2004-01-06 22:38:14 +0000305extern ulong load_addr; /* Default Load Address */
Simon Glass1aec2442011-10-21 18:51:38 +0000306extern ulong save_addr; /* Default Save Address */
307extern ulong save_size; /* Default Save Size */
wdenke2211742002-11-02 23:30:20 +0000308
Jason Hobbs06283a62011-08-31 10:37:30 -0500309/* common/cmd_net.c */
310int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
311
Rob Herring669df7e2012-05-25 10:47:39 +0000312/* common/cmd_fat.c */
313int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
314
315/* common/cmd_ext2.c */
316int do_ext2load(cmd_tbl_t *, int, int, char * const []);
317
wdenke2211742002-11-02 23:30:20 +0000318/* common/cmd_nvedit.c */
319int env_init (void);
320void env_relocate (void);
Rafal Jaworowski26a41792008-01-09 18:05:27 +0100321int envmatch (uchar *, int);
Simon Glass20f86a02014-02-27 13:26:21 -0700322
323/* Avoid unfortunate conflict with libc's getenv() */
324#ifdef CONFIG_SANDBOX
325#define getenv uboot_getenv
326#endif
Wolfgang Denk84b5e802011-07-29 14:42:18 +0200327char *getenv (const char *);
328int getenv_f (const char *name, char *buf, unsigned len);
Simon Glass4a9b4132011-10-14 13:25:18 +0000329ulong getenv_ulong(const char *name, int base, ulong default_val);
Simon Glass76b8f792013-04-20 08:42:43 +0000330
331/**
332 * getenv_hex() - Return an environment variable as a hex value
333 *
334 * Decode an environment as a hex number (it may or may not have a 0x
335 * prefix). If the environment variable cannot be found, or does not start
336 * with hex digits, the default value is returned.
337 *
338 * @varname: Variable to decode
339 * @default_val: Value to return on error
340 */
341ulong getenv_hex(const char *varname, ulong default_val);
342
Joe Hershbergerec8a2522012-12-11 22:16:22 -0600343/*
344 * Read an environment variable as a boolean
345 * Return -1 if variable does not exist (default to true)
346 */
347int getenv_yesno(const char *var);
wdenkc83bf6a2004-01-06 22:38:14 +0000348int saveenv (void);
Wolfgang Denk84b5e802011-07-29 14:42:18 +0200349int setenv (const char *, const char *);
Simon Glassd67f10c2011-10-24 17:59:59 +0000350int setenv_ulong(const char *varname, ulong value);
Simon Glassbfc59962013-02-24 17:33:21 +0000351int setenv_hex(const char *varname, ulong value);
352/**
353 * setenv_addr - Set an environment variable to an address in hex
354 *
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -0400355 * @varname: Environment variable to set
Simon Glassbfc59962013-02-24 17:33:21 +0000356 * @addr: Value to set it to
357 * @return 0 if ok, 1 on error
358 */
359static inline int setenv_addr(const char *varname, const void *addr)
360{
361 return setenv_hex(varname, (ulong)addr);
362}
363
wdenk04a85b32004-04-15 18:22:41 +0000364#ifdef CONFIG_AUTO_COMPLETE
365int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
366#endif
Heiko Schocher2f70c492009-02-10 09:38:52 +0100367int get_env_id (void);
wdenk04a85b32004-04-15 18:22:41 +0000368
wdenkc83bf6a2004-01-06 22:38:14 +0000369void pci_init (void);
370void pci_init_board(void);
wdenke2211742002-11-02 23:30:20 +0000371
wdenke2211742002-11-02 23:30:20 +0000372int misc_init_f (void);
373int misc_init_r (void);
374
wdenk27b207f2003-07-24 23:38:38 +0000375/* common/exports.c */
376void jumptable_init(void);
377
Mike Frysingerecb1dc82009-05-20 04:35:14 -0400378/* common/kallsysm.c */
379const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
380
wdenkc83bf6a2004-01-06 22:38:14 +0000381/* common/memsize.c */
Albert ARIBAUDa55d23c2011-07-03 05:55:33 +0000382long get_ram_size (long *, long);
York Sune3866162014-02-11 11:57:26 -0800383phys_size_t get_effective_memsize(void);
wdenkc83bf6a2004-01-06 22:38:14 +0000384
wdenke2211742002-11-02 23:30:20 +0000385/* $(BOARD)/$(BOARD).c */
386void reset_phy (void);
wdenkc83bf6a2004-01-06 22:38:14 +0000387void fdc_hw_init (void);
wdenke2211742002-11-02 23:30:20 +0000388
389/* $(BOARD)/eeprom.c */
Simon Glasseb5ba3a2017-05-12 21:09:49 -0600390#ifdef CONFIG_CMD_EEPROM
Marek Vasut354e3ed2015-11-10 20:53:31 +0100391void eeprom_init (int bus);
wdenke2211742002-11-02 23:30:20 +0000392int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
393int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
Simon Glasseb5ba3a2017-05-12 21:09:49 -0600394#else
395/*
396 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
397 * some macros here so we don't have to touch every one of those uses
398 */
399#define eeprom_init(bus)
400#define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
401#define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
402#endif
wdenke2211742002-11-02 23:30:20 +0000403
404/*
405 * Set this up regardless of board
406 * type, to prevent errors.
407 */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200408#if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
409# define CONFIG_SYS_DEF_EEPROM_ADDR 0
wdenke2211742002-11-02 23:30:20 +0000410#else
Heiko Schocher548738b2010-01-07 08:55:40 +0100411#if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200412# define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
Heiko Schocher548738b2010-01-07 08:55:40 +0100413#endif
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200414#endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
wdenke2211742002-11-02 23:30:20 +0000415
wdenkbdccc4f2003-08-05 17:43:17 +0000416#if defined(CONFIG_SPI)
wdenke2211742002-11-02 23:30:20 +0000417extern void spi_init_f (void);
418extern void spi_init_r (void);
wdenkc83bf6a2004-01-06 22:38:14 +0000419extern ssize_t spi_read (uchar *, int, uchar *, int);
wdenke2211742002-11-02 23:30:20 +0000420extern ssize_t spi_write (uchar *, int, uchar *, int);
421#endif
422
wdenke2211742002-11-02 23:30:20 +0000423/* $(BOARD)/$(BOARD).c */
wdenkc837dcb2004-01-20 23:12:12 +0000424int board_early_init_f (void);
mario.six@gdsys.cc2a792752017-02-22 16:07:22 +0100425int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
wdenkc837dcb2004-01-20 23:12:12 +0000426int board_late_init (void);
wdenke2211742002-11-02 23:30:20 +0000427int board_postclk_init (void); /* after clocks/timebase, before env/serial */
wdenkc837dcb2004-01-20 23:12:12 +0000428int board_early_init_r (void);
wdenke2211742002-11-02 23:30:20 +0000429void board_poweroff (void);
430
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200431#if defined(CONFIG_SYS_DRAM_TEST)
wdenke2211742002-11-02 23:30:20 +0000432int testdram(void);
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200433#endif /* CONFIG_SYS_DRAM_TEST */
wdenke2211742002-11-02 23:30:20 +0000434
435/* $(CPU)/start.S */
wdenke2211742002-11-02 23:30:20 +0000436int icache_status (void);
437void icache_enable (void);
438void icache_disable(void);
439int dcache_status (void);
440void dcache_enable (void);
441void dcache_disable(void);
Aneesh V2c451f72011-06-16 23:30:47 +0000442void mmu_disable(void);
Benoît Thébaudeau5c6db122013-04-11 09:35:53 +0000443#if defined(CONFIG_ARM)
444void relocate_code(ulong);
445#else
446void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
Benoît Thébaudeau959eaa72013-04-11 09:35:43 +0000447#endif
wdenke2211742002-11-02 23:30:20 +0000448ulong get_endaddr (void);
449void trap_init (ulong);
Simon Glass6e2941d2017-05-17 08:23:06 -0600450
Michal Simek06436312007-04-21 21:02:40 +0200451#if defined (CONFIG_MICROBLAZE)
452unsigned short in16(unsigned int);
453void out16(unsigned int, unsigned short value);
454#endif
wdenke2211742002-11-02 23:30:20 +0000455
456/* $(CPU)/cpu.c */
Timur Tabifbb9ecf2011-08-05 16:15:24 -0500457static inline int cpumask_next(int cpu, unsigned int mask)
458{
459 for (cpu++; !((1 << cpu) & mask); cpu++)
460 ;
461
462 return cpu;
463}
464
465#define for_each_cpu(iter, cpu, num_cpus, mask) \
466 for (iter = 0, cpu = cpumask_next(-1, mask); \
467 iter < num_cpus; \
468 iter++, cpu = cpumask_next(cpu, mask)) \
469
Poonam Aggrwal0e870982009-07-31 12:08:14 +0530470int cpu_numcores (void);
Shaveta Leekhab8bf0ad2015-01-19 12:46:54 +0530471int cpu_num_dspcores(void);
Timur Tabifbb9ecf2011-08-05 16:15:24 -0500472u32 cpu_mask (void);
Shaveta Leekhab8bf0ad2015-01-19 12:46:54 +0530473u32 cpu_dsp_mask(void);
Timur Tabifbb9ecf2011-08-05 16:15:24 -0500474int is_core_valid (unsigned int);
Simon Glasscbcbf712017-01-23 13:31:22 -0700475
476/**
477 * arch_cpu_init() - basic cpu-dependent setup for an architecture
478 *
479 * This is called after early malloc is available. It should handle any
480 * CPU- or SoC- specific init needed to continue the init sequence. See
481 * board_f.c for where it is called. If this is not provided, a default
482 * version (which does nothing) will be used.
483 */
484int arch_cpu_init(void);
485
wdenke2211742002-11-02 23:30:20 +0000486int checkcpu (void);
487int checkicache (void);
488int checkdcache (void);
489void upmconfig (unsigned int, unsigned int *, unsigned int);
490ulong get_tbclk (void);
Przemyslaw Marczak1fb4dab2014-09-01 13:50:48 +0200491void reset_misc (void);
wdenk3ec924a2005-04-03 17:23:39 +0000492void reset_cpu (ulong addr);
Kim Phillips6a16e0d2007-08-15 22:30:26 -0500493void ft_cpu_setup(void *blob, bd_t *bd);
Kim Phillips6a16e0d2007-08-15 22:30:26 -0500494void ft_pci_setup(void *blob, bd_t *bd);
Kim Phillips6a16e0d2007-08-15 22:30:26 -0500495
Andre Przywaraba6a1692013-09-19 18:06:44 +0200496void smp_set_core_boot_addr(unsigned long addr, int corenr);
497void smp_kick_all_cpus(void);
wdenke2211742002-11-02 23:30:20 +0000498
499/* $(CPU)/serial.c */
500int serial_init (void);
501void serial_setbrg (void);
502void serial_putc (const char);
wdenk756f5862005-04-03 15:51:42 +0000503void serial_putc_raw(const char);
wdenke2211742002-11-02 23:30:20 +0000504void serial_puts (const char *);
wdenke2211742002-11-02 23:30:20 +0000505int serial_getc (void);
506int serial_tstc (void);
507
Simon Glass709ea542014-07-23 06:54:59 -0600508/* These versions take a stdio_dev pointer */
509struct stdio_dev;
510int serial_stub_getc(struct stdio_dev *sdev);
511int serial_stub_tstc(struct stdio_dev *sdev);
512
wdenke2211742002-11-02 23:30:20 +0000513/* $(CPU)/speed.c */
514int get_clocks (void);
Simon Glass7a7530a2017-05-17 08:22:44 -0600515#if defined(CONFIG_LH7A40X) || \
Matthias Kaehlckefcfb6322010-02-01 21:29:39 +0100516 defined(CONFIG_EP93XX)
wdenke2211742002-11-02 23:30:20 +0000517ulong get_FCLK (void);
518ulong get_HCLK (void);
519ulong get_PCLK (void);
520ulong get_UCLK (void);
521#endif
wdenkf39748a2004-06-09 13:37:52 +0000522#if defined(CONFIG_LH7A40X)
523ulong get_PLLCLK (void);
524#endif
wdenk281e00a2004-08-01 22:48:16 +0000525#if defined(CONFIG_IMX)
526ulong get_systemPLLCLK(void);
527ulong get_FCLK(void);
528ulong get_HCLK(void);
529ulong get_BCLK(void);
530ulong get_PERCLK1(void);
531ulong get_PERCLK2(void);
532ulong get_PERCLK3(void);
533#endif
wdenke2211742002-11-02 23:30:20 +0000534ulong get_bus_freq (ulong);
Stefan Roese550650d2010-09-20 16:05:31 +0200535int get_serial_clock(void);
wdenke2211742002-11-02 23:30:20 +0000536
wdenke2211742002-11-02 23:30:20 +0000537int cpu_init_r (void);
wdenke2211742002-11-02 23:30:20 +0000538
539/* $(CPU)/interrupts.c */
wdenkc83bf6a2004-01-06 22:38:14 +0000540int interrupt_init (void);
541void timer_interrupt (struct pt_regs *);
wdenke2211742002-11-02 23:30:20 +0000542void external_interrupt (struct pt_regs *);
543void irq_install_handler(int, interrupt_handler_t *, void *);
544void irq_free_handler (int);
545void reset_timer (void);
Simon Glassb2e16a82013-06-11 11:14:39 -0700546
547/* Return value of monotonic microsecond timer */
548unsigned long timer_get_us(void);
549
wdenke2211742002-11-02 23:30:20 +0000550void enable_interrupts (void);
551int disable_interrupts (void);
552
553/* $(CPU)/.../commproc.c */
554int dpram_init (void);
555uint dpram_base(void);
556uint dpram_base_align(uint align);
557uint dpram_alloc(uint size);
558uint dpram_alloc_align(uint size,uint align);
wdenkbdccc4f2003-08-05 17:43:17 +0000559void bootcount_store (ulong);
560ulong bootcount_load (void);
561#define BOOTCOUNT_MAGIC 0xB001C041
wdenke2211742002-11-02 23:30:20 +0000562
563/* $(CPU)/.../<eth> */
Wolfgang Denkc5bded32007-08-29 14:05:30 +0200564void mii_init (void);
wdenke2211742002-11-02 23:30:20 +0000565
566/* $(CPU)/.../lcd.c */
567ulong lcd_setmem (ulong);
568
wdenke2211742002-11-02 23:30:20 +0000569/* $(CPU)/.../video.c */
570ulong video_setmem (ulong);
571
Peter Tyserea0364f2010-04-12 22:28:04 -0500572/* arch/$(ARCH)/lib/cache.c */
Aneesh Vcba4b182011-08-16 04:33:05 +0000573void enable_caches(void);
wdenke2211742002-11-02 23:30:20 +0000574void flush_cache (unsigned long, unsigned long);
Aneesh V2c451f72011-06-16 23:30:47 +0000575void flush_dcache_all(void);
Stefan Roese03d3bfb2009-01-21 17:20:20 +0100576void flush_dcache_range(unsigned long start, unsigned long stop);
577void invalidate_dcache_range(unsigned long start, unsigned long stop);
Aneesh V2c451f72011-06-16 23:30:47 +0000578void invalidate_dcache_all(void);
579void invalidate_icache_all(void);
wdenk0db5bca2003-03-31 17:27:09 +0000580
Simon Glass4d24a112015-05-13 07:02:25 -0600581enum {
582 /* Disable caches (else flush caches but leave them active) */
583 CBL_DISABLE_CACHES = 1 << 0,
584 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
585
586 CBL_ALL = 3,
587};
588
589/**
590 * Clean up ready for linux
591 *
592 * @param flags Flags to control what is done
593 */
594int cleanup_before_linux_select(int flags);
595
Peter Tyserea0364f2010-04-12 22:28:04 -0500596/* arch/$(ARCH)/lib/ticks.S */
Simon Glass19ea4672014-10-15 04:38:33 -0600597uint64_t get_ticks(void);
wdenke2211742002-11-02 23:30:20 +0000598void wait_ticks (unsigned long);
599
Peter Tyserea0364f2010-04-12 22:28:04 -0500600/* arch/$(ARCH)/lib/time.c */
wdenke2211742002-11-02 23:30:20 +0000601ulong usec2ticks (unsigned long usec);
602ulong ticks2usec (unsigned long ticks);
wdenke2211742002-11-02 23:30:20 +0000603
Peter Tyser78acc472010-04-12 22:28:05 -0500604/* lib/gunzip.c */
Wolfgang Wegner87d93a12009-12-09 15:16:47 +0100605int gunzip(void *, int, unsigned char *, unsigned long *);
606int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
607 int stoponerr, int offset);
608
Eric Nelson918e9eb2015-02-17 11:30:30 -0700609/**
610 * gzwrite progress indicators: defined weak to allow board-specific
611 * overrides:
612 *
613 * gzwrite_progress_init called on startup
614 * gzwrite_progress called during decompress/write loop
615 * gzwrite_progress_finish called at end of loop to
616 * indicate success (retcode=0) or failure
617 */
618void gzwrite_progress_init(u64 expected_size);
619
620void gzwrite_progress(int iteration,
621 u64 bytes_written,
622 u64 total_bytes);
623
624void gzwrite_progress_finish(int retcode,
625 u64 totalwritten,
626 u64 totalsize,
627 u32 expected_crc,
628 u32 calculated_crc);
629
630/**
631 * decompress and write gzipped image from memory to block device
632 *
633 * @param src compressed image address
634 * @param len compressed image length in bytes
635 * @param dev block device descriptor
636 * @param szwritebuf bytes per write (pad to erase size)
637 * @param startoffs offset in bytes of first write
638 * @param szexpected expected uncompressed length
639 * may be zero to use gzip trailer
640 * for files under 4GiB
641 */
642int gzwrite(unsigned char *src, int len,
Simon Glass4101f682016-02-29 15:25:34 -0700643 struct blk_desc *dev,
Eric Nelson918e9eb2015-02-17 11:30:30 -0700644 unsigned long szwritebuf,
645 u64 startoffs,
646 u64 szexpected);
647
Julius Werner027b7282015-10-06 20:03:53 -0700648/* lib/lz4_wrapper.c */
649int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
650
Wolfgang Denk54c69772010-06-13 01:45:10 +0200651/* lib/qsort.c */
652void qsort(void *base, size_t nmemb, size_t size,
653 int(*compar)(const void *, const void *));
Mike Frysinger560d4242010-12-17 16:51:59 -0500654int strcmp_compar(const void *, const void *);
Wolfgang Denk54c69772010-06-13 01:45:10 +0200655
Jason Hobbse11938e2011-08-23 11:06:56 +0000656/* lib/uuid.c */
Przemyslaw Marczakd718ded2014-04-02 10:20:03 +0200657#include <uuid.h>
Jason Hobbse11938e2011-08-23 11:06:56 +0000658
Peter Tyser78acc472010-04-12 22:28:05 -0500659/* lib/vsprintf.c */
Simon Glass9785c902011-11-02 09:52:07 +0000660#include <vsprintf.h>
wdenke2211742002-11-02 23:30:20 +0000661
Peter Tyser78acc472010-04-12 22:28:05 -0500662/* lib/strmhz.c */
Ed Swarthout55f79342011-03-05 10:28:17 -0600663char * strmhz(char *buf, unsigned long hz);
Haavard Skinnemoen0768b7a2008-08-18 13:41:27 +0200664
Peter Tyser78acc472010-04-12 22:28:05 -0500665/* lib/crc32.c */
Prafulla Wadaskar449609f2009-08-16 05:28:19 +0530666#include <u-boot/crc.h>
wdenke2211742002-11-02 23:30:20 +0000667
Michael Walle9acf1ca2012-06-05 11:33:14 +0000668/* lib/rand.c */
Michael Walle9acf1ca2012-06-05 11:33:14 +0000669#define RAND_MAX -1U
670void srand(unsigned int seed);
671unsigned int rand(void);
672unsigned int rand_r(unsigned int *seedp);
Michael Walle9acf1ca2012-06-05 11:33:14 +0000673
wdenke2211742002-11-02 23:30:20 +0000674/*
675 * STDIO based functions (can always be used)
676 */
wdenke2211742002-11-02 23:30:20 +0000677/* serial stuff */
Wolfgang Denkd9c27252010-06-20 17:14:14 +0200678int serial_printf (const char *fmt, ...)
Andrew Klossnerdc4b0b32008-07-07 06:41:14 -0700679 __attribute__ ((format (__printf__, 1, 2)));
wdenke2211742002-11-02 23:30:20 +0000680/* stdin */
681int getc(void);
682int tstc(void);
683
684/* stdout */
Simon Glass76f1f382016-09-12 23:18:25 -0600685#if !defined(CONFIG_SPL_BUILD) || \
686 (defined(CONFIG_TPL_BUILD) && defined(CONFIG_TPL_SERIAL_SUPPORT)) || \
687 (defined(CONFIG_SPL_BUILD) && !defined(CONFIG_TPL_BUILD) && \
688 defined(CONFIG_SPL_SERIAL_SUPPORT))
wdenke2211742002-11-02 23:30:20 +0000689void putc(const char c);
690void puts(const char *s);
Wolfgang Denkd9c27252010-06-20 17:14:14 +0200691int printf(const char *fmt, ...)
Andrew Klossnerdc4b0b32008-07-07 06:41:14 -0700692 __attribute__ ((format (__printf__, 1, 2)));
Wolfgang Denkd9c27252010-06-20 17:14:14 +0200693int vprintf(const char *fmt, va_list args);
Simon Glass76f1f382016-09-12 23:18:25 -0600694#else
695#define putc(...) do { } while (0)
696#define puts(...) do { } while (0)
697#define printf(...) do { } while (0)
698#define vprintf(...) do { } while (0)
Heiko Schocher80402f32015-06-29 09:10:46 +0200699#endif
wdenke2211742002-11-02 23:30:20 +0000700
701/* stderr */
702#define eputc(c) fputc(stderr, c)
703#define eputs(s) fputs(stderr, s)
704#define eprintf(fmt,args...) fprintf(stderr,fmt ,##args)
705
706/*
707 * FILE based functions (can only be used AFTER relocation!)
708 */
wdenke2211742002-11-02 23:30:20 +0000709#define stdin 0
710#define stdout 1
711#define stderr 2
712#define MAX_FILES 3
713
Wolfgang Denkd9c27252010-06-20 17:14:14 +0200714int fprintf(int file, const char *fmt, ...)
Andrew Klossnerdc4b0b32008-07-07 06:41:14 -0700715 __attribute__ ((format (__printf__, 2, 3)));
wdenke2211742002-11-02 23:30:20 +0000716void fputs(int file, const char *s);
717void fputc(int file, const char c);
718int ftstc(int file);
719int fgetc(int file);
720
Lei Wen88d52c62012-09-28 04:26:46 +0000721/* lib/gzip.c */
722int gzip(void *dst, unsigned long *lenp,
723 unsigned char *src, unsigned long srclen);
724int zzip(void *dst, unsigned long *lenp, unsigned char *src,
725 unsigned long srclen, int stoponerr,
726 int (*func)(unsigned long, unsigned long));
727
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000728/* lib/net_utils.c */
729#include <net.h>
Joe Hershberger049a95a2015-04-08 01:41:01 -0500730static inline struct in_addr getenv_ip(char *var)
Joe Hershberger4ef8d532012-05-23 08:01:04 +0000731{
732 return string_to_ip(getenv(var));
733}
734
wdenke2211742002-11-02 23:30:20 +0000735int pcmcia_init (void);
736
Uri Mashiach2d8d1902017-01-19 10:51:45 +0200737#ifdef CONFIG_LED_STATUS
Wolfgang Denkfb364be2009-07-27 09:58:14 +0200738# include <status_led.h>
739#endif
Simon Glass097e1782012-01-14 15:24:44 +0000740
741#include <bootstage.h>
wdenke2211742002-11-02 23:30:20 +0000742
Joe Hershberger48522bb2012-05-15 08:59:08 +0000743#ifdef CONFIG_SHOW_ACTIVITY
744void show_activity(int arg);
745#endif
746
Wolfgang Denkfcd3c872009-07-24 00:17:48 +0200747/* Multicore arch functions */
748#ifdef CONFIG_MP
749int cpu_status(int nr);
750int cpu_reset(int nr);
Kumar Gala4194b362010-01-12 11:42:43 -0600751int cpu_disable(int nr);
Wolfgang Denk54841ab2010-06-28 22:00:46 +0200752int cpu_release(int nr, int argc, char * const argv[]);
Wolfgang Denkfcd3c872009-07-24 00:17:48 +0200753#endif
754
Andre Przywara2a6713b2017-01-02 11:48:30 +0000755#else /* __ASSEMBLY__ */
756
757/* Drop a C type modifier (like in 3UL) for constants used in assembly. */
758#define _AC(X, Y) X
759
760#endif /* __ASSEMBLY__ */
Wolfgang Denkfcd3c872009-07-24 00:17:48 +0200761
762/* Put only stuff here that the assembler can digest */
763
Andre Przywara2a6713b2017-01-02 11:48:30 +0000764/* Declare an unsigned long constant digestable both by C and an assembler. */
765#define UL(x) _AC(x, UL)
766
Wolfgang Denkfcd3c872009-07-24 00:17:48 +0200767#ifdef CONFIG_POST
768#define CONFIG_HAS_POST
Michael Zaidman800eb092010-09-20 08:51:53 +0200769#ifndef CONFIG_POST_ALT_LIST
770#define CONFIG_POST_STD_LIST
771#endif
Wolfgang Denkfcd3c872009-07-24 00:17:48 +0200772#endif
773
wdenk8aa1a2d2005-04-04 12:44:11 +0000774#ifdef CONFIG_INIT_CRITICAL
Wolfgang Denk2f6fa462006-08-14 23:17:47 +0200775#error CONFIG_INIT_CRITICAL is deprecated!
wdenk8aa1a2d2005-04-04 12:44:11 +0000776#error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
777#endif
778
Anton Staaf155cfb52011-09-02 13:45:28 +0000779#define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
Andy Fleming4b03ac82008-06-16 13:58:53 -0500780
Anton Staaf1e41f5a2011-10-17 16:46:13 -0700781/*
Simon Glassc9689ca2015-06-23 15:38:31 -0600782 * check_member() - Check the offset of a structure member
783 *
784 * @structure: Name of structure (e.g. global_data)
785 * @member: Name of member (e.g. baudrate)
786 * @offset: Expected offset in bytes
787 */
788#define check_member(structure, member, offset) _Static_assert( \
789 offsetof(struct structure, member) == offset, \
790 "`struct " #structure "` offset for `" #member "` is not " #offset)
791
Simon Glass476476e2015-08-04 12:33:52 -0600792/* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
793#ifdef CONFIG_EFI_STUB
794#define ll_boot_init() false
795#else
796#define ll_boot_init() true
797#endif
798
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +0000799/* Pull in stuff for the build system */
800#ifdef DO_DEPS_ONLY
801# include <environment.h>
802#endif
803
wdenke2211742002-11-02 23:30:20 +0000804#endif /* __COMMON_H_ */