blob: 5e841947c17fc983fb21e3c9cc449155100d0199 [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 Yamada5e882e92017-09-16 14:10:39 +090032#include <stdio.h>
Masahiro Yamadabd426622014-11-07 03:03:28 +090033#include <linux/kernel.h>
Simon Glass76135792017-05-17 08:23:05 -060034
wdenke2211742002-11-02 23:30:20 +000035#include <part.h>
36#include <flash.h>
37#include <image.h>
38
Gabe Black690fb812014-10-15 04:38:31 -060039/* Bring in printf format macros if inttypes.h is included */
40#define __STDC_FORMAT_MACROS
41
York Sun6c480012014-02-26 17:03:19 -080042#ifdef __LP64__
43#define CONFIG_SYS_SUPPORT_64BIT_DATA
44#endif
45
Simon Glass02aa9e62011-06-29 09:49:34 +000046#ifdef DEBUG
Marek Vasut2c5910c2011-10-24 23:41:42 +000047#define _DEBUG 1
Simon Glass02aa9e62011-06-29 09:49:34 +000048#else
Marek Vasut2c5910c2011-10-24 23:41:42 +000049#define _DEBUG 0
Simon Glass02aa9e62011-06-29 09:49:34 +000050#endif
51
Simon Glasse558f6a2016-06-19 19:43:04 -060052#ifdef CONFIG_SPL_BUILD
53#define _SPL_BUILD 1
54#else
55#define _SPL_BUILD 0
56#endif
57
Simon Glass1ec1c3a2016-06-19 19:43:03 -060058/* Define this at the top of a file to add a prefix to debug messages */
Thierry Reding09cf4cd2014-11-12 18:26:50 -070059#ifndef pr_fmt
60#define pr_fmt(fmt) fmt
61#endif
62
Simon Glass02aa9e62011-06-29 09:49:34 +000063/*
Marek Vasut2c5910c2011-10-24 23:41:42 +000064 * Output a debug text when condition "cond" is met. The "cond" should be
65 * computed by a preprocessor in the best case, allowing for the best
66 * optimization.
67 */
Thierry Reding09cf4cd2014-11-12 18:26:50 -070068#define debug_cond(cond, fmt, args...) \
69 do { \
70 if (cond) \
71 printf(pr_fmt(fmt), ##args); \
Marek Vasut2c5910c2011-10-24 23:41:42 +000072 } while (0)
73
Simon Glass1ec1c3a2016-06-19 19:43:03 -060074/* Show a message if DEBUG is defined in a file */
Marek Vasut2c5910c2011-10-24 23:41:42 +000075#define debug(fmt, args...) \
76 debug_cond(_DEBUG, fmt, ##args)
77
Simon Glasse558f6a2016-06-19 19:43:04 -060078/* Show a message if not in SPL */
79#define warn_non_spl(fmt, args...) \
80 debug_cond(!_SPL_BUILD, fmt, ##args)
81
Marek Vasut2c5910c2011-10-24 23:41:42 +000082/*
Simon Glass02aa9e62011-06-29 09:49:34 +000083 * An assertion is run-time check done in debug mode only. If DEBUG is not
84 * defined then it is skipped. If DEBUG is defined and the assertion fails,
85 * then it calls panic*( which may or may not reset/halt U-Boot (see
86 * CONFIG_PANIC_HANG), It is hoped that all failing assertions are found
87 * before release, and after release it is hoped that they don't matter. But
88 * in any case these failing assertions cannot be fixed with a reset (which
89 * may just do the same assertion again).
90 */
91void __assert_fail(const char *assertion, const char *file, unsigned line,
92 const char *function);
93#define assert(x) \
94 ({ if (!(x) && _DEBUG) \
95 __assert_fail(#x, __FILE__, __LINE__, __func__); })
96
Matthias Kaehlcke3b8d1a42010-01-31 17:39:49 +010097#define error(fmt, args...) do { \
Thierry Reding09cf4cd2014-11-12 18:26:50 -070098 printf("ERROR: " pr_fmt(fmt) "\nat %s:%d/%s()\n", \
Matthias Kaehlcke3b8d1a42010-01-31 17:39:49 +010099 ##args, __FILE__, __LINE__, __func__); \
100} while (0)
101
William Juul52c07962007-10-31 13:53:06 +0100102#ifndef BUG
Detlev Zundel1d75a772006-09-01 11:59:23 +0200103#define BUG() do { \
Wolfgang Denk4df0da52006-10-09 00:42:01 +0200104 printf("BUG: failure at %s:%d/%s()!\n", __FILE__, __LINE__, __FUNCTION__); \
Detlev Zundel1d75a772006-09-01 11:59:23 +0200105 panic("BUG!"); \
106} while (0)
107#define BUG_ON(condition) do { if (unlikely((condition)!=0)) BUG(); } while(0)
William Juul52c07962007-10-31 13:53:06 +0100108#endif /* BUG */
Detlev Zundel1d75a772006-09-01 11:59:23 +0200109
wdenk87249ba2004-01-06 22:38:14 +0000110typedef void (interrupt_handler_t)(void *);
wdenke2211742002-11-02 23:30:20 +0000111
wdenk87249ba2004-01-06 22:38:14 +0000112#include <asm/u-boot.h> /* boot information for Linux kernel */
wdenke2211742002-11-02 23:30:20 +0000113#include <asm/global_data.h> /* global data used for startup functions */
114
Heiko Schochereeedb862010-09-17 13:10:34 +0200115#if defined(CONFIG_ENV_IS_EMBEDDED)
116#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
117#elif ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
118 (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
119 defined(CONFIG_ENV_IS_IN_NVRAM)
120#define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
121#else
122#define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
123#endif
wdenk452cfd62002-11-19 11:04:11 +0000124
125/*
wdenke2211742002-11-02 23:30:20 +0000126 * Function Prototypes
127 */
Michal Simekef932b02015-01-30 10:51:46 +0100128int dram_init(void);
wdenke2211742002-11-02 23:30:20 +0000129
Simon Glass4096e3a2017-03-31 08:40:33 -0600130/**
131 * dram_init_banksize() - Set up DRAM bank sizes
132 *
133 * This can be implemented by boards to set up the DRAM bank information in
134 * gd->bd->bi_dram(). It is called just before relocation, after dram_init()
135 * is called.
136 *
137 * If this is not provided, a default implementation will try to set up a
138 * single bank. It will do this if CONFIG_NR_DRAM_BANKS and
139 * CONFIG_SYS_SDRAM_BASE are set. The bank will have a start address of
140 * CONFIG_SYS_SDRAM_BASE and the size will be determined by a call to
141 * get_effective_memsize().
142 *
143 * @return 0 if OK, -ve on error
144 */
145int dram_init_banksize(void);
146
wdenk87249ba2004-01-06 22:38:14 +0000147void hang (void) __attribute__ ((noreturn));
wdenke2211742002-11-02 23:30:20 +0000148
Wolfgang Denk75fc4342011-07-30 12:32:45 +0000149int timer_init(void);
150int cpu_init(void);
151
Simon Glass7da617c2015-04-28 20:25:07 -0600152#include <display_options.h>
wdenke2211742002-11-02 23:30:20 +0000153
154/* common/main.c */
155void main_loop (void);
Simon Glass8161d042012-02-14 19:59:20 +0000156int run_command(const char *cmd, int flag);
Thomas Betkerbe6346b2014-06-05 20:07:57 +0200157int run_command_repeatable(const char *cmd, int flag);
Simon Glassa6642e02012-03-30 21:30:55 +0000158
159/**
160 * Run a list of commands separated by ; or even \0
161 *
162 * Note that if 'len' is not -1, then the command does not need to be nul
163 * terminated, Memory will be allocated for the command in that case.
164 *
165 * @param cmd List of commands to run, each separated bu semicolon
166 * @param len Length of commands excluding terminator if known (-1 if not)
167 * @param flag Execution flags (CMD_FLAG_...)
168 * @return 0 on success, or != 0 on error.
169 */
170int run_command_list(const char *cmd, int len, int flag);
wdenke2211742002-11-02 23:30:20 +0000171
Peter Tysercede5d82010-04-12 22:28:04 -0500172/* arch/$(ARCH)/lib/board.c */
Masahiro Yamada9607f7a2015-01-14 17:07:05 +0900173void board_init_f(ulong);
174void board_init_r(gd_t *, ulong) __attribute__ ((noreturn));
Simon Glass08ef3052015-08-10 20:44:30 -0600175
176/**
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100177 * ulong board_init_f_alloc_reserve - allocate reserved area
Simon Glass08ef3052015-08-10 20:44:30 -0600178 *
179 * This function is called by each architecture very early in the start-up
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100180 * code to allow the C runtime to reserve space on the stack for writable
181 * 'globals' such as GD and the malloc arena.
Simon Glass08ef3052015-08-10 20:44:30 -0600182 *
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100183 * @top: top of the reserve area, growing down.
184 * @return: bottom of reserved area
185 */
186ulong board_init_f_alloc_reserve(ulong top);
187
188/**
189 * board_init_f_init_reserve - initialize the reserved area(s)
Simon Glass08ef3052015-08-10 20:44:30 -0600190 *
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100191 * This function is called once the C runtime has allocated the reserved
192 * area on the stack. It must initialize the GD at the base of that area.
Simon Glass08ef3052015-08-10 20:44:30 -0600193 *
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100194 * @base: top from which reservation was done
Simon Glass08ef3052015-08-10 20:44:30 -0600195 */
Albert ARIBAUD6cb4c462015-11-25 17:56:32 +0100196void board_init_f_init_reserve(ulong base);
Simon Glass08ef3052015-08-10 20:44:30 -0600197
198/**
199 * arch_setup_gd() - Set up the global_data pointer
200 *
201 * This pointer is special in some architectures and cannot easily be assigned
202 * to. For example on x86 it is implemented by adding a specific record to its
203 * Global Descriptor Table! So we we provide a function to carry out this task.
204 * For most architectures this can simply be:
205 *
206 * gd = gd_ptr;
207 *
208 * @gd_ptr: Pointer to global data
209 */
210void arch_setup_gd(gd_t *gd_ptr);
211
Masahiro Yamada9607f7a2015-01-14 17:07:05 +0900212int checkboard(void);
213int show_board_info(void);
214int checkflash(void);
215int checkdram(void);
216int last_stage_init(void);
wdenkb9a83a92003-05-30 12:48:29 +0000217extern ulong monitor_flash_len;
Haiying Wang34c68782006-07-12 10:48:05 -0400218int mac_read_from_eeprom(void);
Masahiro Yamada43c08932014-02-05 11:28:25 +0900219extern u8 __dtb_dt_begin[]; /* embedded device tree blob */
Hadli, Manjunath0dfccbe2012-02-06 00:30:44 +0000220int set_cpu_clk_info(void);
Simon Glasse3a762c2014-04-10 20:01:32 -0600221int mdm_init(void);
Simon Glassc45e3592013-03-11 06:49:53 +0000222int print_cpuinfo(void);
Simon Glass5af29bd2013-03-14 07:20:12 +0000223int update_flash_size(int flash_size);
Simon Glass84640e82014-02-27 13:26:25 -0700224int arch_early_init_r(void);
wdenke2211742002-11-02 23:30:20 +0000225
Simon Glassbbf26ab2017-03-31 08:40:36 -0600226/*
227 * setup_board_extra() - Fill in extra details in the bd_t structure
228 *
229 * @return 0 if OK, -ve on error
230 */
231int setup_board_extra(void);
232
Simon Glasseacd14f2012-11-30 13:01:20 +0000233/**
Simon Glass295c4232017-03-28 10:27:18 -0600234 * arch_fsp_init() - perform firmware support package init
235 *
236 * Where U-Boot relies on binary blobs to handle part of the system init, this
237 * function can be used to set up the blobs. This is used on some Intel
238 * platforms.
239 */
240int arch_fsp_init(void);
241
242/**
Simon Glass7af8d052015-03-05 12:25:16 -0700243 * arch_cpu_init_dm() - init CPU after driver model is available
244 *
245 * This is called immediately after driver model is available before
246 * relocation. This is similar to arch_cpu_init() but is able to reference
247 * devices
248 *
249 * @return 0 if OK, -ve on error
250 */
251int arch_cpu_init_dm(void);
252
253/**
Andreas Bießmann25429862015-02-06 23:06:45 +0100254 * Reserve all necessary stacks
255 *
256 * This is used in generic board init sequence in common/board_f.c. Each
257 * architecture could provide this function to tailor the required stacks.
258 *
259 * On entry gd->start_addr_sp is pointing to the suggested top of the stack.
260 * The callee ensures gd->start_add_sp is 16-byte aligned, so architectures
261 * require only this can leave it untouched.
262 *
263 * On exit gd->start_addr_sp and gd->irq_sp should be set to the respective
264 * positions of the stack. The stack pointer(s) will be set to this later.
265 * gd->irq_sp is only required, if the architecture needs it.
266 *
267 * @return 0 if no error
268 */
269__weak int arch_reserve_stacks(void);
270
271/**
Simon Glasseacd14f2012-11-30 13:01:20 +0000272 * Show the DRAM size in a board-specific way
273 *
274 * This is used by boards to display DRAM information in their own way.
275 *
276 * @param size Size of DRAM (which should be displayed along with other info)
277 */
Andrew Bradfordec9dbc92015-05-22 08:30:14 -0400278void board_show_dram(phys_size_t size);
Simon Glasseacd14f2012-11-30 13:01:20 +0000279
Simon Glass9ca37422013-05-08 08:06:01 +0000280/**
Ma Haijun62358242014-07-12 14:24:06 +0100281 * arch_fixup_fdt() - Write arch-specific information to fdt
Simon Glass9ca37422013-05-08 08:06:01 +0000282 *
Ma Haijun62358242014-07-12 14:24:06 +0100283 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
Simon Glass9ca37422013-05-08 08:06:01 +0000284 *
285 * @blob: FDT blob to write to
286 * @return 0 if ok, or -ve FDT_ERR_... on failure
287 */
Ma Haijun62358242014-07-12 14:24:06 +0100288int arch_fixup_fdt(void *blob);
Simon Glass9ca37422013-05-08 08:06:01 +0000289
Siva Durga Prasad Paladugu05223532017-07-13 19:01:08 +0530290int reserve_mmu(void);
wdenke2211742002-11-02 23:30:20 +0000291/* common/flash.c */
292void flash_perror (int);
293
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200294/* common/cmd_source.c */
295int source (ulong addr, const char *fit_uname);
wdenke2211742002-11-02 23:30:20 +0000296
wdenk87249ba2004-01-06 22:38:14 +0000297extern ulong load_addr; /* Default Load Address */
Simon Glass34f52292011-10-21 18:51:38 +0000298extern ulong save_addr; /* Default Save Address */
299extern ulong save_size; /* Default Save Size */
wdenke2211742002-11-02 23:30:20 +0000300
Jason Hobbs0e3a5932011-08-31 10:37:30 -0500301/* common/cmd_net.c */
302int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
303
Rob Herringeee675f2012-05-25 10:47:39 +0000304/* common/cmd_fat.c */
305int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
306
307/* common/cmd_ext2.c */
308int do_ext2load(cmd_tbl_t *, int, int, char * const []);
309
wdenke2211742002-11-02 23:30:20 +0000310/* common/cmd_nvedit.c */
311int env_init (void);
312void env_relocate (void);
Rafal Jaworowski75b54422008-01-09 18:05:27 +0100313int envmatch (uchar *, int);
Simon Glasse128a4e2014-02-27 13:26:21 -0700314
Simon Glass64b723f2017-08-03 12:22:12 -0600315/**
316 * env_get() - Look up the value of an environment variable
317 *
318 * In U-Boot proper this can be called before relocation (which is when the
319 * environment is loaded from storage, i.e. GD_FLG_ENV_READY is 0). In that
320 * case this function calls env_get_f().
321 *
322 * @varname: Variable to look up
323 * @return value of variable, or NULL if not found
324 */
325char *env_get(const char *varname);
326
327/**
328 * env_get_f() - Look up the value of an environment variable (early)
329 *
330 * This function is called from env_get() if the environment has not been
331 * loaded yet (GD_FLG_ENV_READY flag is 0). Some environment locations will
332 * support reading the value (slowly) and some will not.
333 *
334 * @varname: Variable to look up
335 * @return value of variable, or NULL if not found
336 */
337int env_get_f(const char *name, char *buf, unsigned len);
338
Simon Glass22c34c22017-08-03 12:22:13 -0600339/**
340 * env_get_ulong() - Return an environment variable as an integer value
341 *
342 * Most U-Boot environment variables store hex values. For those which store
343 * (e.g.) base-10 integers, this function can be used to read the value.
344 *
345 * @name: Variable to look up
346 * @base: Base to use (e.g. 10 for base 10, 2 for binary)
347 * @default_val: Default value to return if no value is found
348 * @return the value found, or @default_val if none
349 */
350ulong env_get_ulong(const char *name, int base, ulong default_val);
Simon Glassabbd5122013-04-20 08:42:43 +0000351
352/**
Simon Glass22c34c22017-08-03 12:22:13 -0600353 * env_get_hex() - Return an environment variable as a hex value
Simon Glassabbd5122013-04-20 08:42:43 +0000354 *
355 * Decode an environment as a hex number (it may or may not have a 0x
356 * prefix). If the environment variable cannot be found, or does not start
357 * with hex digits, the default value is returned.
358 *
359 * @varname: Variable to decode
360 * @default_val: Value to return on error
361 */
Simon Glass22c34c22017-08-03 12:22:13 -0600362ulong env_get_hex(const char *varname, ulong default_val);
Simon Glassabbd5122013-04-20 08:42:43 +0000363
Joe Hershberger864ec562012-12-11 22:16:22 -0600364/*
365 * Read an environment variable as a boolean
366 * Return -1 if variable does not exist (default to true)
367 */
Simon Glass22c34c22017-08-03 12:22:13 -0600368int env_get_yesno(const char *var);
Simon Glass6a38e412017-08-03 12:22:09 -0600369
370/**
371 * env_set() - set an environment variable
372 *
373 * This sets or deletes the value of an environment variable. For setting the
374 * value the variable is created if it does not already exist.
375 *
376 * @varname: Variable to adjust
377 * @value: Value to set for the variable, or NULL or "" to delete the variable
378 * @return 0 if OK, 1 on error
379 */
380int env_set(const char *varname, const char *value);
381
Simon Glass044dc9e2013-02-24 17:33:21 +0000382/**
Simon Glass4d949a22017-08-03 12:22:10 -0600383 * env_set_ulong() - set an environment variable to an integer
384 *
385 * @varname: Variable to adjust
386 * @value: Value to set for the variable (will be converted to a string)
387 * @return 0 if OK, 1 on error
388 */
389int env_set_ulong(const char *varname, ulong value);
390
391/**
392 * env_set_hex() - set an environment variable to a hex value
393 *
394 * @varname: Variable to adjust
395 * @value: Value to set for the variable (will be converted to a hex string)
396 * @return 0 if OK, 1 on error
397 */
398int env_set_hex(const char *varname, ulong value);
399
400/**
401 * env_set_addr - Set an environment variable to an address in hex
Simon Glass044dc9e2013-02-24 17:33:21 +0000402 *
Robert P. J. Day832d36e2013-09-16 07:15:45 -0400403 * @varname: Environment variable to set
Simon Glass044dc9e2013-02-24 17:33:21 +0000404 * @addr: Value to set it to
405 * @return 0 if ok, 1 on error
406 */
Simon Glass4d949a22017-08-03 12:22:10 -0600407static inline int env_set_addr(const char *varname, const void *addr)
Simon Glass044dc9e2013-02-24 17:33:21 +0000408{
Simon Glass4d949a22017-08-03 12:22:10 -0600409 return env_set_hex(varname, (ulong)addr);
Simon Glass044dc9e2013-02-24 17:33:21 +0000410}
411
wdenk3902d702004-04-15 18:22:41 +0000412#ifdef CONFIG_AUTO_COMPLETE
413int env_complete(char *var, int maxv, char *cmdv[], int maxsz, char *buf);
414#endif
Heiko Schocher0c303fa2009-02-10 09:38:52 +0100415int get_env_id (void);
wdenk3902d702004-04-15 18:22:41 +0000416
wdenk87249ba2004-01-06 22:38:14 +0000417void pci_init (void);
418void pci_init_board(void);
wdenke2211742002-11-02 23:30:20 +0000419
Cooper Jr., Franklind8b354a2017-06-16 17:25:12 -0500420#if defined(CONFIG_DTB_RESELECT)
421int embedded_dtb_select(void);
422#endif
423
wdenke2211742002-11-02 23:30:20 +0000424int misc_init_f (void);
425int misc_init_r (void);
426
wdenk874ac262003-07-24 23:38:38 +0000427/* common/exports.c */
428void jumptable_init(void);
429
Mike Frysingera46fbba2009-05-20 04:35:14 -0400430/* common/kallsysm.c */
431const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
432
wdenk87249ba2004-01-06 22:38:14 +0000433/* common/memsize.c */
Albert ARIBAUDa9606732011-07-03 05:55:33 +0000434long get_ram_size (long *, long);
York Sun863e8d82014-02-11 11:57:26 -0800435phys_size_t get_effective_memsize(void);
wdenk87249ba2004-01-06 22:38:14 +0000436
wdenke2211742002-11-02 23:30:20 +0000437/* $(BOARD)/$(BOARD).c */
438void reset_phy (void);
wdenk87249ba2004-01-06 22:38:14 +0000439void fdc_hw_init (void);
wdenke2211742002-11-02 23:30:20 +0000440
441/* $(BOARD)/eeprom.c */
Simon Glass7c5ad8b2017-05-12 21:09:49 -0600442#ifdef CONFIG_CMD_EEPROM
Marek Vasutf422ae72015-11-10 20:53:31 +0100443void eeprom_init (int bus);
wdenke2211742002-11-02 23:30:20 +0000444int eeprom_read (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
445int eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
Simon Glass7c5ad8b2017-05-12 21:09:49 -0600446#else
447/*
448 * Some EEPROM code is depecated because it used the legacy I2C interface. Add
449 * some macros here so we don't have to touch every one of those uses
450 */
451#define eeprom_init(bus)
452#define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
453#define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
454#endif
wdenke2211742002-11-02 23:30:20 +0000455
456/*
457 * Set this up regardless of board
458 * type, to prevent errors.
459 */
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200460#if defined(CONFIG_SPI) || !defined(CONFIG_SYS_I2C_EEPROM_ADDR)
461# define CONFIG_SYS_DEF_EEPROM_ADDR 0
wdenke2211742002-11-02 23:30:20 +0000462#else
Heiko Schocher9bb0dd52010-01-07 08:55:40 +0100463#if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200464# define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
Heiko Schocher9bb0dd52010-01-07 08:55:40 +0100465#endif
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200466#endif /* CONFIG_SPI || !defined(CONFIG_SYS_I2C_EEPROM_ADDR) */
wdenke2211742002-11-02 23:30:20 +0000467
wdenk0a658552003-08-05 17:43:17 +0000468#if defined(CONFIG_SPI)
wdenke2211742002-11-02 23:30:20 +0000469extern void spi_init_f (void);
470extern void spi_init_r (void);
wdenk87249ba2004-01-06 22:38:14 +0000471extern ssize_t spi_read (uchar *, int, uchar *, int);
wdenke2211742002-11-02 23:30:20 +0000472extern ssize_t spi_write (uchar *, int, uchar *, int);
473#endif
474
wdenke2211742002-11-02 23:30:20 +0000475/* $(BOARD)/$(BOARD).c */
wdenkda55c6e2004-01-20 23:12:12 +0000476int board_early_init_f (void);
mario.six@gdsys.cc7e9b9d62017-02-22 16:07:22 +0100477int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
wdenkda55c6e2004-01-20 23:12:12 +0000478int board_late_init (void);
wdenke2211742002-11-02 23:30:20 +0000479int board_postclk_init (void); /* after clocks/timebase, before env/serial */
wdenkda55c6e2004-01-20 23:12:12 +0000480int board_early_init_r (void);
wdenke2211742002-11-02 23:30:20 +0000481void board_poweroff (void);
482
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200483#if defined(CONFIG_SYS_DRAM_TEST)
wdenke2211742002-11-02 23:30:20 +0000484int testdram(void);
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200485#endif /* CONFIG_SYS_DRAM_TEST */
wdenke2211742002-11-02 23:30:20 +0000486
487/* $(CPU)/start.S */
wdenke2211742002-11-02 23:30:20 +0000488int icache_status (void);
489void icache_enable (void);
490void icache_disable(void);
491int dcache_status (void);
492void dcache_enable (void);
493void dcache_disable(void);
Aneesh V960f5c02011-06-16 23:30:47 +0000494void mmu_disable(void);
Benoît Thébaudeaua0436612013-04-11 09:35:53 +0000495#if defined(CONFIG_ARM)
496void relocate_code(ulong);
497#else
498void relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
Benoît Thébaudeau9039c102013-04-11 09:35:43 +0000499#endif
wdenke2211742002-11-02 23:30:20 +0000500ulong get_endaddr (void);
501void trap_init (ulong);
Simon Glass243182c2017-05-17 08:23:06 -0600502
wdenke2211742002-11-02 23:30:20 +0000503/* $(CPU)/cpu.c */
Timur Tabi47289422011-08-05 16:15:24 -0500504static inline int cpumask_next(int cpu, unsigned int mask)
505{
506 for (cpu++; !((1 << cpu) & mask); cpu++)
507 ;
508
509 return cpu;
510}
511
512#define for_each_cpu(iter, cpu, num_cpus, mask) \
513 for (iter = 0, cpu = cpumask_next(-1, mask); \
514 iter < num_cpus; \
515 iter++, cpu = cpumask_next(cpu, mask)) \
516
Poonam Aggrwal4baef822009-07-31 12:08:14 +0530517int cpu_numcores (void);
Shaveta Leekhadbf0bc82015-01-19 12:46:54 +0530518int cpu_num_dspcores(void);
Timur Tabi47289422011-08-05 16:15:24 -0500519u32 cpu_mask (void);
Shaveta Leekhadbf0bc82015-01-19 12:46:54 +0530520u32 cpu_dsp_mask(void);
Timur Tabi47289422011-08-05 16:15:24 -0500521int is_core_valid (unsigned int);
Simon Glass302445a2017-01-23 13:31:22 -0700522
523/**
524 * arch_cpu_init() - basic cpu-dependent setup for an architecture
525 *
526 * This is called after early malloc is available. It should handle any
527 * CPU- or SoC- specific init needed to continue the init sequence. See
528 * board_f.c for where it is called. If this is not provided, a default
529 * version (which does nothing) will be used.
530 */
531int arch_cpu_init(void);
532
wdenke2211742002-11-02 23:30:20 +0000533int checkcpu (void);
534int checkicache (void);
535int checkdcache (void);
536void upmconfig (unsigned int, unsigned int *, unsigned int);
537ulong get_tbclk (void);
Przemyslaw Marczakec1c1222014-09-01 13:50:48 +0200538void reset_misc (void);
wdenk1e8d0c52005-04-03 17:23:39 +0000539void reset_cpu (ulong addr);
Kim Phillipsdc0b59d2007-08-15 22:30:26 -0500540void ft_cpu_setup(void *blob, bd_t *bd);
Kim Phillipsdc0b59d2007-08-15 22:30:26 -0500541void ft_pci_setup(void *blob, bd_t *bd);
Kim Phillipsdc0b59d2007-08-15 22:30:26 -0500542
Andre Przywaradbbe1962013-09-19 18:06:44 +0200543void smp_set_core_boot_addr(unsigned long addr, int corenr);
544void smp_kick_all_cpus(void);
wdenke2211742002-11-02 23:30:20 +0000545
546/* $(CPU)/serial.c */
547int serial_init (void);
548void serial_setbrg (void);
549void serial_putc (const char);
wdenke0c812a2005-04-03 15:51:42 +0000550void serial_putc_raw(const char);
wdenke2211742002-11-02 23:30:20 +0000551void serial_puts (const char *);
wdenke2211742002-11-02 23:30:20 +0000552int serial_getc (void);
553int serial_tstc (void);
554
555/* $(CPU)/speed.c */
556int get_clocks (void);
wdenke2211742002-11-02 23:30:20 +0000557ulong get_bus_freq (ulong);
Stefan Roese3ddce572010-09-20 16:05:31 +0200558int get_serial_clock(void);
wdenke2211742002-11-02 23:30:20 +0000559
wdenke2211742002-11-02 23:30:20 +0000560int cpu_init_r (void);
wdenke2211742002-11-02 23:30:20 +0000561
562/* $(CPU)/interrupts.c */
wdenk87249ba2004-01-06 22:38:14 +0000563int interrupt_init (void);
564void timer_interrupt (struct pt_regs *);
wdenke2211742002-11-02 23:30:20 +0000565void external_interrupt (struct pt_regs *);
566void irq_install_handler(int, interrupt_handler_t *, void *);
567void irq_free_handler (int);
568void reset_timer (void);
Simon Glassc44b8002013-06-11 11:14:39 -0700569
570/* Return value of monotonic microsecond timer */
571unsigned long timer_get_us(void);
572
wdenke2211742002-11-02 23:30:20 +0000573void enable_interrupts (void);
574int disable_interrupts (void);
575
576/* $(CPU)/.../commproc.c */
577int dpram_init (void);
578uint dpram_base(void);
579uint dpram_base_align(uint align);
580uint dpram_alloc(uint size);
581uint dpram_alloc_align(uint size,uint align);
wdenk0a658552003-08-05 17:43:17 +0000582void bootcount_store (ulong);
583ulong bootcount_load (void);
584#define BOOTCOUNT_MAGIC 0xB001C041
wdenke2211742002-11-02 23:30:20 +0000585
586/* $(CPU)/.../<eth> */
Wolfgang Denk0769f192007-08-29 14:05:30 +0200587void mii_init (void);
wdenke2211742002-11-02 23:30:20 +0000588
589/* $(CPU)/.../lcd.c */
590ulong lcd_setmem (ulong);
591
wdenke2211742002-11-02 23:30:20 +0000592/* $(CPU)/.../video.c */
593ulong video_setmem (ulong);
594
Peter Tysercede5d82010-04-12 22:28:04 -0500595/* arch/$(ARCH)/lib/cache.c */
Aneesh Vfffbb972011-08-16 04:33:05 +0000596void enable_caches(void);
wdenke2211742002-11-02 23:30:20 +0000597void flush_cache (unsigned long, unsigned long);
Aneesh V960f5c02011-06-16 23:30:47 +0000598void flush_dcache_all(void);
Stefan Roese9bf63bf2009-01-21 17:20:20 +0100599void flush_dcache_range(unsigned long start, unsigned long stop);
600void invalidate_dcache_range(unsigned long start, unsigned long stop);
Aneesh V960f5c02011-06-16 23:30:47 +0000601void invalidate_dcache_all(void);
602void invalidate_icache_all(void);
wdenk359733b2003-03-31 17:27:09 +0000603
Simon Glass442e5d72015-05-13 07:02:25 -0600604enum {
605 /* Disable caches (else flush caches but leave them active) */
606 CBL_DISABLE_CACHES = 1 << 0,
607 CBL_SHOW_BOOTSTAGE_REPORT = 1 << 1,
608
609 CBL_ALL = 3,
610};
611
612/**
613 * Clean up ready for linux
614 *
615 * @param flags Flags to control what is done
616 */
617int cleanup_before_linux_select(int flags);
618
Peter Tysercede5d82010-04-12 22:28:04 -0500619/* arch/$(ARCH)/lib/ticks.S */
Simon Glass0e103162014-10-15 04:38:33 -0600620uint64_t get_ticks(void);
wdenke2211742002-11-02 23:30:20 +0000621void wait_ticks (unsigned long);
622
Peter Tysercede5d82010-04-12 22:28:04 -0500623/* arch/$(ARCH)/lib/time.c */
wdenke2211742002-11-02 23:30:20 +0000624ulong usec2ticks (unsigned long usec);
625ulong ticks2usec (unsigned long ticks);
wdenke2211742002-11-02 23:30:20 +0000626
Peter Tyser685b7f52010-04-12 22:28:05 -0500627/* lib/gunzip.c */
Wolfgang Wegner32d15b92009-12-09 15:16:47 +0100628int gunzip(void *, int, unsigned char *, unsigned long *);
629int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
630 int stoponerr, int offset);
631
Eric Nelson5441b042015-02-17 11:30:30 -0700632/**
633 * gzwrite progress indicators: defined weak to allow board-specific
634 * overrides:
635 *
636 * gzwrite_progress_init called on startup
637 * gzwrite_progress called during decompress/write loop
638 * gzwrite_progress_finish called at end of loop to
639 * indicate success (retcode=0) or failure
640 */
641void gzwrite_progress_init(u64 expected_size);
642
643void gzwrite_progress(int iteration,
644 u64 bytes_written,
645 u64 total_bytes);
646
647void gzwrite_progress_finish(int retcode,
648 u64 totalwritten,
649 u64 totalsize,
650 u32 expected_crc,
651 u32 calculated_crc);
652
653/**
654 * decompress and write gzipped image from memory to block device
655 *
656 * @param src compressed image address
657 * @param len compressed image length in bytes
658 * @param dev block device descriptor
659 * @param szwritebuf bytes per write (pad to erase size)
660 * @param startoffs offset in bytes of first write
661 * @param szexpected expected uncompressed length
662 * may be zero to use gzip trailer
663 * for files under 4GiB
664 */
665int gzwrite(unsigned char *src, int len,
Simon Glasse3394752016-02-29 15:25:34 -0700666 struct blk_desc *dev,
Eric Nelson5441b042015-02-17 11:30:30 -0700667 unsigned long szwritebuf,
668 u64 startoffs,
669 u64 szexpected);
670
Julius Wernerf41a3ca2015-10-06 20:03:53 -0700671/* lib/lz4_wrapper.c */
672int ulz4fn(const void *src, size_t srcn, void *dst, size_t *dstn);
673
Wolfgang Denk90699222010-06-13 01:45:10 +0200674/* lib/qsort.c */
675void qsort(void *base, size_t nmemb, size_t size,
676 int(*compar)(const void *, const void *));
Mike Frysinger8d882322010-12-17 16:51:59 -0500677int strcmp_compar(const void *, const void *);
Wolfgang Denk90699222010-06-13 01:45:10 +0200678
Jason Hobbs6e39cce2011-08-23 11:06:56 +0000679/* lib/uuid.c */
Przemyslaw Marczak0c813362014-04-02 10:20:03 +0200680#include <uuid.h>
Jason Hobbs6e39cce2011-08-23 11:06:56 +0000681
Peter Tyser685b7f52010-04-12 22:28:05 -0500682/* lib/vsprintf.c */
Simon Glassf7ae68062011-11-02 09:52:07 +0000683#include <vsprintf.h>
wdenke2211742002-11-02 23:30:20 +0000684
Peter Tyser685b7f52010-04-12 22:28:05 -0500685/* lib/strmhz.c */
Ed Swarthoutd065acb2011-03-05 10:28:17 -0600686char * strmhz(char *buf, unsigned long hz);
Haavard Skinnemoenb644d6b2008-08-18 13:41:27 +0200687
Peter Tyser685b7f52010-04-12 22:28:05 -0500688/* lib/crc32.c */
Prafulla Wadaskar4d4d67d2009-08-16 05:28:19 +0530689#include <u-boot/crc.h>
wdenke2211742002-11-02 23:30:20 +0000690
Michael Walled96bd012012-06-05 11:33:14 +0000691/* lib/rand.c */
Michael Walled96bd012012-06-05 11:33:14 +0000692#define RAND_MAX -1U
693void srand(unsigned int seed);
694unsigned int rand(void);
695unsigned int rand_r(unsigned int *seedp);
Michael Walled96bd012012-06-05 11:33:14 +0000696
wdenke2211742002-11-02 23:30:20 +0000697/*
698 * STDIO based functions (can always be used)
699 */
wdenke2211742002-11-02 23:30:20 +0000700/* serial stuff */
Wolfgang Denk318ef5c2010-06-20 17:14:14 +0200701int serial_printf (const char *fmt, ...)
Andrew Klossnere4ad4542008-07-07 06:41:14 -0700702 __attribute__ ((format (__printf__, 1, 2)));
wdenke2211742002-11-02 23:30:20 +0000703
Lei Wen7592d1b2012-09-28 04:26:46 +0000704/* lib/gzip.c */
705int gzip(void *dst, unsigned long *lenp,
706 unsigned char *src, unsigned long srclen);
707int zzip(void *dst, unsigned long *lenp, unsigned char *src,
708 unsigned long srclen, int stoponerr,
709 int (*func)(unsigned long, unsigned long));
710
Joe Hershberger05a377b2012-05-23 08:01:04 +0000711/* lib/net_utils.c */
712#include <net.h>
Simon Glassda1a1342017-08-03 12:22:15 -0600713static inline struct in_addr env_get_ip(char *var)
Joe Hershberger05a377b2012-05-23 08:01:04 +0000714{
Simon Glass64b723f2017-08-03 12:22:12 -0600715 return string_to_ip(env_get(var));
Joe Hershberger05a377b2012-05-23 08:01:04 +0000716}
717
wdenke2211742002-11-02 23:30:20 +0000718int pcmcia_init (void);
719
Uri Mashiach4892d392017-01-19 10:51:45 +0200720#ifdef CONFIG_LED_STATUS
Wolfgang Denkdf8e2142009-07-27 09:58:14 +0200721# include <status_led.h>
722#endif
Simon Glass8445d002012-01-14 15:24:44 +0000723
724#include <bootstage.h>
wdenke2211742002-11-02 23:30:20 +0000725
Joe Hershberger77001b432012-05-15 08:59:08 +0000726#ifdef CONFIG_SHOW_ACTIVITY
727void show_activity(int arg);
728#endif
729
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200730/* Multicore arch functions */
731#ifdef CONFIG_MP
732int cpu_status(int nr);
733int cpu_reset(int nr);
Kumar Gala006e2c82010-01-12 11:42:43 -0600734int cpu_disable(int nr);
Wolfgang Denk6262d0212010-06-28 22:00:46 +0200735int cpu_release(int nr, int argc, char * const argv[]);
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200736#endif
737
Andre Przywara9fcee532017-01-02 11:48:30 +0000738#else /* __ASSEMBLY__ */
739
740/* Drop a C type modifier (like in 3UL) for constants used in assembly. */
741#define _AC(X, Y) X
742
743#endif /* __ASSEMBLY__ */
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200744
745/* Put only stuff here that the assembler can digest */
746
Andre Przywara9fcee532017-01-02 11:48:30 +0000747/* Declare an unsigned long constant digestable both by C and an assembler. */
748#define UL(x) _AC(x, UL)
749
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200750#ifdef CONFIG_POST
751#define CONFIG_HAS_POST
Michael Zaidmanf969a682010-09-20 08:51:53 +0200752#ifndef CONFIG_POST_ALT_LIST
753#define CONFIG_POST_STD_LIST
754#endif
Wolfgang Denk66e8d442009-07-24 00:17:48 +0200755#endif
756
wdenk3d3d99f2005-04-04 12:44:11 +0000757#ifdef CONFIG_INIT_CRITICAL
Wolfgang Denk5e3a8732006-08-14 23:17:47 +0200758#error CONFIG_INIT_CRITICAL is deprecated!
wdenk3d3d99f2005-04-04 12:44:11 +0000759#error Read section CONFIG_SKIP_LOWLEVEL_INIT in README.
760#endif
761
Anton Staaf07a036a2011-09-02 13:45:28 +0000762#define ROUND(a,b) (((a) + (b) - 1) & ~((b) - 1))
Andy Fleming2ef5ed02008-06-16 13:58:53 -0500763
Anton Staafcda2e482011-10-17 16:46:13 -0700764/*
Simon Glassd61718b2015-06-23 15:38:31 -0600765 * check_member() - Check the offset of a structure member
766 *
767 * @structure: Name of structure (e.g. global_data)
768 * @member: Name of member (e.g. baudrate)
769 * @offset: Expected offset in bytes
770 */
771#define check_member(structure, member, offset) _Static_assert( \
772 offsetof(struct structure, member) == offset, \
773 "`struct " #structure "` offset for `" #member "` is not " #offset)
774
Simon Glass63f581f2015-08-04 12:33:52 -0600775/* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
776#ifdef CONFIG_EFI_STUB
777#define ll_boot_init() false
778#else
779#define ll_boot_init() true
780#endif
781
Mike Frysinger63b8f122011-07-08 10:44:25 +0000782/* Pull in stuff for the build system */
783#ifdef DO_DEPS_ONLY
784# include <environment.h>
785#endif
786
wdenke2211742002-11-02 23:30:20 +0000787#endif /* __COMMON_H_ */