xref: /openbmc/u-boot/README (revision 39f615ed)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1356eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1366eae68e4SMasahiro Yamada    /cpu		CPU specific files
1376eae68e4SMasahiro Yamada      /arc700		Files specific to ARC 700 CPUs
1386eae68e4SMasahiro Yamada    /lib		Architecture specific library files
1398d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1408d321b81SPeter Tyser    /cpu		CPU specific files
1418d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1428d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1436eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1448d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1458d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1468d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1478d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1488d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1498d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser    /lib		Architecture specific library files
1578d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1588d321b81SPeter Tyser    /cpu		CPU specific files
1598d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1608d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1618d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1628d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1638d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
1678d321b81SPeter Tyser    /lib		Architecture specific library files
1688d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1698d321b81SPeter Tyser    /cpu		CPU specific files
17092bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
1716eae68e4SMasahiro Yamada      /mips64		Files specific to MIPS64 CPUs
1728d321b81SPeter Tyser    /lib		Architecture specific library files
173afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
174afc1ce82SMacpaul Lin    /cpu		CPU specific files
175afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
176afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1778d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1788d321b81SPeter Tyser    /cpu		CPU specific files
1798d321b81SPeter Tyser    /lib		Architecture specific library files
18033c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
18133c7731bSRobert P. J. Day    /cpu		CPU specific files
18233c7731bSRobert P. J. Day    /lib		Architecture specific library files
183a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1868d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1878d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1888d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1898d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1908d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1918d321b81SPeter Tyser    /lib		Architecture specific library files
1928d321b81SPeter Tyser  /sh			Files generic to SH architecture
1938d321b81SPeter Tyser    /cpu		CPU specific files
1948d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1958d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1968d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1978d321b81SPeter Tyser    /lib		Architecture specific library files
1988d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1998d321b81SPeter Tyser    /cpu		CPU specific files
2008d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2018d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2028d321b81SPeter Tyser    /lib		Architecture specific library files
20333c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20433c7731bSRobert P. J. Day    /cpu		CPU specific files
20533c7731bSRobert P. J. Day    /lib		Architecture specific library files
2068d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2078d321b81SPeter Tyser/board			Board dependent files
2088d321b81SPeter Tyser/common			Misc architecture independent functions
2098d321b81SPeter Tyser/disk			Code for disk drive partition handling
2108d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2118d321b81SPeter Tyser/drivers		Commonly used device drivers
21233c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2138d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2148d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2158d321b81SPeter Tyser/include		Header Files
2168d321b81SPeter Tyser/lib			Files generic to all architectures
2178d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2188d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2198d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2208d321b81SPeter Tyser/net			Networking code
2218d321b81SPeter Tyser/post			Power On Self Test
22233c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2238d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
224c609719bSwdenk
225c609719bSwdenkSoftware Configuration:
226c609719bSwdenk=======================
227c609719bSwdenk
228c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
229c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
230c609719bSwdenk
231c609719bSwdenkThere are two classes of configuration variables:
232c609719bSwdenk
233c609719bSwdenk* Configuration _OPTIONS_:
234c609719bSwdenk  These are selectable by the user and have names beginning with
235c609719bSwdenk  "CONFIG_".
236c609719bSwdenk
237c609719bSwdenk* Configuration _SETTINGS_:
238c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
239c609719bSwdenk  you don't know what you're doing; they have names beginning with
2406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
241c609719bSwdenk
242c609719bSwdenkLater we will add a configuration tool - probably similar to or even
243c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
244c609719bSwdenkdo the configuration by hand, which means creating some symbolic
245c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
246c609719bSwdenkas an example here.
247c609719bSwdenk
248c609719bSwdenk
249c609719bSwdenkSelection of Processor Architecture and Board Type:
250c609719bSwdenk---------------------------------------------------
251c609719bSwdenk
252c609719bSwdenkFor all supported boards there are ready-to-use default
253ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
254c609719bSwdenk
255c609719bSwdenkExample: For a TQM823L module type:
256c609719bSwdenk
257c609719bSwdenk	cd u-boot
258ab584d67SHolger Freyther	make TQM823L_defconfig
259c609719bSwdenk
26011ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
261ab584d67SHolger Freythere.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
262c609719bSwdenkdirectory according to the instructions in cogent/README.
263c609719bSwdenk
264c609719bSwdenk
26575b3c3aaSSimon GlassSandbox Environment:
26675b3c3aaSSimon Glass--------------------
26775b3c3aaSSimon Glass
26875b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
26975b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
27075b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
27175b3c3aaSSimon Glassrun some of U-Boot's tests.
27275b3c3aaSSimon Glass
2736b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
27475b3c3aaSSimon Glass
27575b3c3aaSSimon Glass
276db910353SSimon GlassBoard Initialisation Flow:
277db910353SSimon Glass--------------------------
278db910353SSimon Glass
279db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both
280db910353SSimon GlassSPL and U-Boot proper (i.e. they both follow the same rules). At present SPL
281db910353SSimon Glassmostly uses a separate code path, but the funtion names and roles of each
282db910353SSimon Glassfunction are the same. Some boards or architectures may not conform to this.
283db910353SSimon GlassAt least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this.
284db910353SSimon Glass
285db910353SSimon GlassExecution starts with start.S with three functions called during init after
286db910353SSimon Glassthat. The purpose and limitations of each is described below.
287db910353SSimon Glass
288db910353SSimon Glasslowlevel_init():
289db910353SSimon Glass	- purpose: essential init to permit execution to reach board_init_f()
290db910353SSimon Glass	- no global_data or BSS
291db910353SSimon Glass	- there is no stack (ARMv7 may have one but it will soon be removed)
292db910353SSimon Glass	- must not set up SDRAM or use console
293db910353SSimon Glass	- must only do the bare minimum to allow execution to continue to
294db910353SSimon Glass		board_init_f()
295db910353SSimon Glass	- this is almost never needed
296db910353SSimon Glass	- return normally from this function
297db910353SSimon Glass
298db910353SSimon Glassboard_init_f():
299db910353SSimon Glass	- purpose: set up the machine ready for running board_init_r():
300db910353SSimon Glass		i.e. SDRAM and serial UART
301db910353SSimon Glass	- global_data is available
302db910353SSimon Glass	- stack is in SRAM
303db910353SSimon Glass	- BSS is not available, so you cannot use global/static variables,
304db910353SSimon Glass		only stack variables and global_data
305db910353SSimon Glass
306db910353SSimon Glass	Non-SPL-specific notes:
307db910353SSimon Glass	- dram_init() is called to set up DRAM. If already done in SPL this
308db910353SSimon Glass		can do nothing
309db910353SSimon Glass
310db910353SSimon Glass	SPL-specific notes:
311db910353SSimon Glass	- you can override the entire board_init_f() function with your own
312db910353SSimon Glass		version as needed.
313db910353SSimon Glass	- preloader_console_init() can be called here in extremis
314db910353SSimon Glass	- should set up SDRAM, and anything needed to make the UART work
315db910353SSimon Glass	- these is no need to clear BSS, it will be done by crt0.S
316db910353SSimon Glass	- must return normally from this function (don't call board_init_r()
317db910353SSimon Glass		directly)
318db910353SSimon Glass
319db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
320db910353SSimon Glassthis point the stack and global_data are relocated to below
321db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
322db910353SSimon Glassmemory.
323db910353SSimon Glass
324db910353SSimon Glassboard_init_r():
325db910353SSimon Glass	- purpose: main execution, common code
326db910353SSimon Glass	- global_data is available
327db910353SSimon Glass	- SDRAM is available
328db910353SSimon Glass	- BSS is available, all static/global variables can be used
329db910353SSimon Glass	- execution eventually continues to main_loop()
330db910353SSimon Glass
331db910353SSimon Glass	Non-SPL-specific notes:
332db910353SSimon Glass	- U-Boot is relocated to the top of memory and is now running from
333db910353SSimon Glass		there.
334db910353SSimon Glass
335db910353SSimon Glass	SPL-specific notes:
336db910353SSimon Glass	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
337db910353SSimon Glass		CONFIG_SPL_STACK_R_ADDR points into SDRAM
338db910353SSimon Glass	- preloader_console_init() can be called here - typically this is
339db910353SSimon Glass		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
340db910353SSimon Glass		spl_board_init() function containing this call
341db910353SSimon Glass	- loads U-Boot or (in falcon mode) Linux
342db910353SSimon Glass
343db910353SSimon Glass
344db910353SSimon Glass
345c609719bSwdenkConfiguration Options:
346c609719bSwdenk----------------------
347c609719bSwdenk
348c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
349c609719bSwdenksuch information is kept in a configuration file
350c609719bSwdenk"include/configs/<board_name>.h".
351c609719bSwdenk
352c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
353c609719bSwdenk"include/configs/TQM823L.h".
354c609719bSwdenk
355c609719bSwdenk
3567f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
3577f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
3587f6c2cbcSwdenkbuild a config tool - later.
3597f6c2cbcSwdenk
3607f6c2cbcSwdenk
361c609719bSwdenkThe following options need to be configured:
362c609719bSwdenk
3632628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
364c609719bSwdenk
3652628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
3666ccec449SWolfgang Denk
3676ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
36809ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
369c609719bSwdenk
370c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
371c609719bSwdenk		Define exactly one of
372c609719bSwdenk		CONFIG_CMA286_60_OLD
373c609719bSwdenk--- FIXME --- not tested yet:
374c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
375c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
376c609719bSwdenk
377c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
378c609719bSwdenk		Define exactly one of
379c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
380c609719bSwdenk
381c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
382c609719bSwdenk		Define one or more of
383c609719bSwdenk		CONFIG_CMA302
384c609719bSwdenk
385c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
386c609719bSwdenk		Define one or more of
387c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
38811ccc33fSMarcel Ziswiler					  the LCD display every second with
389c609719bSwdenk					  a "rotator" |\-/|\-/
390c609719bSwdenk
391cf946c6dSLei Wen- Marvell Family Member
392cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
393cf946c6dSLei Wen					  multiple fs option at one time
394cf946c6dSLei Wen					  for marvell soc family
395cf946c6dSLei Wen
39611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
39766ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
39866ca92a5Swdenk					  get_gclk_freq() cannot work
3995da627a4Swdenk					  e.g. if there is no 32KHz
4005da627a4Swdenk					  reference PIT/RTC clock
40166ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
40266ca92a5Swdenk					  or XTAL/EXTAL)
403c609719bSwdenk
40466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
4056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
4066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
40766ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
40875d1ea7fSwdenk			See doc/README.MPC866
40975d1ea7fSwdenk
4106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
41175d1ea7fSwdenk
41275d1ea7fSwdenk		Define this to measure the actual CPU clock instead
41375d1ea7fSwdenk		of relying on the correctness of the configured
41475d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
41575d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
41675d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
4176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
41875d1ea7fSwdenk
419506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
420506f3918SHeiko Schocher
421506f3918SHeiko Schocher		Define this option if you want to enable the
422506f3918SHeiko Schocher		ICache only when Code runs from RAM.
423506f3918SHeiko Schocher
42466412c63SKumar Gala- 85xx CPU Options:
425ffd06e02SYork Sun		CONFIG_SYS_PPC64
426ffd06e02SYork Sun
427ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
428ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
429ffd06e02SYork Sun		compliance, among other possible reasons.
430ffd06e02SYork Sun
43166412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
43266412c63SKumar Gala
43366412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
43466412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
43566412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
43666412c63SKumar Gala
4378f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
4388f29084aSKumar Gala
4398f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
4408f29084aSKumar Gala		tree nodes for the given platform.
4418f29084aSKumar Gala
442afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
443afa6b551SPrabhakar Kushwaha
444afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
445afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
446afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
447afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
448afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
449afa6b551SPrabhakar Kushwaha		purpose.
450afa6b551SPrabhakar Kushwaha
45133eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
45233eee330SScott Wood
45333eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
45433eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
45533eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
45633eee330SScott Wood
45733eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
45833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
45933eee330SScott Wood
46033eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
46133eee330SScott Wood		for which the A004510 workaround should be applied.
46233eee330SScott Wood
46333eee330SScott Wood		The rest of SVR is either not relevant to the decision
46433eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
46533eee330SScott Wood		p2041) or is implied by the build target, which controls
46633eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
46733eee330SScott Wood
46833eee330SScott Wood		See Freescale App Note 4493 for more information about
46933eee330SScott Wood		this erratum.
47033eee330SScott Wood
47174fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
47274fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
473b445bbb4SJeremiah Mahler		required during NOR boot.
47474fa22edSPrabhakar Kushwaha
4759f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
4769f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
477b445bbb4SJeremiah Mahler		required during NAND boot and valid for Rev 1.0 SoC revision
4789f074e67SPrabhakar Kushwaha
47933eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
48033eee330SScott Wood
48133eee330SScott Wood		This is the value to write into CCSR offset 0x18600
48233eee330SScott Wood		according to the A004510 workaround.
48333eee330SScott Wood
48464501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
48564501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
48664501c66SPriyanka Jain		connected exclusively to the DSP cores.
48764501c66SPriyanka Jain
488765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
489765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
490765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
491765b0bdbSPriyanka Jain
49264501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
49364501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
49464501c66SPriyanka Jain		connected to the DSP core.
49564501c66SPriyanka Jain
496765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
497765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
498765b0bdbSPriyanka Jain
499b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
500b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
501b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
502b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
503b135991aSPriyanka Jain
504fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
505fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
506fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
507fb4a2409SAneesh Bansal
508aade2004STang Yuantian		CONFIG_DEEP_SLEEP
509b445bbb4SJeremiah Mahler		Indicates this SoC supports deep sleep feature. If deep sleep is
510aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
511aade2004STang Yuantian
5126cb461b4SDaniel Schwierzeck- Generic CPU options:
5132a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
5142a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
5152a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
5162a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
5172a1680e3SYork Sun		should initialize global data before calling board_init_f().
5182a1680e3SYork Sun
5196cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
5206cb461b4SDaniel Schwierzeck
5216cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
5226cb461b4SDaniel Schwierzeck		values is arch specific.
5236cb461b4SDaniel Schwierzeck
5245614e71bSYork Sun		CONFIG_SYS_FSL_DDR
5255614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
5265614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
5275614e71bSYork Sun		SoCs.
5285614e71bSYork Sun
5295614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
5305614e71bSYork Sun		Freescale DDR memory-mapped register base.
5315614e71bSYork Sun
5325614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
5335614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
5345614e71bSYork Sun		deskew training are not available.
5355614e71bSYork Sun
5365614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
5375614e71bSYork Sun		Freescale DDR1 controller.
5385614e71bSYork Sun
5395614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
5405614e71bSYork Sun		Freescale DDR2 controller.
5415614e71bSYork Sun
5425614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
5435614e71bSYork Sun		Freescale DDR3 controller.
5445614e71bSYork Sun
54534e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
54634e026f9SYork Sun		Freescale DDR4 controller.
54734e026f9SYork Sun
5489ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
5499ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
5509ac4ffbdSYork Sun
5515614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
5525614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
5535614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
5545614e71bSYork Sun		implemetation.
5555614e71bSYork Sun
5565614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
5575614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
5585614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
5595614e71bSYork Sun		implementation.
5605614e71bSYork Sun
5615614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
5625614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
56334e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
56434e026f9SYork Sun
56534e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
56634e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
56734e026f9SYork Sun		DDR3L controllers.
56834e026f9SYork Sun
56934e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
57034e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
57134e026f9SYork Sun		DDR4 controllers.
5725614e71bSYork Sun
5731b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5741b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5751b4175d6SPrabhakar Kushwaha
5761b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5771b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5781b4175d6SPrabhakar Kushwaha
579690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
580690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
581690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
582690e4258SPrabhakar Kushwaha
583690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
584690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
585690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
586690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
587690e4258SPrabhakar Kushwaha
58889ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
58989ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
59089ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
59189ad7be8SPrabhakar Kushwaha
5924e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5934e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5944e5b1bd0SYork Sun
5954e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5964e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5974e5b1bd0SYork Sun
5986b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5996b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
6006b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
6016b9e309aSYork Sun		it could be different for ARM SoCs.
6026b9e309aSYork Sun
6036b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
6046b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
6056b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
6066b1e1254SYork Sun		SoCs with ARM core.
6076b1e1254SYork Sun
6081d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
6091d71efbbSYork Sun		Number of controllers used as main memory.
6101d71efbbSYork Sun
6111d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
6121d71efbbSYork Sun		Number of controllers used for other than main memory.
6131d71efbbSYork Sun
614028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
615028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
616028dbb8dSRuchika Gupta
617028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
618028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
619028dbb8dSRuchika Gupta
6200b953ffcSMarkus Klotzbuecher- Intel Monahans options:
6216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
6220b953ffcSMarkus Klotzbuecher
6230b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
6240b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
6250b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
6260b953ffcSMarkus Klotzbuecher
6276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
6280b953ffcSMarkus Klotzbuecher
6290b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
6300b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
6310b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
6320b953ffcSMarkus Klotzbuecher		by this value.
6330b953ffcSMarkus Klotzbuecher
63492bbd64eSDaniel Schwierzeck- MIPS CPU options:
63592bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
63692bbd64eSDaniel Schwierzeck
63792bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
63892bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
63992bbd64eSDaniel Schwierzeck		relocation.
64092bbd64eSDaniel Schwierzeck
64192bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
64292bbd64eSDaniel Schwierzeck
64392bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
64492bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
64592bbd64eSDaniel Schwierzeck		Possible values are:
64692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
64792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
64892bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
64992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
65092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
65192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
65292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
65392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
65492bbd64eSDaniel Schwierzeck
65592bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
65692bbd64eSDaniel Schwierzeck
65792bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
65892bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
65992bbd64eSDaniel Schwierzeck
66092bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
66192bbd64eSDaniel Schwierzeck
66292bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
66392bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
66492bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
66592bbd64eSDaniel Schwierzeck
666b67d8816SChristian Riesch- ARM options:
667b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
668b67d8816SChristian Riesch
669b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
670b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
671b67d8816SChristian Riesch
6725356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
6735356f545SAneesh V
6745356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6755356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6765356f545SAneesh V		better code density. For ARM architectures that support
6775356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6785356f545SAneesh V		GCC.
6795356f545SAneesh V
680c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6810678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6820678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6830678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
684b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
685e392b923SIan Campbell		CONFIG_ARM_ERRATA_773022
686e392b923SIan Campbell		CONFIG_ARM_ERRATA_774769
687e392b923SIan Campbell		CONFIG_ARM_ERRATA_794072
6880678587fSStephen Warren
6890678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6900678587fSStephen Warren		during U-Boot startup. Note that these options force the
6910678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6920678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6930678587fSStephen Warren		set these options unless they apply!
6940678587fSStephen Warren
695207774b2SYork Sun		COUNTER_FREQUENCY
696207774b2SYork Sun		Generic timer clock source frequency.
697207774b2SYork Sun
698207774b2SYork Sun		COUNTER_FREQUENCY_REAL
699207774b2SYork Sun		Generic timer clock source frequency if the real clock is
700207774b2SYork Sun		different from COUNTER_FREQUENCY, and can only be determined
701207774b2SYork Sun		at run time.
702207774b2SYork Sun
703c616a0dfSNishanth Menon		NOTE: The following can be machine specific errata. These
704c616a0dfSNishanth Menon		do have ability to provide rudimentary version and machine
705c616a0dfSNishanth Menon		specific checks, but expect no product checks.
7065902f4ceSNishanth Menon		CONFIG_ARM_ERRATA_430973
707b45c48a7SNishanth Menon		CONFIG_ARM_ERRATA_454179
7089b4d65f9SNishanth Menon		CONFIG_ARM_ERRATA_621766
709c616a0dfSNishanth Menon		CONFIG_ARM_ERRATA_798870
710a615d0beSNishanth Menon		CONFIG_ARM_ERRATA_801819
711c616a0dfSNishanth Menon
71273c38934SStephen Warren- Tegra SoC options:
71373c38934SStephen Warren		CONFIG_TEGRA_SUPPORT_NON_SECURE
71473c38934SStephen Warren
71573c38934SStephen Warren		Support executing U-Boot in non-secure (NS) mode. Certain
71673c38934SStephen Warren		impossible actions will be skipped if the CPU is in NS mode,
71773c38934SStephen Warren		such as ARM architectural timer initialization.
71873c38934SStephen Warren
7195da627a4Swdenk- Linux Kernel Interface:
720c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
721c609719bSwdenk
722c609719bSwdenk		U-Boot stores all clock information in Hz
723c609719bSwdenk		internally. For binary compatibility with older Linux
724c609719bSwdenk		kernels (which expect the clocks passed in the
725c609719bSwdenk		bd_info data to be in MHz) the environment variable
726c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
727c609719bSwdenk		converts clock data to MHZ before passing it to the
728c609719bSwdenk		Linux kernel.
729c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
730c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
731c609719bSwdenk		default environment.
732c609719bSwdenk
7335da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
7345da627a4Swdenk
735b445bbb4SJeremiah Mahler		When transferring memsize parameter to Linux, some versions
7365da627a4Swdenk		expect it to be in bytes, others in MB.
7375da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
7385da627a4Swdenk
739fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
740f57f70aaSWolfgang Denk
741f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
742213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
743213bf8c8SGerald Van Baren		concepts).
744213bf8c8SGerald Van Baren
745213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
746213bf8c8SGerald Van Baren		 * New libfdt-based support
747213bf8c8SGerald Van Baren		 * Adds the "fdt" command
7483bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
749213bf8c8SGerald Van Baren
750b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
751b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
752b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
753b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
754f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
755c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
756f57f70aaSWolfgang Denk
75711ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
75811ccc33fSMarcel Ziswiler		addresses
7593bb342fcSKim Phillips
7604e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
7614e253137SKumar Gala
7624e253137SKumar Gala		Board code has addition modification that it wants to make
7634e253137SKumar Gala		to the flat device tree before handing it off to the kernel
7646705d81eSwdenk
765c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
766c654b517SSimon Glass
767c654b517SSimon Glass		Other code has addition modification that it wants to make
768c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
769c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
770c654b517SSimon Glass		the kernel.
771c654b517SSimon Glass
7720267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
7730267768eSMatthew McClintock
77411ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
7750267768eSMatthew McClintock		param header, the default value is zero if undefined.
7760267768eSMatthew McClintock
7773887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
7783887c3fbSHeiko Schocher
7793887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
7803887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
7813887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
7823887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
7833887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
7843887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
7853887c3fbSHeiko Schocher
7867eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
7877eb29398SIgor Grinberg
7887eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
7897eb29398SIgor Grinberg		machine type and must be used to specify the machine type
7907eb29398SIgor Grinberg		number as it appears in the ARM machine registry
7917eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
7927eb29398SIgor Grinberg		Only boards that have multiple machine types supported
7937eb29398SIgor Grinberg		in a single configuration file and the machine type is
7947eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
7957eb29398SIgor Grinberg
7960b2f4ecaSNiklaus Giger- vxWorks boot parameters:
7970b2f4ecaSNiklaus Giger
7980b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
7999e98b7e3SBin Meng		environments variables: bootdev, bootfile, ipaddr, netmask,
8009e98b7e3SBin Meng		serverip, gatewayip, hostname, othbootargs.
8010b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
8020b2f4ecaSNiklaus Giger
8030b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
8040b2f4ecaSNiklaus Giger		the defaults discussed just above.
8050b2f4ecaSNiklaus Giger
8062c451f78SAneesh V- Cache Configuration:
8072c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
8082c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
8092c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
8102c451f78SAneesh V
81193bc2193SAneesh V- Cache Configuration for ARM:
81293bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
81393bc2193SAneesh V				      controller
81493bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
81593bc2193SAneesh V					controller register space
81693bc2193SAneesh V
8176705d81eSwdenk- Serial Ports:
81848d0192fSAndreas Engel		CONFIG_PL010_SERIAL
8196705d81eSwdenk
8206705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
8216705d81eSwdenk
82248d0192fSAndreas Engel		CONFIG_PL011_SERIAL
8236705d81eSwdenk
8246705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
8256705d81eSwdenk
8266705d81eSwdenk		CONFIG_PL011_CLOCK
8276705d81eSwdenk
8286705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
8296705d81eSwdenk		the clock speed of the UARTs.
8306705d81eSwdenk
8316705d81eSwdenk		CONFIG_PL01x_PORTS
8326705d81eSwdenk
8336705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
8346705d81eSwdenk		define this to a list of base addresses for each (supported)
8356705d81eSwdenk		port. See e.g. include/configs/versatile.h
8366705d81eSwdenk
837d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
838d57dee57SKaricheri, Muralidharan
839d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
840d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
8416705d81eSwdenk
842c609719bSwdenk- Console Interface:
843c609719bSwdenk		Depending on board, define exactly one serial port
844c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
845c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
846c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
847c609719bSwdenk
848c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
849c609719bSwdenk		port routines must be defined elsewhere
850c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
851c609719bSwdenk
852c609719bSwdenk		CONFIG_CFB_CONSOLE
853c609719bSwdenk		Enables console device for a color framebuffer. Needs following
854c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
855c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
856c609719bSwdenk						(default big endian)
857c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
858c609719bSwdenk						rectangle fill
859c609719bSwdenk						(cf. smiLynxEM)
860c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
861c609719bSwdenk						bit-blit (cf. smiLynxEM)
862c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
863c609719bSwdenk						(cols=pitch)
864c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
865c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
866c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
867c609719bSwdenk						(0-5, cf. cfb_console.c)
868c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
869c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
870*39f615edSSimon Glass						(i.e. rx51_kp_init())
871c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
872*39f615edSSimon Glass						(i.e. rx51_kp_tstc)
873c609719bSwdenk			VIDEO_GETC_FCT		get char fct
874*39f615edSSimon Glass						(i.e. rx51_kp_getc)
875c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
876c609719bSwdenk						upper left corner
877a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
878a6c7ad2fSwdenk						linux_logo.h for logo.
879a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
880c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
88111ccc33fSMarcel Ziswiler						additional board info beside
882c609719bSwdenk						the logo
883c609719bSwdenk
88433a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
88533a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
88633a35bbbSPali Rohár		erase functions and limited graphics rendition control).
88733a35bbbSPali Rohár
888c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
889c609719bSwdenk		default i/o. Serial console can be forced with
890c609719bSwdenk		environment 'console=serial'.
891c609719bSwdenk
892a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
893a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
894a3ad8e26Swdenk		the "silent" environment variable. See
895a3ad8e26Swdenk		doc/README.silent for more information.
896a3ad8e26Swdenk
89745ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
89845ae2546SHeiko Schocher			is 0x00.
89945ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
90045ae2546SHeiko Schocher			is 0xa0.
90145ae2546SHeiko Schocher
902c609719bSwdenk- Console Baudrate:
903c609719bSwdenk		CONFIG_BAUDRATE - in bps
904c609719bSwdenk		Select one of the baudrates listed in
9056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
9066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
907c609719bSwdenk
908c92fac91SHeiko Schocher- Console Rx buffer length
909c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
910c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
9112b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
912c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
913c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
914c92fac91SHeiko Schocher		the SMC.
915c92fac91SHeiko Schocher
9169558b48aSGraeme Russ- Pre-Console Buffer:
9179558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
9189558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
9199558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
9209558b48aSGraeme Russ		buffer any console messages prior to the console being
9219558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
9229558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
9239558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
9249558b48aSGraeme Russ		bytes are output before the console is initialised, the
9259558b48aSGraeme Russ		earlier bytes are discarded.
9269558b48aSGraeme Russ
927a8552c7cSHans de Goede		Note that when printing the buffer a copy is made on the
928a8552c7cSHans de Goede		stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
929a8552c7cSHans de Goede
9309558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
9319558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
9329558b48aSGraeme Russ
933046a37bdSSonny Rao- Safe printf() functions
934046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
935046a37bdSSonny Rao		the printf() functions. These are defined in
936046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
937046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
938046a37bdSSonny Rao		If this option is not given then these functions will
939046a37bdSSonny Rao		silently discard their buffer size argument - this means
940046a37bdSSonny Rao		you are not getting any overflow checking in this case.
941046a37bdSSonny Rao
942c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
943c609719bSwdenk		Delay before automatically booting the default image;
944c609719bSwdenk		set to -1 to disable autoboot.
94593d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
94693d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
947c609719bSwdenk
948c609719bSwdenk		See doc/README.autoboot for these options that
949c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
950c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
951c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
952c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
953c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
954c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
955c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
956c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
957c609719bSwdenk		CONFIG_RESET_TO_RETRY
958c609719bSwdenk
959c609719bSwdenk- Autoboot Command:
960c609719bSwdenk		CONFIG_BOOTCOMMAND
961c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
962c609719bSwdenk		define a command string that is automatically executed
963c609719bSwdenk		when no character is read on the console interface
964c609719bSwdenk		within "Boot Delay" after reset.
965c609719bSwdenk
966c609719bSwdenk		CONFIG_BOOTARGS
967c609719bSwdenk		This can be used to pass arguments to the bootm
968c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
969c609719bSwdenk		environment value "bootargs".
970c609719bSwdenk
971c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
972c609719bSwdenk		The value of these goes into the environment as
973c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
974c609719bSwdenk		as a convenience, when switching between booting from
97511ccc33fSMarcel Ziswiler		RAM and NFS.
976c609719bSwdenk
977eda0ba38SHeiko Schocher- Bootcount:
978eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
979eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
980eda0ba38SHeiko Schocher		cycle, see:
981eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
982eda0ba38SHeiko Schocher
983eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
984eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
985eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
986eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
987eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
988eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
989eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
990eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
991eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
992eda0ba38SHeiko Schocher
993c609719bSwdenk- Pre-Boot Commands:
994c609719bSwdenk		CONFIG_PREBOOT
995c609719bSwdenk
996c609719bSwdenk		When this option is #defined, the existence of the
997c609719bSwdenk		environment variable "preboot" will be checked
998c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
999c609719bSwdenk		countdown and/or running the auto-boot command resp.
1000c609719bSwdenk		entering interactive mode.
1001c609719bSwdenk
1002c609719bSwdenk		This feature is especially useful when "preboot" is
1003c609719bSwdenk		automatically generated or modified. For an example
1004c609719bSwdenk		see the LWMON board specific code: here "preboot" is
1005c609719bSwdenk		modified when the user holds down a certain
1006c609719bSwdenk		combination of keys on the (special) keyboard when
1007c609719bSwdenk		booting the systems
1008c609719bSwdenk
1009c609719bSwdenk- Serial Download Echo Mode:
1010c609719bSwdenk		CONFIG_LOADS_ECHO
1011c609719bSwdenk		If defined to 1, all characters received during a
1012c609719bSwdenk		serial download (using the "loads" command) are
1013c609719bSwdenk		echoed back. This might be needed by some terminal
1014c609719bSwdenk		emulations (like "cu"), but may as well just take
1015c609719bSwdenk		time on others. This setting #define's the initial
1016c609719bSwdenk		value of the "loads_echo" environment variable.
1017c609719bSwdenk
1018602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
1019c609719bSwdenk		CONFIG_KGDB_BAUDRATE
1020c609719bSwdenk		Select one of the baudrates listed in
10216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
1022c609719bSwdenk
1023c609719bSwdenk- Monitor Functions:
1024602ad3b3SJon Loeliger		Monitor commands can be included or excluded
1025602ad3b3SJon Loeliger		from the build by using the #include files
1026c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
1027ef0f2f57SJoe Hershberger		commands, or adding #define's for wanted commands.
1028c609719bSwdenk
1029602ad3b3SJon Loeliger		The default command configuration includes all commands
1030602ad3b3SJon Loeliger		except those marked below with a "*".
1031602ad3b3SJon Loeliger
1032b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
1033602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
1034602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
1035602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
1036602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
1037602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
1038602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
1039d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
1040602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
104108d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
1042602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
1043710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
1044602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
1045602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
1046602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
1047a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
1048a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
1049a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
1050a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
1051602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
1052602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
1053246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
1054602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
1055602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
10565e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
1057fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
105888733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
10590c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
106003e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
106103e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
106216f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
106316f4d933SStephen Warren					  that work for multiple fs types
106459e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
1065bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
1066602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
106703e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
1068602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
1069602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
10704d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
107153fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1072a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1073a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1074bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1075602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
1076602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1077602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1078602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
10798fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
10804d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1081602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
1082aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
10830c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1084c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1085602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1086602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1087602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1088602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
10894d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1090d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1091d22c338eSJoe Hershberger					  (169.254.*.*)
1092602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1093602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
10944d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
109502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
109615a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1097602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1098a2681707SWolfgang Denk					  loop, loopw
10994d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1100602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1101602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1102602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
110368d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1104602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1105602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
11064d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1107e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1108e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1109602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1110602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1111602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1112602ad3b3SJon Loeliger					  host
1113602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1114ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1115602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1116602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1117d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1118602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1119602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1120602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1121602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1122602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1123602ad3b3SJon Loeliger					  (4xx only)
1124f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
11254d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
112602c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
11277d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
112874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1129602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
11307a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
11311fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1132da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1133da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1134602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1135602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1136c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
11374d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
113889c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1139c609719bSwdenk
1140c609719bSwdenk		EXAMPLE: If you want all functions except of network
1141c609719bSwdenk		support you can write:
1142c609719bSwdenk
1143602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1144602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1145c609719bSwdenk
1146213bf8c8SGerald Van Baren	Other Commands:
1147213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1148c609719bSwdenk
1149c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1150602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1151c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1152c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1153c609719bSwdenk		8260 (where accesses to the IMMR region must be
1154c609719bSwdenk		uncached), and it cannot be disabled on all other
1155c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1156c609719bSwdenk		initial stack and some data.
1157c609719bSwdenk
1158c609719bSwdenk
1159c609719bSwdenk		XXX - this list needs to get updated!
1160c609719bSwdenk
1161a5ecbe62SWolfgang Denk- Regular expression support:
1162a5ecbe62SWolfgang Denk		CONFIG_REGEX
1163a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1164a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1165a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1166a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1167a5ecbe62SWolfgang Denk
116845ba8077SSimon Glass- Device tree:
116945ba8077SSimon Glass		CONFIG_OF_CONTROL
117045ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
117145ba8077SSimon Glass		to configure its devices, instead of relying on statically
117245ba8077SSimon Glass		compiled #defines in the board file. This option is
117345ba8077SSimon Glass		experimental and only available on a few boards. The device
117445ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
117545ba8077SSimon Glass
11762c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
11772c0f79e4SSimon Glass		be done using one of the two options below:
1178bbb0b128SSimon Glass
1179bbb0b128SSimon Glass		CONFIG_OF_EMBED
1180bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1181bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1182bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1183bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1184bbb0b128SSimon Glass		the global data structure as gd->blob.
118545ba8077SSimon Glass
11862c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
11872c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
11882c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
11892c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
11902c0f79e4SSimon Glass
11912c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
11922c0f79e4SSimon Glass
11932c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
11942c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
11952c0f79e4SSimon Glass		still use the individual files if you need something more
11962c0f79e4SSimon Glass		exotic.
11972c0f79e4SSimon Glass
1198c609719bSwdenk- Watchdog:
1199c609719bSwdenk		CONFIG_WATCHDOG
1200c609719bSwdenk		If this variable is defined, it enables watchdog
12016abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
12026abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
12036abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
12046abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
12056abe6fb6SDetlev Zundel		available, then no further board specific code should
12066abe6fb6SDetlev Zundel		be needed to use it.
12076abe6fb6SDetlev Zundel
12086abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
12096abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
12106abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
12116abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1212c609719bSwdenk
12137bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
12147bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
12157bae0d6fSHeiko Schocher
1216c1551ea8Sstroese- U-Boot Version:
1217c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1218c1551ea8Sstroese		If this variable is defined, an environment variable
1219c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1220c1551ea8Sstroese		version as printed by the "version" command.
1221a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1222a1ea8e51SBenoît Thébaudeau		next reset.
1223c1551ea8Sstroese
1224c609719bSwdenk- Real-Time Clock:
1225c609719bSwdenk
1226602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1227c609719bSwdenk		has to be selected, too. Define exactly one of the
1228c609719bSwdenk		following options:
1229c609719bSwdenk
1230c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1231c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
12324e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1233c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
12341cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1235c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
12367f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1237412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
12383bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
12399536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
12404c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
12416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
124271d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
124371d19f30SHeiko Schocher					  RV3029 RTC.
1244c609719bSwdenk
1245b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1246b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1247b37c7e5eSwdenk
1248e92739d3SPeter Tyser- GPIO Support:
1249e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1250e92739d3SPeter Tyser
12515dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
12525dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
12535dec49caSChris Packham		pins supported by a particular chip.
12545dec49caSChris Packham
1255e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1256e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1257e92739d3SPeter Tyser
1258aa53233aSSimon Glass- I/O tracing:
1259aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1260aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1261aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1262aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1263aa53233aSSimon Glass		the driver behaves the same way before and after a code
1264aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1265aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1266aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1267aa53233aSSimon Glass
1268aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1269aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1270aa53233aSSimon Glass		still continue to operate.
1271aa53233aSSimon Glass
1272aa53233aSSimon Glass			iotrace is enabled
1273aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1274aa53233aSSimon Glass			Size:   00010000	(buffer size)
1275aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1276aa53233aSSimon Glass			Output: 10000120	(start + offset)
1277aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1278aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1279aa53233aSSimon Glass
1280c609719bSwdenk- Timestamp Support:
1281c609719bSwdenk
1282c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1283c609719bSwdenk		(date and time) of an image is printed by image
1284c609719bSwdenk		commands like bootm or iminfo. This option is
1285602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1286c609719bSwdenk
1287923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1288923c46f9SKarl O. Pinc		Zero or more of the following:
1289923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1290923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1291923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1292923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1293923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1294923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1295923c46f9SKarl O. Pinc				       disk/part_efi.c
1296923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1297c609719bSwdenk
1298602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1299218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1300923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1301c609719bSwdenk
1302c609719bSwdenk- IDE Reset method:
13034d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
13044d13cbadSwdenk		board configurations files but used nowhere!
1305c609719bSwdenk
13064d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
13074d13cbadSwdenk		be performed by calling the function
13084d13cbadSwdenk			ide_set_reset(int reset)
13094d13cbadSwdenk		which has to be defined in a board specific file
1310c609719bSwdenk
1311c609719bSwdenk- ATAPI Support:
1312c609719bSwdenk		CONFIG_ATAPI
1313c609719bSwdenk
1314c609719bSwdenk		Set this to enable ATAPI support.
1315c609719bSwdenk
1316c40b2956Swdenk- LBA48 Support
1317c40b2956Swdenk		CONFIG_LBA48
1318c40b2956Swdenk
1319c40b2956Swdenk		Set this to enable support for disks larger than 137GB
13204b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1321c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1322c40b2956Swdenk		support disks up to 2.1TB.
1323c40b2956Swdenk
13246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1325c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1326c40b2956Swdenk			Default is 32bit.
1327c40b2956Swdenk
1328c609719bSwdenk- SCSI Support:
1329c609719bSwdenk		At the moment only there is only support for the
1330c609719bSwdenk		SYM53C8XX SCSI controller; define
1331c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1332c609719bSwdenk
13336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
13346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
13356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1336c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1337c609719bSwdenk		devices.
13386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1339c609719bSwdenk
1340447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1341447c031bSStefan Reinauer		SCSI devices found during the last scan.
1342447c031bSStefan Reinauer
1343c609719bSwdenk- NETWORK Support (PCI):
1344682011ffSwdenk		CONFIG_E1000
1345ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1346ce5207e1SKyle Moffett
1347ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1348ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1349ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1350ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1351ce5207e1SKyle Moffett
1352ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1353ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1354ce5207e1SKyle Moffett		example with the "sspi" command.
1355ce5207e1SKyle Moffett
1356ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1357ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1358ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1359682011ffSwdenk
1360c609719bSwdenk		CONFIG_EEPRO100
1361c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
136211ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1363c609719bSwdenk		write routine for first time initialisation.
1364c609719bSwdenk
1365c609719bSwdenk		CONFIG_TULIP
1366c609719bSwdenk		Support for Digital 2114x chips.
1367c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1368c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1369c609719bSwdenk
1370c609719bSwdenk		CONFIG_NATSEMI
1371c609719bSwdenk		Support for National dp83815 chips.
1372c609719bSwdenk
1373c609719bSwdenk		CONFIG_NS8382X
1374c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1375c609719bSwdenk
137645219c46Swdenk- NETWORK Support (other):
137745219c46Swdenk
1378c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1379c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1380c041e9d2SJens Scharsig
1381c041e9d2SJens Scharsig			CONFIG_RMII
1382c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1383c041e9d2SJens Scharsig
1384c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1385c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1386c041e9d2SJens Scharsig			The driver doen't show link status messages.
1387c041e9d2SJens Scharsig
1388efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1389efdd7319SRob Herring		Support for the Calxeda XGMAC device
1390efdd7319SRob Herring
13913bb46d23SAshok		CONFIG_LAN91C96
139245219c46Swdenk		Support for SMSC's LAN91C96 chips.
139345219c46Swdenk
139445219c46Swdenk			CONFIG_LAN91C96_BASE
139545219c46Swdenk			Define this to hold the physical address
139645219c46Swdenk			of the LAN91C96's I/O space
139745219c46Swdenk
139845219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
139945219c46Swdenk			Define this to enable 32 bit addressing
140045219c46Swdenk
14013bb46d23SAshok		CONFIG_SMC91111
1402f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1403f39748aeSwdenk
1404f39748aeSwdenk			CONFIG_SMC91111_BASE
1405f39748aeSwdenk			Define this to hold the physical address
1406f39748aeSwdenk			of the device (I/O space)
1407f39748aeSwdenk
1408f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1409f39748aeSwdenk			Define this if data bus is 32 bits
1410f39748aeSwdenk
1411f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1412f39748aeSwdenk			Define this to use i/o functions instead of macros
1413f39748aeSwdenk			(some hardware wont work with macros)
1414f39748aeSwdenk
1415dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1416dc02badaSHeiko Schocher		Support for davinci emac
1417dc02badaSHeiko Schocher
1418dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1419dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1420dc02badaSHeiko Schocher
1421b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1422b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1423b3dbf4a5SMacpaul Lin
1424b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1425b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1426b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1427b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1428b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1429b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1430b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1431b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1432b3dbf4a5SMacpaul Lin
1433c2fff331SMike Rapoport		CONFIG_SMC911X
1434557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1435557b377dSJens Gehrlein
1436c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1437557b377dSJens Gehrlein			Define this to hold the physical address
1438557b377dSJens Gehrlein			of the device (I/O space)
1439557b377dSJens Gehrlein
1440c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1441557b377dSJens Gehrlein			Define this if data bus is 32 bits
1442557b377dSJens Gehrlein
1443c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1444557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1445557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1446c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1447557b377dSJens Gehrlein
14483d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
14493d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
14503d0075faSYoshihiro Shimoda
14513d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
14523d0075faSYoshihiro Shimoda			Define the number of ports to be used
14533d0075faSYoshihiro Shimoda
14543d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
14553d0075faSYoshihiro Shimoda			Define the ETH PHY's address
14563d0075faSYoshihiro Shimoda
145768260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
145868260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
145968260aabSYoshihiro Shimoda
1460b2f97cf2SHeiko Schocher- PWM Support:
1461b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1462b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1463b2f97cf2SHeiko Schocher
14645e124724SVadim Bendebury- TPM Support:
146590899cc0SChe-liang Chiou		CONFIG_TPM
146690899cc0SChe-liang Chiou		Support TPM devices.
146790899cc0SChe-liang Chiou
14680766ad2fSChristophe Ricard		CONFIG_TPM_TIS_INFINEON
14690766ad2fSChristophe Ricard		Support for Infineon i2c bus TPM devices. Only one device
14701b393db5STom Wai-Hong Tam		per system is supported at this time.
14711b393db5STom Wai-Hong Tam
14721b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
14731b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
14741b393db5STom Wai-Hong Tam
1475c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1476c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1477c01939c7SDirk Eibach
147890899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
14795e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
14805e124724SVadim Bendebury		per system is supported at this time.
14815e124724SVadim Bendebury
14825e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
14835e124724SVadim Bendebury			Base address where the generic TPM device is mapped
14845e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
14855e124724SVadim Bendebury			0xfed40000.
14865e124724SVadim Bendebury
1487be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1488be6c1529SReinhard Pfau		Add tpm monitor functions.
1489be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1490be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1491be6c1529SReinhard Pfau
1492be6c1529SReinhard Pfau		CONFIG_TPM
1493be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1494be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1495be6c1529SReinhard Pfau		Requires support for a TPM device.
1496be6c1529SReinhard Pfau
1497be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1498be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1499be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1500be6c1529SReinhard Pfau
1501c609719bSwdenk- USB Support:
1502c609719bSwdenk		At the moment only the UHCI host controller is
15034d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1504c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1505c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
150630d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1507c609719bSwdenk		storage devices.
1508c609719bSwdenk		Note:
1509c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1510c609719bSwdenk		(TEAC FD-05PUB).
15114d13cbadSwdenk		MPC5200 USB requires additional defines:
15124d13cbadSwdenk			CONFIG_USB_CLOCK
15134d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1514307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1515307ecb6dSEric Millbrandt				for USB on PSC3
15164d13cbadSwdenk			CONFIG_USB_CONFIG
15174d13cbadSwdenk				for differential drivers: 0x00001000
15184d13cbadSwdenk				for single ended drivers: 0x00005000
1519307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1520307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
15216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1522fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1523fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
15244d13cbadSwdenk
15259ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
15269ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
15279ab4ce22SSimon Glass
15286e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
15296e9e0626SOleksandr Tymoshenko		HW module registers.
15306e9e0626SOleksandr Tymoshenko
153116c8d5e7SWolfgang Denk- USB Device:
153216c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
153316c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
153416c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
153511ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
153616c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
153716c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
153816c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
153916c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
154016c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
154116c8d5e7SWolfgang Denk		a Linux host by
154216c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
154316c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
154416c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
154516c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
154616c8d5e7SWolfgang Denk
154716c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
154816c8d5e7SWolfgang Denk			Define this to build a UDC device
154916c8d5e7SWolfgang Denk
155016c8d5e7SWolfgang Denk			CONFIG_USB_TTY
155116c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
155216c8d5e7SWolfgang Denk			talk to the UDC device
155316c8d5e7SWolfgang Denk
1554f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1555f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1556f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1557f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1558f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1559f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1560f9da0f89SVipin KUMAR			speed.
1561f9da0f89SVipin KUMAR
15626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
156316c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
156416c8d5e7SWolfgang Denk			be set to usbtty.
156516c8d5e7SWolfgang Denk
156616c8d5e7SWolfgang Denk			mpc8xx:
15676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
156816c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
15696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
157016c8d5e7SWolfgang Denk
15716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
157216c8d5e7SWolfgang Denk				Derive USB clock from brgclk
15736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
157416c8d5e7SWolfgang Denk
157516c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
157616c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
157716c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
157816c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
157916c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
158016c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
158116c8d5e7SWolfgang Denk
158216c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
158316c8d5e7SWolfgang Denk			Define this string as the name of your company for
158416c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
158516c8d5e7SWolfgang Denk
158616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
158716c8d5e7SWolfgang Denk			Define this string as the name of your product
158816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
158916c8d5e7SWolfgang Denk
159016c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
159116c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
159216c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
159316c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
159416c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
159516c8d5e7SWolfgang Denk
159616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
159716c8d5e7SWolfgang Denk			Define this as the unique Product ID
159816c8d5e7SWolfgang Denk			for your device
159916c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1600c609719bSwdenk
1601d70a560fSIgor Grinberg- ULPI Layer Support:
1602d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1603d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1604d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1605d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1606d70a560fSIgor Grinberg		viewport is supported.
1607d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1608d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
16096d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
16106d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
16116d365ea0SLucas Stach		the appropriate value in Hz.
1612c609719bSwdenk
1613c609719bSwdenk- MMC Support:
1614c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1615c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1616c609719bSwdenk		accessed from the boot prompt by mapping the device
1617c609719bSwdenk		to physical memory similar to flash. Command line is
1618602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1619602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1620c609719bSwdenk
1621afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1622afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1623afb35666SYoshihiro Shimoda
1624afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1625afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1626afb35666SYoshihiro Shimoda
1627afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1628afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1629afb35666SYoshihiro Shimoda
16301fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
16311fd93c6eSPierre Aubert		Enable the generic MMC driver
16321fd93c6eSPierre Aubert
16331fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
16341fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
16351fd93c6eSPierre Aubert
16361fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
16371fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
16381fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
16391fd93c6eSPierre Aubert
1640b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
164101acd6abSPaul Kocialkowski		CONFIG_USB_FUNCTION_DFU
1642b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1643b3ba6e94STom Rini
1644b3ba6e94STom Rini		CONFIG_CMD_DFU
1645b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1646b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1647b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1648b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1649b3ba6e94STom Rini
1650b3ba6e94STom Rini		CONFIG_DFU_MMC
1651b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1652b3ba6e94STom Rini
1653c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1654c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1655c6631764SPantelis Antoniou
1656a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1657a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1658a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1659a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1660a9479f04SAfzal Mohammed		one that would help mostly the developer.
1661a9479f04SAfzal Mohammed
1662e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1663e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1664e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1665e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1666e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1667e7e75c70SHeiko Schocher
1668ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1669ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1670ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1671ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1672ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1673ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1674ea2453d5SPantelis Antoniou
1675001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1676001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1677001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1678001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1679001a8319SHeiko Schocher
1680001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1681001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1682001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1683001a8319SHeiko Schocher		sending again an USB request to the device.
1684001a8319SHeiko Schocher
16853aab70afSSebastian Siewior- USB Device Android Fastboot support:
168617da3c0cSPaul Kocialkowski		CONFIG_USB_FUNCTION_FASTBOOT
168717da3c0cSPaul Kocialkowski		This enables the USB part of the fastboot gadget
168817da3c0cSPaul Kocialkowski
16893aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
16903aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
16913aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
16923aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
16933aab70afSSebastian Siewior		used on Android devices.
16943aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
16953aab70afSSebastian Siewior
16963aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
16973aab70afSSebastian Siewior		This enables support for booting images which use the Android
16983aab70afSSebastian Siewior		image format header.
16993aab70afSSebastian Siewior
1700a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_ADDR
17013aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
17023aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
17033aab70afSSebastian Siewior		downloaded images.
17043aab70afSSebastian Siewior
1705a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_SIZE
17063aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
17073aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
17083aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
17093aab70afSSebastian Siewior
1710d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1711d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1712d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1713d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1714d1b5ed07SSteve Rae
1715d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1716d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1717d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1718d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1719d1b5ed07SSteve Rae
17200ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
17210ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
17220ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
17230ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
17240ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
17250ff7e585SSteve Rae		This occurs when the specified "partition name" on the
17260ff7e585SSteve Rae		"fastboot flash" command line matches this value.
17270ff7e585SSteve Rae		Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
17280ff7e585SSteve Rae
17296705d81eSwdenk- Journaling Flash filesystem support:
17306705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
17316705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
17326705d81eSwdenk		Define these for a default partition on a NAND device
17336705d81eSwdenk
17346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
17356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
17366705d81eSwdenk		Define these for a default partition on a NOR device
17376705d81eSwdenk
17386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
17396705d81eSwdenk		Define this to create an own partition. You have to provide a
17406705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
17416705d81eSwdenk
17426705d81eSwdenk		If you define only one JFFS2 partition you may also want to
17436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
17446705d81eSwdenk		to disable the command chpart. This is the default when you
17456705d81eSwdenk		have not defined a custom partition
17466705d81eSwdenk
1747c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1748c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1749656f4c65SDonggeun Kim
1750656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1751656f4c65SDonggeun Kim		file in FAT formatted partition.
1752656f4c65SDonggeun Kim
1753656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1754656f4c65SDonggeun Kim		user to write files to FAT.
1755c30a15e5SDonggeun Kim
175684cd9327SGabe BlackCBFS (Coreboot Filesystem) support
175784cd9327SGabe Black		CONFIG_CMD_CBFS
175884cd9327SGabe Black
175984cd9327SGabe Black		Define this to enable support for reading from a Coreboot
176084cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
176184cd9327SGabe Black		and cbfsload.
176284cd9327SGabe Black
17634f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
17644f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
17654f0d1a2aSSiva Durga Prasad Paladugu
17664f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
17674f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
17684f0d1a2aSSiva Durga Prasad Paladugu
1769c609719bSwdenk- Keyboard Support:
1770*39f615edSSimon Glass		See Kconfig help for available keyboard drivers.
1771*39f615edSSimon Glass
1772*39f615edSSimon Glass		CONFIG_KEYBOARD
1773*39f615edSSimon Glass
1774*39f615edSSimon Glass		Define this to enable a custom keyboard support.
1775*39f615edSSimon Glass		This simply calls drv_keyboard_init() which must be
1776*39f615edSSimon Glass		defined in your board-specific files. This option is deprecated
1777*39f615edSSimon Glass		and is only used by novena. For new boards, use driver model
1778*39f615edSSimon Glass		instead.
1779c609719bSwdenk
1780c609719bSwdenk- Video support:
1781c609719bSwdenk		CONFIG_VIDEO
1782c609719bSwdenk
1783c609719bSwdenk		Define this to enable video support (for output to
1784c609719bSwdenk		video).
1785c609719bSwdenk
1786c609719bSwdenk		CONFIG_VIDEO_CT69000
1787c609719bSwdenk
1788c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1789c609719bSwdenk
1790c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1791eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1792eeb1b77bSwdenk		video output is selected via environment 'videoout'
1793eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1794eeb1b77bSwdenk		assumed.
1795c609719bSwdenk
1796eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
179711ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1798eeb1b77bSwdenk		are possible:
1799eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1800eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1801eeb1b77bSwdenk
1802eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1803eeb1b77bSwdenk		-------------+---------------------------------------------
1804eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1805eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1806eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1807eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1808eeb1b77bSwdenk		-------------+---------------------------------------------
1809c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1810c609719bSwdenk
1811eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
18127817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1813eeb1b77bSwdenk
1814eeb1b77bSwdenk
1815a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1816a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1817a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1818a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1819a6c7ad2fSwdenk
18207d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
18217d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
18227d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
18237d3053fbSTimur Tabi		support, and should also define these other macros:
18247d3053fbSTimur Tabi
18257d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
18267d3053fbSTimur Tabi			CONFIG_VIDEO
18277d3053fbSTimur Tabi			CONFIG_CMD_BMP
18287d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
18297d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
18307d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
18317d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
18327d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
18337d3053fbSTimur Tabi
1834ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1835ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1836ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1837ba8e76bdSTimur Tabi		description of this variable.
18387d3053fbSTimur Tabi
1839c609719bSwdenk- LCD Support:	CONFIG_LCD
1840c609719bSwdenk
1841c609719bSwdenk		Define this to enable LCD support (for output to LCD
1842c609719bSwdenk		display); also select one of the supported displays
1843c609719bSwdenk		by defining one of these:
1844c609719bSwdenk
184539cf4804SStelian Pop		CONFIG_ATMEL_LCD:
184639cf4804SStelian Pop
184739cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
184839cf4804SStelian Pop
1849fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1850c609719bSwdenk
1851fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1852c609719bSwdenk
1853fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1854c609719bSwdenk
1855fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1856fd3103bbSwdenk			Active, color, single scan.
1857fd3103bbSwdenk
1858fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1859fd3103bbSwdenk
1860fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1861c609719bSwdenk			Active, color, single scan.
1862c609719bSwdenk
1863c609719bSwdenk		CONFIG_SHARP_16x9
1864c609719bSwdenk
1865c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1866c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1867c609719bSwdenk
1868c609719bSwdenk		CONFIG_SHARP_LQ64D341
1869c609719bSwdenk
1870c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1871c609719bSwdenk			Active, color, single scan.
1872c609719bSwdenk
1873c609719bSwdenk		CONFIG_HLD1045
1874c609719bSwdenk
1875c609719bSwdenk			HLD1045 display, 640x480.
1876c609719bSwdenk			Active, color, single scan.
1877c609719bSwdenk
1878c609719bSwdenk		CONFIG_OPTREX_BW
1879c609719bSwdenk
1880c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1881c609719bSwdenk			or
1882c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1883c609719bSwdenk			or
1884c609719bSwdenk			Hitachi	 SP14Q002
1885c609719bSwdenk
1886c609719bSwdenk			320x240. Black & white.
1887c609719bSwdenk
1888c609719bSwdenk		Normally display is black on white background; define
18896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1890c609719bSwdenk
1891676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1892676d319eSSimon Glass
1893b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1894676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1895676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1896676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1897676d319eSSimon Glass		a per-section basis.
1898676d319eSSimon Glass
18990d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
19000d89efefSSimon Glass
19010d89efefSSimon Glass		When the console need to be scrolled, this is the number of
19020d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
19030d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
19040d89efefSSimon Glass		is slow.
1905676d319eSSimon Glass
1906604c7d4aSHannes Petermaier		CONFIG_LCD_ROTATION
1907604c7d4aSHannes Petermaier
1908604c7d4aSHannes Petermaier		Sometimes, for example if the display is mounted in portrait
1909604c7d4aSHannes Petermaier		mode or even if it's mounted landscape but rotated by 180degree,
1910604c7d4aSHannes Petermaier		we need to rotate our content of the display relative to the
1911604c7d4aSHannes Petermaier		framebuffer, so that user can read the messages which are
1912604c7d4aSHannes Petermaier		printed out.
1913604c7d4aSHannes Petermaier		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1914604c7d4aSHannes Petermaier		initialized with a given rotation from "vl_rot" out of
1915604c7d4aSHannes Petermaier		"vidinfo_t" which is provided by the board specific code.
1916604c7d4aSHannes Petermaier		The value for vl_rot is coded as following (matching to
1917604c7d4aSHannes Petermaier		fbcon=rotate:<n> linux-kernel commandline):
1918604c7d4aSHannes Petermaier		0 = no rotation respectively 0 degree
1919604c7d4aSHannes Petermaier		1 = 90 degree rotation
1920604c7d4aSHannes Petermaier		2 = 180 degree rotation
1921604c7d4aSHannes Petermaier		3 = 270 degree rotation
1922604c7d4aSHannes Petermaier
1923604c7d4aSHannes Petermaier		If CONFIG_LCD_ROTATION is not defined, the console will be
1924604c7d4aSHannes Petermaier		initialized with 0degree rotation.
1925604c7d4aSHannes Petermaier
192645d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
192745d7f525STom Wai-Hong Tam
192845d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
192945d7f525STom Wai-Hong Tam
1930735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1931735987c5STom Wai-Hong Tam
1932735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1933735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1934735987c5STom Wai-Hong Tam
19357152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1936d791b1dcSwdenk
1937d791b1dcSwdenk		If this option is set, the environment is checked for
1938d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1939d791b1dcSwdenk		of logo, copyright and system information on the LCD
1940e94d2cd9Swdenk		is suppressed and the BMP image at the address
1941d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1942d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1943d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1944d791b1dcSwdenk		loaded very quickly after power-on.
1945d791b1dcSwdenk
1946c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1947c0880485SNikita Kiryanov
1948c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1949c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
19501551df35STom Rini		(see README.displaying-bmps).
1951c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1952c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1953c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1954c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1955c0880485SNikita Kiryanov		there is no need to set this option.
1956c0880485SNikita Kiryanov
19571ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
19581ca298ceSMatthias Weisser
19591ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
19601ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
19611ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
19621ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
19631ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
19641ca298ceSMatthias Weisser		specify 'm' for centering the image.
19651ca298ceSMatthias Weisser
19661ca298ceSMatthias Weisser		Example:
19671ca298ceSMatthias Weisser		setenv splashpos m,m
19681ca298ceSMatthias Weisser			=> image at center of screen
19691ca298ceSMatthias Weisser
19701ca298ceSMatthias Weisser		setenv splashpos 30,20
19711ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
19721ca298ceSMatthias Weisser
19731ca298ceSMatthias Weisser		setenv splashpos -10,m
19741ca298ceSMatthias Weisser			=> vertically centered image
19751ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
19761ca298ceSMatthias Weisser
197798f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
197898f4a3dfSStefan Roese
197998f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
198098f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
198198f4a3dfSStefan Roese		splashscreen support or the bmp command.
198298f4a3dfSStefan Roese
1983d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1984d5011762SAnatolij Gustschin
1985d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1986d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1987d5011762SAnatolij Gustschin		bmp command.
1988d5011762SAnatolij Gustschin
1989b445bbb4SJeremiah Mahler- Do compressing for memory range:
1990f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1991f2b96dfbSLei Wen
1992f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1993f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1994f2b96dfbSLei Wen
1995c29fdfc1Swdenk- Compression support:
19968ef70478SKees Cook		CONFIG_GZIP
19978ef70478SKees Cook
19988ef70478SKees Cook		Enabled by default to support gzip compressed images.
19998ef70478SKees Cook
2000c29fdfc1Swdenk		CONFIG_BZIP2
2001c29fdfc1Swdenk
2002c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
2003c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
2004c29fdfc1Swdenk		compressed images are supported.
2005c29fdfc1Swdenk
2006c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
20076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
2008c29fdfc1Swdenk		be at least 4MB.
2009d791b1dcSwdenk
2010fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
2011fc9c1727SLuigi 'Comio' Mantellini
2012fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
2013fc9c1727SLuigi 'Comio' Mantellini		images is included.
2014fc9c1727SLuigi 'Comio' Mantellini
2015fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
2016fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
2017fc9c1727SLuigi 'Comio' Mantellini		formula:
2018fc9c1727SLuigi 'Comio' Mantellini
2019fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
2020fc9c1727SLuigi 'Comio' Mantellini
2021fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
2022fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
2023fc9c1727SLuigi 'Comio' Mantellini
2024fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
2025fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2026fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2027fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
2028fc9c1727SLuigi 'Comio' Mantellini
2029fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
2030fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
20316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
2032fc9c1727SLuigi 'Comio' Mantellini
20338ef70478SKees Cook		CONFIG_LZO
20348ef70478SKees Cook
20358ef70478SKees Cook		If this option is set, support for LZO compressed images
20368ef70478SKees Cook		is included.
20378ef70478SKees Cook
203817ea1177Swdenk- MII/PHY support:
203917ea1177Swdenk		CONFIG_PHY_ADDR
204017ea1177Swdenk
204117ea1177Swdenk		The address of PHY on MII bus.
204217ea1177Swdenk
204317ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
204417ea1177Swdenk
204517ea1177Swdenk		The clock frequency of the MII bus
204617ea1177Swdenk
204717ea1177Swdenk		CONFIG_PHY_GIGE
204817ea1177Swdenk
204917ea1177Swdenk		If this option is set, support for speed/duplex
205011ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
205117ea1177Swdenk
205217ea1177Swdenk		CONFIG_PHY_RESET_DELAY
205317ea1177Swdenk
205417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
205517ea1177Swdenk		reset before any MII register access is possible.
205617ea1177Swdenk		For such PHY, set this option to the usec delay
205717ea1177Swdenk		required. (minimum 300usec for LXT971A)
205817ea1177Swdenk
205917ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
206017ea1177Swdenk
206117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
206217ea1177Swdenk		command issued before MII status register can be read
206317ea1177Swdenk
2064c609719bSwdenk- IP address:
2065c609719bSwdenk		CONFIG_IPADDR
2066c609719bSwdenk
2067c609719bSwdenk		Define a default value for the IP address to use for
206811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
2069c609719bSwdenk		determined through e.g. bootp.
20701ebcd654SWolfgang Denk		(Environment variable "ipaddr")
2071c609719bSwdenk
2072c609719bSwdenk- Server IP address:
2073c609719bSwdenk		CONFIG_SERVERIP
2074c609719bSwdenk
2075c609719bSwdenk		Defines a default value for the IP address of a TFTP
2076c609719bSwdenk		server to contact when using the "tftboot" command.
20771ebcd654SWolfgang Denk		(Environment variable "serverip")
2078c609719bSwdenk
207997cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
208097cfe861SRobin Getz
208197cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
208297cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
208397cfe861SRobin Getz
20841ebcd654SWolfgang Denk- Gateway IP address:
20851ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
20861ebcd654SWolfgang Denk
20871ebcd654SWolfgang Denk		Defines a default value for the IP address of the
20881ebcd654SWolfgang Denk		default router where packets to other networks are
20891ebcd654SWolfgang Denk		sent to.
20901ebcd654SWolfgang Denk		(Environment variable "gatewayip")
20911ebcd654SWolfgang Denk
20921ebcd654SWolfgang Denk- Subnet mask:
20931ebcd654SWolfgang Denk		CONFIG_NETMASK
20941ebcd654SWolfgang Denk
20951ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
20961ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
20971ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
20981ebcd654SWolfgang Denk		forwarded through a router.
20991ebcd654SWolfgang Denk		(Environment variable "netmask")
21001ebcd654SWolfgang Denk
210153a5c424SDavid Updegraff- Multicast TFTP Mode:
210253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
210353a5c424SDavid Updegraff
210453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
210553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
210611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
210753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
210853a5c424SDavid Updegraff		multicast group.
210953a5c424SDavid Updegraff
2110c609719bSwdenk- BOOTP Recovery Mode:
2111c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2112c609719bSwdenk
2113c609719bSwdenk		If you have many targets in a network that try to
2114c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2115c609719bSwdenk		systems send out BOOTP requests at precisely the same
2116c609719bSwdenk		moment (which would happen for instance at recovery
2117c609719bSwdenk		from a power failure, when all systems will try to
2118c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2119c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2120c609719bSwdenk		inserted before sending out BOOTP requests. The
21216c33c785SWolfgang Denk		following delays are inserted then:
2122c609719bSwdenk
2123c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2124c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2125c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2126c609719bSwdenk		4th and following
2127c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2128c609719bSwdenk
212992ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
213092ac8accSThierry Reding
213192ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
213292ac8accSThierry Reding		server will copy the ID from client requests to responses and
213392ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
213492ac8accSThierry Reding		an incoming response. Some servers will check that addresses
213592ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
213692ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
213792ac8accSThierry Reding		respond. Network congestion may also influence the time it
213892ac8accSThierry Reding		takes for a response to make it back to the client. If that
213992ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
214092ac8accSThierry Reding		to allow earlier responses to still be accepted after these
214192ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
214292ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
214392ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
214492ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
214592ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
214692ac8accSThierry Reding
2147fe389a82Sstroese- DHCP Advanced Options:
21481fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
21491fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2150fe389a82Sstroese
21511fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
21521fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
21531fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
21541fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
21551fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
21561fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
21571fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
21581fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
21591fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
21601fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
21611fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
21621fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
21632c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2164fe389a82Sstroese
21655d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
21665d110f0aSWilson Callan		environment variable, not the BOOTP server.
2167fe389a82Sstroese
21682c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
21692c00e099SJoe Hershberger		after the configured retry count, the call will fail
21702c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
21712c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
21722c00e099SJoe Hershberger		is not available.
21732c00e099SJoe Hershberger
2174fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2175fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2176fe389a82Sstroese		than one DNS serverip is offered to the client.
2177fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2178fe389a82Sstroese		serverip will be stored in the additional environment
2179fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2180fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
21811fe80d79SJon Loeliger		is defined.
2182fe389a82Sstroese
2183fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2184fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2185fe389a82Sstroese		need the hostname of the DHCP requester.
21865d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
21871fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
21881fe80d79SJon Loeliger		option 12 to the DHCP server.
2189fe389a82Sstroese
2190d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2191d9a2f416SAras Vaichas
2192d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2193d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2194d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2195d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2196d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2197d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2198d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2199d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2200d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2201d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2202d9a2f416SAras Vaichas		this delay.
2203d9a2f416SAras Vaichas
2204d22c338eSJoe Hershberger - Link-local IP address negotiation:
2205d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2206d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2207d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2208d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2209d22c338eSJoe Hershberger
2210d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2211d22c338eSJoe Hershberger
2212a3d991bdSwdenk - CDP Options:
2213a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2214a3d991bdSwdenk
2215a3d991bdSwdenk		The device id used in CDP trigger frames.
2216a3d991bdSwdenk
2217a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2218a3d991bdSwdenk
2219a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2220a3d991bdSwdenk		of the device.
2221a3d991bdSwdenk
2222a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2223a3d991bdSwdenk
2224a3d991bdSwdenk		A printf format string which contains the ascii name of
2225a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
222611ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2227a3d991bdSwdenk
2228a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2229a3d991bdSwdenk
2230a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2231a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2232a3d991bdSwdenk
2233a3d991bdSwdenk		CONFIG_CDP_VERSION
2234a3d991bdSwdenk
2235a3d991bdSwdenk		An ascii string containing the version of the software.
2236a3d991bdSwdenk
2237a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2238a3d991bdSwdenk
2239a3d991bdSwdenk		An ascii string containing the name of the platform.
2240a3d991bdSwdenk
2241a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2242a3d991bdSwdenk
2243a3d991bdSwdenk		A 32bit integer sent on the trigger.
2244a3d991bdSwdenk
2245a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2246a3d991bdSwdenk
2247a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2248a3d991bdSwdenk		device in .1 of milliwatts.
2249a3d991bdSwdenk
2250a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2251a3d991bdSwdenk
2252a3d991bdSwdenk		A byte containing the id of the VLAN.
2253a3d991bdSwdenk
2254c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2255c609719bSwdenk
2256c609719bSwdenk		Several configurations allow to display the current
2257c609719bSwdenk		status using a LED. For instance, the LED will blink
2258c609719bSwdenk		fast while running U-Boot code, stop blinking as
2259c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2260c609719bSwdenk		start blinking slow once the Linux kernel is running
2261c609719bSwdenk		(supported by a status LED driver in the Linux
2262c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2263c609719bSwdenk		feature in U-Boot.
2264c609719bSwdenk
22651df7bbbaSIgor Grinberg		Additional options:
22661df7bbbaSIgor Grinberg
22671df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
22681df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
22691df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
22701df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
22711df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
22721df7bbbaSIgor Grinberg
22739dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
22749dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
22759dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
22769dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
22779dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
22789dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
22799dfdcdfeSIgor Grinberg
2280c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2281c609719bSwdenk
2282c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2283c609719bSwdenk		on those systems that support this (optional)
2284c609719bSwdenk		feature, like the TQM8xxL modules.
2285c609719bSwdenk
22863f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2287c609719bSwdenk
22883f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
22893f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
22903f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
22913f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
22923f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
22933f4978c7SHeiko Schocher		interface.
22943f4978c7SHeiko Schocher
22953f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2296ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2297ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2298ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2299ea818dbbSHeiko Schocher		    for defining speed and slave address
2300ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2301ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2302ea818dbbSHeiko Schocher		    for defining speed and slave address
2303ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2304ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2305ea818dbbSHeiko Schocher		    for defining speed and slave address
2306ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2307ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2308ea818dbbSHeiko Schocher		    for defining speed and slave address
23093f4978c7SHeiko Schocher
231000f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
231100f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
231200f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
231300f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
231400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
231500f792e0SHeiko Schocher		    bus.
231600f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
231700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
231800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
231900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
232000f792e0SHeiko Schocher		    second bus.
232100f792e0SHeiko Schocher
23221f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
23231f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
23241f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
23251f2ba722SSimon Glass		    100000 and the slave addr 0!
23261f2ba722SSimon Glass
2327880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2328880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2329880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2330880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2331880540deSDirk Eibach
2332fac96408Strem		- drivers/i2c/i2c_mxc.c
2333fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
233403544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
233503544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
233603544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
233703544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
2338fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2339fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2340fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2341fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2342fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2343fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
234403544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
234503544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
2346b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
2347fac96408Strem		for speed, and 0 for slave.
2348fac96408Strem
23491086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
23501086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
23511086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
23521086bfa9SNobuhiro Iwamatsu
23531086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
23541086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
23551086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
23561086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
23571086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
23581086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
23591086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
23601086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
23611086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
23621086bfa9SNobuhiro Iwamatsu
23632035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
23642035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
23652035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
23662035d77dSNobuhiro Iwamatsu
23672035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
23682035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
23692035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
23702035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
23712035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
23722035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
23732035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
23742035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
23752035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
23762035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
23772035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
23782035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2379b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
23802035d77dSNobuhiro Iwamatsu
23816789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
23826789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
23836789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
23846789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
23856789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
23866789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
23876789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
23886789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
23896789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
23906789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
23916789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
23926789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
23936789e84eSHeiko Schocher
23940bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
23950bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
23960bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
23970bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
23980bdffe71SHeiko Schocher
2399e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2400e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2401e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2402e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2403e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2404e717fc6dSNaveen Krishna Ch
2405b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2406b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2407b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2408b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2409b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2410b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2411b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2412b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2413b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2414b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2415b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2416b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2417b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2418b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2419071be896SDirk Eibach		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2420071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2421071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2422071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2423071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2424071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2425071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2426071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2427071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
2428b46226bdSDirk Eibach
24293f4978c7SHeiko Schocher		additional defines:
24303f4978c7SHeiko Schocher
24313f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2432b445bbb4SJeremiah Mahler		Hold the number of i2c buses you want to use. If you
24333f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
24343f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
24353f4978c7SHeiko Schocher		omit this define.
24363f4978c7SHeiko Schocher
24373f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
24383f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
24393f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
24403f4978c7SHeiko Schocher		omit this define.
24413f4978c7SHeiko Schocher
24423f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
24433f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
24443f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
24453f4978c7SHeiko Schocher		define.
24463f4978c7SHeiko Schocher
24473f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2448b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
24493f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
24503f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
24513f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
24523f4978c7SHeiko Schocher
24533f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
24543f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
24553f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
24563f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
24573f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
24583f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
24593f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
24603f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
24613f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
24623f4978c7SHeiko Schocher					}
24633f4978c7SHeiko Schocher
24643f4978c7SHeiko Schocher		which defines
24653f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2466ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2467ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2468ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2469ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2470ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
24713f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2472ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2473ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
24743f4978c7SHeiko Schocher
24753f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
24763f4978c7SHeiko Schocher
2477ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
24783f4978c7SHeiko Schocher
24793f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
24803f4978c7SHeiko Schocher		provides the following compelling advantages:
24813f4978c7SHeiko Schocher
24823f4978c7SHeiko Schocher		- more than one i2c adapter is usable
24833f4978c7SHeiko Schocher		- approved multibus support
24843f4978c7SHeiko Schocher		- better i2c mux support
24853f4978c7SHeiko Schocher
24863f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
24873f4978c7SHeiko Schocher
2488ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2489ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2490ea818dbbSHeiko Schocher		for the selected CPU.
2491c609719bSwdenk
2492b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2493602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2494b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2495b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2496c609719bSwdenk		command line interface.
2497c609719bSwdenk
2498bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2499c609719bSwdenk
2500b37c7e5eSwdenk		There are several other quantities that must also be
2501ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2502c609719bSwdenk
25036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2504b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
25056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
250611ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2507c609719bSwdenk
25088d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2509a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
25108d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
25118d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
25128d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2513b37c7e5eSwdenk
25145da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
25155da71efaSEric Millbrandt
25165da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
25175da71efaSEric Millbrandt		chips might think that the current transfer is still
25185da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
25195da71efaSEric Millbrandt		commands until the slave device responds.
25205da71efaSEric Millbrandt
2521b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2522b37c7e5eSwdenk
2523ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2524b37c7e5eSwdenk		then the following macros need to be defined (examples are
2525b37c7e5eSwdenk		from include/configs/lwmon.h):
2526c609719bSwdenk
2527c609719bSwdenk		I2C_INIT
2528c609719bSwdenk
2529b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2530c609719bSwdenk		controller or configure ports.
2531c609719bSwdenk
2532b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2533b37c7e5eSwdenk
2534c609719bSwdenk		I2C_PORT
2535c609719bSwdenk
2536c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2537c609719bSwdenk		assumes both bits are on the same port). Valid values
2538c609719bSwdenk		are 0..3 for ports A..D.
2539c609719bSwdenk
2540c609719bSwdenk		I2C_ACTIVE
2541c609719bSwdenk
2542c609719bSwdenk		The code necessary to make the I2C data line active
2543c609719bSwdenk		(driven).  If the data line is open collector, this
2544c609719bSwdenk		define can be null.
2545c609719bSwdenk
2546b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2547b37c7e5eSwdenk
2548c609719bSwdenk		I2C_TRISTATE
2549c609719bSwdenk
2550c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2551c609719bSwdenk		(inactive).  If the data line is open collector, this
2552c609719bSwdenk		define can be null.
2553c609719bSwdenk
2554b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2555b37c7e5eSwdenk
2556c609719bSwdenk		I2C_READ
2557c609719bSwdenk
2558472d5460SYork Sun		Code that returns true if the I2C data line is high,
2559472d5460SYork Sun		false if it is low.
2560c609719bSwdenk
2561b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2562b37c7e5eSwdenk
2563c609719bSwdenk		I2C_SDA(bit)
2564c609719bSwdenk
2565472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2566472d5460SYork Sun		is false, it clears it (low).
2567c609719bSwdenk
2568b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2569b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2570b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2571b37c7e5eSwdenk
2572c609719bSwdenk		I2C_SCL(bit)
2573c609719bSwdenk
2574472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2575472d5460SYork Sun		is false, it clears it (low).
2576c609719bSwdenk
2577b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2578b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2579b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2580b37c7e5eSwdenk
2581c609719bSwdenk		I2C_DELAY
2582c609719bSwdenk
2583c609719bSwdenk		This delay is invoked four times per clock cycle so this
2584c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2585b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2586b37c7e5eSwdenk		like:
2587b37c7e5eSwdenk
2588b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2589c609719bSwdenk
2590793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2591793b5726SMike Frysinger
2592793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2593793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2594793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2595793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2596793b5726SMike Frysinger
2597793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2598793b5726SMike Frysinger		the generic GPIO functions.
2599793b5726SMike Frysinger
26006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
260147cd00faSwdenk
260247cd00faSwdenk		When a board is reset during an i2c bus transfer
260347cd00faSwdenk		chips might think that the current transfer is still
260447cd00faSwdenk		in progress. On some boards it is possible to access
260547cd00faSwdenk		the i2c SCLK line directly, either by using the
260647cd00faSwdenk		processor pin as a GPIO or by having a second pin
260747cd00faSwdenk		connected to the bus. If this option is defined a
260847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
260947cd00faSwdenk		is run early in the boot sequence.
261047cd00faSwdenk
261126a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
261226a33504SRichard Retanubun
261326a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
261426a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
261526a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
261626a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
261726a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
261826a33504SRichard Retanubun		controller provide such a method. It is called at the end of
261926a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
262026a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
262126a33504SRichard Retanubun
262217ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
262317ea1177Swdenk
262417ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
262517ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
262617ea1177Swdenk		variable "i2cfast". (see also i2cfast)
262717ea1177Swdenk
2628bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2629bb99ad6dSBen Warren
2630bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2631bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2632bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2633bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2634bb99ad6dSBen Warren
26356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2636bb99ad6dSBen Warren
2637bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
26380f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
26390f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
26400f89c54bSPeter Tyser		a 1D array of device addresses
2641bb99ad6dSBen Warren
2642bb99ad6dSBen Warren		e.g.
2643bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
26446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2645bb99ad6dSBen Warren
2646bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2647bb99ad6dSBen Warren
2648bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
26496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2650bb99ad6dSBen Warren
2651bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2652bb99ad6dSBen Warren
26536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2654be5e6181STimur Tabi
2655be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2656be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2657be5e6181STimur Tabi
26586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
26590dc018ecSStefan Roese
26600dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
26610dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
26620dc018ecSStefan Roese
26636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
26640dc018ecSStefan Roese
26650dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
26660dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
26670dc018ecSStefan Roese
26686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
26699ebbb54fSVictor Gallardo
26709ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
26719ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
26729ebbb54fSVictor Gallardo		specified DTT device.
26739ebbb54fSVictor Gallardo
26742ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
26752ac6985aSAndrew Dyer
26762ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
26772ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
26782ac6985aSAndrew Dyer		between writing the address pointer and reading the
26792ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
26802ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
26812ac6985aSAndrew Dyer		devices can use either method, but some require one or
26822ac6985aSAndrew Dyer		the other.
2683be5e6181STimur Tabi
2684c609719bSwdenk- SPI Support:	CONFIG_SPI
2685c609719bSwdenk
2686c609719bSwdenk		Enables SPI driver (so far only tested with
2687c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2688c609719bSwdenk		D/As on the SACSng board)
2689c609719bSwdenk
26906639562eSYoshihiro Shimoda		CONFIG_SH_SPI
26916639562eSYoshihiro Shimoda
26926639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
26936639562eSYoshihiro Shimoda		only SH7757 is supported.
26946639562eSYoshihiro Shimoda
2695c609719bSwdenk		CONFIG_SPI_X
2696c609719bSwdenk
2697c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2698c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2699c609719bSwdenk
2700c609719bSwdenk		CONFIG_SOFT_SPI
2701c609719bSwdenk
2702c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2703c609719bSwdenk		using hardware support. This is a general purpose
2704c609719bSwdenk		driver that only requires three general I/O port pins
2705c609719bSwdenk		(two outputs, one input) to function. If this is
2706c609719bSwdenk		defined, the board configuration must define several
2707c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2708c609719bSwdenk		an example, see include/configs/sacsng.h.
2709c609719bSwdenk
271004a9e118SBen Warren		CONFIG_HARD_SPI
271104a9e118SBen Warren
271204a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
271304a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
271404a9e118SBen Warren		must define a list of chip-select function pointers.
271504a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
271604a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
271704a9e118SBen Warren
271838254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
271938254f45SGuennadi Liakhovetski
272038254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
27212e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
272238254f45SGuennadi Liakhovetski
2723f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2724f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2725f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2726f659b573SHeiko Schocher
27270133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
27280133502eSMatthias Fuchs
27290133502eSMatthias Fuchs		Enables FPGA subsystem.
27300133502eSMatthias Fuchs
27310133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
27320133502eSMatthias Fuchs
27330133502eSMatthias Fuchs		Enables support for specific chip vendors.
27340133502eSMatthias Fuchs		(ALTERA, XILINX)
27350133502eSMatthias Fuchs
27360133502eSMatthias Fuchs		CONFIG_FPGA_<family>
27370133502eSMatthias Fuchs
27380133502eSMatthias Fuchs		Enables support for FPGA family.
27390133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
27400133502eSMatthias Fuchs
27410133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2742c609719bSwdenk
2743c609719bSwdenk		Specify the number of FPGA devices to support.
2744c609719bSwdenk
274564e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
274664e809afSSiva Durga Prasad Paladugu
274764e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
274864e809afSSiva Durga Prasad Paladugu
274967193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
275067193864SMichal Simek
275167193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
275267193864SMichal Simek
275367193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
275467193864SMichal Simek
275567193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
275667193864SMichal Simek		(Xilinx only)
275767193864SMichal Simek
27586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2759c609719bSwdenk
2760c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2761c609719bSwdenk
27626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2763c609719bSwdenk
2764c609719bSwdenk		Enable checks on FPGA configuration interface busy
2765c609719bSwdenk		status by the configuration function. This option
2766c609719bSwdenk		will require a board or device specific function to
2767c609719bSwdenk		be written.
2768c609719bSwdenk
2769c609719bSwdenk		CONFIG_FPGA_DELAY
2770c609719bSwdenk
2771c609719bSwdenk		If defined, a function that provides delays in the FPGA
2772c609719bSwdenk		configuration driver.
2773c609719bSwdenk
27746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2775c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2776c609719bSwdenk
27776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2778c609719bSwdenk
2779c609719bSwdenk		Check for configuration errors during FPGA bitfile
2780c609719bSwdenk		loading. For example, abort during Virtex II
2781c609719bSwdenk		configuration if the INIT_B line goes low (which
2782c609719bSwdenk		indicated a CRC error).
2783c609719bSwdenk
27846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2785c609719bSwdenk
2786b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2787b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2788c609719bSwdenk		FPGA configuration sequence. The default time is 500
278911ccc33fSMarcel Ziswiler		ms.
2790c609719bSwdenk
27916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2792c609719bSwdenk
2793b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
279411ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2795c609719bSwdenk
27966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2797c609719bSwdenk
2798c609719bSwdenk		Time to wait after FPGA configuration. The default is
279911ccc33fSMarcel Ziswiler		200 ms.
2800c609719bSwdenk
2801c609719bSwdenk- Configuration Management:
2802b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2803b2b8a696SStefan Roese
2804b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2805b2b8a696SStefan Roese		with a special header) as build targets. By defining
2806b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2807b2b8a696SStefan Roese		special image will be automatically built upon calling
2808b2b8a696SStefan Roese		make / MAKEALL.
2809b2b8a696SStefan Roese
2810c609719bSwdenk		CONFIG_IDENT_STRING
2811c609719bSwdenk
2812c609719bSwdenk		If defined, this string will be added to the U-Boot
2813c609719bSwdenk		version information (U_BOOT_VERSION)
2814c609719bSwdenk
2815c609719bSwdenk- Vendor Parameter Protection:
2816c609719bSwdenk
2817c609719bSwdenk		U-Boot considers the values of the environment
2818c609719bSwdenk		variables "serial#" (Board Serial Number) and
28197152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2820c609719bSwdenk		are set once by the board vendor / manufacturer, and
2821c609719bSwdenk		protects these variables from casual modification by
2822c609719bSwdenk		the user. Once set, these variables are read-only,
2823c609719bSwdenk		and write or delete attempts are rejected. You can
282411ccc33fSMarcel Ziswiler		change this behaviour:
2825c609719bSwdenk
2826c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2827c609719bSwdenk		file, the write protection for vendor parameters is
282847cd00faSwdenk		completely disabled. Anybody can change or delete
2829c609719bSwdenk		these parameters.
2830c609719bSwdenk
283192ac5208SJoe Hershberger		Alternatively, if you define _both_ an ethaddr in the
283292ac5208SJoe Hershberger		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
283311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2834c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2835c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2836c609719bSwdenk		read-only.]
2837c609719bSwdenk
28382598090bSJoe Hershberger		The same can be accomplished in a more flexible way
28392598090bSJoe Hershberger		for any variable by configuring the type of access
28402598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
28412598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
28422598090bSJoe Hershberger
2843c609719bSwdenk- Protected RAM:
2844c609719bSwdenk		CONFIG_PRAM
2845c609719bSwdenk
2846c609719bSwdenk		Define this variable to enable the reservation of
2847c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2848c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2849c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2850c609719bSwdenk		this default value by defining an environment
2851c609719bSwdenk		variable "pram" to the number of kB you want to
2852c609719bSwdenk		reserve. Note that the board info structure will
2853c609719bSwdenk		still show the full amount of RAM. If pRAM is
2854c609719bSwdenk		reserved, a new environment variable "mem" will
2855c609719bSwdenk		automatically be defined to hold the amount of
2856c609719bSwdenk		remaining RAM in a form that can be passed as boot
2857c609719bSwdenk		argument to Linux, for instance like that:
2858c609719bSwdenk
2859fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2860c609719bSwdenk			saveenv
2861c609719bSwdenk
2862c609719bSwdenk		This way you can tell Linux not to use this memory,
2863c609719bSwdenk		either, which results in a memory region that will
2864c609719bSwdenk		not be affected by reboots.
2865c609719bSwdenk
2866c609719bSwdenk		*WARNING* If your board configuration uses automatic
2867c609719bSwdenk		detection of the RAM size, you must make sure that
2868c609719bSwdenk		this memory test is non-destructive. So far, the
2869c609719bSwdenk		following board configurations are known to be
2870c609719bSwdenk		"pRAM-clean":
2871c609719bSwdenk
28721b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
28731b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2874544d97e9SWolfgang Denk			FLAGADM, TQM8260
2875c609719bSwdenk
287640fef049SGabe Black- Access to physical memory region (> 4GB)
287740fef049SGabe Black		Some basic support is provided for operations on memory not
287840fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
287940fef049SGabe Black		support access to more than 4GB of memory on 32-bit
288040fef049SGabe Black		machines using physical address extension or similar.
288140fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
288240fef049SGabe Black		currently only supports clearing the memory.
288340fef049SGabe Black
2884c609719bSwdenk- Error Recovery:
2885c609719bSwdenk		CONFIG_PANIC_HANG
2886c609719bSwdenk
2887c609719bSwdenk		Define this variable to stop the system in case of a
2888c609719bSwdenk		fatal error, so that you have to reset it manually.
2889c609719bSwdenk		This is probably NOT a good idea for an embedded
289011ccc33fSMarcel Ziswiler		system where you want the system to reboot
2891c609719bSwdenk		automatically as fast as possible, but it may be
2892c609719bSwdenk		useful during development since you can try to debug
2893c609719bSwdenk		the conditions that lead to the situation.
2894c609719bSwdenk
2895c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2896c609719bSwdenk
2897c609719bSwdenk		This variable defines the number of retries for
2898c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2899c609719bSwdenk		before giving up the operation. If not defined, a
2900c609719bSwdenk		default value of 5 is used.
2901c609719bSwdenk
290240cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
290340cb90eeSGuennadi Liakhovetski
290440cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
290540cb90eeSGuennadi Liakhovetski
290648a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
290748a3e999STetsuyuki Kobayashi
290848a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
290948a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
291048a3e999STetsuyuki Kobayashi		try longer timeout such as
291148a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
291248a3e999STetsuyuki Kobayashi
2913c609719bSwdenk- Command Interpreter:
29148078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
291504a85b3bSwdenk
291604a85b3bSwdenk		Enable auto completion of commands using TAB.
291704a85b3bSwdenk
29186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2919c609719bSwdenk
2920c609719bSwdenk		This defines the secondary prompt string, which is
2921c609719bSwdenk		printed when the command interpreter needs more input
2922c609719bSwdenk		to complete a command. Usually "> ".
2923c609719bSwdenk
2924c609719bSwdenk	Note:
2925c609719bSwdenk
2926c609719bSwdenk		In the current implementation, the local variables
2927c609719bSwdenk		space and global environment variables space are
2928c609719bSwdenk		separated. Local variables are those you define by
29293b57fe0aSwdenk		simply typing `name=value'. To access a local
2930c609719bSwdenk		variable later on, you have write `$name' or
29313b57fe0aSwdenk		`${name}'; to execute the contents of a variable
29323b57fe0aSwdenk		directly type `$name' at the command prompt.
2933c609719bSwdenk
2934c609719bSwdenk		Global environment variables are those you use
2935c609719bSwdenk		setenv/printenv to work with. To run a command stored
2936c609719bSwdenk		in such a variable, you need to use the run command,
2937c609719bSwdenk		and you must not use the '$' sign to access them.
2938c609719bSwdenk
2939c609719bSwdenk		To store commands and special characters in a
2940c609719bSwdenk		variable, please use double quotation marks
2941c609719bSwdenk		surrounding the whole text of the variable, instead
2942c609719bSwdenk		of the backslashes before semicolons and special
2943c609719bSwdenk		symbols.
2944c609719bSwdenk
2945b445bbb4SJeremiah Mahler- Command Line Editing and History:
2946aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2947aa0c71acSWolfgang Denk
294811ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2949aa0c71acSWolfgang Denk		command line input operations
2950aa0c71acSWolfgang Denk
2951a8c7c708Swdenk- Default Environment:
2952c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2953c609719bSwdenk
2954c609719bSwdenk		Define this to contain any number of null terminated
2955c609719bSwdenk		strings (variable = value pairs) that will be part of
29567152b1d0Swdenk		the default environment compiled into the boot image.
29572262cfeeSwdenk
2958c609719bSwdenk		For example, place something like this in your
2959c609719bSwdenk		board's config file:
2960c609719bSwdenk
2961c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2962c609719bSwdenk			"myvar1=value1\0" \
2963c609719bSwdenk			"myvar2=value2\0"
2964c609719bSwdenk
2965c609719bSwdenk		Warning: This method is based on knowledge about the
2966c609719bSwdenk		internal format how the environment is stored by the
29672262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2968c609719bSwdenk		interface! Although it is unlikely that this format
29697152b1d0Swdenk		will change soon, there is no guarantee either.
2970c609719bSwdenk		You better know what you are doing here.
2971c609719bSwdenk
2972c609719bSwdenk		Note: overly (ab)use of the default environment is
2973c609719bSwdenk		discouraged. Make sure to check other ways to preset
297474de7aefSWolfgang Denk		the environment like the "source" command or the
2975c609719bSwdenk		boot command first.
2976c609719bSwdenk
29775e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
29785e724ca2SStephen Warren
29795e724ca2SStephen Warren		Define this in order to add variables describing the
29805e724ca2SStephen Warren		U-Boot build configuration to the default environment.
29815e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
29825e724ca2SStephen Warren
29835e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
29845e724ca2SStephen Warren
29855e724ca2SStephen Warren		- CONFIG_SYS_ARCH
29865e724ca2SStephen Warren		- CONFIG_SYS_CPU
29875e724ca2SStephen Warren		- CONFIG_SYS_BOARD
29885e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
29895e724ca2SStephen Warren		- CONFIG_SYS_SOC
29905e724ca2SStephen Warren
29917e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
29927e27f89fSTom Rini
29937e27f89fSTom Rini		Define this in order to add variables describing certain
29947e27f89fSTom Rini		run-time determined information about the hardware to the
29957e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
29967e27f89fSTom Rini
299706fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
299806fd8538SSimon Glass
299906fd8538SSimon Glass		Normally the environment is loaded when the board is
3000b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
300106fd8538SSimon Glass		that so that the environment is not available until
300206fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
300306fd8538SSimon Glass		this is instead controlled by the value of
300406fd8538SSimon Glass		/config/load-environment.
300506fd8538SSimon Glass
30063b10cf12SChris Packham- Parallel Flash support:
30073b10cf12SChris Packham		CONFIG_SYS_NO_FLASH
30083b10cf12SChris Packham
30093b10cf12SChris Packham		Traditionally U-boot was run on systems with parallel NOR
30103b10cf12SChris Packham		flash. This option is used to disable support for parallel NOR
30113b10cf12SChris Packham		flash. This option should be defined if the board does not have
30123b10cf12SChris Packham		parallel flash.
30133b10cf12SChris Packham
30143b10cf12SChris Packham		If this option is not defined one of the generic flash drivers
30153b10cf12SChris Packham		(e.g.  CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
30163b10cf12SChris Packham		selected or the board must provide an implementation of the
30173b10cf12SChris Packham		flash API (see include/flash.h).
30183b10cf12SChris Packham
3019a8c7c708Swdenk- DataFlash Support:
30202abbe075Swdenk		CONFIG_HAS_DATAFLASH
30212abbe075Swdenk
30222abbe075Swdenk		Defining this option enables DataFlash features and
30232abbe075Swdenk		allows to read/write in Dataflash via the standard
30242abbe075Swdenk		commands cp, md...
30252abbe075Swdenk
3026f61ec45eSEric Nelson- Serial Flash support
3027f61ec45eSEric Nelson		CONFIG_CMD_SF
3028f61ec45eSEric Nelson
3029f61ec45eSEric Nelson		Defining this option enables SPI flash commands
3030f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
3031f61ec45eSEric Nelson
3032f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
3033f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
3034f61ec45eSEric Nelson		commands.
3035f61ec45eSEric Nelson
3036f61ec45eSEric Nelson		The following defaults may be provided by the platform
3037f61ec45eSEric Nelson		to handle the common case when only a single serial
3038f61ec45eSEric Nelson		flash is present on the system.
3039f61ec45eSEric Nelson
3040f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
3041f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
3042f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
3043f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
3044f61ec45eSEric Nelson
304524007273SSimon Glass		CONFIG_CMD_SF_TEST
304624007273SSimon Glass
304724007273SSimon Glass		Define this option to include a destructive SPI flash
304824007273SSimon Glass		test ('sf test').
304924007273SSimon Glass
3050b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
3051b902e07cSJagannadha Sutradharudu Teki
3052b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
3053b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
3054b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
3055b902e07cSJagannadha Sutradharudu Teki
30563f85ce27Swdenk- SystemACE Support:
30573f85ce27Swdenk		CONFIG_SYSTEMACE
30583f85ce27Swdenk
30593f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
30603f85ce27Swdenk		chips attached via some sort of local bus. The address
306111ccc33fSMarcel Ziswiler		of the chip must also be defined in the
30626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
30633f85ce27Swdenk
30643f85ce27Swdenk		#define CONFIG_SYSTEMACE
30656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
30663f85ce27Swdenk
30673f85ce27Swdenk		When SystemACE support is added, the "ace" device type
30683f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
30693f85ce27Swdenk
3070ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
3071ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
3072ecb0ccd9SWolfgang Denk
307328cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
3074ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
307528cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
3076ecb0ccd9SWolfgang Denk		number generator is used.
3077ecb0ccd9SWolfgang Denk
307828cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
307928cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
308028cb9375SWolfgang Denk		defined, the normal port 69 is used.
308128cb9375SWolfgang Denk
308228cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
3083ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
3084ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
3085ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
3086ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
3087ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
3088ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
3089ecb0ccd9SWolfgang Denk
3090bf36c5d5SSimon Glass- Hashing support:
3091bf36c5d5SSimon Glass		CONFIG_CMD_HASH
3092bf36c5d5SSimon Glass
3093bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
3094bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3095bf36c5d5SSimon Glass
3096bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3097bf36c5d5SSimon Glass
3098bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3099bf36c5d5SSimon Glass		size a little.
3100bf36c5d5SSimon Glass
310194e3c8c4Sgaurav rana		CONFIG_SHA1 - This option enables support of hashing using SHA1
310294e3c8c4Sgaurav rana		algorithm. The hash is calculated in software.
310394e3c8c4Sgaurav rana		CONFIG_SHA256 - This option enables support of hashing using
310494e3c8c4Sgaurav rana		SHA256 algorithm. The hash is calculated in software.
310594e3c8c4Sgaurav rana		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
310694e3c8c4Sgaurav rana		for SHA1/SHA256 hashing.
310794e3c8c4Sgaurav rana		This affects the 'hash' command and also the
310894e3c8c4Sgaurav rana		hash_lookup_algo() function.
310994e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL - This option enables
311094e3c8c4Sgaurav rana		hardware-acceleration for SHA1/SHA256 progressive hashing.
311194e3c8c4Sgaurav rana		Data can be streamed in a block at a time and the hashing
311294e3c8c4Sgaurav rana		is performed in hardware.
3113bf36c5d5SSimon Glass
3114bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3115bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3116bf36c5d5SSimon Glass
3117a11f1873SRobert Winkler- Freescale i.MX specific commands:
3118a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3119a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3120a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3121a11f1873SRobert Winkler
3122a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3123a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3124a11f1873SRobert Winkler		a boot from specific media.
3125a11f1873SRobert Winkler
3126a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3127a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3128a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3129a11f1873SRobert Winkler		will set it back to normal.  This command currently
3130a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3131a11f1873SRobert Winkler
313219c402afSSimon Glass- Signing support:
313319c402afSSimon Glass		CONFIG_RSA
313419c402afSSimon Glass
313519c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
31368bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
313719c402afSSimon Glass
3138c937ff6dSRuchika Gupta		The Modular Exponentiation algorithm in RSA is implemented using
3139c937ff6dSRuchika Gupta		driver model. So CONFIG_DM needs to be enabled by default for this
3140c937ff6dSRuchika Gupta		library to function.
3141c937ff6dSRuchika Gupta
314219c402afSSimon Glass		The signing part is build into mkimage regardless of this
3143c937ff6dSRuchika Gupta		option. The software based modular exponentiation is built into
3144c937ff6dSRuchika Gupta		mkimage irrespective of this option.
314519c402afSSimon Glass
31469e50c406SHeiko Schocher- bootcount support:
31479e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
31489e50c406SHeiko Schocher
31499e50c406SHeiko Schocher		This enables the bootcounter support, see:
31509e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
31519e50c406SHeiko Schocher
31529e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
31539e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
31549e50c406SHeiko Schocher		CONFIG_BLACKFIN
31559e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
31569e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
31579e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
31589e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
31599e50c406SHeiko Schocher		enable support for the bootcounter in RAM
31609e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
31619e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
31629e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
31639e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
31649e50c406SHeiko Schocher						    the bootcounter.
31659e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
316619c402afSSimon Glass
3167a8c7c708Swdenk- Show boot progress:
3168c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3169c609719bSwdenk
3170c609719bSwdenk		Defining this option allows to add some board-
3171c609719bSwdenk		specific code (calling a user-provided function
3172c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3173c609719bSwdenk		the system's boot progress on some display (for
3174c609719bSwdenk		example, some LED's) on your board. At the moment,
3175c609719bSwdenk		the following checkpoints are implemented:
3176c609719bSwdenk
317794fd1316SSimon Glass
31781372cce2SMarian BalakowiczLegacy uImage format:
31791372cce2SMarian Balakowicz
3180c609719bSwdenk  Arg	Where			When
3181c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3182c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3183c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3184c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3185c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3186c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3187c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3188c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3189c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
31901372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3191c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3192c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3193c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3194c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
31951372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3196c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
31971372cce2SMarian Balakowicz
31981372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
31991372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
32001372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
32011372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
32021372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
32031372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
32041372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
320511ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
32061372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
32071372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
32081372cce2SMarian Balakowicz
3209ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3210c609719bSwdenk
3211a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
321263e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
321363e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
321463e73c9aSwdenk
3215566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3216566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3217566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3218566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3219566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3220566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3221566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3222566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3223566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3224566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3225566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3226566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3227566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3228566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3229566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3230566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3231566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3232566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3233566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3234566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3235566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3236566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3237566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3238566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3239566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3240566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3241566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3242566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3243566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3244566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3245566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3246566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3247566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3248566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3249566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3250566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3251566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3252566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3253566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3254566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3255566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3256566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3257566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3258566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3259566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3260566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3261566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3262c609719bSwdenk
3263566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3264c609719bSwdenk
3265566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3266566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3267566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3268206c60cbSwdenk
3269566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3270bc0571fcSJoe Hershberger   80	common/cmd_net.c	before calling net_loop()
3271bc0571fcSJoe Hershberger  -81	common/cmd_net.c	some error in net_loop() occurred
3272bc0571fcSJoe Hershberger   81	common/cmd_net.c	net_loop() back without error
3273566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3274566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
327574de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
327674de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3277566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3278c609719bSwdenk
32791372cce2SMarian BalakowiczFIT uImage format:
32801372cce2SMarian Balakowicz
32811372cce2SMarian Balakowicz  Arg	Where			When
32821372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
32831372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
32841372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
32851372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
32861372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
32871372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3288f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
32891372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
32901372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
32911372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
32921372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
32931372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
329411ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
329511ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
32961372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
32971372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
32981372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
32991372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
33001372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
33011372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
33021372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
33031372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
33041372cce2SMarian Balakowicz
33051372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
33061372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
33071372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
330811ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
33091372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
33101372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
33111372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
33121372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
33131372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
33141372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
33151372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
33161372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
33171372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
33181372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
33191372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
33201372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
33211372cce2SMarian Balakowicz
332211ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
33231372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
33241372cce2SMarian Balakowicz
332511ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
33261372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
33271372cce2SMarian Balakowicz
332811ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
33291372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
33301372cce2SMarian Balakowicz
333121d29f7fSHeiko Schocher- legacy image format:
333221d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
333321d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
333421d29f7fSHeiko Schocher
333521d29f7fSHeiko Schocher		Default:
333621d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
333721d29f7fSHeiko Schocher
333821d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
333921d29f7fSHeiko Schocher		disable the legacy image format
334021d29f7fSHeiko Schocher
334121d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
334221d29f7fSHeiko Schocher		enabled per default for backward compatibility.
334321d29f7fSHeiko Schocher
3344d95f6ec7SGabe Black- FIT image support:
3345d95f6ec7SGabe Black		CONFIG_FIT
3346d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3347d95f6ec7SGabe Black
3348d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3349d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3350d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3351d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3352d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3353d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3354d95f6ec7SGabe Black
33553e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
33563e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
335794e3c8c4Sgaurav rana		using a hash signed and verified using RSA. If
335894e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
335994e3c8c4Sgaurav rana		hashing is available using hardware, RSA library will use it.
336094e3c8c4Sgaurav rana		See doc/uImage.FIT/signature.txt for more details.
33613e569a6bSSimon Glass
336221d29f7fSHeiko Schocher		WARNING: When relying on signed FIT images with required
336321d29f7fSHeiko Schocher		signature check the legacy image format is default
336421d29f7fSHeiko Schocher		disabled. If a board need legacy image format support
336521d29f7fSHeiko Schocher		enable this through CONFIG_IMAGE_FORMAT_LEGACY
336621d29f7fSHeiko Schocher
33679a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
33689a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
33699a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
33709a4f479bSDirk Eibach		with this option.
33719a4f479bSDirk Eibach
33724cf2609bSWolfgang Denk- Standalone program support:
33734cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
33744cf2609bSWolfgang Denk
33756feff899SWolfgang Denk		This option defines a board specific value for the
33766feff899SWolfgang Denk		address where standalone program gets loaded, thus
33776feff899SWolfgang Denk		overwriting the architecture dependent default
33784cf2609bSWolfgang Denk		settings.
33794cf2609bSWolfgang Denk
33804cf2609bSWolfgang Denk- Frame Buffer Address:
33814cf2609bSWolfgang Denk		CONFIG_FB_ADDR
33824cf2609bSWolfgang Denk
33834cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
338444a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
338544a53b57SWolfgang Denk		when using a graphics controller has separate video
338644a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
338744a53b57SWolfgang Denk		the given address instead of dynamically reserving it
338844a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
338944a53b57SWolfgang Denk		the memory for the frame buffer depending on the
339044a53b57SWolfgang Denk		configured panel size.
33914cf2609bSWolfgang Denk
33924cf2609bSWolfgang Denk		Please see board_init_f function.
33934cf2609bSWolfgang Denk
3394cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3395cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3396cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3397cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3398cccfc2abSDetlev Zundel
3399cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3400cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3401cccfc2abSDetlev Zundel
3402cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3403cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3404cccfc2abSDetlev Zundel
3405cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3406cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3407cccfc2abSDetlev Zundel
3408cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3409cccfc2abSDetlev Zundel
3410cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3411cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3412cccfc2abSDetlev Zundel
341370c219cdSJoe Hershberger- UBI support
341470c219cdSJoe Hershberger		CONFIG_CMD_UBI
341570c219cdSJoe Hershberger
341670c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
341770c219cdSJoe Hershberger		with the UBI flash translation layer
341870c219cdSJoe Hershberger
341970c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
342070c219cdSJoe Hershberger
3421147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3422147162daSJoe Hershberger
3423147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3424147162daSJoe Hershberger		warnings and errors enabled.
3425147162daSJoe Hershberger
3426ff94bc40SHeiko Schocher
3427ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3428ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3429ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3430ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3431ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3432ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3433ff94bc40SHeiko Schocher
3434ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3435ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3436ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3437ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3438ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3439ff94bc40SHeiko Schocher
3440ff94bc40SHeiko Schocher		default: 4096
3441ff94bc40SHeiko Schocher
3442ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3443ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3444ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3445ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3446ff94bc40SHeiko Schocher		flash), this value is ignored.
3447ff94bc40SHeiko Schocher
3448ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3449ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3450ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3451ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3452ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3453ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3454ff94bc40SHeiko Schocher
3455ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3456ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3457ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3458ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3459ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3460ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3461ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3462ff94bc40SHeiko Schocher		partition.
3463ff94bc40SHeiko Schocher
3464ff94bc40SHeiko Schocher		default: 20
3465ff94bc40SHeiko Schocher
3466ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3467ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3468ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3469ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3470ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3471ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3472ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3473ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3474ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3475ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3476ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3477ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3478ff94bc40SHeiko Schocher
3479ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3480ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3481ff94bc40SHeiko Schocher		without a fastmap.
3482ff94bc40SHeiko Schocher		default: 0
3483ff94bc40SHeiko Schocher
34840195a7bbSHeiko Schocher		CONFIG_MTD_UBI_FM_DEBUG
34850195a7bbSHeiko Schocher		Enable UBI fastmap debug
34860195a7bbSHeiko Schocher		default: 0
34870195a7bbSHeiko Schocher
348870c219cdSJoe Hershberger- UBIFS support
348970c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
349070c219cdSJoe Hershberger
349170c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
349270c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
349370c219cdSJoe Hershberger
349470c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
349570c219cdSJoe Hershberger
3496147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3497147162daSJoe Hershberger
3498147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3499147162daSJoe Hershberger		warnings and errors enabled.
3500147162daSJoe Hershberger
35016a11cf48SDaniel Schwierzeck- SPL framework
35026a11cf48SDaniel Schwierzeck		CONFIG_SPL
35036a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
35046a11cf48SDaniel Schwierzeck
350595579793STom Rini		CONFIG_SPL_LDSCRIPT
350695579793STom Rini		LDSCRIPT for linking the SPL binary.
350795579793STom Rini
35086ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
35096ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
35106ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
35116ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
35128960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
35136ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
35146ebc3461SAlbert ARIBAUD
351595579793STom Rini		CONFIG_SPL_MAX_SIZE
35166ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
35176ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
35186ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
35196ebc3461SAlbert ARIBAUD		not exceed it.
352095579793STom Rini
35216a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
35226a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
35236a11cf48SDaniel Schwierzeck
352494a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
352594a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
352694a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
352794a45bb1SScott Wood
352895579793STom Rini		CONFIG_SPL_BSS_START_ADDR
352995579793STom Rini		Link address for the BSS within the SPL binary.
353095579793STom Rini
353195579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
35326ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
35336ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
35346ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
35358960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
35366ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
353795579793STom Rini
353895579793STom Rini		CONFIG_SPL_STACK
353995579793STom Rini		Adress of the start of the stack SPL will use
354095579793STom Rini
35418c80eb3bSAlbert ARIBAUD \(3ADEV\)		CONFIG_SPL_PANIC_ON_RAW_IMAGE
35428c80eb3bSAlbert ARIBAUD \(3ADEV\)		When defined, SPL will panic() if the image it has
35438c80eb3bSAlbert ARIBAUD \(3ADEV\)		loaded does not have a signature.
35448c80eb3bSAlbert ARIBAUD \(3ADEV\)		Defining this is useful when code which loads images
35458c80eb3bSAlbert ARIBAUD \(3ADEV\)		in SPL cannot guarantee that absolutely all read errors
35468c80eb3bSAlbert ARIBAUD \(3ADEV\)		will be caught.
35478c80eb3bSAlbert ARIBAUD \(3ADEV\)		An example is the LPC32XX MLC NAND driver, which will
35488c80eb3bSAlbert ARIBAUD \(3ADEV\)		consider that a completely unreadable NAND block is bad,
35498c80eb3bSAlbert ARIBAUD \(3ADEV\)		and thus should be skipped silently.
35508c80eb3bSAlbert ARIBAUD \(3ADEV\)
355194a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
355294a45bb1SScott Wood		Adress of the start of the stack SPL will use after
355394a45bb1SScott Wood		relocation.  If unspecified, this is equal to
355494a45bb1SScott Wood		CONFIG_SPL_STACK.
355594a45bb1SScott Wood
355695579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
355795579793STom Rini		Starting address of the malloc pool used in SPL.
35589ac4fc82SFabio Estevam		When this option is set the full malloc is used in SPL and
35599ac4fc82SFabio Estevam		it is set up by spl_init() and before that, the simple malloc()
35609ac4fc82SFabio Estevam		can be used if CONFIG_SYS_MALLOC_F is defined.
356195579793STom Rini
356295579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
356395579793STom Rini		The size of the malloc pool used in SPL.
35646a11cf48SDaniel Schwierzeck
356547f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
356647f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
356747f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
356847f7bcaeSTom Rini		NAND loading of the Linux Kernel.
356947f7bcaeSTom Rini
35709607faf2STom Rini		CONFIG_SPL_OS_BOOT
35719607faf2STom Rini		Enable booting directly to an OS from SPL.
35729607faf2STom Rini		See also: doc/README.falcon
35739607faf2STom Rini
3574861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3575861a86f4STom Rini		For ARM, enable an optional function to print more information
3576861a86f4STom Rini		about the running system.
3577861a86f4STom Rini
35784b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
35794b919725SScott Wood		Arch init code should be built for a very small image
35804b919725SScott Wood
35816a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
35826a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
35836a11cf48SDaniel Schwierzeck
35846a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
35856a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
35866a11cf48SDaniel Schwierzeck
35876a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
35886a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
35896a11cf48SDaniel Schwierzeck
35906a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
35916a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
35926a11cf48SDaniel Schwierzeck
35936a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
35946a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
35956a11cf48SDaniel Schwierzeck
359695579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
359795579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3598e2ccdf89SPaul Kocialkowski		Address and partition on the MMC to load U-Boot from
359995579793STom Rini		when the MMC is being used in raw mode.
360095579793STom Rini
3601b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3602b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3603b97300b6SPaul Kocialkowski		used in raw mode
3604b97300b6SPaul Kocialkowski
36052b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
36062b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
36072b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
36082b75b0adSPeter Korsgaard
36092b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
36102b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
36112b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
36122b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
36132b75b0adSPeter Korsgaard		(for falcon mode)
36142b75b0adSPeter Korsgaard
3615e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3616e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3617e2ccdf89SPaul Kocialkowski		used in fs mode
3618e2ccdf89SPaul Kocialkowski
361995579793STom Rini		CONFIG_SPL_FAT_SUPPORT
362095579793STom Rini		Support for fs/fat/libfat.o in SPL binary
362195579793STom Rini
3622fae81c72SGuillaume GARDET		CONFIG_SPL_EXT_SUPPORT
3623fae81c72SGuillaume GARDET		Support for EXT filesystem in SPL binary
362495579793STom Rini
3625fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3626fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3627fae81c72SGuillaume GARDET
3628fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
36297ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3630fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
36317ad2cc79SPeter Korsgaard
3632fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
36337ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3634fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
36357ad2cc79SPeter Korsgaard
363606f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
363706f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
363806f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
363906f60ae3SScott Wood		continuing (the hardware starts execution after just
364006f60ae3SScott Wood		loading the first page rather than the full 4K).
364106f60ae3SScott Wood
3642651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3643651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3644651fcf60SPrabhakar Kushwaha
36456f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
36466f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
36476f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
36486f2f01b9SScott Wood
36496f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
36506f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
36516f2f01b9SScott Wood
36526f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
36536f2f01b9SScott Wood		Include standard software ECC in the SPL
36546f2f01b9SScott Wood
365595579793STom Rini		CONFIG_SPL_NAND_SIMPLE
36567d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
36577d4b7955SScott Wood		expose the cmd_ctrl() interface.
365895579793STom Rini
36596dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
36606dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
36616dd3b566STom Rini		environment on NAND support within SPL.
36626dd3b566STom Rini
36630c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
36640c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
36650c3117b1SHeiko Schocher		if you need to save space.
36660c3117b1SHeiko Schocher
3667bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3668bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
36695614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3670bb0dc108SYing Zhang
36717c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
36727c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
36737c8eea59SYing Zhang		SPL binary.
36747c8eea59SYing Zhang
367595579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
367695579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
367795579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
367895579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
367995579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
368095579793STom Rini		Defines the size and behavior of the NAND that SPL uses
36817d4b7955SScott Wood		to read U-Boot
368295579793STom Rini
3683fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3684fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3685fbe76ae4SPrabhakar Kushwaha
368695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
36877d4b7955SScott Wood		Location in NAND to read U-Boot from
36887d4b7955SScott Wood
36897d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
36907d4b7955SScott Wood		Location in memory to load U-Boot to
36917d4b7955SScott Wood
36927d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
36937d4b7955SScott Wood		Size of image to load
369495579793STom Rini
369595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
36967d4b7955SScott Wood		Entry point in loaded image to jump to
369795579793STom Rini
369895579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
369995579793STom Rini		Define this if you need to first read the OOB and then the
3700b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
370195579793STom Rini
370295579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
370395579793STom Rini		Support for an OMAP3-specific set of functions to return the
370495579793STom Rini		ID and MFR of the first attached NAND chip, if present.
370595579793STom Rini
37066a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
37076a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
37086a11cf48SDaniel Schwierzeck
37096a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
37106a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
37116a11cf48SDaniel Schwierzeck
37126a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
37136a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
37146a11cf48SDaniel Schwierzeck
3715c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3716c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3717c57b953dSPavel Machek
37186a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
37196a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
37201372cce2SMarian Balakowicz
3721ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3722ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3723ba1bee43SYing Zhang
3724ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3725ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3726ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3727ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3728ba1bee43SYing Zhang
372974752baaSScott Wood		CONFIG_SPL_PAD_TO
37306113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
37316113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
37326113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
37336113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
37346113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
373574752baaSScott Wood
3736ca2fca22SScott Wood		CONFIG_SPL_TARGET
3737ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3738ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3739ca2fca22SScott Wood		example if more than one image needs to be produced.
3740ca2fca22SScott Wood
374187ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
374287ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
374387ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
374487ebee39SSimon Glass		option to re-enable it. This will affect the output of the
374587ebee39SSimon Glass		bootm command when booting a FIT image.
374687ebee39SSimon Glass
37473aa29de0SYing Zhang- TPL framework
37483aa29de0SYing Zhang		CONFIG_TPL
37493aa29de0SYing Zhang		Enable building of TPL globally.
37503aa29de0SYing Zhang
37513aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
37523aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
37533aa29de0SYing Zhang		the TPL payload. By default, this is defined as
37543aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
37553aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
37563aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
37573aa29de0SYing Zhang
3758c609719bSwdenkModem Support:
3759c609719bSwdenk--------------
3760c609719bSwdenk
3761566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3762c609719bSwdenk
376311ccc33fSMarcel Ziswiler- Modem support enable:
3764c609719bSwdenk		CONFIG_MODEM_SUPPORT
3765c609719bSwdenk
3766c609719bSwdenk- RTS/CTS Flow control enable:
3767c609719bSwdenk		CONFIG_HWFLOW
3768c609719bSwdenk
3769c609719bSwdenk- Modem debug support:
3770c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3771c609719bSwdenk
3772c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3773c609719bSwdenk		for modem support. Useful only with BDI2000.
3774c609719bSwdenk
3775a8c7c708Swdenk- Interrupt support (PPC):
3776a8c7c708Swdenk
3777a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3778a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
377911ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3780a8c7c708Swdenk		should set decrementer_count to appropriate value. If
378111ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3782a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
378311ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3784a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3785a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3786a8c7c708Swdenk		general timer_interrupt().
3787a8c7c708Swdenk
3788c609719bSwdenk- General:
3789c609719bSwdenk
3790c609719bSwdenk		In the target system modem support is enabled when a
3791c609719bSwdenk		specific key (key combination) is pressed during
3792c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
379311ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3794c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3795c609719bSwdenk		function, returning 1 and thus enabling modem
3796c609719bSwdenk		initialization.
3797c609719bSwdenk
3798c609719bSwdenk		If there are no modem init strings in the
3799c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3800c609719bSwdenk		previous output (banner, info printfs) will be
380111ccc33fSMarcel Ziswiler		suppressed, though.
3802c609719bSwdenk
3803c609719bSwdenk		See also: doc/README.Modem
3804c609719bSwdenk
38059660e442SHelmut RaigerBoard initialization settings:
38069660e442SHelmut Raiger------------------------------
38079660e442SHelmut Raiger
38089660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
38099660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
38109660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
38119660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
38129660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
38139660e442SHelmut Raigertypically in board_init_f() and board_init_r().
38149660e442SHelmut Raiger
38159660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
38169660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
38179660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
38189660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3819c609719bSwdenk
3820c609719bSwdenkConfiguration Settings:
3821c609719bSwdenk-----------------------
3822c609719bSwdenk
38234d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
38244d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
38254d1fd7f1SYork Sun
38266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3827c609719bSwdenk		undefine this when you're short of memory.
3828c609719bSwdenk
38292fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
38302fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
38312fb2604dSPeter Tyser
38326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3833c609719bSwdenk		prompt for user input.
3834c609719bSwdenk
38356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3836c609719bSwdenk
38376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3838c609719bSwdenk
38396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3840c609719bSwdenk
38416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3842c609719bSwdenk		the application (usually a Linux kernel) when it is
3843c609719bSwdenk		booted
3844c609719bSwdenk
38456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3846c609719bSwdenk		List of legal baudrate settings for this board.
3847c609719bSwdenk
38486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3849c609719bSwdenk		Suppress display of console information at boot.
3850c609719bSwdenk
38516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3852c609719bSwdenk		If the board specific function
3853c609719bSwdenk			extern int overwrite_console (void);
3854c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3855c609719bSwdenk		serial port, else the settings in the environment are used.
3856c609719bSwdenk
38576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3858c609719bSwdenk		Enable the call to overwrite_console().
3859c609719bSwdenk
38606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3861c609719bSwdenk		Enable overwrite of previous console environment settings.
3862c609719bSwdenk
38636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3864c609719bSwdenk		Begin and End addresses of the area used by the
3865c609719bSwdenk		simple memory test.
3866c609719bSwdenk
38676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3868c609719bSwdenk		Enable an alternate, more extensive memory test.
3869c609719bSwdenk
38706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
38715f535fe1Swdenk		Scratch address used by the alternate memory test
38725f535fe1Swdenk		You only need to set this if address zero isn't writeable
38735f535fe1Swdenk
38746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
38756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
387614f73ca6SStefan Roese		this specified memory area will get subtracted from the top
387711ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
387814f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
387914f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
388014f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
38815e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
388214f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
38835e12e75dSStefan Roese		will have to get fixed in Linux additionally.
388414f73ca6SStefan Roese
388514f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
388614f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
388714f73ca6SStefan Roese		be touched.
388814f73ca6SStefan Roese
388914f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
389014f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
389114f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
389214f73ca6SStefan Roese		non page size aligned address and this could cause major
389314f73ca6SStefan Roese		problems.
389414f73ca6SStefan Roese
38956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3896c609719bSwdenk		Enable temporary baudrate change while serial download
3897c609719bSwdenk
38986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3899c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3900c609719bSwdenk
39016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3902c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3903c609719bSwdenk		Cogent motherboard)
3904c609719bSwdenk
39056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3906c609719bSwdenk		Physical start address of Flash memory.
3907c609719bSwdenk
39086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3909c609719bSwdenk		Physical start address of boot monitor code (set by
3910c609719bSwdenk		make config files to be same as the text base address
391114d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
39126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3913c609719bSwdenk
39146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
39153b57fe0aSwdenk		Size of memory reserved for monitor code, used to
39163b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
39173b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
39183b57fe0aSwdenk		flash sector.
3919c609719bSwdenk
39206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3921c609719bSwdenk		Size of DRAM reserved for malloc() use.
3922c609719bSwdenk
3923d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3924d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3925d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3926d59476b6SSimon Glass		will become available before relocation. The address is just
3927d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3928d59476b6SSimon Glass		space.
3929d59476b6SSimon Glass
3930d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3931d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3932d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3933b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
3934d59476b6SSimon Glass		U-Boot relocates itself.
3935d59476b6SSimon Glass
3936e7b14e9aSSimon Glass		Pre-relocation malloc() is only supported on ARM and sandbox
393729afe9e6SSimon Glass		at present but is fairly easy to enable for other archs.
393829afe9e6SSimon Glass
393938687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
394038687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
394138687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
394238687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
394338687ae6SSimon Glass
39441dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
39451dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
39461dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
39471dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
39481dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
39491dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
39501dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
39511dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
39521dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
39531dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
39541dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
39551dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
39561dfdd9baSThierry Reding		written to another region in the same cache-line. This can
39571dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
39581dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
39591dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
39601dfdd9baSThierry Reding
39611dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
39621dfdd9baSThierry Reding
39636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
396415940c9aSStefan Roese		Normally compressed uImages are limited to an
396515940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
39666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
396715940c9aSStefan Roese		to adjust this setting to your needs.
3968c609719bSwdenk
39696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3970c609719bSwdenk		Maximum size of memory mapped by the startup code of
3971c609719bSwdenk		the Linux kernel; all data that must be processed by
39727d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
39737d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
39741bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
39757d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3976c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3977c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3978c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3979c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3980c609719bSwdenk
3981fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3982fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3983fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3984fca43cc8SJohn Rigby		is enabled.
3985fca43cc8SJohn Rigby
3986fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3987fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3988fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3989fca43cc8SJohn Rigby
3990fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3991fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3992fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3993fca43cc8SJohn Rigby
39946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3995c609719bSwdenk		Max number of Flash memory banks
3996c609719bSwdenk
39976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3998c609719bSwdenk		Max number of sectors on a Flash chip
3999c609719bSwdenk
40006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
4001c609719bSwdenk		Timeout for Flash erase operations (in ms)
4002c609719bSwdenk
40036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
4004c609719bSwdenk		Timeout for Flash write operations (in ms)
4005c609719bSwdenk
40066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
40078564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
40088564acf9Swdenk
40096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
40108564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
40118564acf9Swdenk
40126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
40138564acf9Swdenk		If defined, hardware flash sectors protection is used
40148564acf9Swdenk		instead of U-Boot software protection.
40158564acf9Swdenk
40166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
4017c609719bSwdenk
4018c609719bSwdenk		Enable TFTP transfers directly to flash memory;
4019c609719bSwdenk		without this option such a download has to be
4020c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
4021c609719bSwdenk		copy from RAM to flash.
4022c609719bSwdenk
4023c609719bSwdenk		The two-step approach is usually more reliable, since
4024c609719bSwdenk		you can check if the download worked before you erase
402511ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
402611ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
4027c609719bSwdenk		downloaded image) this option may be very useful.
4028c609719bSwdenk
40296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
4030c609719bSwdenk		Define if the flash driver uses extra elements in the
40315653fc33Swdenk		common flash structure for storing flash geometry.
40325653fc33Swdenk
403300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
40345653fc33Swdenk		This option also enables the building of the cfi_flash driver
40355653fc33Swdenk		in the drivers directory
403653cf9435Sstroese
403791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
403891809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
403991809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
404091809ed5SPiotr Ziecik		to the MTD layer.
404191809ed5SPiotr Ziecik
40426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
404396ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
404496ef831fSGuennadi Liakhovetski
404596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
404696ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
404796ef831fSGuennadi Liakhovetski		write commands.
404896ef831fSGuennadi Liakhovetski
40496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
40505568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
40515568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
40525568e613SStefan Roese		is useful, if some of the configured banks are only
40535568e613SStefan Roese		optionally available.
40545568e613SStefan Roese
40559a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
40569a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
40579a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
40589a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
40599a042e9cSJerry Van Baren
4060352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
4061352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
4062352ef3f1SStefan Roese		against the source after the write operation. An error message
4063352ef3f1SStefan Roese		will be printed when the contents are not identical.
4064352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
4065352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
4066352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
4067352ef3f1SStefan Roese		this option if you really know what you are doing.
4068352ef3f1SStefan Roese
40696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
407011ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
407111ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
407253cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
407353cf9435Sstroese		buffers can be full shortly after enabling the interface
407411ccc33fSMarcel Ziswiler		on high Ethernet traffic.
407553cf9435Sstroese		Defaults to 4 if not defined.
4076c609719bSwdenk
4077ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
4078ea882bafSWolfgang Denk
4079ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
4080ea882bafSWolfgang Denk	internally to store the environment settings. The default
4081ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
4082ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
4083ea882bafSWolfgang Denk	lib/hashtable.c for details.
4084ea882bafSWolfgang Denk
40852598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
40862598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
40871bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
40882598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
40892598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
40902598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
40912598090bSJoe Hershberger
40922598090bSJoe Hershberger	The format of the list is:
40932598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
4094b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
4095b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
40962598090bSJoe Hershberger		entry = variable_name[:attributes]
40972598090bSJoe Hershberger		list = entry[,list]
40982598090bSJoe Hershberger
40992598090bSJoe Hershberger	The type attributes are:
41002598090bSJoe Hershberger		s - String (default)
41012598090bSJoe Hershberger		d - Decimal
41022598090bSJoe Hershberger		x - Hexadecimal
41032598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
41042598090bSJoe Hershberger		i - IP address
41052598090bSJoe Hershberger		m - MAC address
41062598090bSJoe Hershberger
4107267541f7SJoe Hershberger	The access attributes are:
4108267541f7SJoe Hershberger		a - Any (default)
4109267541f7SJoe Hershberger		r - Read-only
4110267541f7SJoe Hershberger		o - Write-once
4111267541f7SJoe Hershberger		c - Change-default
4112267541f7SJoe Hershberger
41132598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
41142598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
4115b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
41162598090bSJoe Hershberger
41172598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
41182598090bSJoe Hershberger		Define this to a list (string) to define validation that
41192598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
41202598090bSJoe Hershberger		environment variable.  To override a setting in the static
41212598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
41222598090bSJoe Hershberger		".flags" variable.
41232598090bSJoe Hershberger
4124bdf1fe4eSJoe Hershberger	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4125bdf1fe4eSJoe Hershberger	regular expression. This allows multiple variables to define the same
4126bdf1fe4eSJoe Hershberger	flags without explicitly listing them for each variable.
4127bdf1fe4eSJoe Hershberger
4128267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
4129267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
4130267541f7SJoe Hershberger	access flags.
4131267541f7SJoe Hershberger
41325c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
41335c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
41345c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
41355c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
41365c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
41375c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
41380a12e687SMasahiro Yamada	must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
41390a12e687SMasahiro Yamada	If you find problems enabling this option on your board please report
41400a12e687SMasahiro Yamada	the problem and send patches!
41415c1a7ea6SSimon Glass
41420b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
41430b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
41440b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
4145b445bbb4SJeremiah Mahler	the value can be calculated on a given board.
4146632efa74SSimon Glass
41470d296cc2SGabe Black- CONFIG_USE_STDINT
41480d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
41490d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
41500d296cc2SGabe Black	building U-Boot to enable this.
41510d296cc2SGabe Black
4152c609719bSwdenkThe following definitions that deal with the placement and management
4153c609719bSwdenkof environment data (variable area); in general, we support the
4154c609719bSwdenkfollowing configurations:
4155c609719bSwdenk
4156c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
4157c3eb3fe4SMike Frysinger
4158c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
4159c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
4160c3eb3fe4SMike Frysinger
41615a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
4162c609719bSwdenk
4163c609719bSwdenk	Define this if the environment is in flash memory.
4164c609719bSwdenk
4165c609719bSwdenk	a) The environment occupies one whole flash sector, which is
4166c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
4167c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
4168c609719bSwdenk	   sector" type flash chips, which have several smaller
4169c609719bSwdenk	   sectors at the start or the end. For instance, such a
4170c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4171c609719bSwdenk	   such a case you would place the environment in one of the
4172c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
4173c609719bSwdenk	   "top boot sector" type flash chips, you would put the
4174c609719bSwdenk	   environment in one of the last sectors, leaving a gap
4175c609719bSwdenk	   between U-Boot and the environment.
4176c609719bSwdenk
41770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4178c609719bSwdenk
4179c609719bSwdenk	   Offset of environment data (variable area) to the
4180c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
4181c609719bSwdenk	   type flash chips the second sector can be used: the offset
4182c609719bSwdenk	   for this sector is given here.
4183c609719bSwdenk
41846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4185c609719bSwdenk
41860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4187c609719bSwdenk
4188c609719bSwdenk	   This is just another way to specify the start address of
4189c609719bSwdenk	   the flash sector containing the environment (instead of
41900e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
4191c609719bSwdenk
41920e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
4193c609719bSwdenk
4194c609719bSwdenk	   Size of the sector containing the environment.
4195c609719bSwdenk
4196c609719bSwdenk
4197c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
4198c609719bSwdenk	   In such a case you don't want to spend a whole sector for
4199c609719bSwdenk	   the environment.
4200c609719bSwdenk
42010e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4202c609719bSwdenk
42035a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
42040e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4205c609719bSwdenk	   of this flash sector for the environment. This saves
4206c609719bSwdenk	   memory for the RAM copy of the environment.
4207c609719bSwdenk
4208c609719bSwdenk	   It may also save flash memory if you decide to use this
4209c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
4210c609719bSwdenk	   since then the remainder of the flash sector could be used
4211c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4212c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4213c609719bSwdenk	   updating the environment in flash makes it always
4214c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4215c609719bSwdenk	   wrong before the contents has been restored from a copy in
4216c609719bSwdenk	   RAM, your target system will be dead.
4217c609719bSwdenk
42180e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
42190e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4220c609719bSwdenk
4221c609719bSwdenk	   These settings describe a second storage area used to hold
422211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
42233e38691eSwdenk	   a valid backup copy in case there is a power failure during
4224c609719bSwdenk	   a "saveenv" operation.
4225c609719bSwdenk
4226c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4227c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4228c609719bSwdenkaccordingly!
4229c609719bSwdenk
4230c609719bSwdenk
42319314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4232c609719bSwdenk
4233c609719bSwdenk	Define this if you have some non-volatile memory device
4234c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4235c609719bSwdenk	environment.
4236c609719bSwdenk
42370e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
42380e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4239c609719bSwdenk
424011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4241c609719bSwdenk	  want to use for environment. It is assumed that this memory
4242c609719bSwdenk	  can just be read and written to, without any special
4243c609719bSwdenk	  provision.
4244c609719bSwdenk
4245c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4246b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
424711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4248c609719bSwdenkU-Boot will hang.
4249c609719bSwdenk
4250c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4251c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4252c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4253c609719bSwdenkto save the current settings.
4254c609719bSwdenk
4255c609719bSwdenk
4256bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4257c609719bSwdenk
4258c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4259c609719bSwdenk	device and a driver for it.
4260c609719bSwdenk
42610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
42620e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4263c609719bSwdenk
4264c609719bSwdenk	  These two #defines specify the offset and size of the
4265c609719bSwdenk	  environment area within the total memory of your EEPROM.
4266c609719bSwdenk
42676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4268c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4269c609719bSwdenk	  The default address is zero.
4270c609719bSwdenk
4271189d257bSChristian Gmeiner	- CONFIG_SYS_I2C_EEPROM_BUS:
4272189d257bSChristian Gmeiner	  If defined, specified the i2c bus of the EEPROM device.
4273189d257bSChristian Gmeiner
42746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4275c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4276c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4277c609719bSwdenk	  would require six bits.
4278c609719bSwdenk
42796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4280c609719bSwdenk	  If defined, the number of milliseconds to delay between
4281c609719bSwdenk	  page writes.	The default is zero milliseconds.
4282c609719bSwdenk
42836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4284c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4285c609719bSwdenk	  that this is NOT the chip address length!
4286c609719bSwdenk
42876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
42885cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
42895cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
42905cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
42915cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
42925cf91d6bSwdenk	  byte chips.
42935cf91d6bSwdenk
42945cf91d6bSwdenk	  Note that we consider the length of the address field to
42955cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
42965cf91d6bSwdenk	  in the chip address.
42975cf91d6bSwdenk
42986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4299c609719bSwdenk	  The size in bytes of the EEPROM device.
4300c609719bSwdenk
4301548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4302548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4303548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4304548738b4SHeiko Schocher
4305548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4306548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4307548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4308548738b4SHeiko Schocher	  EEPROM. For example:
4309548738b4SHeiko Schocher
4310ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4311548738b4SHeiko Schocher
4312548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4313548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4314c609719bSwdenk
4315057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
43165779d8d9Swdenk
43175779d8d9Swdenk	Define this if you have a DataFlash memory device which you
43185779d8d9Swdenk	want to use for the environment.
43195779d8d9Swdenk
43200e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
43210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
43220e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
43235779d8d9Swdenk
43245779d8d9Swdenk	  These three #defines specify the offset and size of the
43255779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
43265779d8d9Swdenk	  at the specified address.
43275779d8d9Swdenk
4328bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4329bd83b592SWu, Josh
4330bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4331bd83b592SWu, Josh	want to use for the environment.
4332bd83b592SWu, Josh
4333bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4334bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4335bd83b592SWu, Josh
4336bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4337bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4338bd83b592SWu, Josh	  aligned to an erase sector boundary.
4339bd83b592SWu, Josh
4340bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4341bd83b592SWu, Josh
4342bd83b592SWu, Josh	  Define the SPI flash's sector size.
4343bd83b592SWu, Josh
4344bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4345bd83b592SWu, Josh
4346bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4347bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4348bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
4349bd83b592SWu, Josh	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4350bd83b592SWu, Josh	  aligned to an erase sector boundary.
4351bd83b592SWu, Josh
4352bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4353bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4354bd83b592SWu, Josh
4355bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4356bd83b592SWu, Josh
4357bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4358bd83b592SWu, Josh
4359bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4360bd83b592SWu, Josh
4361bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4362bd83b592SWu, Josh
4363bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4364bd83b592SWu, Josh
43650a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
43660a85a9e7SLiu Gang
43670a85a9e7SLiu Gang	Define this if you have a remote memory space which you
43680a85a9e7SLiu Gang	want to use for the local device's environment.
43690a85a9e7SLiu Gang
43700a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
43710a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
43720a85a9e7SLiu Gang
43730a85a9e7SLiu Gang	  These two #defines specify the address and size of the
43740a85a9e7SLiu Gang	  environment area within the remote memory space. The
43750a85a9e7SLiu Gang	  local device can get the environment from remote memory
4376fc54c7faSLiu Gang	  space by SRIO or PCIE links.
43770a85a9e7SLiu Gang
43780a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
43790a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4380fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4381fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
43820a85a9e7SLiu Gang
438351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
438413a5695bSwdenk
438513a5695bSwdenk	Define this if you have a NAND device which you want to use
438613a5695bSwdenk	for the environment.
438713a5695bSwdenk
43880e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
43890e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
439013a5695bSwdenk
439113a5695bSwdenk	  These two #defines specify the offset and size of the environment
4392fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4393fdd813deSScott Wood	  aligned to an erase block boundary.
43945779d8d9Swdenk
4395fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4396e443c944SMarkus Klotzbuecher
43970e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4398fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4399fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4400fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4401fdd813deSScott Wood	  aligned to an erase block boundary.
4402e443c944SMarkus Klotzbuecher
4403fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4404fdd813deSScott Wood
4405fdd813deSScott Wood	  Specifies the length of the region in which the environment
4406fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4407fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4408fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4409fdd813deSScott Wood	  the range to be avoided.
4410fdd813deSScott Wood
4411fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4412fdd813deSScott Wood
4413fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4414fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4415fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4416fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4417fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4418e443c944SMarkus Klotzbuecher
4419b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4420b74ab737SGuennadi Liakhovetski
4421b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4422b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4423b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4424b74ab737SGuennadi Liakhovetski
44252b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
44262b74433fSJoe Hershberger
44272b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
44282b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
44292b74433fSJoe Hershberger	accesses, which is important on NAND.
44302b74433fSJoe Hershberger
44312b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
44322b74433fSJoe Hershberger
44332b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
44342b74433fSJoe Hershberger
44352b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
44362b74433fSJoe Hershberger
44372b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
44382b74433fSJoe Hershberger	  environment in.
44392b74433fSJoe Hershberger
4440785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4441785881f7SJoe Hershberger
4442785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4443785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4444785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4445785881f7SJoe Hershberger
44462b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
44472b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
44482b74433fSJoe Hershberger
44492b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
44502b74433fSJoe Hershberger	  when storing the env in UBI.
44512b74433fSJoe Hershberger
4452d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4453d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4454d1db76f1SWu, Josh
4455d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4456d1db76f1SWu, Josh
4457d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4458d1db76f1SWu, Josh
4459d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4460d1db76f1SWu, Josh
4461d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4462d1db76f1SWu, Josh         be as following:
4463d1db76f1SWu, Josh
4464d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4465d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4466d1db76f1SWu, Josh                        partition table.
4467d1db76f1SWu, Josh               - "D:0": device D.
4468d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4469d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4470d1db76f1SWu, Josh                              table.
4471d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4472b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
4473d1db76f1SWu, Josh                           partition table then means device D.
4474d1db76f1SWu, Josh
4475d1db76f1SWu, Josh       - FAT_ENV_FILE:
4476d1db76f1SWu, Josh
4477d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4478b445bbb4SJeremiah Mahler         environment.
4479d1db76f1SWu, Josh
4480d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4481b445bbb4SJeremiah Mahler         This should be defined. Otherwise it cannot save the environment file.
4482d1db76f1SWu, Josh
448306e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
448406e4ae5fSStephen Warren
448506e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
448606e4ae5fSStephen Warren	environment.
448706e4ae5fSStephen Warren
448806e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
448906e4ae5fSStephen Warren
449006e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
449106e4ae5fSStephen Warren
449206e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
449306e4ae5fSStephen Warren
449406e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
449506e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
449606e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
449706e4ae5fSStephen Warren
449806e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
449906e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
450006e4ae5fSStephen Warren
450106e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
450206e4ae5fSStephen Warren	  area within the specified MMC device.
450306e4ae5fSStephen Warren
45045c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
45055c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
45065c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
45075c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
45085c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
45095c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
45105c088ee8SStephen Warren	  maximum possible space before it, to store other data.
45115c088ee8SStephen Warren
451206e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
451306e4ae5fSStephen Warren	  MMC sector boundary.
451406e4ae5fSStephen Warren
451506e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
451606e4ae5fSStephen Warren
451706e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
451806e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
451906e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
452006e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
452106e4ae5fSStephen Warren
45225c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
45235c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
45245c088ee8SStephen Warren
452506e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
452606e4ae5fSStephen Warren	  an MMC sector boundary.
452706e4ae5fSStephen Warren
452806e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
452906e4ae5fSStephen Warren
453006e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
453106e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
453206e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
453306e4ae5fSStephen Warren
45346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4535c609719bSwdenk
4536c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4537c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4538c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4539c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4540c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4541c609719bSwdenk	to be a good choice since it makes it far enough from the
4542c609719bSwdenk	start of the data area as well as from the stack pointer.
4543c609719bSwdenk
4544e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4545c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4546cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4547c609719bSwdenkuntil then to read environment variables.
4548c609719bSwdenk
454985ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
455085ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
455185ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
455285ec0bccSwdenknecessary, because the first environment variable we need is the
455385ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
455485ec0bccSwdenkhave any device yet where we could complain.]
4555c609719bSwdenk
4556c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4557c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
455885ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4559c609719bSwdenk
45606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4561fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4562fc3e2165Swdenk
45636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4564fc3e2165Swdenk		      also needs to be defined.
4565fc3e2165Swdenk
45666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4567fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4568c609719bSwdenk
4569f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4570f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4571f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4572f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4573f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4574f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4575f5675aa5SRon Madrid
4576b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4577b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4578b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4579b2b92f53SSimon Glass		to do this.
4580b2b92f53SSimon Glass
4581e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4582e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4583e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4584e2e3e2b1SSimon Glass		present.
4585e2e3e2b1SSimon Glass
4586feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4587feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4588feb85801SSascha Silbe		build system checks that the actual size does not
4589feb85801SSascha Silbe		exceed it.
4590feb85801SSascha Silbe
4591c609719bSwdenkLow Level (hardware related) configuration options:
4592dc7c9a1aSwdenk---------------------------------------------------
4593c609719bSwdenk
45946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4595c609719bSwdenk		Cache Line Size of the CPU.
4596c609719bSwdenk
45976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4598c609719bSwdenk		Default address of the IMMR after system reset.
45992535d602Swdenk
46002535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
46012535d602Swdenk		and RPXsuper) to be able to adjust the position of
46022535d602Swdenk		the IMMR register after a reset.
4603c609719bSwdenk
4604e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4605e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4606e46fedfeSTimur Tabi		PowerPC SOCs.
4607e46fedfeSTimur Tabi
4608e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4609e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4610e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4611e46fedfeSTimur Tabi
4612e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4613e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4614e46fedfeSTimur Tabi
4615e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4616e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4617e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4618e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4619e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4620e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4621e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4622e46fedfeSTimur Tabi
4623e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4624e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4625e46fedfeSTimur Tabi
4626e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4627e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4628e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4629e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4630e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4631e46fedfeSTimur Tabi
4632e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4633e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4634e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4635e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4636e46fedfeSTimur Tabi
4637e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4638e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4639e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4640e46fedfeSTimur Tabi
46417f6c2cbcSwdenk- Floppy Disk Support:
46426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
46437f6c2cbcSwdenk
46447f6c2cbcSwdenk		the default drive number (default value 0)
46457f6c2cbcSwdenk
46466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
46477f6c2cbcSwdenk
464811ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
46497f6c2cbcSwdenk		(default value 1)
46507f6c2cbcSwdenk
46516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
46527f6c2cbcSwdenk
46537f6c2cbcSwdenk		defines the offset of register from address. It
46547f6c2cbcSwdenk		depends on which part of the data bus is connected to
465511ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
46567f6c2cbcSwdenk
46576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
46586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
46597f6c2cbcSwdenk		default value.
46607f6c2cbcSwdenk
46616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
46627f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
46637f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
4664b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
46657f6c2cbcSwdenk		initializations.
46667f6c2cbcSwdenk
46670abddf82SMacpaul Lin- CONFIG_IDE_AHB:
46680abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
46690abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
46700abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
46710abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
46720abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4673b445bbb4SJeremiah Mahler		is required.
46740abddf82SMacpaul Lin
46756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
467625d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
467725d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4678c609719bSwdenk
46796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4680c609719bSwdenk
46817152b1d0Swdenk		Start address of memory area that can be used for
4682c609719bSwdenk		initial data and stack; please note that this must be
4683c609719bSwdenk		writable memory that is working WITHOUT special
4684c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4685c609719bSwdenk		will become available only after programming the
4686c609719bSwdenk		memory controller and running certain initialization
4687c609719bSwdenk		sequences.
4688c609719bSwdenk
4689c609719bSwdenk		U-Boot uses the following memory types:
4690c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4691c609719bSwdenk		- MPC824X: data cache
4692c609719bSwdenk		- PPC4xx:  data cache
4693c609719bSwdenk
46946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4695c609719bSwdenk
4696c609719bSwdenk		Offset of the initial data structure in the memory
46976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
46986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4699c609719bSwdenk		data is located at the end of the available space
4700553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
47016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
47026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
47036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4704c609719bSwdenk
4705c609719bSwdenk	Note:
4706c609719bSwdenk		On the MPC824X (or other systems that use the data
4707c609719bSwdenk		cache for initial memory) the address chosen for
47086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4709c609719bSwdenk		point to an otherwise UNUSED address space between
4710c609719bSwdenk		the top of RAM and the start of the PCI space.
4711c609719bSwdenk
47126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4713c609719bSwdenk
47146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4715c609719bSwdenk
47166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4717c609719bSwdenk
47186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4719c609719bSwdenk
47206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4721c609719bSwdenk
47226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4723c609719bSwdenk
47246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4725c609719bSwdenk		SDRAM timing
4726c609719bSwdenk
47276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4728c609719bSwdenk		periodic timer for refresh
4729c609719bSwdenk
47306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4731c609719bSwdenk
47326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
47336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
47346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
47356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4736c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4737c609719bSwdenk
4738c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
47396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
47406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4741c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4742c609719bSwdenk
47436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
47446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4745c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4746c609719bSwdenk		Prescaler definitions (SDRAM timing)
4747c609719bSwdenk
47486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4749c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4750c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4751c609719bSwdenk
47526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4753b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4754b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4755b423d055SHeiko Schocher
47566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4757c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4758c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4759c609719bSwdenk
47606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4761c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4762c609719bSwdenk		wrong setting might damage your board. Read
4763c609719bSwdenk		doc/README.MBX before setting this variable!
4764c609719bSwdenk
47656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4766ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4767ea909b76Swdenk		(Power On Self Tests). This definition overrides
4768ea909b76Swdenk		#define'd default value in commproc.h resp.
4769ea909b76Swdenk		cpm_8260.h.
4770ea909b76Swdenk
47716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
47726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
47736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
47746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
47756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
47766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
47776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
47786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4779a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
47805d232d0eSwdenk
47819cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
47829cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
47839cacf4fcSDirk Eibach		required.
47849cacf4fcSDirk Eibach
478569fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4786b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
478769fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
478869fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
478969fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
479069fd2d3bSAndrew Sharp		by coreboot or similar.
479169fd2d3bSAndrew Sharp
4792842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4793842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4794842033e6SGabor Juhos
4795a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4796a09b9b68SKumar Gala		Chip has SRIO or not
4797a09b9b68SKumar Gala
4798a09b9b68SKumar Gala- CONFIG_SRIO1:
4799a09b9b68SKumar Gala		Board has SRIO 1 port available
4800a09b9b68SKumar Gala
4801a09b9b68SKumar Gala- CONFIG_SRIO2:
4802a09b9b68SKumar Gala		Board has SRIO 2 port available
4803a09b9b68SKumar Gala
4804c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4805c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4806c8b28152SLiu Gang
4807a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4808a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4809a09b9b68SKumar Gala
4810a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4811a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4812a09b9b68SKumar Gala
4813a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4814a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4815a09b9b68SKumar Gala
481666bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
481766bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
481866bd1846SFabio Estevam		a 16 bit bus.
481966bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4820a430e916SFabio Estevam		Example of drivers that use it:
482166bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4822a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4823eced4626SAlex Waterman
4824eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4825eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4826eced4626SAlex Waterman		a default value will be used.
4827eced4626SAlex Waterman
4828bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4829218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4830218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4831218ca724SWolfgang Denk
4832bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4833bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4834bb99ad6dSBen Warren
48356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4836218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4837218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4838218ca724SWolfgang Denk		to something your driver can deal with.
4839bb99ad6dSBen Warren
48401b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
48411b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
48421b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
48431b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
48441b3e3c4fSYork Sun		header files or board specific files.
48451b3e3c4fSYork Sun
48466f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
48476f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
48486f5e1dc5SYork Sun
4849e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
4850e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
4851e32d59a2SYork Sun
48524516ff81SYork Sun- CONFIG_FSL_DDR_BIST
48534516ff81SYork Sun		Enable built-in memory test for Freescale DDR controllers.
48544516ff81SYork Sun
48556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4856218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4857218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
48582ad6b513STimur Tabi
4859c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4860c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4861c26e454dSwdenk
4862c26e454dSwdenk- CONFIG_FEC[12]_PHY
4863c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
48646e592385Swdenk		to the given FEC; i. e.
4865c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4866c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4867c26e454dSwdenk
4868c26e454dSwdenk		When set to -1, means to probe for first available.
4869c26e454dSwdenk
4870c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4871c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4872c26e454dSwdenk		(so program the FEC to ignore it).
4873c26e454dSwdenk
4874c26e454dSwdenk- CONFIG_RMII
4875c26e454dSwdenk		Enable RMII mode for all FECs.
4876c26e454dSwdenk		Note that this is a global option, we can't
4877c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4878c26e454dSwdenk
48795cf91d6bSwdenk- CONFIG_CRC32_VERIFY
48805cf91d6bSwdenk		Add a verify option to the crc32 command.
48815cf91d6bSwdenk		The syntax is:
48825cf91d6bSwdenk
48835cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
48845cf91d6bSwdenk
48855cf91d6bSwdenk		Where address/count indicate a memory area
48865cf91d6bSwdenk		and crc32 is the correct crc32 which the
48875cf91d6bSwdenk		area should have.
48885cf91d6bSwdenk
488956523f12Swdenk- CONFIG_LOOPW
489056523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4891602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
489256523f12Swdenk
48937b466641Sstroese- CONFIG_MX_CYCLIC
48947b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
48957b466641Sstroese		"md/mw" commands.
48967b466641Sstroese		Examples:
48977b466641Sstroese
48987b466641Sstroese		=> mdc.b 10 4 500
48997b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
49007b466641Sstroese
49017b466641Sstroese		=> mwc.l 100 12345678 10
49027b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
49037b466641Sstroese
49047b466641Sstroese		This only takes effect if the memory commands are activated
4905602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
49067b466641Sstroese
49078aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4908afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4909e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4910e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4911e03f3169SWolfgang Denk		relocate itself into RAM.
49128aa1a2d1Swdenk
4913e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4914e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4915e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4916e03f3169SWolfgang Denk		these initializations itself.
49178aa1a2d1Swdenk
4918401bb30bSAneesh V- CONFIG_SPL_BUILD
4919df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4920df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4921df81238bSMagnus Lilja		compiling a NAND SPL.
4922400558b5Swdenk
49233aa29de0SYing Zhang- CONFIG_TPL_BUILD
49243aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
49253aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
49263aa29de0SYing Zhang		It is loaded by the SPL.
49273aa29de0SYing Zhang
49285df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
49295df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
49305df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
49315df572f0SYing Zhang		previous 4k of the .text section.
49325df572f0SYing Zhang
49334213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
49344213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
49354213fc29SSimon Glass		effective address. It is therefore not necessary to regard
49364213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
49374213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
49384213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
49394213fc29SSimon Glass		addressable memory. This option causes some memory accesses
49404213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
49414213fc29SSimon Glass
4942d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4943d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4944d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4945d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4946d8834a13SMatthias Weisser		conditions but may increase the binary size.
4947d8834a13SMatthias Weisser
4948588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4949588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4950588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4951b16f521aSGabe Black
4952fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4953fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4954fc33705eSMark Jackson
4955fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
49565b5ece9eSGabe Black
495716678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
495816678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
495916678eb4SHeiko Schocher
4960999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4961999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4962999d7d32SKaricheri, Muralidharan		driver that uses this:
4963999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4964999d7d32SKaricheri, Muralidharan
4965f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4966f2717b47STimur Tabi-----------------------------------
4967f2717b47STimur Tabi
4968f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4969f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4970f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4971f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4972f2717b47STimur Tabiwithin that device.
4973f2717b47STimur Tabi
4974dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4975dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4976dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4977dcf1d774SZhao Qiang	is also specified.
4978dcf1d774SZhao Qiang
4979dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4980dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4981f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4982f2717b47STimur Tabi	is also specified.
4983f2717b47STimur Tabi
4984f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4985f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4986f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4987f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4988f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4989f2717b47STimur Tabi
4990f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4991f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4992f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4993f2717b47STimur Tabi	virtual address in NOR flash.
4994f2717b47STimur Tabi
4995f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4996f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4997f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4998f2717b47STimur Tabi
4999f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5000f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
5001f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5002f2717b47STimur Tabi
5003f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5004f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
5005f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5006f2717b47STimur Tabi
5007292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5008292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
5009292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
5010fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5011fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
5012fc54c7faSLiu Gang	master's memory space.
5013f2717b47STimur Tabi
5014b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
5015b940ca64SJ. German Rivera---------------------------------------------------------
5016b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
5017b940ca64SJ. German Rivera"firmware".
5018b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
5019b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
5020b940ca64SJ. German Riverawithin that device.
5021b940ca64SJ. German Rivera
5022b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
5023b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
5024b940ca64SJ. German Rivera
5025b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR
5026b940ca64SJ. German Rivera	The address in the storage device where the firmware is located.  The
5027b940ca64SJ. German Rivera	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5028b940ca64SJ. German Rivera	is also specified.
5029b940ca64SJ. German Rivera
5030b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH
5031b940ca64SJ. German Rivera	The maximum possible size of the firmware.  The firmware binary format
5032b940ca64SJ. German Rivera	has a field that specifies the actual size of the firmware, but it
5033b940ca64SJ. German Rivera	might not be possible to read any part of the firmware unless some
5034b940ca64SJ. German Rivera	local storage is allocated to hold the entire firmware first.
5035b940ca64SJ. German Rivera
5036b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR
5037b940ca64SJ. German Rivera	Specifies that MC firmware is located in NOR flash, mapped as
5038b940ca64SJ. German Rivera	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5039b940ca64SJ. German Rivera	virtual address in NOR flash.
5040b940ca64SJ. German Rivera
50415c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support:
50425c055089SPrabhakar Kushwaha-------------------------------------------
50435c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of
50445c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom.
50455c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting.
50465c055089SPrabhakar Kushwaha
50475c055089SPrabhakar Kushwaha- CONFIG_FSL_DEBUG_SERVER
50485c055089SPrabhakar Kushwaha	Enable the Debug Server for Layerscape SoCs.
50495c055089SPrabhakar Kushwaha
50505c055089SPrabhakar Kushwaha- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
50515c055089SPrabhakar Kushwaha	Define minimum DDR size required for debug server image
50525c055089SPrabhakar Kushwaha
50535c055089SPrabhakar Kushwaha- CONFIG_SYS_MEM_TOP_HIDE_MIN
50545c055089SPrabhakar Kushwaha	Define minimum DDR size to be hided from top of the DDR memory
50555c055089SPrabhakar Kushwaha
5056f3f431a7SPaul KocialkowskiReproducible builds
5057f3f431a7SPaul Kocialkowski-------------------
5058f3f431a7SPaul Kocialkowski
5059f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build
5060f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value.
5061f3f431a7SPaul Kocialkowski
5062f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable.
5063f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
5064f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot.
5065f3f431a7SPaul Kocialkowski
5066f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
5067f3f431a7SPaul Kocialkowski
5068c609719bSwdenkBuilding the Software:
5069c609719bSwdenk======================
5070c609719bSwdenk
5071218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
5072218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
5073218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
5074218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
5075218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5076218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
5077c609719bSwdenk
5078218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
5079218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
5080218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
5081218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
5082218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
5083c609719bSwdenk
5084218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
5085218ca724SWolfgang Denk	$ export CROSS_COMPILE
5086c609719bSwdenk
50872f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
50882f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
50892f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
50902f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
50912f8d396bSPeter Tyser
50922f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
50932f8d396bSPeter Tyser
50942f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
50952f8d396bSPeter Tyser      be executed on computers running Windows.
50962f8d396bSPeter Tyser
5097c609719bSwdenkU-Boot is intended to be simple to build. After installing the
5098c609719bSwdenksources you must configure U-Boot for one specific board type. This
5099c609719bSwdenkis done by typing:
5100c609719bSwdenk
5101ab584d67SHolger Freyther	make NAME_defconfig
5102c609719bSwdenk
5103ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
51044d675ae6SMichael Jonesrations; see boards.cfg for supported names.
510554387ac9Swdenk
5106c609719bSwdenkNote: for some board special configuration names may exist; check if
5107c609719bSwdenk      additional information is available from the board vendor; for
51082729af9dSwdenk      instance, the TQM823L systems are available without (standard)
51092729af9dSwdenk      or with LCD support. You can select such additional "features"
511011ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
5111c609719bSwdenk
5112ab584d67SHolger Freyther      make TQM823L_defconfig
51132729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
5114c609719bSwdenk
5115ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
5116c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
5117c609719bSwdenk
5118c609719bSwdenk      etc.
5119c609719bSwdenk
5120c609719bSwdenk
5121c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
51227152b1d0Swdenkimages ready for download to / installation on your system:
5123c609719bSwdenk
5124c609719bSwdenk- "u-boot.bin" is a raw binary image
5125c609719bSwdenk- "u-boot" is an image in ELF binary format
5126c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
5127c609719bSwdenk
5128baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
5129baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
5130baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
5131baf31249SMarian Balakowicz
5132baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
5133baf31249SMarian Balakowicz
5134baf31249SMarian Balakowicz	make O=/tmp/build distclean
5135ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
5136baf31249SMarian Balakowicz	make O=/tmp/build all
5137baf31249SMarian Balakowicz
5138adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
5139baf31249SMarian Balakowicz
5140adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
5141baf31249SMarian Balakowicz	make distclean
5142ab584d67SHolger Freyther	make NAME_defconfig
5143baf31249SMarian Balakowicz	make all
5144baf31249SMarian Balakowicz
5145adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
5146baf31249SMarian Balakowiczvariable.
5147baf31249SMarian Balakowicz
5148c609719bSwdenk
5149c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
5150c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
5151c609719bSwdenknative "make".
5152c609719bSwdenk
5153c609719bSwdenk
5154c609719bSwdenkIf the system board that you have is not listed, then you will need
5155c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
5156c609719bSwdenksteps:
5157c609719bSwdenk
5158c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
51594d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
51604d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
5161c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
516285ec0bccSwdenk    files you need. In your board directory, you will need at least
516385ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
516485ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
516585ec0bccSwdenk    your board
5166c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
5167c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
5168ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
5169c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
5170c609719bSwdenk    to be installed on your target system.
517185ec0bccSwdenk6.  Debug and solve any problems that might arise.
5172c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
5173c609719bSwdenk
5174c609719bSwdenk
5175c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
5176c609719bSwdenk==============================================================
5177c609719bSwdenk
5178c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
5179c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
5180c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
5181c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
5182218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
5183c609719bSwdenk
5184c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
5185c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
5186c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
5187c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
5188c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
51897152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
5190218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
5191218ca724SWolfgang Denkyou can type
5192c609719bSwdenk
5193c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
5194c609719bSwdenk
5195c609719bSwdenkor to build on a native PowerPC system you can type
5196c609719bSwdenk
5197c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
5198c609719bSwdenk
5199218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
5200218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
5201218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
5202218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
5203218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
5204218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
5205218ca724SWolfgang Denkvariable. For example:
5206baf31249SMarian Balakowicz
5207baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
5208baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
5209baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
5210baf31249SMarian Balakowicz
5211218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
5212218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
5213218ca724SWolfgang Denkduring the whole build process.
5214baf31249SMarian Balakowicz
5215baf31249SMarian Balakowicz
5216c609719bSwdenkSee also "U-Boot Porting Guide" below.
5217c609719bSwdenk
5218c609719bSwdenk
5219c609719bSwdenkMonitor Commands - Overview:
5220c609719bSwdenk============================
5221c609719bSwdenk
5222c609719bSwdenkgo	- start application at address 'addr'
5223c609719bSwdenkrun	- run commands in an environment variable
5224c609719bSwdenkbootm	- boot application image from memory
5225c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
522644f074c7SMarek Vasutbootz   - boot zImage from memory
5227c609719bSwdenktftpboot- boot image via network using TFTP protocol
5228c609719bSwdenk	       and env variables "ipaddr" and "serverip"
5229c609719bSwdenk	       (and eventually "gatewayip")
52301fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
5231c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
5232c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5233c609719bSwdenkloads	- load S-Record file over serial line
5234c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
5235c609719bSwdenkmd	- memory display
5236c609719bSwdenkmm	- memory modify (auto-incrementing)
5237c609719bSwdenknm	- memory modify (constant address)
5238c609719bSwdenkmw	- memory write (fill)
5239c609719bSwdenkcp	- memory copy
5240c609719bSwdenkcmp	- memory compare
5241c609719bSwdenkcrc32	- checksum calculation
52420f89c54bSPeter Tyseri2c	- I2C sub-system
5243c609719bSwdenksspi	- SPI utility commands
5244c609719bSwdenkbase	- print or set address offset
5245c609719bSwdenkprintenv- print environment variables
5246c609719bSwdenksetenv	- set environment variables
5247c609719bSwdenksaveenv - save environment variables to persistent storage
5248c609719bSwdenkprotect - enable or disable FLASH write protection
5249c609719bSwdenkerase	- erase FLASH memory
5250c609719bSwdenkflinfo	- print FLASH memory information
525110635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
5252c609719bSwdenkbdinfo	- print Board Info structure
5253c609719bSwdenkiminfo	- print header information for application image
5254c609719bSwdenkconinfo - print console devices and informations
5255c609719bSwdenkide	- IDE sub-system
5256c609719bSwdenkloop	- infinite loop on address range
525756523f12Swdenkloopw	- infinite write loop on address range
5258c609719bSwdenkmtest	- simple RAM test
5259c609719bSwdenkicache	- enable or disable instruction cache
5260c609719bSwdenkdcache	- enable or disable data cache
5261c609719bSwdenkreset	- Perform RESET of the CPU
5262c609719bSwdenkecho	- echo args to console
5263c609719bSwdenkversion - print monitor version
5264c609719bSwdenkhelp	- print online help
5265c609719bSwdenk?	- alias for 'help'
5266c609719bSwdenk
5267c609719bSwdenk
5268c609719bSwdenkMonitor Commands - Detailed Description:
5269c609719bSwdenk========================================
5270c609719bSwdenk
5271c609719bSwdenkTODO.
5272c609719bSwdenk
5273c609719bSwdenkFor now: just type "help <command>".
5274c609719bSwdenk
5275c609719bSwdenk
5276c609719bSwdenkEnvironment Variables:
5277c609719bSwdenk======================
5278c609719bSwdenk
5279c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5280c609719bSwdenkcan be made persistent by saving to Flash memory.
5281c609719bSwdenk
5282c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5283c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5284c609719bSwdenkwithout a value can be used to delete a variable from the
5285c609719bSwdenkenvironment. As long as you don't save the environment you are
5286c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5287c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5288c609719bSwdenk
5289c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5290c96f86eeSWolfgang Denk
5291c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5292c609719bSwdenk
5293c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5294c609719bSwdenk
5295c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5296c609719bSwdenk
5297c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5298c609719bSwdenk
5299c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5300c609719bSwdenk
5301c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5302c609719bSwdenk
53037d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
53047d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
53057d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
53067d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
53077d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
53087d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5309c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5310c3624e6eSGrant Likely		  bootm_mapsize.
5311c3624e6eSGrant Likely
5312c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5313c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5314c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5315c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5316c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5317c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5318c3624e6eSGrant Likely		  used otherwise.
53197d721e34SBartlomiej Sieka
53207d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
53217d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
53227d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
53237d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
53247d721e34SBartlomiej Sieka		  environment variable.
53257d721e34SBartlomiej Sieka
53264bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
53274bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
53284bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
53294bae9090SBartlomiej Sieka
5330c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5331c609719bSwdenk		  "bootp" will just load perform a lookup of the
5332c609719bSwdenk		  configuration from the BOOTP server, but not try to
5333c609719bSwdenk		  load any image using TFTP
5334c609719bSwdenk
5335c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5336c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5337c609719bSwdenk		  be automatically started (by internally calling
5338c609719bSwdenk		  "bootm")
5339c609719bSwdenk
53404a6fd34bSwdenk		  If set to "no", a standalone image passed to the
53414a6fd34bSwdenk		  "bootm" command will be copied to the load address
53424a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
53434a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
53444a6fd34bSwdenk		  data.
53454a6fd34bSwdenk
5346a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5347a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5348fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5349fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5350fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5351fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5352fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5353fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5354fa34f6b2SShawn Guo		  access it during the boot procedure.
5355fa34f6b2SShawn Guo
5356a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5357a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5358a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5359a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5360a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5361a28afca5SDavid A. Long		  must be accessible by the kernel.
5362a28afca5SDavid A. Long
5363eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5364eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5365eea63e05SSimon Glass		  defined.
5366eea63e05SSimon Glass
536717ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
536817ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
536917ea1177Swdenk		  mode (400kHZ). This environment variable is used in
537017ea1177Swdenk		  initialization code. So, for changes to be effective
537117ea1177Swdenk		  it must be saved and board must be reset.
537217ea1177Swdenk
5373c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5374c609719bSwdenk		  If this variable is not set, initrd images will be
5375c609719bSwdenk		  copied to the highest possible address in RAM; this
5376c609719bSwdenk		  is usually what you want since it allows for
5377c609719bSwdenk		  maximum initrd size. If for some reason you want to
5378c609719bSwdenk		  make sure that the initrd image is loaded below the
53796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5380c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5381c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5382c609719bSwdenk		  address to use (U-Boot will still check that it
5383c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5384c609719bSwdenk
5385c609719bSwdenk		  For instance, when you have a system with 16 MB
53867152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5387c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5388c609719bSwdenk		  the "bootargs" variable. However, now you must make
53897152b1d0Swdenk		  sure that the initrd image is placed in the first
5390c609719bSwdenk		  12 MB as well - this can be done with
5391c609719bSwdenk
5392c609719bSwdenk		  setenv initrd_high 00c00000
5393c609719bSwdenk
539438b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
539538b99261Swdenk		  indication to U-Boot that all addresses are legal
539638b99261Swdenk		  for the Linux kernel, including addresses in flash
539738b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
539838b99261Swdenk		  ramdisk at all. This may be useful to reduce the
539938b99261Swdenk		  boot time on your system, but requires that this
540038b99261Swdenk		  feature is supported by your Linux kernel.
540138b99261Swdenk
5402c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5403c609719bSwdenk
5404c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5405dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5406c609719bSwdenk
5407c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5408c609719bSwdenk
5409c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5410c609719bSwdenk
5411c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5412c609719bSwdenk
5413c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5414c609719bSwdenk
5415c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5416c609719bSwdenk
5417e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5418a3d991bdSwdenk
5419e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5420e2a53458SMike Frysinger		  For example you can do the following
5421a3d991bdSwdenk
542248690d80SHeiko Schocher		  => setenv ethact FEC
542348690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
542448690d80SHeiko Schocher		  => setenv ethact SCC
542548690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5426a3d991bdSwdenk
5427e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5428e1692577SMatthias Fuchs		  available network interfaces.
5429e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5430e1692577SMatthias Fuchs
5431a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5432a3d991bdSwdenk		  either succeed or fail without retrying.
54336e592385Swdenk		  When set to "once" the network operation will
54346e592385Swdenk		  fail when all the available network interfaces
54356e592385Swdenk		  are tried once without success.
5436a3d991bdSwdenk		  Useful on scripts which control the retry operation
5437a3d991bdSwdenk		  themselves.
5438a3d991bdSwdenk
5439b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5440a1cf027aSJean-Christophe PLAGNIOL-VILLARD
5441b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
54428d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
54438d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
54448d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
54458d51aacdSSimon Glass		  is silent.
54468d51aacdSSimon Glass
5447f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpsrcp	- If this is set, the value is used for TFTP's
5448ecb0ccd9SWolfgang Denk		  UDP source port.
5449ecb0ccd9SWolfgang Denk
5450f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpdstp	- If this is set, the value is used for TFTP's UDP
545128cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
545228cb9375SWolfgang Denk
5453c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5454c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5455c96f86eeSWolfgang Denk
5456c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5457c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5458c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5459c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5460c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5461c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5462c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5463c96f86eeSWolfgang Denk
5464f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
5465f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unit, minimum value = 0). Defines how many timeouts
5466f5fb7346SAlbert ARIBAUD \(3ADEV\)		  can happen during a single file transfer before that
5467f5fb7346SAlbert ARIBAUD \(3ADEV\)		  transfer is aborted. The default is 10, and 0 means
5468f5fb7346SAlbert ARIBAUD \(3ADEV\)		  'no timeouts allowed'. Increasing this value may help
5469f5fb7346SAlbert ARIBAUD \(3ADEV\)		  downloads succeed with high packet loss rates, or with
5470f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unreliable TFTP servers or client hardware.
5471f5fb7346SAlbert ARIBAUD \(3ADEV\)
5472a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
547311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5474a3d991bdSwdenk		  VLAN tagged frames.
5475c609719bSwdenk
5476dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5477dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5478dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5479dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5480dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5481dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5482dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5483dc0b7b0eSJason Hobbs
5484dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5485aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some
5486dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5487dc0b7b0eSJason Hobbs
5488dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5489dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5490dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5491dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5492dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5493dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5494dc0b7b0eSJason Hobbs
5495c609719bSwdenkThe following environment variables may be used and automatically
5496c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5497c609719bSwdenkdepending the information provided by your boot server:
5498c609719bSwdenk
5499c609719bSwdenk  bootfile	- see above
5500c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5501fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5502c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5503c609719bSwdenk  hostname	- Target hostname
5504c609719bSwdenk  ipaddr	- see above
5505c609719bSwdenk  netmask	- Subnet Mask
5506c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5507c609719bSwdenk  serverip	- see above
5508c609719bSwdenk
5509c609719bSwdenk
5510c609719bSwdenkThere are two special Environment Variables:
5511c609719bSwdenk
5512c609719bSwdenk  serial#	- contains hardware identification information such
5513c609719bSwdenk		  as type string and/or serial number
5514c609719bSwdenk  ethaddr	- Ethernet address
5515c609719bSwdenk
5516c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5517c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5518c609719bSwdenkonce they have been set once.
5519c609719bSwdenk
5520c609719bSwdenk
5521c1551ea8SstroeseFurther special Environment Variables:
5522c1551ea8Sstroese
5523c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5524c1551ea8Sstroese		  with the "version" command. This variable is
5525c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5526c1551ea8Sstroese
5527c1551ea8Sstroese
5528c609719bSwdenkPlease note that changes to some configuration parameters may take
5529c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5530c609719bSwdenk
5531c609719bSwdenk
5532170ab110SJoe HershbergerCallback functions for environment variables:
5533170ab110SJoe Hershberger---------------------------------------------
5534170ab110SJoe Hershberger
5535170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5536b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
5537170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5538170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5539170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5540170ab110SJoe Hershberger
5541170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5542170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5543170ab110SJoe Hershberger
5544170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5545170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5546170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5547170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5548170ab110SJoe Hershberger
5549170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5550170ab110SJoe Hershberger	list = entry[,list]
5551170ab110SJoe Hershberger
5552170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5553170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5554170ab110SJoe Hershberger
5555170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5556170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5557170ab110SJoe Hershbergeroverride any association in the static list. You can define
5558170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5559b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
5560170ab110SJoe Hershberger
5561bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a
5562bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to
5563bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out.
5564bdf1fe4eSJoe Hershberger
5565170ab110SJoe Hershberger
5566f07771ccSwdenkCommand Line Parsing:
5567f07771ccSwdenk=====================
5568f07771ccSwdenk
5569f07771ccSwdenkThere are two different command line parsers available with U-Boot:
55707152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5571f07771ccSwdenk
5572f07771ccSwdenkOld, simple command line parser:
5573f07771ccSwdenk--------------------------------
5574f07771ccSwdenk
5575f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5576f07771ccSwdenk- several commands on one line, separated by ';'
5577fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5578f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5579f07771ccSwdenk  for example:
5580fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5581f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5582f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5583f07771ccSwdenk
5584f07771ccSwdenkHush shell:
5585f07771ccSwdenk-----------
5586f07771ccSwdenk
5587f07771ccSwdenk- similar to Bourne shell, with control structures like
5588f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5589f07771ccSwdenk  until...do...done, ...
5590f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5591f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5592f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5593f07771ccSwdenk  command
5594f07771ccSwdenk
5595f07771ccSwdenkGeneral rules:
5596f07771ccSwdenk--------------
5597f07771ccSwdenk
5598f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5599f07771ccSwdenk    command) contains several commands separated by semicolon, and
5600f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5601f07771ccSwdenk    executed anyway.
5602f07771ccSwdenk
5603f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
560411ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5605f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5606f07771ccSwdenk    variables are not executed.
5607f07771ccSwdenk
5608c609719bSwdenkNote for Redundant Ethernet Interfaces:
5609c609719bSwdenk=======================================
5610c609719bSwdenk
561111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5612c609719bSwdenksuch configurations and is capable of automatic selection of a
56137152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5614c609719bSwdenk
5615c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5616c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5617c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5618c609719bSwdenk
5619c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5620c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5621c609719bSwdenkding setting in the environment; if the corresponding environment
5622c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5623c609719bSwdenk
5624c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5625c609719bSwdenk  environment, the SROM's address is used.
5626c609719bSwdenk
5627c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5628c609719bSwdenk  environment exists, then the value from the environment variable is
5629c609719bSwdenk  used.
5630c609719bSwdenk
5631c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5632c609719bSwdenk  both addresses are the same, this MAC address is used.
5633c609719bSwdenk
5634c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5635c609719bSwdenk  addresses differ, the value from the environment is used and a
5636c609719bSwdenk  warning is printed.
5637c609719bSwdenk
5638c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5639bef1014bSJoe Hershberger  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5640bef1014bSJoe Hershberger  a random, locally-assigned MAC is used.
5641c609719bSwdenk
5642ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5643ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5644ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5645ecee9324SBen WarrenThe naming convention is as follows:
5646ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5647c609719bSwdenk
5648c609719bSwdenkImage Formats:
5649c609719bSwdenk==============
5650c609719bSwdenk
56513310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
56523310c549SMarian Balakowiczimages in two formats:
56533310c549SMarian Balakowicz
56543310c549SMarian BalakowiczNew uImage format (FIT)
56553310c549SMarian Balakowicz-----------------------
56563310c549SMarian Balakowicz
56573310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
56583310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
56593310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
56603310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
56613310c549SMarian Balakowicz
56623310c549SMarian Balakowicz
56633310c549SMarian BalakowiczOld uImage format
56643310c549SMarian Balakowicz-----------------
56653310c549SMarian Balakowicz
56663310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
56673310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
56683310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5669c609719bSwdenk
5670c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5671c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5672f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5673f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5674f5ed9e39SPeter Tyser  INTEGRITY).
56757b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5676afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5677afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5678c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5679c609719bSwdenk* Load Address
5680c609719bSwdenk* Entry Point
5681c609719bSwdenk* Image Name
5682c609719bSwdenk* Image Timestamp
5683c609719bSwdenk
5684c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5685c609719bSwdenkand the data portions of the image are secured against corruption by
5686c609719bSwdenkCRC32 checksums.
5687c609719bSwdenk
5688c609719bSwdenk
5689c609719bSwdenkLinux Support:
5690c609719bSwdenk==============
5691c609719bSwdenk
5692c609719bSwdenkAlthough U-Boot should support any OS or standalone application
56937152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5694c609719bSwdenkU-Boot.
5695c609719bSwdenk
5696c609719bSwdenkU-Boot includes many features that so far have been part of some
5697c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5698c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5699c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
57007152b1d0Swdenkserves several purposes:
5701c609719bSwdenk
5702c609719bSwdenk- the same features can be used for other OS or standalone
5703c609719bSwdenk  applications (for instance: using compressed images to reduce the
5704c609719bSwdenk  Flash memory footprint)
5705c609719bSwdenk
5706c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
57077152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5708c609719bSwdenk
5709c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5710c609719bSwdenk  images; of course this also means that different kernel images can
5711c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5712c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5713c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5714c609719bSwdenk  software is easier now.
5715c609719bSwdenk
5716c609719bSwdenk
5717c609719bSwdenkLinux HOWTO:
5718c609719bSwdenk============
5719c609719bSwdenk
5720c609719bSwdenkPorting Linux to U-Boot based systems:
5721c609719bSwdenk---------------------------------------
5722c609719bSwdenk
5723c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5724c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5725c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5726c609719bSwdenkLinux :-).
5727c609719bSwdenk
5728a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5729c609719bSwdenk
5730c609719bSwdenkJust make sure your machine specific header file (for instance
5731c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
57321dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
57331dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
57346d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5735c609719bSwdenk
57362eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
57372eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
57382eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
57392eb31b13SSimon Glassdoc/driver-model.
57402eb31b13SSimon Glass
5741c609719bSwdenk
5742c609719bSwdenkConfiguring the Linux kernel:
5743c609719bSwdenk-----------------------------
5744c609719bSwdenk
5745c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5746c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5747c609719bSwdenk
5748c609719bSwdenk
5749c609719bSwdenkBuilding a Linux Image:
5750c609719bSwdenk-----------------------
5751c609719bSwdenk
575224ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
575324ee89b9Swdenknot used. If you use recent kernel source, a new build target
575424ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
575524ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
575624ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
575724ee89b9Swdenk100% compatible format.
5758c609719bSwdenk
5759c609719bSwdenkExample:
5760c609719bSwdenk
5761ab584d67SHolger Freyther	make TQM850L_defconfig
5762c609719bSwdenk	make oldconfig
5763c609719bSwdenk	make dep
576424ee89b9Swdenk	make uImage
5765c609719bSwdenk
576624ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
576724ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
576824ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5769c609719bSwdenk
577024ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
577124ee89b9Swdenk
577224ee89b9Swdenk* convert the kernel into a raw binary image:
577324ee89b9Swdenk
577424ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
577524ee89b9Swdenk				 -R .note -R .comment \
577624ee89b9Swdenk				 -S vmlinux linux.bin
577724ee89b9Swdenk
577824ee89b9Swdenk* compress the binary image:
577924ee89b9Swdenk
578024ee89b9Swdenk	gzip -9 linux.bin
578124ee89b9Swdenk
578224ee89b9Swdenk* package compressed binary image for U-Boot:
578324ee89b9Swdenk
578424ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
578524ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
578624ee89b9Swdenk		-d linux.bin.gz uImage
578724ee89b9Swdenk
578824ee89b9Swdenk
578924ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
579024ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
579124ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
579224ee89b9Swdenkbyte header containing information about target architecture,
579324ee89b9Swdenkoperating system, image type, compression method, entry points, time
579424ee89b9Swdenkstamp, CRC32 checksums, etc.
579524ee89b9Swdenk
579624ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
579724ee89b9Swdenkprint the header information, or to build new images.
5798c609719bSwdenk
5799c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5800c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5801c609719bSwdenkchecksum verification:
5802c609719bSwdenk
5803c609719bSwdenk	tools/mkimage -l image
5804c609719bSwdenk	  -l ==> list image header information
5805c609719bSwdenk
5806c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5807c609719bSwdenkfrom a "data file" which is used as image payload:
5808c609719bSwdenk
5809c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5810c609719bSwdenk		      -n name -d data_file image
5811c609719bSwdenk	  -A ==> set architecture to 'arch'
5812c609719bSwdenk	  -O ==> set operating system to 'os'
5813c609719bSwdenk	  -T ==> set image type to 'type'
5814c609719bSwdenk	  -C ==> set compression type 'comp'
5815c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5816c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5817c609719bSwdenk	  -n ==> set image name to 'name'
5818c609719bSwdenk	  -d ==> use image data from 'datafile'
5819c609719bSwdenk
582069459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
582169459791Swdenkaddress (0x00000000), but the entry point address depends on the
582269459791Swdenkkernel version:
5823c609719bSwdenk
5824c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
582524ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5826c609719bSwdenk
5827c609719bSwdenkSo a typical call to build a U-Boot image would read:
5828c609719bSwdenk
582924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
583024ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5831a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
583224ee89b9Swdenk	> examples/uImage.TQM850L
583324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5834c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5835c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5836c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5837c609719bSwdenk	Load Address: 0x00000000
583824ee89b9Swdenk	Entry Point:  0x00000000
5839c609719bSwdenk
5840c609719bSwdenkTo verify the contents of the image (or check for corruption):
5841c609719bSwdenk
584224ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
584324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5844c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5845c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5846c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5847c609719bSwdenk	Load Address: 0x00000000
584824ee89b9Swdenk	Entry Point:  0x00000000
5849c609719bSwdenk
5850c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5851c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5852c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5853c609719bSwdenkneed to be uncompressed:
5854c609719bSwdenk
5855a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
585624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
585724ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5858a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
585924ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
586024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5861c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5862c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5863c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5864c609719bSwdenk	Load Address: 0x00000000
586524ee89b9Swdenk	Entry Point:  0x00000000
5866c609719bSwdenk
5867c609719bSwdenk
5868c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5869c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5870c609719bSwdenk
5871c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5872c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5873c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5874c609719bSwdenk	Image Name:   Simple Ramdisk Image
5875c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5876c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5877c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5878c609719bSwdenk	Load Address: 0x00000000
5879c609719bSwdenk	Entry Point:  0x00000000
5880c609719bSwdenk
5881a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5882a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5883a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5884a804b5ceSGuilherme Maciel Ferreirafrom the image:
5885a804b5ceSGuilherme Maciel Ferreira
5886f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5887f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5888f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5889f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5890a804b5ceSGuilherme Maciel Ferreira
5891c609719bSwdenk
5892c609719bSwdenkInstalling a Linux Image:
5893c609719bSwdenk-------------------------
5894c609719bSwdenk
5895c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5896c609719bSwdenkyou must convert the image to S-Record format:
5897c609719bSwdenk
5898c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5899c609719bSwdenk
5900c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5901c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5902c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5903c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5904c609719bSwdenkcommand.
5905c609719bSwdenk
5906c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5907c609719bSwdenkTQM8xxL is in the first Flash bank):
5908c609719bSwdenk
5909c609719bSwdenk	=> erase 40100000 401FFFFF
5910c609719bSwdenk
5911c609719bSwdenk	.......... done
5912c609719bSwdenk	Erased 8 sectors
5913c609719bSwdenk
5914c609719bSwdenk	=> loads 40100000
5915c609719bSwdenk	## Ready for S-Record download ...
5916c609719bSwdenk	~>examples/image.srec
5917c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5918c609719bSwdenk	...
5919c609719bSwdenk	15989 15990 15991 15992
5920c609719bSwdenk	[file transfer complete]
5921c609719bSwdenk	[connected]
5922c609719bSwdenk	## Start Addr = 0x00000000
5923c609719bSwdenk
5924c609719bSwdenk
5925c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5926c609719bSwdenkthis includes a checksum verification so you can be sure no data
5927c609719bSwdenkcorruption happened:
5928c609719bSwdenk
5929c609719bSwdenk	=> imi 40100000
5930c609719bSwdenk
5931c609719bSwdenk	## Checking Image at 40100000 ...
5932c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5933c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5934c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5935c609719bSwdenk	   Load Address: 00000000
5936c609719bSwdenk	   Entry Point:	 0000000c
5937c609719bSwdenk	   Verifying Checksum ... OK
5938c609719bSwdenk
5939c609719bSwdenk
5940c609719bSwdenkBoot Linux:
5941c609719bSwdenk-----------
5942c609719bSwdenk
5943c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5944c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5945c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5946c609719bSwdenkparameters. You can check and modify this variable using the
5947c609719bSwdenk"printenv" and "setenv" commands:
5948c609719bSwdenk
5949c609719bSwdenk
5950c609719bSwdenk	=> printenv bootargs
5951c609719bSwdenk	bootargs=root=/dev/ram
5952c609719bSwdenk
5953c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5954c609719bSwdenk
5955c609719bSwdenk	=> printenv bootargs
5956c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5957c609719bSwdenk
5958c609719bSwdenk	=> bootm 40020000
5959c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5960c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5961c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5962c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5963c609719bSwdenk	   Load Address: 00000000
5964c609719bSwdenk	   Entry Point:	 0000000c
5965c609719bSwdenk	   Verifying Checksum ... OK
5966c609719bSwdenk	   Uncompressing Kernel Image ... OK
5967c609719bSwdenk	Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000
5968c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5969c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5970c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5971c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5972c609719bSwdenk	...
5973c609719bSwdenk
597411ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
59757152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5976c609719bSwdenkformat!) to the "bootm" command:
5977c609719bSwdenk
5978c609719bSwdenk	=> imi 40100000 40200000
5979c609719bSwdenk
5980c609719bSwdenk	## Checking Image at 40100000 ...
5981c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5982c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5983c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5984c609719bSwdenk	   Load Address: 00000000
5985c609719bSwdenk	   Entry Point:	 0000000c
5986c609719bSwdenk	   Verifying Checksum ... OK
5987c609719bSwdenk
5988c609719bSwdenk	## Checking Image at 40200000 ...
5989c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5990c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5991c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5992c609719bSwdenk	   Load Address: 00000000
5993c609719bSwdenk	   Entry Point:	 00000000
5994c609719bSwdenk	   Verifying Checksum ... OK
5995c609719bSwdenk
5996c609719bSwdenk	=> bootm 40100000 40200000
5997c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5998c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5999c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6000c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
6001c609719bSwdenk	   Load Address: 00000000
6002c609719bSwdenk	   Entry Point:	 0000000c
6003c609719bSwdenk	   Verifying Checksum ... OK
6004c609719bSwdenk	   Uncompressing Kernel Image ... OK
6005c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
6006c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
6007c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
6008c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
6009c609719bSwdenk	   Load Address: 00000000
6010c609719bSwdenk	   Entry Point:	 00000000
6011c609719bSwdenk	   Verifying Checksum ... OK
6012c609719bSwdenk	   Loading Ramdisk ... OK
6013c609719bSwdenk	Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000
6014c609719bSwdenk	Boot arguments: root=/dev/ram
6015c609719bSwdenk	time_init: decrementer frequency = 187500000/60
6016c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
6017c609719bSwdenk	...
6018c609719bSwdenk	RAMDISK: Compressed image found at block 0
6019c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
6020c609719bSwdenk
6021c609719bSwdenk	bash#
6022c609719bSwdenk
60230267768eSMatthew McClintockBoot Linux and pass a flat device tree:
60240267768eSMatthew McClintock-----------
60250267768eSMatthew McClintock
60260267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
60270267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
60280267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
60290267768eSMatthew McClintockflat device tree:
60300267768eSMatthew McClintock
60310267768eSMatthew McClintock=> print oftaddr
60320267768eSMatthew McClintockoftaddr=0x300000
60330267768eSMatthew McClintock=> print oft
60340267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
60350267768eSMatthew McClintock=> tftp $oftaddr $oft
60360267768eSMatthew McClintockSpeed: 1000, full duplex
60370267768eSMatthew McClintockUsing TSEC0 device
60380267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
60390267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
60400267768eSMatthew McClintockLoad address: 0x300000
60410267768eSMatthew McClintockLoading: #
60420267768eSMatthew McClintockdone
60430267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
60440267768eSMatthew McClintock=> tftp $loadaddr $bootfile
60450267768eSMatthew McClintockSpeed: 1000, full duplex
60460267768eSMatthew McClintockUsing TSEC0 device
60470267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
60480267768eSMatthew McClintockFilename 'uImage'.
60490267768eSMatthew McClintockLoad address: 0x200000
60500267768eSMatthew McClintockLoading:############
60510267768eSMatthew McClintockdone
60520267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
60530267768eSMatthew McClintock=> print loadaddr
60540267768eSMatthew McClintockloadaddr=200000
60550267768eSMatthew McClintock=> print oftaddr
60560267768eSMatthew McClintockoftaddr=0x300000
60570267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
60580267768eSMatthew McClintock## Booting image at 00200000 ...
60590267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
60600267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
60610267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
60620267768eSMatthew McClintock   Load Address: 00000000
60630267768eSMatthew McClintock   Entry Point:	 00000000
60640267768eSMatthew McClintock   Verifying Checksum ... OK
60650267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
60660267768eSMatthew McClintockBooting using flat device tree at 0x300000
60670267768eSMatthew McClintockUsing MPC85xx ADS machine description
60680267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
60690267768eSMatthew McClintock[snip]
60700267768eSMatthew McClintock
60710267768eSMatthew McClintock
60726069ff26SwdenkMore About U-Boot Image Types:
60736069ff26Swdenk------------------------------
60746069ff26Swdenk
60756069ff26SwdenkU-Boot supports the following image types:
60766069ff26Swdenk
60776069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
60786069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
60796069ff26Swdenk	well) you can continue to work in U-Boot after return from
60806069ff26Swdenk	the Standalone Program.
60816069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
60826069ff26Swdenk	will take over control completely. Usually these programs
60836069ff26Swdenk	will install their own set of exception handlers, device
60846069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
60856069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
60866069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
60876069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
60886069ff26Swdenk	being started.
60896069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
60906069ff26Swdenk	(Linux) kernel image and one or more data images like
60916069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
60926069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
60936069ff26Swdenk	server provides just a single image file, but you want to get
60946069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
60956069ff26Swdenk
60966069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
60976069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
60986069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
60996069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
61006069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
61016069ff26Swdenk	a multiple of 4 bytes).
61026069ff26Swdenk
61036069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
61046069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
61056069ff26Swdenk	flash memory.
61066069ff26Swdenk
61076069ff26Swdenk   "Script files" are command sequences that will be executed by
61086069ff26Swdenk	U-Boot's command interpreter; this feature is especially
61096069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
61106069ff26Swdenk	as command interpreter.
61116069ff26Swdenk
611244f074c7SMarek VasutBooting the Linux zImage:
611344f074c7SMarek Vasut-------------------------
611444f074c7SMarek Vasut
611544f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
611644f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
611744f074c7SMarek Vasutas the syntax of "bootm" command.
611844f074c7SMarek Vasut
61198ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
6120017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
6121017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
6122017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
6123017e1f3fSMarek Vasut
6124c609719bSwdenk
6125c609719bSwdenkStandalone HOWTO:
6126c609719bSwdenk=================
6127c609719bSwdenk
6128c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
6129c609719bSwdenkrun "standalone" applications, which can use some resources of
6130c609719bSwdenkU-Boot like console I/O functions or interrupt services.
6131c609719bSwdenk
6132c609719bSwdenkTwo simple examples are included with the sources:
6133c609719bSwdenk
6134c609719bSwdenk"Hello World" Demo:
6135c609719bSwdenk-------------------
6136c609719bSwdenk
6137c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
6138c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
6139c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
6140c609719bSwdenklike that:
6141c609719bSwdenk
6142c609719bSwdenk	=> loads
6143c609719bSwdenk	## Ready for S-Record download ...
6144c609719bSwdenk	~>examples/hello_world.srec
6145c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6146c609719bSwdenk	[file transfer complete]
6147c609719bSwdenk	[connected]
6148c609719bSwdenk	## Start Addr = 0x00040004
6149c609719bSwdenk
6150c609719bSwdenk	=> go 40004 Hello World! This is a test.
6151c609719bSwdenk	## Starting application at 0x00040004 ...
6152c609719bSwdenk	Hello World
6153c609719bSwdenk	argc = 7
6154c609719bSwdenk	argv[0] = "40004"
6155c609719bSwdenk	argv[1] = "Hello"
6156c609719bSwdenk	argv[2] = "World!"
6157c609719bSwdenk	argv[3] = "This"
6158c609719bSwdenk	argv[4] = "is"
6159c609719bSwdenk	argv[5] = "a"
6160c609719bSwdenk	argv[6] = "test."
6161c609719bSwdenk	argv[7] = "<NULL>"
6162c609719bSwdenk	Hit any key to exit ...
6163c609719bSwdenk
6164c609719bSwdenk	## Application terminated, rc = 0x0
6165c609719bSwdenk
6166c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
6167c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
6168c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
6169c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
6170c609719bSwdenkcharacter, but this is just a demo program. The application can be
6171c609719bSwdenkcontrolled by the following keys:
6172c609719bSwdenk
6173c609719bSwdenk	? - print current values og the CPM Timer registers
6174c609719bSwdenk	b - enable interrupts and start timer
6175c609719bSwdenk	e - stop timer and disable interrupts
6176c609719bSwdenk	q - quit application
6177c609719bSwdenk
6178c609719bSwdenk	=> loads
6179c609719bSwdenk	## Ready for S-Record download ...
6180c609719bSwdenk	~>examples/timer.srec
6181c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6182c609719bSwdenk	[file transfer complete]
6183c609719bSwdenk	[connected]
6184c609719bSwdenk	## Start Addr = 0x00040004
6185c609719bSwdenk
6186c609719bSwdenk	=> go 40004
6187c609719bSwdenk	## Starting application at 0x00040004 ...
6188c609719bSwdenk	TIMERS=0xfff00980
6189c609719bSwdenk	Using timer 1
6190c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6191c609719bSwdenk
6192c609719bSwdenkHit 'b':
6193c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
6194c609719bSwdenk	Enabling timer
6195c609719bSwdenkHit '?':
6196c609719bSwdenk	[q, b, e, ?] ........
6197c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6198c609719bSwdenkHit '?':
6199c609719bSwdenk	[q, b, e, ?] .
6200c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6201c609719bSwdenkHit '?':
6202c609719bSwdenk	[q, b, e, ?] .
6203c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6204c609719bSwdenkHit '?':
6205c609719bSwdenk	[q, b, e, ?] .
6206c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6207c609719bSwdenkHit 'e':
6208c609719bSwdenk	[q, b, e, ?] ...Stopping timer
6209c609719bSwdenkHit 'q':
6210c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
6211c609719bSwdenk
6212c609719bSwdenk
621385ec0bccSwdenkMinicom warning:
621485ec0bccSwdenk================
621585ec0bccSwdenk
62167152b1d0SwdenkOver time, many people have reported problems when trying to use the
621785ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
621885ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
6219f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
622085ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
6221e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
6222e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6223e53515a2SKarl O. Pincfor help with kermit.
6224e53515a2SKarl O. Pinc
622585ec0bccSwdenk
622652f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
622752f52c14Swdenkconfiguration to your "File transfer protocols" section:
622852f52c14Swdenk
622952f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
623052f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
623152f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
623252f52c14Swdenk
623352f52c14Swdenk
6234c609719bSwdenkNetBSD Notes:
6235c609719bSwdenk=============
6236c609719bSwdenk
6237c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
6238c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
6239c609719bSwdenk
6240c609719bSwdenkBuilding requires a cross environment; it is known to work on
6241c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6242c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
6243c609719bSwdenkNote that the cross-powerpc package does not install include files;
6244c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
6245c609719bSwdenkmissing.  This file has to be installed and patched manually:
6246c609719bSwdenk
6247c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
6248c609719bSwdenk	# mkdir powerpc
6249c609719bSwdenk	# ln -s powerpc machine
6250c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6251c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6252c609719bSwdenk
6253c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6254c609719bSwdenkand U-Boot include files.
6255c609719bSwdenk
6256c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6257c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6258c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6259c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
62602a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6261c609719bSwdenk
6262c609719bSwdenk
6263c609719bSwdenkImplementation Internals:
6264c609719bSwdenk=========================
6265c609719bSwdenk
6266c609719bSwdenkThe following is not intended to be a complete description of every
6267c609719bSwdenkimplementation detail. However, it should help to understand the
6268c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6269c609719bSwdenkhardware.
6270c609719bSwdenk
6271c609719bSwdenk
6272c609719bSwdenkInitial Stack, Global Data:
6273c609719bSwdenk---------------------------
6274c609719bSwdenk
6275c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6276c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6277c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6278c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6279c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6280c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6281c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6282c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6283c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6284c609719bSwdenklocked as (mis-) used as memory, etc.
6285c609719bSwdenk
62867152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
62870668236bSWolfgang Denk	U-Boot mailing list:
628843d9616cSwdenk
628943d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
629043d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
629143d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
629243d9616cSwdenk	...
629343d9616cSwdenk
629443d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
629543d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
629643d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
629743d9616cSwdenk	is that the cache is being used as a temporary supply of
629843d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
629911ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
630043d9616cSwdenk	can see how this works by studying the cache architecture and
630143d9616cSwdenk	operation in the architecture and processor-specific manuals.
630243d9616cSwdenk
630343d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
630443d9616cSwdenk	is another option for the system designer to use as an
630511ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
630643d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
630743d9616cSwdenk	board designers haven't used it for something that would
630843d9616cSwdenk	cause you grief during the initial boot! It is frequently not
630943d9616cSwdenk	used.
631043d9616cSwdenk
63116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
631243d9616cSwdenk	with your processor/board/system design. The default value
631343d9616cSwdenk	you will find in any recent u-boot distribution in
63148a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
631543d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
631643d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
631743d9616cSwdenk	that are supposed to respond to that address! That code in
631843d9616cSwdenk	start.S has been around a while and should work as is when
631943d9616cSwdenk	you get the config right.
632043d9616cSwdenk
632143d9616cSwdenk	-Chris Hallinan
632243d9616cSwdenk	DS4.COM, Inc.
632343d9616cSwdenk
6324c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6325c609719bSwdenkcode for the initialization procedures:
6326c609719bSwdenk
6327c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6328c609719bSwdenk  to write it.
6329c609719bSwdenk
6330b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
6331c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
63327152b1d0Swdenk  zation is performed later (when relocating to RAM).
6333c609719bSwdenk
6334c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6335c609719bSwdenk  that.
6336c609719bSwdenk
6337c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6338b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
6339c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6340c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6341c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6342c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6343c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6344c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6345c609719bSwdenkreserve for this purpose.
6346c609719bSwdenk
63477152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6348c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6349c609719bSwdenkGCC's implementation.
6350c609719bSwdenk
6351c609719bSwdenkFor PowerPC, the following registers have specific use:
6352c609719bSwdenk	R1:	stack pointer
6353e7670f6cSWolfgang Denk	R2:	reserved for system use
6354c609719bSwdenk	R3-R4:	parameter passing and return values
6355c609719bSwdenk	R5-R10: parameter passing
6356c609719bSwdenk	R13:	small data area pointer
6357c609719bSwdenk	R30:	GOT pointer
6358c609719bSwdenk	R31:	frame pointer
6359c609719bSwdenk
6360e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6361e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6362e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6363c609719bSwdenk
6364e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6365c609719bSwdenk
6366c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6367c609719bSwdenk    address of the global data structure is known at compile time),
6368c609719bSwdenk    but it turned out that reserving a register results in somewhat
6369c609719bSwdenk    smaller code - although the code savings are not that big (on
6370c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6371c609719bSwdenk    624 text + 127 data).
6372c609719bSwdenk
6373c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
63744c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
63754c58eb55SMike Frysinger
6376c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
63774c58eb55SMike Frysinger
6378c609719bSwdenkOn ARM, the following registers are used:
6379c609719bSwdenk
6380c609719bSwdenk	R0:	function argument word/integer result
6381c609719bSwdenk	R1-R3:	function argument word
638212eba1b4SJeroen Hofstee	R9:	platform specific
638312eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6384c609719bSwdenk	R11:	argument (frame) pointer
6385c609719bSwdenk	R12:	temporary workspace
6386c609719bSwdenk	R13:	stack pointer
6387c609719bSwdenk	R14:	link register
6388c609719bSwdenk	R15:	program counter
6389c609719bSwdenk
639012eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
639112eba1b4SJeroen Hofstee
639212eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6393c609719bSwdenk
63940df01fd3SThomas ChouOn Nios II, the ABI is documented here:
63950df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
63960df01fd3SThomas Chou
63970df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
63980df01fd3SThomas Chou
63990df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
64000df01fd3SThomas Chou    to access small data sections, so gp is free.
64010df01fd3SThomas Chou
6402afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6403afc1ce82SMacpaul Lin
6404afc1ce82SMacpaul Lin	R0-R1:	argument/return
6405afc1ce82SMacpaul Lin	R2-R5:	argument
6406afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6407afc1ce82SMacpaul Lin	R16:	trampoline register
6408afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6409afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6410afc1ce82SMacpaul Lin	R30:	link register (LP)
6411afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6412afc1ce82SMacpaul Lin	PC:	program counter (PC)
6413afc1ce82SMacpaul Lin
6414afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6415afc1ce82SMacpaul Lin
6416d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6417d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6418c609719bSwdenk
6419c609719bSwdenkMemory Management:
6420c609719bSwdenk------------------
6421c609719bSwdenk
6422c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6423c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6424c609719bSwdenk
6425c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6426c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6427c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6428c609719bSwdenkphysical memory banks.
6429c609719bSwdenk
6430c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6431c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6432c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6433c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
64346d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6435c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6436c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6437c609719bSwdenk
6438c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6439c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6440c609719bSwdenk
6441c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6442c609719bSwdenkthis:
6443c609719bSwdenk
6444c609719bSwdenk	0x0000 0000	Exception Vector code
6445c609719bSwdenk	      :
6446c609719bSwdenk	0x0000 1FFF
6447c609719bSwdenk	0x0000 2000	Free for Application Use
6448c609719bSwdenk	      :
6449c609719bSwdenk	      :
6450c609719bSwdenk
6451c609719bSwdenk	      :
6452c609719bSwdenk	      :
6453c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6454c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6455c609719bSwdenk	0x00FC 0000	Malloc Arena
6456c609719bSwdenk	      :
6457c609719bSwdenk	0x00FD FFFF
6458c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6459c609719bSwdenk	...		eventually: LCD or video framebuffer
6460c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6461c609719bSwdenk	0x00FF FFFF	[End of RAM]
6462c609719bSwdenk
6463c609719bSwdenk
6464c609719bSwdenkSystem Initialization:
6465c609719bSwdenk----------------------
6466c609719bSwdenk
6467c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
646811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6469c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
64707152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6471c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6472c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6473c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6474c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6475c609719bSwdenkthe caches and the SIU.
6476c609719bSwdenk
6477c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6478c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6479c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6480c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6481c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6482c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6483c609719bSwdenkbanks.
6484c609719bSwdenk
6485c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
64867152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6487c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6488c609719bSwdenk0x00000000, with any additional banks following immediately to create
6489c609719bSwdenkcontiguous memory starting from 0.
6490c609719bSwdenk
6491c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6492c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6493c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6494c609719bSwdenkpages, and the final stack is set up.
6495c609719bSwdenk
6496c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6497c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6498c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6499c609719bSwdenknew address in RAM.
6500c609719bSwdenk
6501c609719bSwdenk
6502c609719bSwdenkU-Boot Porting Guide:
6503c609719bSwdenk----------------------
6504c609719bSwdenk
6505c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
65066aff3115Swdenklist, October 2002]
6507c609719bSwdenk
6508c609719bSwdenk
6509c609719bSwdenkint main(int argc, char *argv[])
6510c609719bSwdenk{
6511c609719bSwdenk	sighandler_t no_more_time;
6512c609719bSwdenk
6513c609719bSwdenk	signal(SIGALRM, no_more_time);
6514c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6515c609719bSwdenk
6516c609719bSwdenk	if (available_money > available_manpower) {
65176c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6518c609719bSwdenk		return 0;
6519c609719bSwdenk	}
6520c609719bSwdenk
6521c609719bSwdenk	Download latest U-Boot source;
6522c609719bSwdenk
65230668236bSWolfgang Denk	Subscribe to u-boot mailing list;
65246aff3115Swdenk
65256c3fef28SJerry Van Baren	if (clueless)
6526c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6527c609719bSwdenk
6528c609719bSwdenk	while (learning) {
6529c609719bSwdenk		Read the README file in the top level directory;
65307cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
65316c3fef28SJerry Van Baren		Read applicable doc/*.README;
6532c609719bSwdenk		Read the source, Luke;
65336c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6534c609719bSwdenk	}
6535c609719bSwdenk
65366c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
65376c3fef28SJerry Van Baren		Buy a BDI3000;
65386c3fef28SJerry Van Baren	else
6539c609719bSwdenk		Add a lot of aggravation and time;
6540c609719bSwdenk
65416c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
65426c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
65436c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
65446c3fef28SJerry Van Baren	} else {
6545c609719bSwdenk		Create your own board support subdirectory;
65466c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
65476c3fef28SJerry Van Baren	}
65486c3fef28SJerry Van Baren	Edit new board/<myboard> files
65496c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6550c609719bSwdenk
65516c3fef28SJerry Van Baren	while (!accepted) {
6552c609719bSwdenk		while (!running) {
6553c609719bSwdenk			do {
6554c609719bSwdenk				Add / modify source code;
6555c609719bSwdenk			} until (compiles);
6556c609719bSwdenk			Debug;
6557c609719bSwdenk			if (clueless)
6558c609719bSwdenk				email("Hi, I am having problems...");
6559c609719bSwdenk		}
65606c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
65616c3fef28SJerry Van Baren		if (reasonable critiques)
65626c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
65636c3fef28SJerry Van Baren		else
65646c3fef28SJerry Van Baren			Defend code as written;
65656c3fef28SJerry Van Baren	}
6566c609719bSwdenk
6567c609719bSwdenk	return 0;
6568c609719bSwdenk}
6569c609719bSwdenk
6570c609719bSwdenkvoid no_more_time (int sig)
6571c609719bSwdenk{
6572c609719bSwdenk      hire_a_guru();
6573c609719bSwdenk}
6574c609719bSwdenk
6575c609719bSwdenk
6576c609719bSwdenkCoding Standards:
6577c609719bSwdenk-----------------
6578c609719bSwdenk
6579c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
65802c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
65817ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6582c609719bSwdenk
65832c051651SDetlev ZundelSource files originating from a different project (for example the
65842c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
6585b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
65862c051651SDetlev Zundelsources.
65872c051651SDetlev Zundel
65882c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
65892c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
65902c051651SDetlev Zundelin your code.
6591c609719bSwdenk
6592c178d3daSwdenkPlease also stick to the following formatting rules:
6593180d3f74Swdenk- remove any trailing white space
65947ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6595180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
65967ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6597180d3f74Swdenk- do not add trailing empty lines to source files
6598180d3f74Swdenk
6599c609719bSwdenkSubmissions which do not conform to the standards may be returned
6600c609719bSwdenkwith a request to reformat the changes.
6601c609719bSwdenk
6602c609719bSwdenk
6603c609719bSwdenkSubmitting Patches:
6604c609719bSwdenk-------------------
6605c609719bSwdenk
6606c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6607c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6608c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6609c609719bSwdenk
66100d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6611218ca724SWolfgang Denk
66120668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
66130668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
66140668236bSWolfgang Denk
6615c609719bSwdenkWhen you send a patch, please include the following information with
6616c609719bSwdenkit:
6617c609719bSwdenk
6618c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6619c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6620c609719bSwdenk  patch actually fixes something.
6621c609719bSwdenk
6622c609719bSwdenk* For new features: a description of the feature and your
6623c609719bSwdenk  implementation.
6624c609719bSwdenk
6625c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6626c609719bSwdenk
6627c609719bSwdenk* For major contributions, your entry to the CREDITS file
6628c609719bSwdenk
662927af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
663027af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6631c609719bSwdenk
6632c609719bSwdenk* If your patch adds new configuration options, don't forget to
6633c609719bSwdenk  document these in the README file.
6634c609719bSwdenk
6635218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6636218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
66377ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6638218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6639218ca724SWolfgang Denk  with some other mail clients.
6640c609719bSwdenk
6641218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6642218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6643218ca724SWolfgang Denk  GNU diff.
66446dff5529Swdenk
6645218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6646218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6647218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6648218ca724SWolfgang Denk  affected files).
6649218ca724SWolfgang Denk
6650218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6651218ca724SWolfgang Denk  and compressed attachments must not be used.
6652c609719bSwdenk
665352f52c14Swdenk* If one logical set of modifications affects or creates several
665452f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
665552f52c14Swdenk
665652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
665752f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
665852f52c14Swdenk
665952f52c14Swdenk
6660c609719bSwdenkNotes:
6661c609719bSwdenk
6662c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6663c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6664c609719bSwdenk  for any of the boards.
6665c609719bSwdenk
6666c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6667c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6668c609719bSwdenk  returned with a request to re-formatting / split it.
6669c609719bSwdenk
6670c609719bSwdenk* If you modify existing code, make sure that your new code does not
6671c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6672c609719bSwdenk  When adding new features, these should compile conditionally only
6673c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6674c609719bSwdenk  disabled must not need more memory than the old code without your
6675c609719bSwdenk  modification.
667690dc6704Swdenk
66770668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
66780668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
66790668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
66800668236bSWolfgang Denk  bigger than the size limit should be avoided.
6681