xref: /openbmc/u-boot/README (revision aa9e6044)
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
377207b366SRobert P. J. DayIn case of problems see the CHANGELOG file to find out who contributed
387207b366SRobert P. J. Daythe specific port. In addition, there are various MAINTAINERS files
397207b366SRobert P. J. Dayscattered throughout the U-Boot source identifying the people or
407207b366SRobert P. J. Daycompanies responsible for various boards and subsystems.
41c609719bSwdenk
427207b366SRobert P. J. DayNote: As of August, 2010, there is no longer a CHANGELOG file in the
437207b366SRobert P. J. Dayactual U-Boot source tree; however, it can be created dynamically
447207b366SRobert P. J. Dayfrom the Git log using:
45adb9d851SRobert P. J. Day
46adb9d851SRobert P. J. Day	make CHANGELOG
47adb9d851SRobert P. J. Day
48c609719bSwdenk
49c609719bSwdenkWhere to get help:
50c609719bSwdenk==================
51c609719bSwdenk
52c609719bSwdenkIn case you have questions about, problems with or contributions for
537207b366SRobert P. J. DayU-Boot, you should send a message to the U-Boot mailing list at
540c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
550c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
560c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
570c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
58c609719bSwdenk
59c609719bSwdenk
60218ca724SWolfgang DenkWhere to get source code:
61218ca724SWolfgang Denk=========================
62218ca724SWolfgang Denk
637207b366SRobert P. J. DayThe U-Boot source code is maintained in the Git repository at
64218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
65218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66218ca724SWolfgang Denk
67218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6811ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
69218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70218ca724SWolfgang Denkdirectory.
71218ca724SWolfgang Denk
72d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
73218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
74218ca724SWolfgang Denk
75218ca724SWolfgang Denk
76c609719bSwdenkWhere we come from:
77c609719bSwdenk===================
78c609719bSwdenk
79c609719bSwdenk- start from 8xxrom sources
8024ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
81c609719bSwdenk- clean up code
82c609719bSwdenk- make it easier to add custom boards
83c609719bSwdenk- make it possible to add other [PowerPC] CPUs
84c609719bSwdenk- extend functions, especially:
85c609719bSwdenk  * Provide extended interface to Linux boot loader
86c609719bSwdenk  * S-Record download
87c609719bSwdenk  * network boot
8811ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8924ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
90c609719bSwdenk- add other CPU families (starting with ARM)
9124ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
920d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9324ee89b9Swdenk
9424ee89b9Swdenk
9524ee89b9SwdenkNames and Spelling:
9624ee89b9Swdenk===================
9724ee89b9Swdenk
9824ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9924ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10024ee89b9Swdenkin source files etc.). Example:
10124ee89b9Swdenk
10224ee89b9Swdenk	This is the README file for the U-Boot project.
10324ee89b9Swdenk
10424ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10524ee89b9Swdenk
10624ee89b9Swdenk	include/asm-ppc/u-boot.h
10724ee89b9Swdenk
10824ee89b9Swdenk	#include <asm/u-boot.h>
10924ee89b9Swdenk
11024ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
11124ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11224ee89b9Swdenk
11324ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11424ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
115c609719bSwdenk
116c609719bSwdenk
11793f19cc0SwdenkVersioning:
11893f19cc0Swdenk===========
11993f19cc0Swdenk
120360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
121360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
122360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
123360d883aSThomas Webernames consisting of the calendar year and month of the release date.
124360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
125360d883aSThomas Weberreleases in "stable" maintenance trees.
12693f19cc0Swdenk
127360d883aSThomas WeberExamples:
128360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
129360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
130360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
13193f19cc0Swdenk
13293f19cc0Swdenk
133c609719bSwdenkDirectory Hierarchy:
134c609719bSwdenk====================
135c609719bSwdenk
1368d321b81SPeter Tyser/arch			Architecture specific files
1376eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1388d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1398d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1408d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1418d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1428d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1438d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
144afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
1458d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
14633c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
147a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1487207b366SRobert P. J. Day  /sandbox		Files generic to HW-independent "sandbox"
1498d321b81SPeter Tyser  /sh			Files generic to SH architecture
1508d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
15133c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
1528d321b81SPeter Tyser/api			Machine/arch independent API for external apps
1538d321b81SPeter Tyser/board			Board dependent files
1548d321b81SPeter Tyser/common			Misc architecture independent functions
1557207b366SRobert P. J. Day/configs		Board default configuration files
1568d321b81SPeter Tyser/disk			Code for disk drive partition handling
1578d321b81SPeter Tyser/doc			Documentation (don't expect too much)
1588d321b81SPeter Tyser/drivers		Commonly used device drivers
15933c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
1608d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
1618d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
1628d321b81SPeter Tyser/include		Header Files
1637207b366SRobert P. J. Day/lib			Library routines generic to all architectures
1647207b366SRobert P. J. Day/Licenses		Various license files
1658d321b81SPeter Tyser/net			Networking code
1668d321b81SPeter Tyser/post			Power On Self Test
1677207b366SRobert P. J. Day/scripts		Various build scripts and Makefiles
1687207b366SRobert P. J. Day/test			Various unit test files
1698d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
170c609719bSwdenk
171c609719bSwdenkSoftware Configuration:
172c609719bSwdenk=======================
173c609719bSwdenk
174c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
175c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
176c609719bSwdenk
177c609719bSwdenkThere are two classes of configuration variables:
178c609719bSwdenk
179c609719bSwdenk* Configuration _OPTIONS_:
180c609719bSwdenk  These are selectable by the user and have names beginning with
181c609719bSwdenk  "CONFIG_".
182c609719bSwdenk
183c609719bSwdenk* Configuration _SETTINGS_:
184c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
185c609719bSwdenk  you don't know what you're doing; they have names beginning with
1866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
187c609719bSwdenk
1887207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating
1897207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently,
1907207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel,
1917207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your
1927207b366SRobert P. J. Daybuild.
193c609719bSwdenk
194c609719bSwdenk
195c609719bSwdenkSelection of Processor Architecture and Board Type:
196c609719bSwdenk---------------------------------------------------
197c609719bSwdenk
198c609719bSwdenkFor all supported boards there are ready-to-use default
199ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
200c609719bSwdenk
201c609719bSwdenkExample: For a TQM823L module type:
202c609719bSwdenk
203c609719bSwdenk	cd u-boot
204ab584d67SHolger Freyther	make TQM823L_defconfig
205c609719bSwdenk
2067207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board
2077207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file
2087207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards.
209c609719bSwdenk
21075b3c3aaSSimon GlassSandbox Environment:
21175b3c3aaSSimon Glass--------------------
21275b3c3aaSSimon Glass
21375b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
21475b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
21575b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
21675b3c3aaSSimon Glassrun some of U-Boot's tests.
21775b3c3aaSSimon Glass
2186b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
21975b3c3aaSSimon Glass
22075b3c3aaSSimon Glass
221db910353SSimon GlassBoard Initialisation Flow:
222db910353SSimon Glass--------------------------
223db910353SSimon Glass
224db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both
2257207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules).
226db910353SSimon Glass
2277207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in
2287207b366SRobert P. J. Daymore detail later in this file.
2297207b366SRobert P. J. Day
2307207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names
2317207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures
2327207b366SRobert P. J. Daymay not conform to this.  At least most ARM boards which use
2337207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this.
2347207b366SRobert P. J. Day
2357207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly
2367207b366SRobert P. J. DayCPU-specific) start.S file, such as:
2377207b366SRobert P. J. Day
2387207b366SRobert P. J. Day	- arch/arm/cpu/armv7/start.S
2397207b366SRobert P. J. Day	- arch/powerpc/cpu/mpc83xx/start.S
2407207b366SRobert P. J. Day	- arch/mips/cpu/start.S
2417207b366SRobert P. J. Day
2427207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and
2437207b366SRobert P. J. Daylimitations of each of these functions are described below.
244db910353SSimon Glass
245db910353SSimon Glasslowlevel_init():
246db910353SSimon Glass	- purpose: essential init to permit execution to reach board_init_f()
247db910353SSimon Glass	- no global_data or BSS
248db910353SSimon Glass	- there is no stack (ARMv7 may have one but it will soon be removed)
249db910353SSimon Glass	- must not set up SDRAM or use console
250db910353SSimon Glass	- must only do the bare minimum to allow execution to continue to
251db910353SSimon Glass		board_init_f()
252db910353SSimon Glass	- this is almost never needed
253db910353SSimon Glass	- return normally from this function
254db910353SSimon Glass
255db910353SSimon Glassboard_init_f():
256db910353SSimon Glass	- purpose: set up the machine ready for running board_init_r():
257db910353SSimon Glass		i.e. SDRAM and serial UART
258db910353SSimon Glass	- global_data is available
259db910353SSimon Glass	- stack is in SRAM
260db910353SSimon Glass	- BSS is not available, so you cannot use global/static variables,
261db910353SSimon Glass		only stack variables and global_data
262db910353SSimon Glass
263db910353SSimon Glass	Non-SPL-specific notes:
264db910353SSimon Glass	- dram_init() is called to set up DRAM. If already done in SPL this
265db910353SSimon Glass		can do nothing
266db910353SSimon Glass
267db910353SSimon Glass	SPL-specific notes:
268db910353SSimon Glass	- you can override the entire board_init_f() function with your own
269db910353SSimon Glass		version as needed.
270db910353SSimon Glass	- preloader_console_init() can be called here in extremis
271db910353SSimon Glass	- should set up SDRAM, and anything needed to make the UART work
272db910353SSimon Glass	- these is no need to clear BSS, it will be done by crt0.S
273db910353SSimon Glass	- must return normally from this function (don't call board_init_r()
274db910353SSimon Glass		directly)
275db910353SSimon Glass
276db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
277db910353SSimon Glassthis point the stack and global_data are relocated to below
278db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
279db910353SSimon Glassmemory.
280db910353SSimon Glass
281db910353SSimon Glassboard_init_r():
282db910353SSimon Glass	- purpose: main execution, common code
283db910353SSimon Glass	- global_data is available
284db910353SSimon Glass	- SDRAM is available
285db910353SSimon Glass	- BSS is available, all static/global variables can be used
286db910353SSimon Glass	- execution eventually continues to main_loop()
287db910353SSimon Glass
288db910353SSimon Glass	Non-SPL-specific notes:
289db910353SSimon Glass	- U-Boot is relocated to the top of memory and is now running from
290db910353SSimon Glass		there.
291db910353SSimon Glass
292db910353SSimon Glass	SPL-specific notes:
293db910353SSimon Glass	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
294db910353SSimon Glass		CONFIG_SPL_STACK_R_ADDR points into SDRAM
295db910353SSimon Glass	- preloader_console_init() can be called here - typically this is
296db910353SSimon Glass		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
297db910353SSimon Glass		spl_board_init() function containing this call
298db910353SSimon Glass	- loads U-Boot or (in falcon mode) Linux
299db910353SSimon Glass
300db910353SSimon Glass
301db910353SSimon Glass
302c609719bSwdenkConfiguration Options:
303c609719bSwdenk----------------------
304c609719bSwdenk
305c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
306c609719bSwdenksuch information is kept in a configuration file
307c609719bSwdenk"include/configs/<board_name>.h".
308c609719bSwdenk
309c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
310c609719bSwdenk"include/configs/TQM823L.h".
311c609719bSwdenk
312c609719bSwdenk
3137f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
3147f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
3157f6c2cbcSwdenkbuild a config tool - later.
3167f6c2cbcSwdenk
3177f6c2cbcSwdenk
318c609719bSwdenkThe following options need to be configured:
319c609719bSwdenk
3202628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
321c609719bSwdenk
3222628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
3236ccec449SWolfgang Denk
3246ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
32509ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
326c609719bSwdenk
327c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
328c609719bSwdenk		Define exactly one of
329c609719bSwdenk		CONFIG_CMA286_60_OLD
330c609719bSwdenk--- FIXME --- not tested yet:
331c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
332c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
333c609719bSwdenk
334c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
335c609719bSwdenk		Define exactly one of
336c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
337c609719bSwdenk
338c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
339c609719bSwdenk		Define one or more of
340c609719bSwdenk		CONFIG_CMA302
341c609719bSwdenk
342c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
343c609719bSwdenk		Define one or more of
344c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
34511ccc33fSMarcel Ziswiler					  the LCD display every second with
346c609719bSwdenk					  a "rotator" |\-/|\-/
347c609719bSwdenk
348cf946c6dSLei Wen- Marvell Family Member
349cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
350cf946c6dSLei Wen					  multiple fs option at one time
351cf946c6dSLei Wen					  for marvell soc family
352cf946c6dSLei Wen
35311ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
35466ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
35566ca92a5Swdenk					  get_gclk_freq() cannot work
3565da627a4Swdenk					  e.g. if there is no 32KHz
3575da627a4Swdenk					  reference PIT/RTC clock
35866ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
35966ca92a5Swdenk					  or XTAL/EXTAL)
360c609719bSwdenk
36166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
36466ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
36575d1ea7fSwdenk			See doc/README.MPC866
36675d1ea7fSwdenk
3676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
36875d1ea7fSwdenk
36975d1ea7fSwdenk		Define this to measure the actual CPU clock instead
37075d1ea7fSwdenk		of relying on the correctness of the configured
37175d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
37275d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
37375d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
37575d1ea7fSwdenk
376506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
377506f3918SHeiko Schocher
378506f3918SHeiko Schocher		Define this option if you want to enable the
379506f3918SHeiko Schocher		ICache only when Code runs from RAM.
380506f3918SHeiko Schocher
38166412c63SKumar Gala- 85xx CPU Options:
382ffd06e02SYork Sun		CONFIG_SYS_PPC64
383ffd06e02SYork Sun
384ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
385ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
386ffd06e02SYork Sun		compliance, among other possible reasons.
387ffd06e02SYork Sun
38866412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
38966412c63SKumar Gala
39066412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
39166412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
39266412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
39366412c63SKumar Gala
3948f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3958f29084aSKumar Gala
3968f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3978f29084aSKumar Gala		tree nodes for the given platform.
3988f29084aSKumar Gala
399afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
400afa6b551SPrabhakar Kushwaha
401afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
402afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
403afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
404afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
405afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
406afa6b551SPrabhakar Kushwaha		purpose.
407afa6b551SPrabhakar Kushwaha
40833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
40933eee330SScott Wood
41033eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
41133eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
41233eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
41333eee330SScott Wood
41433eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
41533eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
41633eee330SScott Wood
41733eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
41833eee330SScott Wood		for which the A004510 workaround should be applied.
41933eee330SScott Wood
42033eee330SScott Wood		The rest of SVR is either not relevant to the decision
42133eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
42233eee330SScott Wood		p2041) or is implied by the build target, which controls
42333eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
42433eee330SScott Wood
42533eee330SScott Wood		See Freescale App Note 4493 for more information about
42633eee330SScott Wood		this erratum.
42733eee330SScott Wood
42874fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
42974fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
430b445bbb4SJeremiah Mahler		required during NOR boot.
43174fa22edSPrabhakar Kushwaha
4329f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
4339f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
434b445bbb4SJeremiah Mahler		required during NAND boot and valid for Rev 1.0 SoC revision
4359f074e67SPrabhakar Kushwaha
43633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
43733eee330SScott Wood
43833eee330SScott Wood		This is the value to write into CCSR offset 0x18600
43933eee330SScott Wood		according to the A004510 workaround.
44033eee330SScott Wood
44164501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
44264501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
44364501c66SPriyanka Jain		connected exclusively to the DSP cores.
44464501c66SPriyanka Jain
445765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
446765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
447765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
448765b0bdbSPriyanka Jain
44964501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
45064501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
45164501c66SPriyanka Jain		connected to the DSP core.
45264501c66SPriyanka Jain
453765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
454765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
455765b0bdbSPriyanka Jain
456b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
457b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
458b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
459b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
460b135991aSPriyanka Jain
461fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
462fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
463a187559eSBin Meng		time of U-Boot entry and is required to be re-initialized.
464fb4a2409SAneesh Bansal
465aade2004STang Yuantian		CONFIG_DEEP_SLEEP
466b445bbb4SJeremiah Mahler		Indicates this SoC supports deep sleep feature. If deep sleep is
467aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
468aade2004STang Yuantian
4696cb461b4SDaniel Schwierzeck- Generic CPU options:
4702a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4712a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4722a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4732a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4742a1680e3SYork Sun		should initialize global data before calling board_init_f().
4752a1680e3SYork Sun
4766cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4776cb461b4SDaniel Schwierzeck
4786cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4796cb461b4SDaniel Schwierzeck		values is arch specific.
4806cb461b4SDaniel Schwierzeck
4815614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4825614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4835614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4845614e71bSYork Sun		SoCs.
4855614e71bSYork Sun
4865614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4875614e71bSYork Sun		Freescale DDR memory-mapped register base.
4885614e71bSYork Sun
4895614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4905614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4915614e71bSYork Sun		deskew training are not available.
4925614e71bSYork Sun
4935614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4945614e71bSYork Sun		Freescale DDR1 controller.
4955614e71bSYork Sun
4965614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4975614e71bSYork Sun		Freescale DDR2 controller.
4985614e71bSYork Sun
4995614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
5005614e71bSYork Sun		Freescale DDR3 controller.
5015614e71bSYork Sun
50234e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
50334e026f9SYork Sun		Freescale DDR4 controller.
50434e026f9SYork Sun
5059ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
5069ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
5079ac4ffbdSYork Sun
5085614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
5095614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
5105614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
5115614e71bSYork Sun		implemetation.
5125614e71bSYork Sun
5135614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
5145614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
5155614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
5165614e71bSYork Sun		implementation.
5175614e71bSYork Sun
5185614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
5195614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
52034e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
52134e026f9SYork Sun
52234e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
52334e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
52434e026f9SYork Sun		DDR3L controllers.
52534e026f9SYork Sun
52634e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
52734e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
52834e026f9SYork Sun		DDR4 controllers.
5295614e71bSYork Sun
5301b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5311b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5321b4175d6SPrabhakar Kushwaha
5331b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5341b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5351b4175d6SPrabhakar Kushwaha
536690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
537690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
538690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
539690e4258SPrabhakar Kushwaha
540690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
541690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
542690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
543690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
544690e4258SPrabhakar Kushwaha
54589ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
54689ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
54789ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
54889ad7be8SPrabhakar Kushwaha
5494e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5504e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5514e5b1bd0SYork Sun
5524e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5534e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5544e5b1bd0SYork Sun
5556b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5566b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5576b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5586b9e309aSYork Sun		it could be different for ARM SoCs.
5596b9e309aSYork Sun
5606b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5616b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5626b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5636b1e1254SYork Sun		SoCs with ARM core.
5646b1e1254SYork Sun
5651d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
5661d71efbbSYork Sun		Number of controllers used as main memory.
5671d71efbbSYork Sun
5681d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
5691d71efbbSYork Sun		Number of controllers used for other than main memory.
5701d71efbbSYork Sun
57144937214SPrabhakar Kushwaha		CONFIG_SYS_FSL_HAS_DP_DDR
57244937214SPrabhakar Kushwaha		Defines the SoC has DP-DDR used for DPAA.
57344937214SPrabhakar Kushwaha
574028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
575028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
576028dbb8dSRuchika Gupta
577028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
578028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
579028dbb8dSRuchika Gupta
5800b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5820b953ffcSMarkus Klotzbuecher
5830b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5840b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5850b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5860b953ffcSMarkus Klotzbuecher
5876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5880b953ffcSMarkus Klotzbuecher
5890b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5900b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5910b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5920b953ffcSMarkus Klotzbuecher		by this value.
5930b953ffcSMarkus Klotzbuecher
59492bbd64eSDaniel Schwierzeck- MIPS CPU options:
59592bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
59692bbd64eSDaniel Schwierzeck
59792bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
59892bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
59992bbd64eSDaniel Schwierzeck		relocation.
60092bbd64eSDaniel Schwierzeck
60192bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
60292bbd64eSDaniel Schwierzeck
60392bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
60492bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
60592bbd64eSDaniel Schwierzeck		Possible values are:
60692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
60792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
60892bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
60992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
61092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
61192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
61292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
61392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
61492bbd64eSDaniel Schwierzeck
61592bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
61692bbd64eSDaniel Schwierzeck
61792bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
61892bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
61992bbd64eSDaniel Schwierzeck
62092bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
62192bbd64eSDaniel Schwierzeck
62292bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
62392bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
62492bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
62592bbd64eSDaniel Schwierzeck
626b67d8816SChristian Riesch- ARM options:
627b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
628b67d8816SChristian Riesch
629b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
630b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
631b67d8816SChristian Riesch
6325356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
6335356f545SAneesh V
6345356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6355356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6365356f545SAneesh V		better code density. For ARM architectures that support
6375356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6385356f545SAneesh V		GCC.
6395356f545SAneesh V
640c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6410678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6420678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6430678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
644b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
645e392b923SIan Campbell		CONFIG_ARM_ERRATA_773022
646e392b923SIan Campbell		CONFIG_ARM_ERRATA_774769
647e392b923SIan Campbell		CONFIG_ARM_ERRATA_794072
6480678587fSStephen Warren
6490678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6500678587fSStephen Warren		during U-Boot startup. Note that these options force the
6510678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6520678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6530678587fSStephen Warren		set these options unless they apply!
6540678587fSStephen Warren
655207774b2SYork Sun		COUNTER_FREQUENCY
656207774b2SYork Sun		Generic timer clock source frequency.
657207774b2SYork Sun
658207774b2SYork Sun		COUNTER_FREQUENCY_REAL
659207774b2SYork Sun		Generic timer clock source frequency if the real clock is
660207774b2SYork Sun		different from COUNTER_FREQUENCY, and can only be determined
661207774b2SYork Sun		at run time.
662207774b2SYork Sun
663c616a0dfSNishanth Menon		NOTE: The following can be machine specific errata. These
664c616a0dfSNishanth Menon		do have ability to provide rudimentary version and machine
665c616a0dfSNishanth Menon		specific checks, but expect no product checks.
6665902f4ceSNishanth Menon		CONFIG_ARM_ERRATA_430973
667b45c48a7SNishanth Menon		CONFIG_ARM_ERRATA_454179
6689b4d65f9SNishanth Menon		CONFIG_ARM_ERRATA_621766
669c616a0dfSNishanth Menon		CONFIG_ARM_ERRATA_798870
670a615d0beSNishanth Menon		CONFIG_ARM_ERRATA_801819
671c616a0dfSNishanth Menon
67273c38934SStephen Warren- Tegra SoC options:
67373c38934SStephen Warren		CONFIG_TEGRA_SUPPORT_NON_SECURE
67473c38934SStephen Warren
67573c38934SStephen Warren		Support executing U-Boot in non-secure (NS) mode. Certain
67673c38934SStephen Warren		impossible actions will be skipped if the CPU is in NS mode,
67773c38934SStephen Warren		such as ARM architectural timer initialization.
67873c38934SStephen Warren
6795da627a4Swdenk- Linux Kernel Interface:
680c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
681c609719bSwdenk
682c609719bSwdenk		U-Boot stores all clock information in Hz
683c609719bSwdenk		internally. For binary compatibility with older Linux
684c609719bSwdenk		kernels (which expect the clocks passed in the
685c609719bSwdenk		bd_info data to be in MHz) the environment variable
686c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
687c609719bSwdenk		converts clock data to MHZ before passing it to the
688c609719bSwdenk		Linux kernel.
689c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
690c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
691c609719bSwdenk		default environment.
692c609719bSwdenk
6935da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
6945da627a4Swdenk
695b445bbb4SJeremiah Mahler		When transferring memsize parameter to Linux, some versions
6965da627a4Swdenk		expect it to be in bytes, others in MB.
6975da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6985da627a4Swdenk
699fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
700f57f70aaSWolfgang Denk
701f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
702213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
703213bf8c8SGerald Van Baren		concepts).
704213bf8c8SGerald Van Baren
705213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
706213bf8c8SGerald Van Baren		 * New libfdt-based support
707213bf8c8SGerald Van Baren		 * Adds the "fdt" command
7083bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
709213bf8c8SGerald Van Baren
710b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
711b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
712b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
713b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
714f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
715c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
716f57f70aaSWolfgang Denk
71711ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
71811ccc33fSMarcel Ziswiler		addresses
7193bb342fcSKim Phillips
7204e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
7214e253137SKumar Gala
7224e253137SKumar Gala		Board code has addition modification that it wants to make
7234e253137SKumar Gala		to the flat device tree before handing it off to the kernel
7246705d81eSwdenk
725c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
726c654b517SSimon Glass
727c654b517SSimon Glass		Other code has addition modification that it wants to make
728c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
729c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
730c654b517SSimon Glass		the kernel.
731c654b517SSimon Glass
7320267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
7330267768eSMatthew McClintock
73411ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
7350267768eSMatthew McClintock		param header, the default value is zero if undefined.
7360267768eSMatthew McClintock
7373887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
7383887c3fbSHeiko Schocher
7393887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
7403887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
7413887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
7423887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
7433887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
7443887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
7453887c3fbSHeiko Schocher
7467eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
7477eb29398SIgor Grinberg
7487eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
7497eb29398SIgor Grinberg		machine type and must be used to specify the machine type
7507eb29398SIgor Grinberg		number as it appears in the ARM machine registry
7517eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
7527eb29398SIgor Grinberg		Only boards that have multiple machine types supported
7537eb29398SIgor Grinberg		in a single configuration file and the machine type is
7547eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
7557eb29398SIgor Grinberg
7560b2f4ecaSNiklaus Giger- vxWorks boot parameters:
7570b2f4ecaSNiklaus Giger
7580b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
7599e98b7e3SBin Meng		environments variables: bootdev, bootfile, ipaddr, netmask,
7609e98b7e3SBin Meng		serverip, gatewayip, hostname, othbootargs.
7610b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
7620b2f4ecaSNiklaus Giger
7630b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
7640b2f4ecaSNiklaus Giger		the defaults discussed just above.
7650b2f4ecaSNiklaus Giger
7662c451f78SAneesh V- Cache Configuration:
7672c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
7682c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
7692c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
7702c451f78SAneesh V
77193bc2193SAneesh V- Cache Configuration for ARM:
77293bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
77393bc2193SAneesh V				      controller
77493bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
77593bc2193SAneesh V					controller register space
77693bc2193SAneesh V
7776705d81eSwdenk- Serial Ports:
77848d0192fSAndreas Engel		CONFIG_PL010_SERIAL
7796705d81eSwdenk
7806705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
7816705d81eSwdenk
78248d0192fSAndreas Engel		CONFIG_PL011_SERIAL
7836705d81eSwdenk
7846705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
7856705d81eSwdenk
7866705d81eSwdenk		CONFIG_PL011_CLOCK
7876705d81eSwdenk
7886705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
7896705d81eSwdenk		the clock speed of the UARTs.
7906705d81eSwdenk
7916705d81eSwdenk		CONFIG_PL01x_PORTS
7926705d81eSwdenk
7936705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
7946705d81eSwdenk		define this to a list of base addresses for each (supported)
7956705d81eSwdenk		port. See e.g. include/configs/versatile.h
7966705d81eSwdenk
797d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
798d57dee57SKaricheri, Muralidharan
799d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
800d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
8016705d81eSwdenk
802c609719bSwdenk- Console Interface:
803c609719bSwdenk		Depending on board, define exactly one serial port
804c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
805c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
806c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
807c609719bSwdenk
808c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
809c609719bSwdenk		port routines must be defined elsewhere
810c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
811c609719bSwdenk
812c609719bSwdenk		CONFIG_CFB_CONSOLE
813c609719bSwdenk		Enables console device for a color framebuffer. Needs following
814c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
815c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
816c609719bSwdenk						(default big endian)
817c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
818c609719bSwdenk						rectangle fill
819c609719bSwdenk						(cf. smiLynxEM)
820c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
821c609719bSwdenk						bit-blit (cf. smiLynxEM)
822c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
823c609719bSwdenk						(cols=pitch)
824c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
825c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
826c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
827c609719bSwdenk						(0-5, cf. cfb_console.c)
828c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
829c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
83039f615edSSimon Glass						(i.e. rx51_kp_init())
831c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
83239f615edSSimon Glass						(i.e. rx51_kp_tstc)
833c609719bSwdenk			VIDEO_GETC_FCT		get char fct
83439f615edSSimon Glass						(i.e. rx51_kp_getc)
835c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
836c609719bSwdenk						upper left corner
837a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
838a6c7ad2fSwdenk						linux_logo.h for logo.
839a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
840c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
84111ccc33fSMarcel Ziswiler						additional board info beside
842c609719bSwdenk						the logo
843c609719bSwdenk
84433a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
84533a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
84633a35bbbSPali Rohár		erase functions and limited graphics rendition control).
84733a35bbbSPali Rohár
848c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
849c609719bSwdenk		default i/o. Serial console can be forced with
850c609719bSwdenk		environment 'console=serial'.
851c609719bSwdenk
852a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
853a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
854a3ad8e26Swdenk		the "silent" environment variable. See
855a3ad8e26Swdenk		doc/README.silent for more information.
856a3ad8e26Swdenk
85745ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
85845ae2546SHeiko Schocher			is 0x00.
85945ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
86045ae2546SHeiko Schocher			is 0xa0.
86145ae2546SHeiko Schocher
862c609719bSwdenk- Console Baudrate:
863c609719bSwdenk		CONFIG_BAUDRATE - in bps
864c609719bSwdenk		Select one of the baudrates listed in
8656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
8666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
867c609719bSwdenk
868c92fac91SHeiko Schocher- Console Rx buffer length
869c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
870c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
8712b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
872c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
873c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
874c92fac91SHeiko Schocher		the SMC.
875c92fac91SHeiko Schocher
8769558b48aSGraeme Russ- Pre-Console Buffer:
8779558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
8789558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
8799558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8809558b48aSGraeme Russ		buffer any console messages prior to the console being
8819558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8829558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8839558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8849558b48aSGraeme Russ		bytes are output before the console is initialised, the
8859558b48aSGraeme Russ		earlier bytes are discarded.
8869558b48aSGraeme Russ
887a8552c7cSHans de Goede		Note that when printing the buffer a copy is made on the
888a8552c7cSHans de Goede		stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
889a8552c7cSHans de Goede
8909558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8919558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8929558b48aSGraeme Russ
893c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
894c609719bSwdenk		Delay before automatically booting the default image;
895c609719bSwdenk		set to -1 to disable autoboot.
89693d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
89793d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
898c609719bSwdenk
899c609719bSwdenk		See doc/README.autoboot for these options that
900c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
901c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
902c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
903c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
904c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
905c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
906c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
907c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
908c609719bSwdenk		CONFIG_RESET_TO_RETRY
909c609719bSwdenk
910c609719bSwdenk- Autoboot Command:
911c609719bSwdenk		CONFIG_BOOTCOMMAND
912c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
913c609719bSwdenk		define a command string that is automatically executed
914c609719bSwdenk		when no character is read on the console interface
915c609719bSwdenk		within "Boot Delay" after reset.
916c609719bSwdenk
917c609719bSwdenk		CONFIG_BOOTARGS
918c609719bSwdenk		This can be used to pass arguments to the bootm
919c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
920c609719bSwdenk		environment value "bootargs".
921c609719bSwdenk
922c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
923c609719bSwdenk		The value of these goes into the environment as
924c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
925c609719bSwdenk		as a convenience, when switching between booting from
92611ccc33fSMarcel Ziswiler		RAM and NFS.
927c609719bSwdenk
928eda0ba38SHeiko Schocher- Bootcount:
929eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
930eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
931eda0ba38SHeiko Schocher		cycle, see:
932eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
933eda0ba38SHeiko Schocher
934eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
935eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
936eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
937eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
938eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
939eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
940eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
941eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
942eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
943eda0ba38SHeiko Schocher
944c609719bSwdenk- Pre-Boot Commands:
945c609719bSwdenk		CONFIG_PREBOOT
946c609719bSwdenk
947c609719bSwdenk		When this option is #defined, the existence of the
948c609719bSwdenk		environment variable "preboot" will be checked
949c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
950c609719bSwdenk		countdown and/or running the auto-boot command resp.
951c609719bSwdenk		entering interactive mode.
952c609719bSwdenk
953c609719bSwdenk		This feature is especially useful when "preboot" is
954c609719bSwdenk		automatically generated or modified. For an example
955c609719bSwdenk		see the LWMON board specific code: here "preboot" is
956c609719bSwdenk		modified when the user holds down a certain
957c609719bSwdenk		combination of keys on the (special) keyboard when
958c609719bSwdenk		booting the systems
959c609719bSwdenk
960c609719bSwdenk- Serial Download Echo Mode:
961c609719bSwdenk		CONFIG_LOADS_ECHO
962c609719bSwdenk		If defined to 1, all characters received during a
963c609719bSwdenk		serial download (using the "loads" command) are
964c609719bSwdenk		echoed back. This might be needed by some terminal
965c609719bSwdenk		emulations (like "cu"), but may as well just take
966c609719bSwdenk		time on others. This setting #define's the initial
967c609719bSwdenk		value of the "loads_echo" environment variable.
968c609719bSwdenk
969602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
970c609719bSwdenk		CONFIG_KGDB_BAUDRATE
971c609719bSwdenk		Select one of the baudrates listed in
9726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
973c609719bSwdenk
974c609719bSwdenk- Monitor Functions:
975602ad3b3SJon Loeliger		Monitor commands can be included or excluded
976602ad3b3SJon Loeliger		from the build by using the #include files
977c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
978ef0f2f57SJoe Hershberger		commands, or adding #define's for wanted commands.
979c609719bSwdenk
980602ad3b3SJon Loeliger		The default command configuration includes all commands
981602ad3b3SJon Loeliger		except those marked below with a "*".
982602ad3b3SJon Loeliger
983b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
984602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
985602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
986602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
987602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
988602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
989602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
990d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
991602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
99208d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
993602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
994710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
995602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
996602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
997602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
998a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
999a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
1000a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
1001a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
1002602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
1003602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
1004246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
1005602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
1006*aa9e6044SNikita Kiryanov		CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
1007602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
10085e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
1009fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
101088733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
10110c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
101203e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
101303e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
101416f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
101516f4d933SStephen Warren					  that work for multiple fs types
101659e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
1017bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
1018602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
101903e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
1020602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
1021602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
10224d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
102353fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1024a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1025a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1026bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1027602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1028602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1029602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
10308fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
10314d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1032602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
1033aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
10340c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1035c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1036602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1037602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1038602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1039602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
10404d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1041d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1042d22c338eSJoe Hershberger					  (169.254.*.*)
1043602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1044602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
10454d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
104602c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
104715a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1048602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1049a2681707SWolfgang Denk					  loop, loopw
10504d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1051602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1052602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1053602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
105468d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1055602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1056602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
10574d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1058e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1059e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1060602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1061602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1062602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1063602ad3b3SJon Loeliger					  host
1064602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1065ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1066602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1067602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1068d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1069602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1070c649e3c9SSimon Glass		CONFIG_SCSI		* SCSI Support
1071602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1072602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1073602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1074602ad3b3SJon Loeliger					  (4xx only)
1075f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10764d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
107702c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10787d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
107974de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1080602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10817a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10821fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1083da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1084da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1085602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1086602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1087c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10884d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
108989c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1090c609719bSwdenk
1091c609719bSwdenk		EXAMPLE: If you want all functions except of network
1092c609719bSwdenk		support you can write:
1093c609719bSwdenk
1094602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1095602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1096c609719bSwdenk
1097213bf8c8SGerald Van Baren	Other Commands:
1098213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1099c609719bSwdenk
1100c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1101602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1102c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1103c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1104c609719bSwdenk		8260 (where accesses to the IMMR region must be
1105c609719bSwdenk		uncached), and it cannot be disabled on all other
1106c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1107c609719bSwdenk		initial stack and some data.
1108c609719bSwdenk
1109c609719bSwdenk
1110c609719bSwdenk		XXX - this list needs to get updated!
1111c609719bSwdenk
1112302a6487SSimon Glass- Removal of commands
1113302a6487SSimon Glass		If no commands are needed to boot, you can disable
1114302a6487SSimon Glass		CONFIG_CMDLINE to remove them. In this case, the command line
1115302a6487SSimon Glass		will not be available, and when U-Boot wants to execute the
1116302a6487SSimon Glass		boot command (on start-up) it will call board_run_command()
1117302a6487SSimon Glass		instead. This can reduce image size significantly for very
1118302a6487SSimon Glass		simple boot procedures.
1119302a6487SSimon Glass
1120a5ecbe62SWolfgang Denk- Regular expression support:
1121a5ecbe62SWolfgang Denk		CONFIG_REGEX
1122a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1123a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1124a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1125a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1126a5ecbe62SWolfgang Denk
112745ba8077SSimon Glass- Device tree:
112845ba8077SSimon Glass		CONFIG_OF_CONTROL
112945ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
113045ba8077SSimon Glass		to configure its devices, instead of relying on statically
113145ba8077SSimon Glass		compiled #defines in the board file. This option is
113245ba8077SSimon Glass		experimental and only available on a few boards. The device
113345ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
113445ba8077SSimon Glass
11352c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
11362c0f79e4SSimon Glass		be done using one of the two options below:
1137bbb0b128SSimon Glass
1138bbb0b128SSimon Glass		CONFIG_OF_EMBED
1139bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1140bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1141bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1142bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1143bbb0b128SSimon Glass		the global data structure as gd->blob.
114445ba8077SSimon Glass
11452c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
11462c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
11472c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
11482c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
11492c0f79e4SSimon Glass
11502c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
11512c0f79e4SSimon Glass
11522c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
11532c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
11542c0f79e4SSimon Glass		still use the individual files if you need something more
11552c0f79e4SSimon Glass		exotic.
11562c0f79e4SSimon Glass
1157c609719bSwdenk- Watchdog:
1158c609719bSwdenk		CONFIG_WATCHDOG
1159c609719bSwdenk		If this variable is defined, it enables watchdog
11606abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
11616abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
11626abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
11636abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
11646abe6fb6SDetlev Zundel		available, then no further board specific code should
11656abe6fb6SDetlev Zundel		be needed to use it.
11666abe6fb6SDetlev Zundel
11676abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
11686abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
11696abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
11706abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1171c609719bSwdenk
11727bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
11737bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
11747bae0d6fSHeiko Schocher
1175c1551ea8Sstroese- U-Boot Version:
1176c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1177c1551ea8Sstroese		If this variable is defined, an environment variable
1178c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1179c1551ea8Sstroese		version as printed by the "version" command.
1180a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1181a1ea8e51SBenoît Thébaudeau		next reset.
1182c1551ea8Sstroese
1183c609719bSwdenk- Real-Time Clock:
1184c609719bSwdenk
1185602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1186c609719bSwdenk		has to be selected, too. Define exactly one of the
1187c609719bSwdenk		following options:
1188c609719bSwdenk
1189c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1190c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11914e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1192c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11931cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1194c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11957f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1196412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
11973bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11989536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11994c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
12006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
120171d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
120271d19f30SHeiko Schocher					  RV3029 RTC.
1203c609719bSwdenk
1204b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1205b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1206b37c7e5eSwdenk
1207e92739d3SPeter Tyser- GPIO Support:
1208e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1209e92739d3SPeter Tyser
12105dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
12115dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
12125dec49caSChris Packham		pins supported by a particular chip.
12135dec49caSChris Packham
1214e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1215e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1216e92739d3SPeter Tyser
1217aa53233aSSimon Glass- I/O tracing:
1218aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1219aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1220aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1221aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1222aa53233aSSimon Glass		the driver behaves the same way before and after a code
1223aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1224aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1225aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1226aa53233aSSimon Glass
1227aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1228aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1229aa53233aSSimon Glass		still continue to operate.
1230aa53233aSSimon Glass
1231aa53233aSSimon Glass			iotrace is enabled
1232aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1233aa53233aSSimon Glass			Size:   00010000	(buffer size)
1234aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1235aa53233aSSimon Glass			Output: 10000120	(start + offset)
1236aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1237aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1238aa53233aSSimon Glass
1239c609719bSwdenk- Timestamp Support:
1240c609719bSwdenk
1241c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1242c609719bSwdenk		(date and time) of an image is printed by image
1243c609719bSwdenk		commands like bootm or iminfo. This option is
1244602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1245c609719bSwdenk
1246923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1247923c46f9SKarl O. Pinc		Zero or more of the following:
1248923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1249923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1250923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1251923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1252923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1253923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1254923c46f9SKarl O. Pinc				       disk/part_efi.c
1255923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1256c609719bSwdenk
1257602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1258c649e3c9SSimon Glass		CONFIG_SCSI) you must configure support for at
1259923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1260c609719bSwdenk
1261c609719bSwdenk- IDE Reset method:
12624d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
12634d13cbadSwdenk		board configurations files but used nowhere!
1264c609719bSwdenk
12654d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
12664d13cbadSwdenk		be performed by calling the function
12674d13cbadSwdenk			ide_set_reset(int reset)
12684d13cbadSwdenk		which has to be defined in a board specific file
1269c609719bSwdenk
1270c609719bSwdenk- ATAPI Support:
1271c609719bSwdenk		CONFIG_ATAPI
1272c609719bSwdenk
1273c609719bSwdenk		Set this to enable ATAPI support.
1274c609719bSwdenk
1275c40b2956Swdenk- LBA48 Support
1276c40b2956Swdenk		CONFIG_LBA48
1277c40b2956Swdenk
1278c40b2956Swdenk		Set this to enable support for disks larger than 137GB
12794b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1280c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1281c40b2956Swdenk		support disks up to 2.1TB.
1282c40b2956Swdenk
12836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1284c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1285c40b2956Swdenk			Default is 32bit.
1286c40b2956Swdenk
1287c609719bSwdenk- SCSI Support:
1288c609719bSwdenk		At the moment only there is only support for the
1289c609719bSwdenk		SYM53C8XX SCSI controller; define
1290c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1291c609719bSwdenk
12926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
12936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
12946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1295c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1296c609719bSwdenk		devices.
12976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1298c609719bSwdenk
1299447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1300447c031bSStefan Reinauer		SCSI devices found during the last scan.
1301447c031bSStefan Reinauer
1302c609719bSwdenk- NETWORK Support (PCI):
1303682011ffSwdenk		CONFIG_E1000
1304ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1305ce5207e1SKyle Moffett
1306ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1307ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1308ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1309ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1310ce5207e1SKyle Moffett
1311ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1312ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1313ce5207e1SKyle Moffett		example with the "sspi" command.
1314ce5207e1SKyle Moffett
1315ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1316ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1317ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1318682011ffSwdenk
1319c609719bSwdenk		CONFIG_EEPRO100
1320c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
132111ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1322c609719bSwdenk		write routine for first time initialisation.
1323c609719bSwdenk
1324c609719bSwdenk		CONFIG_TULIP
1325c609719bSwdenk		Support for Digital 2114x chips.
1326c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1327c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1328c609719bSwdenk
1329c609719bSwdenk		CONFIG_NATSEMI
1330c609719bSwdenk		Support for National dp83815 chips.
1331c609719bSwdenk
1332c609719bSwdenk		CONFIG_NS8382X
1333c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1334c609719bSwdenk
133545219c46Swdenk- NETWORK Support (other):
133645219c46Swdenk
1337c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1338c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1339c041e9d2SJens Scharsig
1340c041e9d2SJens Scharsig			CONFIG_RMII
1341c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1342c041e9d2SJens Scharsig
1343c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1344c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1345c041e9d2SJens Scharsig			The driver doen't show link status messages.
1346c041e9d2SJens Scharsig
1347efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1348efdd7319SRob Herring		Support for the Calxeda XGMAC device
1349efdd7319SRob Herring
13503bb46d23SAshok		CONFIG_LAN91C96
135145219c46Swdenk		Support for SMSC's LAN91C96 chips.
135245219c46Swdenk
135345219c46Swdenk			CONFIG_LAN91C96_BASE
135445219c46Swdenk			Define this to hold the physical address
135545219c46Swdenk			of the LAN91C96's I/O space
135645219c46Swdenk
135745219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
135845219c46Swdenk			Define this to enable 32 bit addressing
135945219c46Swdenk
13603bb46d23SAshok		CONFIG_SMC91111
1361f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1362f39748aeSwdenk
1363f39748aeSwdenk			CONFIG_SMC91111_BASE
1364f39748aeSwdenk			Define this to hold the physical address
1365f39748aeSwdenk			of the device (I/O space)
1366f39748aeSwdenk
1367f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1368f39748aeSwdenk			Define this if data bus is 32 bits
1369f39748aeSwdenk
1370f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1371f39748aeSwdenk			Define this to use i/o functions instead of macros
1372f39748aeSwdenk			(some hardware wont work with macros)
1373f39748aeSwdenk
1374dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1375dc02badaSHeiko Schocher		Support for davinci emac
1376dc02badaSHeiko Schocher
1377dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1378dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1379dc02badaSHeiko Schocher
1380b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1381b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1382b3dbf4a5SMacpaul Lin
1383b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1384b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1385b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1386b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1387b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1388b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1389b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1390b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1391b3dbf4a5SMacpaul Lin
1392c2fff331SMike Rapoport		CONFIG_SMC911X
1393557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1394557b377dSJens Gehrlein
1395c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1396557b377dSJens Gehrlein			Define this to hold the physical address
1397557b377dSJens Gehrlein			of the device (I/O space)
1398557b377dSJens Gehrlein
1399c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1400557b377dSJens Gehrlein			Define this if data bus is 32 bits
1401557b377dSJens Gehrlein
1402c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1403557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1404557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1405c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1406557b377dSJens Gehrlein
14073d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
14083d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
14093d0075faSYoshihiro Shimoda
14103d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
14113d0075faSYoshihiro Shimoda			Define the number of ports to be used
14123d0075faSYoshihiro Shimoda
14133d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
14143d0075faSYoshihiro Shimoda			Define the ETH PHY's address
14153d0075faSYoshihiro Shimoda
141668260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
141768260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
141868260aabSYoshihiro Shimoda
1419b2f97cf2SHeiko Schocher- PWM Support:
1420b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1421b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1422b2f97cf2SHeiko Schocher
14235e124724SVadim Bendebury- TPM Support:
142490899cc0SChe-liang Chiou		CONFIG_TPM
142590899cc0SChe-liang Chiou		Support TPM devices.
142690899cc0SChe-liang Chiou
14270766ad2fSChristophe Ricard		CONFIG_TPM_TIS_INFINEON
14280766ad2fSChristophe Ricard		Support for Infineon i2c bus TPM devices. Only one device
14291b393db5STom Wai-Hong Tam		per system is supported at this time.
14301b393db5STom Wai-Hong Tam
14311b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
14321b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
14331b393db5STom Wai-Hong Tam
14343aa74088SChristophe Ricard		CONFIG_TPM_ST33ZP24
14353aa74088SChristophe Ricard		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
14363aa74088SChristophe Ricard
14373aa74088SChristophe Ricard			CONFIG_TPM_ST33ZP24_I2C
14383aa74088SChristophe Ricard			Support for STMicroelectronics ST33ZP24 I2C devices.
14393aa74088SChristophe Ricard			Requires TPM_ST33ZP24 and I2C.
14403aa74088SChristophe Ricard
1441b75fdc11SChristophe Ricard			CONFIG_TPM_ST33ZP24_SPI
1442b75fdc11SChristophe Ricard			Support for STMicroelectronics ST33ZP24 SPI devices.
1443b75fdc11SChristophe Ricard			Requires TPM_ST33ZP24 and SPI.
1444b75fdc11SChristophe Ricard
1445c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1446c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1447c01939c7SDirk Eibach
144890899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
14495e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
14505e124724SVadim Bendebury		per system is supported at this time.
14515e124724SVadim Bendebury
14525e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
14535e124724SVadim Bendebury			Base address where the generic TPM device is mapped
14545e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
14555e124724SVadim Bendebury			0xfed40000.
14565e124724SVadim Bendebury
1457be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1458be6c1529SReinhard Pfau		Add tpm monitor functions.
1459be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1460be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1461be6c1529SReinhard Pfau
1462be6c1529SReinhard Pfau		CONFIG_TPM
1463be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1464be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1465be6c1529SReinhard Pfau		Requires support for a TPM device.
1466be6c1529SReinhard Pfau
1467be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1468be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1469be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1470be6c1529SReinhard Pfau
1471c609719bSwdenk- USB Support:
1472c609719bSwdenk		At the moment only the UHCI host controller is
14734d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1474c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1475c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
147630d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1477c609719bSwdenk		storage devices.
1478c609719bSwdenk		Note:
1479c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1480c609719bSwdenk		(TEAC FD-05PUB).
14814d13cbadSwdenk		MPC5200 USB requires additional defines:
14824d13cbadSwdenk			CONFIG_USB_CLOCK
14834d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1484307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1485307ecb6dSEric Millbrandt				for USB on PSC3
14864d13cbadSwdenk			CONFIG_USB_CONFIG
14874d13cbadSwdenk				for differential drivers: 0x00001000
14884d13cbadSwdenk				for single ended drivers: 0x00005000
1489307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1490307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
14916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1492fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1493fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
14944d13cbadSwdenk
14959ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
14969ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
14979ab4ce22SSimon Glass
14986e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
14996e9e0626SOleksandr Tymoshenko		HW module registers.
15006e9e0626SOleksandr Tymoshenko
150116c8d5e7SWolfgang Denk- USB Device:
150216c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
150316c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
150416c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
150511ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
150616c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
150716c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
150816c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
150916c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
151016c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
151116c8d5e7SWolfgang Denk		a Linux host by
151216c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
151316c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
151416c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
151516c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
151616c8d5e7SWolfgang Denk
151716c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
151816c8d5e7SWolfgang Denk			Define this to build a UDC device
151916c8d5e7SWolfgang Denk
152016c8d5e7SWolfgang Denk			CONFIG_USB_TTY
152116c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
152216c8d5e7SWolfgang Denk			talk to the UDC device
152316c8d5e7SWolfgang Denk
1524f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1525f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1526f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1527f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1528f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1529f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1530f9da0f89SVipin KUMAR			speed.
1531f9da0f89SVipin KUMAR
15326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
153316c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
153416c8d5e7SWolfgang Denk			be set to usbtty.
153516c8d5e7SWolfgang Denk
153616c8d5e7SWolfgang Denk			mpc8xx:
15376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
153816c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
15396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
154016c8d5e7SWolfgang Denk
15416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
154216c8d5e7SWolfgang Denk				Derive USB clock from brgclk
15436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
154416c8d5e7SWolfgang Denk
154516c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
154616c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
154716c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
154816c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
154916c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
155016c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
155116c8d5e7SWolfgang Denk
155216c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
155316c8d5e7SWolfgang Denk			Define this string as the name of your company for
155416c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
155516c8d5e7SWolfgang Denk
155616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
155716c8d5e7SWolfgang Denk			Define this string as the name of your product
155816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
155916c8d5e7SWolfgang Denk
156016c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
156116c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
156216c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
156316c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
156416c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
156516c8d5e7SWolfgang Denk
156616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
156716c8d5e7SWolfgang Denk			Define this as the unique Product ID
156816c8d5e7SWolfgang Denk			for your device
156916c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1570c609719bSwdenk
1571d70a560fSIgor Grinberg- ULPI Layer Support:
1572d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1573d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1574d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1575d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1576d70a560fSIgor Grinberg		viewport is supported.
1577d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1578d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
15796d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
15806d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
15816d365ea0SLucas Stach		the appropriate value in Hz.
1582c609719bSwdenk
1583c609719bSwdenk- MMC Support:
1584c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1585c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1586c609719bSwdenk		accessed from the boot prompt by mapping the device
1587c609719bSwdenk		to physical memory similar to flash. Command line is
1588602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1589602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1590c609719bSwdenk
1591afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1592afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1593afb35666SYoshihiro Shimoda
1594afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1595afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1596afb35666SYoshihiro Shimoda
1597afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1598afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1599afb35666SYoshihiro Shimoda
16001fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
16011fd93c6eSPierre Aubert		Enable the generic MMC driver
16021fd93c6eSPierre Aubert
16031fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
16041fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
16051fd93c6eSPierre Aubert
16061fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
16071fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
16081fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
16091fd93c6eSPierre Aubert
1610b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
161101acd6abSPaul Kocialkowski		CONFIG_USB_FUNCTION_DFU
1612b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1613b3ba6e94STom Rini
1614b3ba6e94STom Rini		CONFIG_CMD_DFU
1615b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1616b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1617b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1618b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1619b3ba6e94STom Rini
1620b3ba6e94STom Rini		CONFIG_DFU_MMC
1621b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1622b3ba6e94STom Rini
1623c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1624c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1625c6631764SPantelis Antoniou
1626a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1627a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1628a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1629a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1630a9479f04SAfzal Mohammed		one that would help mostly the developer.
1631a9479f04SAfzal Mohammed
1632e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1633e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1634e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1635e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1636e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1637e7e75c70SHeiko Schocher
1638ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1639ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1640ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1641ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1642ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1643ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1644ea2453d5SPantelis Antoniou
1645001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1646001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1647001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1648001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1649001a8319SHeiko Schocher
1650001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1651001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1652001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1653001a8319SHeiko Schocher		sending again an USB request to the device.
1654001a8319SHeiko Schocher
16553aab70afSSebastian Siewior- USB Device Android Fastboot support:
165617da3c0cSPaul Kocialkowski		CONFIG_USB_FUNCTION_FASTBOOT
165717da3c0cSPaul Kocialkowski		This enables the USB part of the fastboot gadget
165817da3c0cSPaul Kocialkowski
16593aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
16603aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
16613aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
16623aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
16633aab70afSSebastian Siewior		used on Android devices.
16643aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
16653aab70afSSebastian Siewior
16663aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
16673aab70afSSebastian Siewior		This enables support for booting images which use the Android
16683aab70afSSebastian Siewior		image format header.
16693aab70afSSebastian Siewior
1670a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_ADDR
16713aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
16723aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
16733aab70afSSebastian Siewior		downloaded images.
16743aab70afSSebastian Siewior
1675a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_SIZE
16763aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
16773aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
16783aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
16793aab70afSSebastian Siewior
1680d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1681d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1682d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1683d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1684d1b5ed07SSteve Rae
1685d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1686d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1687d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1688d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1689d1b5ed07SSteve Rae
16900ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
16910ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
16920ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
16930ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
16940ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
16950ff7e585SSteve Rae		This occurs when the specified "partition name" on the
16960ff7e585SSteve Rae		"fastboot flash" command line matches this value.
16970ff7e585SSteve Rae		Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
16980ff7e585SSteve Rae
16996705d81eSwdenk- Journaling Flash filesystem support:
17006705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
17016705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
17026705d81eSwdenk		Define these for a default partition on a NAND device
17036705d81eSwdenk
17046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
17056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
17066705d81eSwdenk		Define these for a default partition on a NOR device
17076705d81eSwdenk
17086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
17096705d81eSwdenk		Define this to create an own partition. You have to provide a
17106705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
17116705d81eSwdenk
17126705d81eSwdenk		If you define only one JFFS2 partition you may also want to
17136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
17146705d81eSwdenk		to disable the command chpart. This is the default when you
17156705d81eSwdenk		have not defined a custom partition
17166705d81eSwdenk
1717c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1718c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1719656f4c65SDonggeun Kim
1720656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1721656f4c65SDonggeun Kim		file in FAT formatted partition.
1722656f4c65SDonggeun Kim
1723656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1724656f4c65SDonggeun Kim		user to write files to FAT.
1725c30a15e5SDonggeun Kim
172684cd9327SGabe BlackCBFS (Coreboot Filesystem) support
172784cd9327SGabe Black		CONFIG_CMD_CBFS
172884cd9327SGabe Black
172984cd9327SGabe Black		Define this to enable support for reading from a Coreboot
173084cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
173184cd9327SGabe Black		and cbfsload.
173284cd9327SGabe Black
17334f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
17344f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
17354f0d1a2aSSiva Durga Prasad Paladugu
17364f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
17374f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
17384f0d1a2aSSiva Durga Prasad Paladugu
1739c609719bSwdenk- Keyboard Support:
174039f615edSSimon Glass		See Kconfig help for available keyboard drivers.
174139f615edSSimon Glass
174239f615edSSimon Glass		CONFIG_KEYBOARD
174339f615edSSimon Glass
174439f615edSSimon Glass		Define this to enable a custom keyboard support.
174539f615edSSimon Glass		This simply calls drv_keyboard_init() which must be
174639f615edSSimon Glass		defined in your board-specific files. This option is deprecated
174739f615edSSimon Glass		and is only used by novena. For new boards, use driver model
174839f615edSSimon Glass		instead.
1749c609719bSwdenk
1750c609719bSwdenk- Video support:
1751c609719bSwdenk		CONFIG_VIDEO
1752c609719bSwdenk
1753c609719bSwdenk		Define this to enable video support (for output to
1754c609719bSwdenk		video).
1755c609719bSwdenk
1756c609719bSwdenk		CONFIG_VIDEO_CT69000
1757c609719bSwdenk
1758c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1759c609719bSwdenk
1760c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1761eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1762eeb1b77bSwdenk		video output is selected via environment 'videoout'
1763eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1764eeb1b77bSwdenk		assumed.
1765c609719bSwdenk
1766eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
176711ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1768eeb1b77bSwdenk		are possible:
1769eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1770eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1771eeb1b77bSwdenk
1772eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1773eeb1b77bSwdenk		-------------+---------------------------------------------
1774eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1775eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1776eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1777eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1778eeb1b77bSwdenk		-------------+---------------------------------------------
1779c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1780c609719bSwdenk
1781eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
17827817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1783eeb1b77bSwdenk
1784eeb1b77bSwdenk
1785a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1786a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1787a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1788a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1789a6c7ad2fSwdenk
17907d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
17917d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
17927d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
17937d3053fbSTimur Tabi		support, and should also define these other macros:
17947d3053fbSTimur Tabi
17957d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
17967d3053fbSTimur Tabi			CONFIG_VIDEO
17977d3053fbSTimur Tabi			CONFIG_CMD_BMP
17987d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
17997d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
18007d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
18017d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
18027d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
18037d3053fbSTimur Tabi
1804ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1805ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
18068eca9439SFabio Estevam		boot.  See the documentation file doc/README.video for a
1807ba8e76bdSTimur Tabi		description of this variable.
18087d3053fbSTimur Tabi
1809c609719bSwdenk- LCD Support:	CONFIG_LCD
1810c609719bSwdenk
1811c609719bSwdenk		Define this to enable LCD support (for output to LCD
1812c609719bSwdenk		display); also select one of the supported displays
1813c609719bSwdenk		by defining one of these:
1814c609719bSwdenk
181539cf4804SStelian Pop		CONFIG_ATMEL_LCD:
181639cf4804SStelian Pop
181739cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
181839cf4804SStelian Pop
1819fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1820c609719bSwdenk
1821fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1822c609719bSwdenk
1823fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1824c609719bSwdenk
1825fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1826fd3103bbSwdenk			Active, color, single scan.
1827fd3103bbSwdenk
1828fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1829fd3103bbSwdenk
1830fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1831c609719bSwdenk			Active, color, single scan.
1832c609719bSwdenk
1833c609719bSwdenk		CONFIG_SHARP_16x9
1834c609719bSwdenk
1835c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1836c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1837c609719bSwdenk
1838c609719bSwdenk		CONFIG_SHARP_LQ64D341
1839c609719bSwdenk
1840c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1841c609719bSwdenk			Active, color, single scan.
1842c609719bSwdenk
1843c609719bSwdenk		CONFIG_HLD1045
1844c609719bSwdenk
1845c609719bSwdenk			HLD1045 display, 640x480.
1846c609719bSwdenk			Active, color, single scan.
1847c609719bSwdenk
1848c609719bSwdenk		CONFIG_OPTREX_BW
1849c609719bSwdenk
1850c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1851c609719bSwdenk			or
1852c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1853c609719bSwdenk			or
1854c609719bSwdenk			Hitachi	 SP14Q002
1855c609719bSwdenk
1856c609719bSwdenk			320x240. Black & white.
1857c609719bSwdenk
1858c609719bSwdenk		Normally display is black on white background; define
18596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1860c609719bSwdenk
1861676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1862676d319eSSimon Glass
1863b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1864676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1865676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1866676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1867676d319eSSimon Glass		a per-section basis.
1868676d319eSSimon Glass
18690d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
18700d89efefSSimon Glass
18710d89efefSSimon Glass		When the console need to be scrolled, this is the number of
18720d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
18730d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
18740d89efefSSimon Glass		is slow.
1875676d319eSSimon Glass
1876604c7d4aSHannes Petermaier		CONFIG_LCD_ROTATION
1877604c7d4aSHannes Petermaier
1878604c7d4aSHannes Petermaier		Sometimes, for example if the display is mounted in portrait
1879604c7d4aSHannes Petermaier		mode or even if it's mounted landscape but rotated by 180degree,
1880604c7d4aSHannes Petermaier		we need to rotate our content of the display relative to the
1881604c7d4aSHannes Petermaier		framebuffer, so that user can read the messages which are
1882604c7d4aSHannes Petermaier		printed out.
1883604c7d4aSHannes Petermaier		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1884604c7d4aSHannes Petermaier		initialized with a given rotation from "vl_rot" out of
1885604c7d4aSHannes Petermaier		"vidinfo_t" which is provided by the board specific code.
1886604c7d4aSHannes Petermaier		The value for vl_rot is coded as following (matching to
1887604c7d4aSHannes Petermaier		fbcon=rotate:<n> linux-kernel commandline):
1888604c7d4aSHannes Petermaier		0 = no rotation respectively 0 degree
1889604c7d4aSHannes Petermaier		1 = 90 degree rotation
1890604c7d4aSHannes Petermaier		2 = 180 degree rotation
1891604c7d4aSHannes Petermaier		3 = 270 degree rotation
1892604c7d4aSHannes Petermaier
1893604c7d4aSHannes Petermaier		If CONFIG_LCD_ROTATION is not defined, the console will be
1894604c7d4aSHannes Petermaier		initialized with 0degree rotation.
1895604c7d4aSHannes Petermaier
189645d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
189745d7f525STom Wai-Hong Tam
189845d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
189945d7f525STom Wai-Hong Tam
1900735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1901735987c5STom Wai-Hong Tam
1902735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1903735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1904735987c5STom Wai-Hong Tam
19057152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1906d791b1dcSwdenk
1907d791b1dcSwdenk		If this option is set, the environment is checked for
1908d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1909d791b1dcSwdenk		of logo, copyright and system information on the LCD
1910e94d2cd9Swdenk		is suppressed and the BMP image at the address
1911d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1912d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1913d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1914d791b1dcSwdenk		loaded very quickly after power-on.
1915d791b1dcSwdenk
1916c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1917c0880485SNikita Kiryanov
1918c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1919c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1920ab5645f1SFabio Estevam		(see doc/README.displaying-bmps).
1921c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1922c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1923c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1924c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1925c0880485SNikita Kiryanov		there is no need to set this option.
1926c0880485SNikita Kiryanov
19271ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
19281ca298ceSMatthias Weisser
19291ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
19301ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
19311ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
19321ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
19331ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
19341ca298ceSMatthias Weisser		specify 'm' for centering the image.
19351ca298ceSMatthias Weisser
19361ca298ceSMatthias Weisser		Example:
19371ca298ceSMatthias Weisser		setenv splashpos m,m
19381ca298ceSMatthias Weisser			=> image at center of screen
19391ca298ceSMatthias Weisser
19401ca298ceSMatthias Weisser		setenv splashpos 30,20
19411ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
19421ca298ceSMatthias Weisser
19431ca298ceSMatthias Weisser		setenv splashpos -10,m
19441ca298ceSMatthias Weisser			=> vertically centered image
19451ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
19461ca298ceSMatthias Weisser
194798f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
194898f4a3dfSStefan Roese
194998f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
195098f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
195198f4a3dfSStefan Roese		splashscreen support or the bmp command.
195298f4a3dfSStefan Roese
1953d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1954d5011762SAnatolij Gustschin
1955d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1956d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1957d5011762SAnatolij Gustschin		bmp command.
1958d5011762SAnatolij Gustschin
1959b445bbb4SJeremiah Mahler- Do compressing for memory range:
1960f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1961f2b96dfbSLei Wen
1962f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1963f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1964f2b96dfbSLei Wen
1965c29fdfc1Swdenk- Compression support:
19668ef70478SKees Cook		CONFIG_GZIP
19678ef70478SKees Cook
19688ef70478SKees Cook		Enabled by default to support gzip compressed images.
19698ef70478SKees Cook
1970c29fdfc1Swdenk		CONFIG_BZIP2
1971c29fdfc1Swdenk
1972c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1973c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1974c29fdfc1Swdenk		compressed images are supported.
1975c29fdfc1Swdenk
1976c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
19776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1978c29fdfc1Swdenk		be at least 4MB.
1979d791b1dcSwdenk
1980fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1981fc9c1727SLuigi 'Comio' Mantellini
1982fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1983fc9c1727SLuigi 'Comio' Mantellini		images is included.
1984fc9c1727SLuigi 'Comio' Mantellini
1985fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1986fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1987fc9c1727SLuigi 'Comio' Mantellini		formula:
1988fc9c1727SLuigi 'Comio' Mantellini
1989fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1990fc9c1727SLuigi 'Comio' Mantellini
1991fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1992fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1993fc9c1727SLuigi 'Comio' Mantellini
1994fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1995fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1996fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1997fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1998fc9c1727SLuigi 'Comio' Mantellini
1999fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
2000fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
20016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
2002fc9c1727SLuigi 'Comio' Mantellini
20038ef70478SKees Cook		CONFIG_LZO
20048ef70478SKees Cook
20058ef70478SKees Cook		If this option is set, support for LZO compressed images
20068ef70478SKees Cook		is included.
20078ef70478SKees Cook
200817ea1177Swdenk- MII/PHY support:
200917ea1177Swdenk		CONFIG_PHY_ADDR
201017ea1177Swdenk
201117ea1177Swdenk		The address of PHY on MII bus.
201217ea1177Swdenk
201317ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
201417ea1177Swdenk
201517ea1177Swdenk		The clock frequency of the MII bus
201617ea1177Swdenk
201717ea1177Swdenk		CONFIG_PHY_GIGE
201817ea1177Swdenk
201917ea1177Swdenk		If this option is set, support for speed/duplex
202011ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
202117ea1177Swdenk
202217ea1177Swdenk		CONFIG_PHY_RESET_DELAY
202317ea1177Swdenk
202417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
202517ea1177Swdenk		reset before any MII register access is possible.
202617ea1177Swdenk		For such PHY, set this option to the usec delay
202717ea1177Swdenk		required. (minimum 300usec for LXT971A)
202817ea1177Swdenk
202917ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
203017ea1177Swdenk
203117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
203217ea1177Swdenk		command issued before MII status register can be read
203317ea1177Swdenk
2034c609719bSwdenk- IP address:
2035c609719bSwdenk		CONFIG_IPADDR
2036c609719bSwdenk
2037c609719bSwdenk		Define a default value for the IP address to use for
203811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
2039c609719bSwdenk		determined through e.g. bootp.
20401ebcd654SWolfgang Denk		(Environment variable "ipaddr")
2041c609719bSwdenk
2042c609719bSwdenk- Server IP address:
2043c609719bSwdenk		CONFIG_SERVERIP
2044c609719bSwdenk
2045c609719bSwdenk		Defines a default value for the IP address of a TFTP
2046c609719bSwdenk		server to contact when using the "tftboot" command.
20471ebcd654SWolfgang Denk		(Environment variable "serverip")
2048c609719bSwdenk
204997cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
205097cfe861SRobin Getz
205197cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
205297cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
205397cfe861SRobin Getz
20541ebcd654SWolfgang Denk- Gateway IP address:
20551ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
20561ebcd654SWolfgang Denk
20571ebcd654SWolfgang Denk		Defines a default value for the IP address of the
20581ebcd654SWolfgang Denk		default router where packets to other networks are
20591ebcd654SWolfgang Denk		sent to.
20601ebcd654SWolfgang Denk		(Environment variable "gatewayip")
20611ebcd654SWolfgang Denk
20621ebcd654SWolfgang Denk- Subnet mask:
20631ebcd654SWolfgang Denk		CONFIG_NETMASK
20641ebcd654SWolfgang Denk
20651ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
20661ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
20671ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
20681ebcd654SWolfgang Denk		forwarded through a router.
20691ebcd654SWolfgang Denk		(Environment variable "netmask")
20701ebcd654SWolfgang Denk
207153a5c424SDavid Updegraff- Multicast TFTP Mode:
207253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
207353a5c424SDavid Updegraff
207453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
207553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
207611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
207753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
207853a5c424SDavid Updegraff		multicast group.
207953a5c424SDavid Updegraff
2080c609719bSwdenk- BOOTP Recovery Mode:
2081c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2082c609719bSwdenk
2083c609719bSwdenk		If you have many targets in a network that try to
2084c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2085c609719bSwdenk		systems send out BOOTP requests at precisely the same
2086c609719bSwdenk		moment (which would happen for instance at recovery
2087c609719bSwdenk		from a power failure, when all systems will try to
2088c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2089c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2090c609719bSwdenk		inserted before sending out BOOTP requests. The
20916c33c785SWolfgang Denk		following delays are inserted then:
2092c609719bSwdenk
2093c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2094c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2095c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2096c609719bSwdenk		4th and following
2097c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2098c609719bSwdenk
209992ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
210092ac8accSThierry Reding
210192ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
210292ac8accSThierry Reding		server will copy the ID from client requests to responses and
210392ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
210492ac8accSThierry Reding		an incoming response. Some servers will check that addresses
210592ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
210692ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
210792ac8accSThierry Reding		respond. Network congestion may also influence the time it
210892ac8accSThierry Reding		takes for a response to make it back to the client. If that
210992ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
211092ac8accSThierry Reding		to allow earlier responses to still be accepted after these
211192ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
211292ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
211392ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
211492ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
211592ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
211692ac8accSThierry Reding
2117fe389a82Sstroese- DHCP Advanced Options:
21181fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
21191fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2120fe389a82Sstroese
21211fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
21221fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
21231fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
21241fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
21251fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
21261fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
21271fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
21281fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
21291fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
21301fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
21311fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
21321fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
21332c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2134fe389a82Sstroese
21355d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
21365d110f0aSWilson Callan		environment variable, not the BOOTP server.
2137fe389a82Sstroese
21382c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
21392c00e099SJoe Hershberger		after the configured retry count, the call will fail
21402c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
21412c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
21422c00e099SJoe Hershberger		is not available.
21432c00e099SJoe Hershberger
2144fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2145fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2146fe389a82Sstroese		than one DNS serverip is offered to the client.
2147fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2148fe389a82Sstroese		serverip will be stored in the additional environment
2149fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2150fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
21511fe80d79SJon Loeliger		is defined.
2152fe389a82Sstroese
2153fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2154fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2155fe389a82Sstroese		need the hostname of the DHCP requester.
21565d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
21571fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
21581fe80d79SJon Loeliger		option 12 to the DHCP server.
2159fe389a82Sstroese
2160d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2161d9a2f416SAras Vaichas
2162d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2163d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2164d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2165d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2166d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2167d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2168d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2169d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2170d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2171d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2172d9a2f416SAras Vaichas		this delay.
2173d9a2f416SAras Vaichas
2174d22c338eSJoe Hershberger - Link-local IP address negotiation:
2175d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2176d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2177d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2178d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2179d22c338eSJoe Hershberger
2180d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2181d22c338eSJoe Hershberger
2182a3d991bdSwdenk - CDP Options:
2183a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2184a3d991bdSwdenk
2185a3d991bdSwdenk		The device id used in CDP trigger frames.
2186a3d991bdSwdenk
2187a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2188a3d991bdSwdenk
2189a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2190a3d991bdSwdenk		of the device.
2191a3d991bdSwdenk
2192a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2193a3d991bdSwdenk
2194a3d991bdSwdenk		A printf format string which contains the ascii name of
2195a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
219611ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2197a3d991bdSwdenk
2198a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2199a3d991bdSwdenk
2200a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2201a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2202a3d991bdSwdenk
2203a3d991bdSwdenk		CONFIG_CDP_VERSION
2204a3d991bdSwdenk
2205a3d991bdSwdenk		An ascii string containing the version of the software.
2206a3d991bdSwdenk
2207a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2208a3d991bdSwdenk
2209a3d991bdSwdenk		An ascii string containing the name of the platform.
2210a3d991bdSwdenk
2211a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2212a3d991bdSwdenk
2213a3d991bdSwdenk		A 32bit integer sent on the trigger.
2214a3d991bdSwdenk
2215a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2216a3d991bdSwdenk
2217a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2218a3d991bdSwdenk		device in .1 of milliwatts.
2219a3d991bdSwdenk
2220a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2221a3d991bdSwdenk
2222a3d991bdSwdenk		A byte containing the id of the VLAN.
2223a3d991bdSwdenk
2224c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2225c609719bSwdenk
2226c609719bSwdenk		Several configurations allow to display the current
2227c609719bSwdenk		status using a LED. For instance, the LED will blink
2228c609719bSwdenk		fast while running U-Boot code, stop blinking as
2229c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2230c609719bSwdenk		start blinking slow once the Linux kernel is running
2231c609719bSwdenk		(supported by a status LED driver in the Linux
2232c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2233c609719bSwdenk		feature in U-Boot.
2234c609719bSwdenk
22351df7bbbaSIgor Grinberg		Additional options:
22361df7bbbaSIgor Grinberg
22371df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
22381df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
22391df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
22401df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
22411df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
22421df7bbbaSIgor Grinberg
22439dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
22449dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
22459dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
22469dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
22479dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
22489dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
22499dfdcdfeSIgor Grinberg
2250c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2251c609719bSwdenk
2252c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2253c609719bSwdenk		on those systems that support this (optional)
2254c609719bSwdenk		feature, like the TQM8xxL modules.
2255c609719bSwdenk
22563f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2257c609719bSwdenk
22583f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
22593f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
22603f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
22613f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
22623f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
22633f4978c7SHeiko Schocher		interface.
22643f4978c7SHeiko Schocher
22653f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2266ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2267ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2268ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2269ea818dbbSHeiko Schocher		    for defining speed and slave address
2270ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2271ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2272ea818dbbSHeiko Schocher		    for defining speed and slave address
2273ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2274ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2275ea818dbbSHeiko Schocher		    for defining speed and slave address
2276ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2277ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2278ea818dbbSHeiko Schocher		    for defining speed and slave address
22793f4978c7SHeiko Schocher
228000f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
228100f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
228200f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
228300f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
228400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
228500f792e0SHeiko Schocher		    bus.
228600f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
228700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
228800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
228900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
229000f792e0SHeiko Schocher		    second bus.
229100f792e0SHeiko Schocher
22921f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
22931f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
22941f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
22951f2ba722SSimon Glass		    100000 and the slave addr 0!
22961f2ba722SSimon Glass
2297880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2298880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2299880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2300880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2301880540deSDirk Eibach
2302fac96408Strem		- drivers/i2c/i2c_mxc.c
2303fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
230403544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
230503544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
230603544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
230703544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
2308fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2309fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2310fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2311fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2312fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2313fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
231403544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
231503544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
2316b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
2317fac96408Strem		for speed, and 0 for slave.
2318fac96408Strem
23191086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
23201086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
23211086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
23221086bfa9SNobuhiro Iwamatsu
23231086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
23241086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
23251086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
23261086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
23271086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
23281086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
23291086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
23301086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
23311086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
23321086bfa9SNobuhiro Iwamatsu
23332035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
23342035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
23352035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
23362035d77dSNobuhiro Iwamatsu
23372035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
23382035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
23392035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
23402035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
23412035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
23422035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
23432035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
23442035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
23452035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
23462035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
23472035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
23482035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2349b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
23502035d77dSNobuhiro Iwamatsu
23516789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
23526789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
23536789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
23546789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
23556789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
23566789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
23576789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
23586789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
23596789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
23606789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
23616789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
23626789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
23636789e84eSHeiko Schocher
23640bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
23650bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
23660bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
23670bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
23680bdffe71SHeiko Schocher
2369e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2370e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2371e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2372e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2373e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2374e717fc6dSNaveen Krishna Ch
2375b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2376b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2377b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2378b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2379b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2380b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2381b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2382b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2383b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2384b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2385b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2386b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2387b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2388b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2389071be896SDirk Eibach		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2390071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2391071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2392071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2393071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2394071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2395071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2396071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2397071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
2398b46226bdSDirk Eibach
23993f4978c7SHeiko Schocher		additional defines:
24003f4978c7SHeiko Schocher
24013f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2402b445bbb4SJeremiah Mahler		Hold the number of i2c buses you want to use. If you
24033f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
24043f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
24053f4978c7SHeiko Schocher		omit this define.
24063f4978c7SHeiko Schocher
24073f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
24083f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
24093f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
24103f4978c7SHeiko Schocher		omit this define.
24113f4978c7SHeiko Schocher
24123f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
24133f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
24143f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
24153f4978c7SHeiko Schocher		define.
24163f4978c7SHeiko Schocher
24173f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2418b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
24193f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
24203f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
24213f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
24223f4978c7SHeiko Schocher
24233f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
24243f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
24253f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
24263f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
24273f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
24283f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
24293f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
24303f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
24313f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
24323f4978c7SHeiko Schocher					}
24333f4978c7SHeiko Schocher
24343f4978c7SHeiko Schocher		which defines
24353f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2436ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2437ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2438ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2439ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2440ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
24413f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2442ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2443ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
24443f4978c7SHeiko Schocher
24453f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
24463f4978c7SHeiko Schocher
2447ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
24483f4978c7SHeiko Schocher
24493f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
24503f4978c7SHeiko Schocher		provides the following compelling advantages:
24513f4978c7SHeiko Schocher
24523f4978c7SHeiko Schocher		- more than one i2c adapter is usable
24533f4978c7SHeiko Schocher		- approved multibus support
24543f4978c7SHeiko Schocher		- better i2c mux support
24553f4978c7SHeiko Schocher
24563f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
24573f4978c7SHeiko Schocher
2458ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2459ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2460ea818dbbSHeiko Schocher		for the selected CPU.
2461c609719bSwdenk
2462b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2463602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2464b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2465b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2466c609719bSwdenk		command line interface.
2467c609719bSwdenk
2468bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2469c609719bSwdenk
2470b37c7e5eSwdenk		There are several other quantities that must also be
2471ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2472c609719bSwdenk
24736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2474b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
24756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
247611ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2477c609719bSwdenk
24788d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2479a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
24808d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
24818d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
24828d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2483b37c7e5eSwdenk
24845da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
24855da71efaSEric Millbrandt
24865da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
24875da71efaSEric Millbrandt		chips might think that the current transfer is still
24885da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
24895da71efaSEric Millbrandt		commands until the slave device responds.
24905da71efaSEric Millbrandt
2491b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2492b37c7e5eSwdenk
2493ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2494b37c7e5eSwdenk		then the following macros need to be defined (examples are
2495b37c7e5eSwdenk		from include/configs/lwmon.h):
2496c609719bSwdenk
2497c609719bSwdenk		I2C_INIT
2498c609719bSwdenk
2499b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2500c609719bSwdenk		controller or configure ports.
2501c609719bSwdenk
2502b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2503b37c7e5eSwdenk
2504c609719bSwdenk		I2C_PORT
2505c609719bSwdenk
2506c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2507c609719bSwdenk		assumes both bits are on the same port). Valid values
2508c609719bSwdenk		are 0..3 for ports A..D.
2509c609719bSwdenk
2510c609719bSwdenk		I2C_ACTIVE
2511c609719bSwdenk
2512c609719bSwdenk		The code necessary to make the I2C data line active
2513c609719bSwdenk		(driven).  If the data line is open collector, this
2514c609719bSwdenk		define can be null.
2515c609719bSwdenk
2516b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2517b37c7e5eSwdenk
2518c609719bSwdenk		I2C_TRISTATE
2519c609719bSwdenk
2520c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2521c609719bSwdenk		(inactive).  If the data line is open collector, this
2522c609719bSwdenk		define can be null.
2523c609719bSwdenk
2524b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2525b37c7e5eSwdenk
2526c609719bSwdenk		I2C_READ
2527c609719bSwdenk
2528472d5460SYork Sun		Code that returns true if the I2C data line is high,
2529472d5460SYork Sun		false if it is low.
2530c609719bSwdenk
2531b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2532b37c7e5eSwdenk
2533c609719bSwdenk		I2C_SDA(bit)
2534c609719bSwdenk
2535472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2536472d5460SYork Sun		is false, it clears it (low).
2537c609719bSwdenk
2538b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2539b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2540b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2541b37c7e5eSwdenk
2542c609719bSwdenk		I2C_SCL(bit)
2543c609719bSwdenk
2544472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2545472d5460SYork Sun		is false, it clears it (low).
2546c609719bSwdenk
2547b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2548b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2549b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2550b37c7e5eSwdenk
2551c609719bSwdenk		I2C_DELAY
2552c609719bSwdenk
2553c609719bSwdenk		This delay is invoked four times per clock cycle so this
2554c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2555b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2556b37c7e5eSwdenk		like:
2557b37c7e5eSwdenk
2558b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2559c609719bSwdenk
2560793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2561793b5726SMike Frysinger
2562793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2563793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2564793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2565793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2566793b5726SMike Frysinger
2567793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2568793b5726SMike Frysinger		the generic GPIO functions.
2569793b5726SMike Frysinger
25706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
257147cd00faSwdenk
257247cd00faSwdenk		When a board is reset during an i2c bus transfer
257347cd00faSwdenk		chips might think that the current transfer is still
257447cd00faSwdenk		in progress. On some boards it is possible to access
257547cd00faSwdenk		the i2c SCLK line directly, either by using the
257647cd00faSwdenk		processor pin as a GPIO or by having a second pin
257747cd00faSwdenk		connected to the bus. If this option is defined a
257847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
257947cd00faSwdenk		is run early in the boot sequence.
258047cd00faSwdenk
258126a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
258226a33504SRichard Retanubun
258326a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
258426a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
258526a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
258626a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
258726a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
258826a33504SRichard Retanubun		controller provide such a method. It is called at the end of
258926a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
259026a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
259126a33504SRichard Retanubun
259217ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
259317ea1177Swdenk
259417ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
259517ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
259617ea1177Swdenk		variable "i2cfast". (see also i2cfast)
259717ea1177Swdenk
2598bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2599bb99ad6dSBen Warren
2600bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2601bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2602bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2603bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2604bb99ad6dSBen Warren
26056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2606bb99ad6dSBen Warren
2607bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
26080f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
26090f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
26100f89c54bSPeter Tyser		a 1D array of device addresses
2611bb99ad6dSBen Warren
2612bb99ad6dSBen Warren		e.g.
2613bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
26146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2615bb99ad6dSBen Warren
2616bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2617bb99ad6dSBen Warren
2618bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
26196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2620bb99ad6dSBen Warren
2621bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2622bb99ad6dSBen Warren
26236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2624be5e6181STimur Tabi
2625be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2626be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2627be5e6181STimur Tabi
26286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
26290dc018ecSStefan Roese
26300dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
26310dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
26320dc018ecSStefan Roese
26336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
26340dc018ecSStefan Roese
26350dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
26360dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
26370dc018ecSStefan Roese
26386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
26399ebbb54fSVictor Gallardo
26409ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
26419ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
26429ebbb54fSVictor Gallardo		specified DTT device.
26439ebbb54fSVictor Gallardo
26442ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
26452ac6985aSAndrew Dyer
26462ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
26472ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
26482ac6985aSAndrew Dyer		between writing the address pointer and reading the
26492ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
26502ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
26512ac6985aSAndrew Dyer		devices can use either method, but some require one or
26522ac6985aSAndrew Dyer		the other.
2653be5e6181STimur Tabi
2654c609719bSwdenk- SPI Support:	CONFIG_SPI
2655c609719bSwdenk
2656c609719bSwdenk		Enables SPI driver (so far only tested with
2657c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2658c609719bSwdenk		D/As on the SACSng board)
2659c609719bSwdenk
26606639562eSYoshihiro Shimoda		CONFIG_SH_SPI
26616639562eSYoshihiro Shimoda
26626639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
26636639562eSYoshihiro Shimoda		only SH7757 is supported.
26646639562eSYoshihiro Shimoda
2665c609719bSwdenk		CONFIG_SOFT_SPI
2666c609719bSwdenk
2667c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2668c609719bSwdenk		using hardware support. This is a general purpose
2669c609719bSwdenk		driver that only requires three general I/O port pins
2670c609719bSwdenk		(two outputs, one input) to function. If this is
2671c609719bSwdenk		defined, the board configuration must define several
2672c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2673c609719bSwdenk		an example, see include/configs/sacsng.h.
2674c609719bSwdenk
267504a9e118SBen Warren		CONFIG_HARD_SPI
267604a9e118SBen Warren
267704a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
267804a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
267904a9e118SBen Warren		must define a list of chip-select function pointers.
268004a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
268104a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
268204a9e118SBen Warren
268338254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
268438254f45SGuennadi Liakhovetski
268538254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
26862e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
268738254f45SGuennadi Liakhovetski
2688f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2689f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2690f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2691f659b573SHeiko Schocher
26920133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
26930133502eSMatthias Fuchs
26940133502eSMatthias Fuchs		Enables FPGA subsystem.
26950133502eSMatthias Fuchs
26960133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
26970133502eSMatthias Fuchs
26980133502eSMatthias Fuchs		Enables support for specific chip vendors.
26990133502eSMatthias Fuchs		(ALTERA, XILINX)
27000133502eSMatthias Fuchs
27010133502eSMatthias Fuchs		CONFIG_FPGA_<family>
27020133502eSMatthias Fuchs
27030133502eSMatthias Fuchs		Enables support for FPGA family.
27040133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
27050133502eSMatthias Fuchs
27060133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2707c609719bSwdenk
2708c609719bSwdenk		Specify the number of FPGA devices to support.
2709c609719bSwdenk
271064e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
271164e809afSSiva Durga Prasad Paladugu
271264e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
271364e809afSSiva Durga Prasad Paladugu
271467193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
271567193864SMichal Simek
271667193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
271767193864SMichal Simek
271867193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
271967193864SMichal Simek
272067193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
272167193864SMichal Simek		(Xilinx only)
272267193864SMichal Simek
27236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2724c609719bSwdenk
2725c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2726c609719bSwdenk
27276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2728c609719bSwdenk
2729c609719bSwdenk		Enable checks on FPGA configuration interface busy
2730c609719bSwdenk		status by the configuration function. This option
2731c609719bSwdenk		will require a board or device specific function to
2732c609719bSwdenk		be written.
2733c609719bSwdenk
2734c609719bSwdenk		CONFIG_FPGA_DELAY
2735c609719bSwdenk
2736c609719bSwdenk		If defined, a function that provides delays in the FPGA
2737c609719bSwdenk		configuration driver.
2738c609719bSwdenk
27396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2740c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2741c609719bSwdenk
27426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2743c609719bSwdenk
2744c609719bSwdenk		Check for configuration errors during FPGA bitfile
2745c609719bSwdenk		loading. For example, abort during Virtex II
2746c609719bSwdenk		configuration if the INIT_B line goes low (which
2747c609719bSwdenk		indicated a CRC error).
2748c609719bSwdenk
27496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2750c609719bSwdenk
2751b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2752b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2753c609719bSwdenk		FPGA configuration sequence. The default time is 500
275411ccc33fSMarcel Ziswiler		ms.
2755c609719bSwdenk
27566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2757c609719bSwdenk
2758b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
275911ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2760c609719bSwdenk
27616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2762c609719bSwdenk
2763c609719bSwdenk		Time to wait after FPGA configuration. The default is
276411ccc33fSMarcel Ziswiler		200 ms.
2765c609719bSwdenk
2766c609719bSwdenk- Configuration Management:
2767b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2768b2b8a696SStefan Roese
2769b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2770b2b8a696SStefan Roese		with a special header) as build targets. By defining
2771b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2772b2b8a696SStefan Roese		special image will be automatically built upon calling
2773b2b8a696SStefan Roese		make / MAKEALL.
2774b2b8a696SStefan Roese
2775c609719bSwdenk		CONFIG_IDENT_STRING
2776c609719bSwdenk
2777c609719bSwdenk		If defined, this string will be added to the U-Boot
2778c609719bSwdenk		version information (U_BOOT_VERSION)
2779c609719bSwdenk
2780c609719bSwdenk- Vendor Parameter Protection:
2781c609719bSwdenk
2782c609719bSwdenk		U-Boot considers the values of the environment
2783c609719bSwdenk		variables "serial#" (Board Serial Number) and
27847152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2785c609719bSwdenk		are set once by the board vendor / manufacturer, and
2786c609719bSwdenk		protects these variables from casual modification by
2787c609719bSwdenk		the user. Once set, these variables are read-only,
2788c609719bSwdenk		and write or delete attempts are rejected. You can
278911ccc33fSMarcel Ziswiler		change this behaviour:
2790c609719bSwdenk
2791c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2792c609719bSwdenk		file, the write protection for vendor parameters is
279347cd00faSwdenk		completely disabled. Anybody can change or delete
2794c609719bSwdenk		these parameters.
2795c609719bSwdenk
279692ac5208SJoe Hershberger		Alternatively, if you define _both_ an ethaddr in the
279792ac5208SJoe Hershberger		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
279811ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2799c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2800c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2801c609719bSwdenk		read-only.]
2802c609719bSwdenk
28032598090bSJoe Hershberger		The same can be accomplished in a more flexible way
28042598090bSJoe Hershberger		for any variable by configuring the type of access
28052598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
28062598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
28072598090bSJoe Hershberger
2808c609719bSwdenk- Protected RAM:
2809c609719bSwdenk		CONFIG_PRAM
2810c609719bSwdenk
2811c609719bSwdenk		Define this variable to enable the reservation of
2812c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2813c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2814c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2815c609719bSwdenk		this default value by defining an environment
2816c609719bSwdenk		variable "pram" to the number of kB you want to
2817c609719bSwdenk		reserve. Note that the board info structure will
2818c609719bSwdenk		still show the full amount of RAM. If pRAM is
2819c609719bSwdenk		reserved, a new environment variable "mem" will
2820c609719bSwdenk		automatically be defined to hold the amount of
2821c609719bSwdenk		remaining RAM in a form that can be passed as boot
2822c609719bSwdenk		argument to Linux, for instance like that:
2823c609719bSwdenk
2824fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2825c609719bSwdenk			saveenv
2826c609719bSwdenk
2827c609719bSwdenk		This way you can tell Linux not to use this memory,
2828c609719bSwdenk		either, which results in a memory region that will
2829c609719bSwdenk		not be affected by reboots.
2830c609719bSwdenk
2831c609719bSwdenk		*WARNING* If your board configuration uses automatic
2832c609719bSwdenk		detection of the RAM size, you must make sure that
2833c609719bSwdenk		this memory test is non-destructive. So far, the
2834c609719bSwdenk		following board configurations are known to be
2835c609719bSwdenk		"pRAM-clean":
2836c609719bSwdenk
28371b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
28381b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2839544d97e9SWolfgang Denk			FLAGADM, TQM8260
2840c609719bSwdenk
284140fef049SGabe Black- Access to physical memory region (> 4GB)
284240fef049SGabe Black		Some basic support is provided for operations on memory not
284340fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
284440fef049SGabe Black		support access to more than 4GB of memory on 32-bit
284540fef049SGabe Black		machines using physical address extension or similar.
284640fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
284740fef049SGabe Black		currently only supports clearing the memory.
284840fef049SGabe Black
2849c609719bSwdenk- Error Recovery:
2850c609719bSwdenk		CONFIG_PANIC_HANG
2851c609719bSwdenk
2852c609719bSwdenk		Define this variable to stop the system in case of a
2853c609719bSwdenk		fatal error, so that you have to reset it manually.
2854c609719bSwdenk		This is probably NOT a good idea for an embedded
285511ccc33fSMarcel Ziswiler		system where you want the system to reboot
2856c609719bSwdenk		automatically as fast as possible, but it may be
2857c609719bSwdenk		useful during development since you can try to debug
2858c609719bSwdenk		the conditions that lead to the situation.
2859c609719bSwdenk
2860c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2861c609719bSwdenk
2862c609719bSwdenk		This variable defines the number of retries for
2863c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2864c609719bSwdenk		before giving up the operation. If not defined, a
2865c609719bSwdenk		default value of 5 is used.
2866c609719bSwdenk
286740cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
286840cb90eeSGuennadi Liakhovetski
286940cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
287040cb90eeSGuennadi Liakhovetski
287148a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
287248a3e999STetsuyuki Kobayashi
287348a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
287448a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
287548a3e999STetsuyuki Kobayashi		try longer timeout such as
287648a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
287748a3e999STetsuyuki Kobayashi
2878c609719bSwdenk- Command Interpreter:
28798078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
288004a85b3bSwdenk
288104a85b3bSwdenk		Enable auto completion of commands using TAB.
288204a85b3bSwdenk
28836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2884c609719bSwdenk
2885c609719bSwdenk		This defines the secondary prompt string, which is
2886c609719bSwdenk		printed when the command interpreter needs more input
2887c609719bSwdenk		to complete a command. Usually "> ".
2888c609719bSwdenk
2889c609719bSwdenk	Note:
2890c609719bSwdenk
2891c609719bSwdenk		In the current implementation, the local variables
2892c609719bSwdenk		space and global environment variables space are
2893c609719bSwdenk		separated. Local variables are those you define by
28943b57fe0aSwdenk		simply typing `name=value'. To access a local
2895c609719bSwdenk		variable later on, you have write `$name' or
28963b57fe0aSwdenk		`${name}'; to execute the contents of a variable
28973b57fe0aSwdenk		directly type `$name' at the command prompt.
2898c609719bSwdenk
2899c609719bSwdenk		Global environment variables are those you use
2900c609719bSwdenk		setenv/printenv to work with. To run a command stored
2901c609719bSwdenk		in such a variable, you need to use the run command,
2902c609719bSwdenk		and you must not use the '$' sign to access them.
2903c609719bSwdenk
2904c609719bSwdenk		To store commands and special characters in a
2905c609719bSwdenk		variable, please use double quotation marks
2906c609719bSwdenk		surrounding the whole text of the variable, instead
2907c609719bSwdenk		of the backslashes before semicolons and special
2908c609719bSwdenk		symbols.
2909c609719bSwdenk
2910b445bbb4SJeremiah Mahler- Command Line Editing and History:
2911aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2912aa0c71acSWolfgang Denk
291311ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2914aa0c71acSWolfgang Denk		command line input operations
2915aa0c71acSWolfgang Denk
2916f3b267b3SMarek Vasut- Command Line PS1/PS2 support:
2917f3b267b3SMarek Vasut		CONFIG_CMDLINE_PS_SUPPORT
2918f3b267b3SMarek Vasut
2919f3b267b3SMarek Vasut		Enable support for changing the command prompt string
2920f3b267b3SMarek Vasut		at run-time. Only static string is supported so far.
2921f3b267b3SMarek Vasut		The string is obtained from environment variables PS1
2922f3b267b3SMarek Vasut		and PS2.
2923f3b267b3SMarek Vasut
2924a8c7c708Swdenk- Default Environment:
2925c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2926c609719bSwdenk
2927c609719bSwdenk		Define this to contain any number of null terminated
2928c609719bSwdenk		strings (variable = value pairs) that will be part of
29297152b1d0Swdenk		the default environment compiled into the boot image.
29302262cfeeSwdenk
2931c609719bSwdenk		For example, place something like this in your
2932c609719bSwdenk		board's config file:
2933c609719bSwdenk
2934c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2935c609719bSwdenk			"myvar1=value1\0" \
2936c609719bSwdenk			"myvar2=value2\0"
2937c609719bSwdenk
2938c609719bSwdenk		Warning: This method is based on knowledge about the
2939c609719bSwdenk		internal format how the environment is stored by the
29402262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2941c609719bSwdenk		interface! Although it is unlikely that this format
29427152b1d0Swdenk		will change soon, there is no guarantee either.
2943c609719bSwdenk		You better know what you are doing here.
2944c609719bSwdenk
2945c609719bSwdenk		Note: overly (ab)use of the default environment is
2946c609719bSwdenk		discouraged. Make sure to check other ways to preset
294774de7aefSWolfgang Denk		the environment like the "source" command or the
2948c609719bSwdenk		boot command first.
2949c609719bSwdenk
29505e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
29515e724ca2SStephen Warren
29525e724ca2SStephen Warren		Define this in order to add variables describing the
29535e724ca2SStephen Warren		U-Boot build configuration to the default environment.
29545e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
29555e724ca2SStephen Warren
29565e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
29575e724ca2SStephen Warren
29585e724ca2SStephen Warren		- CONFIG_SYS_ARCH
29595e724ca2SStephen Warren		- CONFIG_SYS_CPU
29605e724ca2SStephen Warren		- CONFIG_SYS_BOARD
29615e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
29625e724ca2SStephen Warren		- CONFIG_SYS_SOC
29635e724ca2SStephen Warren
29647e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
29657e27f89fSTom Rini
29667e27f89fSTom Rini		Define this in order to add variables describing certain
29677e27f89fSTom Rini		run-time determined information about the hardware to the
29687e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
29697e27f89fSTom Rini
297006fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
297106fd8538SSimon Glass
297206fd8538SSimon Glass		Normally the environment is loaded when the board is
2973b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
297406fd8538SSimon Glass		that so that the environment is not available until
297506fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
297606fd8538SSimon Glass		this is instead controlled by the value of
297706fd8538SSimon Glass		/config/load-environment.
297806fd8538SSimon Glass
29793b10cf12SChris Packham- Parallel Flash support:
29803b10cf12SChris Packham		CONFIG_SYS_NO_FLASH
29813b10cf12SChris Packham
2982a187559eSBin Meng		Traditionally U-Boot was run on systems with parallel NOR
29833b10cf12SChris Packham		flash. This option is used to disable support for parallel NOR
29843b10cf12SChris Packham		flash. This option should be defined if the board does not have
29853b10cf12SChris Packham		parallel flash.
29863b10cf12SChris Packham
29873b10cf12SChris Packham		If this option is not defined one of the generic flash drivers
29883b10cf12SChris Packham		(e.g.  CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
29893b10cf12SChris Packham		selected or the board must provide an implementation of the
29903b10cf12SChris Packham		flash API (see include/flash.h).
29913b10cf12SChris Packham
2992a8c7c708Swdenk- DataFlash Support:
29932abbe075Swdenk		CONFIG_HAS_DATAFLASH
29942abbe075Swdenk
29952abbe075Swdenk		Defining this option enables DataFlash features and
29962abbe075Swdenk		allows to read/write in Dataflash via the standard
29972abbe075Swdenk		commands cp, md...
29982abbe075Swdenk
2999f61ec45eSEric Nelson- Serial Flash support
3000f61ec45eSEric Nelson		CONFIG_CMD_SF
3001f61ec45eSEric Nelson
3002f61ec45eSEric Nelson		Defining this option enables SPI flash commands
3003f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
3004f61ec45eSEric Nelson
3005f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
3006f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
3007f61ec45eSEric Nelson		commands.
3008f61ec45eSEric Nelson
3009f61ec45eSEric Nelson		The following defaults may be provided by the platform
3010f61ec45eSEric Nelson		to handle the common case when only a single serial
3011f61ec45eSEric Nelson		flash is present on the system.
3012f61ec45eSEric Nelson
3013f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
3014f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
3015f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
3016f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
3017f61ec45eSEric Nelson
301824007273SSimon Glass		CONFIG_CMD_SF_TEST
301924007273SSimon Glass
302024007273SSimon Glass		Define this option to include a destructive SPI flash
302124007273SSimon Glass		test ('sf test').
302224007273SSimon Glass
3023b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
3024b902e07cSJagannadha Sutradharudu Teki
3025b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
3026b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
3027b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
3028b902e07cSJagannadha Sutradharudu Teki
30293f85ce27Swdenk- SystemACE Support:
30303f85ce27Swdenk		CONFIG_SYSTEMACE
30313f85ce27Swdenk
30323f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
30333f85ce27Swdenk		chips attached via some sort of local bus. The address
303411ccc33fSMarcel Ziswiler		of the chip must also be defined in the
30356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
30363f85ce27Swdenk
30373f85ce27Swdenk		#define CONFIG_SYSTEMACE
30386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
30393f85ce27Swdenk
30403f85ce27Swdenk		When SystemACE support is added, the "ace" device type
30413f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
30423f85ce27Swdenk
3043ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
3044ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
3045ecb0ccd9SWolfgang Denk
304628cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
3047ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
304828cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
3049ecb0ccd9SWolfgang Denk		number generator is used.
3050ecb0ccd9SWolfgang Denk
305128cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
305228cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
305328cb9375SWolfgang Denk		defined, the normal port 69 is used.
305428cb9375SWolfgang Denk
305528cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
3056ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
3057ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
3058ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
3059ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
3060ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
3061ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
3062ecb0ccd9SWolfgang Denk
3063bf36c5d5SSimon Glass- Hashing support:
3064bf36c5d5SSimon Glass		CONFIG_CMD_HASH
3065bf36c5d5SSimon Glass
3066bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
3067bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3068bf36c5d5SSimon Glass
3069bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3070bf36c5d5SSimon Glass
3071bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3072bf36c5d5SSimon Glass		size a little.
3073bf36c5d5SSimon Glass
307494e3c8c4Sgaurav rana		CONFIG_SHA1 - This option enables support of hashing using SHA1
307594e3c8c4Sgaurav rana		algorithm. The hash is calculated in software.
307694e3c8c4Sgaurav rana		CONFIG_SHA256 - This option enables support of hashing using
307794e3c8c4Sgaurav rana		SHA256 algorithm. The hash is calculated in software.
307894e3c8c4Sgaurav rana		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
307994e3c8c4Sgaurav rana		for SHA1/SHA256 hashing.
308094e3c8c4Sgaurav rana		This affects the 'hash' command and also the
308194e3c8c4Sgaurav rana		hash_lookup_algo() function.
308294e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL - This option enables
308394e3c8c4Sgaurav rana		hardware-acceleration for SHA1/SHA256 progressive hashing.
308494e3c8c4Sgaurav rana		Data can be streamed in a block at a time and the hashing
308594e3c8c4Sgaurav rana		is performed in hardware.
3086bf36c5d5SSimon Glass
3087bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3088bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3089bf36c5d5SSimon Glass
3090a11f1873SRobert Winkler- Freescale i.MX specific commands:
3091a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3092a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3093a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3094a11f1873SRobert Winkler
3095a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3096a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3097a11f1873SRobert Winkler		a boot from specific media.
3098a11f1873SRobert Winkler
3099a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3100a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3101a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3102a11f1873SRobert Winkler		will set it back to normal.  This command currently
3103a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3104a11f1873SRobert Winkler
31059e50c406SHeiko Schocher- bootcount support:
31069e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
31079e50c406SHeiko Schocher
31089e50c406SHeiko Schocher		This enables the bootcounter support, see:
31099e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
31109e50c406SHeiko Schocher
31119e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
31129e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
31139e50c406SHeiko Schocher		CONFIG_BLACKFIN
31149e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
31159e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
31169e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
31179e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
31189e50c406SHeiko Schocher		enable support for the bootcounter in RAM
31199e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
31209e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
31219e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
31229e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
31239e50c406SHeiko Schocher						    the bootcounter.
31249e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
312519c402afSSimon Glass
3126a8c7c708Swdenk- Show boot progress:
3127c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3128c609719bSwdenk
3129c609719bSwdenk		Defining this option allows to add some board-
3130c609719bSwdenk		specific code (calling a user-provided function
3131c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3132c609719bSwdenk		the system's boot progress on some display (for
3133c609719bSwdenk		example, some LED's) on your board. At the moment,
3134c609719bSwdenk		the following checkpoints are implemented:
3135c609719bSwdenk
313694fd1316SSimon Glass
31371372cce2SMarian BalakowiczLegacy uImage format:
31381372cce2SMarian Balakowicz
3139c609719bSwdenk  Arg	Where			When
3140c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3141c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3142c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3143c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3144c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3145c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3146c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3147c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3148c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
31491372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3150c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3151c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3152c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3153c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
31541372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3155c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
31561372cce2SMarian Balakowicz
31571372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
31581372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
31591372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
31601372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
31611372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
31621372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
31631372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
316411ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
31651372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
31661372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
31671372cce2SMarian Balakowicz
3168ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3169c609719bSwdenk
3170a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
317163e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
317263e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
317363e73c9aSwdenk
3174566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3175566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3176566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3177566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3178566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3179566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3180566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3181566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3182566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3183566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3184566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3185566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3186566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3187566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3188566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3189566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3190566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3191566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3192566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3193566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3194566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3195566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3196566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3197566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3198566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3199566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3200566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3201566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3202566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3203566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3204566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3205566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3206566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3207566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3208566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3209566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3210566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3211566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3212566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3213566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3214566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3215566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3216566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3217566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3218566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3219566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3220566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3221c609719bSwdenk
3222566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3223c609719bSwdenk
3224566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3225566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3226566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3227206c60cbSwdenk
3228566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3229bc0571fcSJoe Hershberger   80	common/cmd_net.c	before calling net_loop()
3230bc0571fcSJoe Hershberger  -81	common/cmd_net.c	some error in net_loop() occurred
3231bc0571fcSJoe Hershberger   81	common/cmd_net.c	net_loop() back without error
3232566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3233566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
323474de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
323574de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3236566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3237c609719bSwdenk
32381372cce2SMarian BalakowiczFIT uImage format:
32391372cce2SMarian Balakowicz
32401372cce2SMarian Balakowicz  Arg	Where			When
32411372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
32421372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
32431372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
32441372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
32451372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
32461372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3247f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
32481372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
32491372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
32501372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
32511372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
32521372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
325311ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
325411ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
32551372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
32561372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
32571372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
32581372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
32591372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
32601372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
32611372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
32621372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
32631372cce2SMarian Balakowicz
32641372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
32651372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
32661372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
326711ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
32681372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
32691372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
32701372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
32711372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
32721372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
32731372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
32741372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
32751372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
32761372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
32771372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
32781372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
32791372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
32801372cce2SMarian Balakowicz
328111ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
32821372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
32831372cce2SMarian Balakowicz
328411ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
32851372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
32861372cce2SMarian Balakowicz
328711ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
32881372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
32891372cce2SMarian Balakowicz
329021d29f7fSHeiko Schocher- legacy image format:
329121d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
329221d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
329321d29f7fSHeiko Schocher
329421d29f7fSHeiko Schocher		Default:
329521d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
329621d29f7fSHeiko Schocher
329721d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
329821d29f7fSHeiko Schocher		disable the legacy image format
329921d29f7fSHeiko Schocher
330021d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
330121d29f7fSHeiko Schocher		enabled per default for backward compatibility.
330221d29f7fSHeiko Schocher
3303d95f6ec7SGabe Black- FIT image support:
33049a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
33059a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
33069a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
33079a4f479bSDirk Eibach		with this option.
33089a4f479bSDirk Eibach
330973223f0eSSimon Glass		TODO(sjg@chromium.org): Adjust this option to be positive,
331073223f0eSSimon Glass		and move it to Kconfig
331173223f0eSSimon Glass
33124cf2609bSWolfgang Denk- Standalone program support:
33134cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
33144cf2609bSWolfgang Denk
33156feff899SWolfgang Denk		This option defines a board specific value for the
33166feff899SWolfgang Denk		address where standalone program gets loaded, thus
33176feff899SWolfgang Denk		overwriting the architecture dependent default
33184cf2609bSWolfgang Denk		settings.
33194cf2609bSWolfgang Denk
33204cf2609bSWolfgang Denk- Frame Buffer Address:
33214cf2609bSWolfgang Denk		CONFIG_FB_ADDR
33224cf2609bSWolfgang Denk
33234cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
332444a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
332544a53b57SWolfgang Denk		when using a graphics controller has separate video
332644a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
332744a53b57SWolfgang Denk		the given address instead of dynamically reserving it
332844a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
332944a53b57SWolfgang Denk		the memory for the frame buffer depending on the
333044a53b57SWolfgang Denk		configured panel size.
33314cf2609bSWolfgang Denk
33324cf2609bSWolfgang Denk		Please see board_init_f function.
33334cf2609bSWolfgang Denk
3334cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3335cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3336cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3337cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3338cccfc2abSDetlev Zundel
3339cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3340cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3341cccfc2abSDetlev Zundel
3342cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3343cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3344cccfc2abSDetlev Zundel
3345cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3346cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3347cccfc2abSDetlev Zundel
3348cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3349cccfc2abSDetlev Zundel
3350cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3351cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3352cccfc2abSDetlev Zundel
335370c219cdSJoe Hershberger- UBI support
335470c219cdSJoe Hershberger		CONFIG_CMD_UBI
335570c219cdSJoe Hershberger
335670c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
335770c219cdSJoe Hershberger		with the UBI flash translation layer
335870c219cdSJoe Hershberger
335970c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
336070c219cdSJoe Hershberger
3361147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3362147162daSJoe Hershberger
3363147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3364147162daSJoe Hershberger		warnings and errors enabled.
3365147162daSJoe Hershberger
3366ff94bc40SHeiko Schocher
3367ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3368ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3369ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3370ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3371ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3372ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3373ff94bc40SHeiko Schocher
3374ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3375ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3376ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3377ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3378ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3379ff94bc40SHeiko Schocher
3380ff94bc40SHeiko Schocher		default: 4096
3381ff94bc40SHeiko Schocher
3382ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3383ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3384ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3385ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3386ff94bc40SHeiko Schocher		flash), this value is ignored.
3387ff94bc40SHeiko Schocher
3388ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3389ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3390ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3391ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3392ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3393ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3394ff94bc40SHeiko Schocher
3395ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3396ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3397ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3398ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3399ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3400ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3401ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3402ff94bc40SHeiko Schocher		partition.
3403ff94bc40SHeiko Schocher
3404ff94bc40SHeiko Schocher		default: 20
3405ff94bc40SHeiko Schocher
3406ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3407ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3408ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3409ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3410ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3411ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3412ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3413ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3414ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3415ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3416ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3417ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3418ff94bc40SHeiko Schocher
3419ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3420ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3421ff94bc40SHeiko Schocher		without a fastmap.
3422ff94bc40SHeiko Schocher		default: 0
3423ff94bc40SHeiko Schocher
34240195a7bbSHeiko Schocher		CONFIG_MTD_UBI_FM_DEBUG
34250195a7bbSHeiko Schocher		Enable UBI fastmap debug
34260195a7bbSHeiko Schocher		default: 0
34270195a7bbSHeiko Schocher
342870c219cdSJoe Hershberger- UBIFS support
342970c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
343070c219cdSJoe Hershberger
343170c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
343270c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
343370c219cdSJoe Hershberger
343470c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
343570c219cdSJoe Hershberger
3436147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3437147162daSJoe Hershberger
3438147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3439147162daSJoe Hershberger		warnings and errors enabled.
3440147162daSJoe Hershberger
34416a11cf48SDaniel Schwierzeck- SPL framework
34426a11cf48SDaniel Schwierzeck		CONFIG_SPL
34436a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
34446a11cf48SDaniel Schwierzeck
344595579793STom Rini		CONFIG_SPL_LDSCRIPT
344695579793STom Rini		LDSCRIPT for linking the SPL binary.
344795579793STom Rini
34486ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
34496ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
34506ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
34516ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
34528960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
34536ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
34546ebc3461SAlbert ARIBAUD
345595579793STom Rini		CONFIG_SPL_MAX_SIZE
34566ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
34576ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
34586ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
34596ebc3461SAlbert ARIBAUD		not exceed it.
346095579793STom Rini
34616a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
34626a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
34636a11cf48SDaniel Schwierzeck
346494a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
346594a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
346694a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
346794a45bb1SScott Wood
346895579793STom Rini		CONFIG_SPL_BSS_START_ADDR
346995579793STom Rini		Link address for the BSS within the SPL binary.
347095579793STom Rini
347195579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
34726ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
34736ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
34746ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
34758960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
34766ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
347795579793STom Rini
347895579793STom Rini		CONFIG_SPL_STACK
347995579793STom Rini		Adress of the start of the stack SPL will use
348095579793STom Rini
34818c80eb3bSAlbert ARIBAUD \(3ADEV\)		CONFIG_SPL_PANIC_ON_RAW_IMAGE
34828c80eb3bSAlbert ARIBAUD \(3ADEV\)		When defined, SPL will panic() if the image it has
34838c80eb3bSAlbert ARIBAUD \(3ADEV\)		loaded does not have a signature.
34848c80eb3bSAlbert ARIBAUD \(3ADEV\)		Defining this is useful when code which loads images
34858c80eb3bSAlbert ARIBAUD \(3ADEV\)		in SPL cannot guarantee that absolutely all read errors
34868c80eb3bSAlbert ARIBAUD \(3ADEV\)		will be caught.
34878c80eb3bSAlbert ARIBAUD \(3ADEV\)		An example is the LPC32XX MLC NAND driver, which will
34888c80eb3bSAlbert ARIBAUD \(3ADEV\)		consider that a completely unreadable NAND block is bad,
34898c80eb3bSAlbert ARIBAUD \(3ADEV\)		and thus should be skipped silently.
34908c80eb3bSAlbert ARIBAUD \(3ADEV\)
3491e0727515SMarek Vasut		CONFIG_SPL_ABORT_ON_RAW_IMAGE
3492e0727515SMarek Vasut		When defined, SPL will proceed to another boot method
3493e0727515SMarek Vasut		if the image it has loaded does not have a signature.
3494e0727515SMarek Vasut
349594a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
349694a45bb1SScott Wood		Adress of the start of the stack SPL will use after
349794a45bb1SScott Wood		relocation.  If unspecified, this is equal to
349894a45bb1SScott Wood		CONFIG_SPL_STACK.
349994a45bb1SScott Wood
350095579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
350195579793STom Rini		Starting address of the malloc pool used in SPL.
35029ac4fc82SFabio Estevam		When this option is set the full malloc is used in SPL and
35039ac4fc82SFabio Estevam		it is set up by spl_init() and before that, the simple malloc()
35049ac4fc82SFabio Estevam		can be used if CONFIG_SYS_MALLOC_F is defined.
350595579793STom Rini
350695579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
350795579793STom Rini		The size of the malloc pool used in SPL.
35086a11cf48SDaniel Schwierzeck
350947f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
351047f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
351147f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
351247f7bcaeSTom Rini		NAND loading of the Linux Kernel.
351347f7bcaeSTom Rini
35149607faf2STom Rini		CONFIG_SPL_OS_BOOT
35159607faf2STom Rini		Enable booting directly to an OS from SPL.
35169607faf2STom Rini		See also: doc/README.falcon
35179607faf2STom Rini
3518861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3519861a86f4STom Rini		For ARM, enable an optional function to print more information
3520861a86f4STom Rini		about the running system.
3521861a86f4STom Rini
35224b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
35234b919725SScott Wood		Arch init code should be built for a very small image
35244b919725SScott Wood
35256a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
35266a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
35276a11cf48SDaniel Schwierzeck
35286a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
35296a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
35306a11cf48SDaniel Schwierzeck
35316a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
35326a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
35336a11cf48SDaniel Schwierzeck
35346a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
35356a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
35366a11cf48SDaniel Schwierzeck
35376a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
35386a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
35396a11cf48SDaniel Schwierzeck
354095579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
354195579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3542e2ccdf89SPaul Kocialkowski		Address and partition on the MMC to load U-Boot from
354395579793STom Rini		when the MMC is being used in raw mode.
354495579793STom Rini
3545b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3546b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3547b97300b6SPaul Kocialkowski		used in raw mode
3548b97300b6SPaul Kocialkowski
35492b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
35502b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
35512b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
35522b75b0adSPeter Korsgaard
35532b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
35542b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
35552b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
35562b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
35572b75b0adSPeter Korsgaard		(for falcon mode)
35582b75b0adSPeter Korsgaard
3559e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3560e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3561e2ccdf89SPaul Kocialkowski		used in fs mode
3562e2ccdf89SPaul Kocialkowski
356395579793STom Rini		CONFIG_SPL_FAT_SUPPORT
356495579793STom Rini		Support for fs/fat/libfat.o in SPL binary
356595579793STom Rini
3566fae81c72SGuillaume GARDET		CONFIG_SPL_EXT_SUPPORT
3567fae81c72SGuillaume GARDET		Support for EXT filesystem in SPL binary
356895579793STom Rini
3569fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3570fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3571fae81c72SGuillaume GARDET
3572fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
35737ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3574fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
35757ad2cc79SPeter Korsgaard
3576fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
35777ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3578fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
35797ad2cc79SPeter Korsgaard
358006f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
358106f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
358206f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
358306f60ae3SScott Wood		continuing (the hardware starts execution after just
358406f60ae3SScott Wood		loading the first page rather than the full 4K).
358506f60ae3SScott Wood
3586651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3587651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3588651fcf60SPrabhakar Kushwaha
35896f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
35906f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
35916f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
35926f2f01b9SScott Wood
35936f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
35946f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
35956f2f01b9SScott Wood
35966f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
35976f2f01b9SScott Wood		Include standard software ECC in the SPL
35986f2f01b9SScott Wood
359995579793STom Rini		CONFIG_SPL_NAND_SIMPLE
36007d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
36017d4b7955SScott Wood		expose the cmd_ctrl() interface.
360295579793STom Rini
36036dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
36046dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
36056dd3b566STom Rini		environment on NAND support within SPL.
36066dd3b566STom Rini
36070c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
36080c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
36090c3117b1SHeiko Schocher		if you need to save space.
36100c3117b1SHeiko Schocher
3611bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3612bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
36135614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3614bb0dc108SYing Zhang
36157c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
36167c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
36177c8eea59SYing Zhang		SPL binary.
36187c8eea59SYing Zhang
361995579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
362095579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
362195579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
362295579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
362395579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
362495579793STom Rini		Defines the size and behavior of the NAND that SPL uses
36257d4b7955SScott Wood		to read U-Boot
362695579793STom Rini
3627fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3628fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3629fbe76ae4SPrabhakar Kushwaha
363095579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
36317d4b7955SScott Wood		Location in NAND to read U-Boot from
36327d4b7955SScott Wood
36337d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
36347d4b7955SScott Wood		Location in memory to load U-Boot to
36357d4b7955SScott Wood
36367d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
36377d4b7955SScott Wood		Size of image to load
363895579793STom Rini
363995579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
36407d4b7955SScott Wood		Entry point in loaded image to jump to
364195579793STom Rini
364295579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
364395579793STom Rini		Define this if you need to first read the OOB and then the
3644b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
364595579793STom Rini
364695579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
364795579793STom Rini		Support for an OMAP3-specific set of functions to return the
364895579793STom Rini		ID and MFR of the first attached NAND chip, if present.
364995579793STom Rini
36506a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
36516a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
36526a11cf48SDaniel Schwierzeck
36536a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
36546a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
36556a11cf48SDaniel Schwierzeck
36566a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
36576a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
36586a11cf48SDaniel Schwierzeck
3659c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3660c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3661c57b953dSPavel Machek
36626a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
36636a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
36641372cce2SMarian Balakowicz
3665ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3666ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3667ba1bee43SYing Zhang
3668ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3669ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3670ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3671ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3672ba1bee43SYing Zhang
367374752baaSScott Wood		CONFIG_SPL_PAD_TO
36746113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
36756113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
36766113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
36776113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
36786113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
367974752baaSScott Wood
3680ca2fca22SScott Wood		CONFIG_SPL_TARGET
3681ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3682ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3683ca2fca22SScott Wood		example if more than one image needs to be produced.
3684ca2fca22SScott Wood
368587ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
368687ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
368787ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
368887ebee39SSimon Glass		option to re-enable it. This will affect the output of the
368987ebee39SSimon Glass		bootm command when booting a FIT image.
369087ebee39SSimon Glass
36913aa29de0SYing Zhang- TPL framework
36923aa29de0SYing Zhang		CONFIG_TPL
36933aa29de0SYing Zhang		Enable building of TPL globally.
36943aa29de0SYing Zhang
36953aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
36963aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
36973aa29de0SYing Zhang		the TPL payload. By default, this is defined as
36983aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
36993aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
37003aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
37013aa29de0SYing Zhang
3702a8c7c708Swdenk- Interrupt support (PPC):
3703a8c7c708Swdenk
3704a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3705a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
370611ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3707a8c7c708Swdenk		should set decrementer_count to appropriate value. If
370811ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3709a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
371011ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3711a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3712a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3713a8c7c708Swdenk		general timer_interrupt().
3714a8c7c708Swdenk
3715c609719bSwdenk
37169660e442SHelmut RaigerBoard initialization settings:
37179660e442SHelmut Raiger------------------------------
37189660e442SHelmut Raiger
37199660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
37209660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
37219660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
37229660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
37239660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
37249660e442SHelmut Raigertypically in board_init_f() and board_init_r().
37259660e442SHelmut Raiger
37269660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
37279660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
37289660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
37299660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3730c609719bSwdenk
3731c609719bSwdenkConfiguration Settings:
3732c609719bSwdenk-----------------------
3733c609719bSwdenk
37344d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
37354d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
37364d1fd7f1SYork Sun
37376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3738c609719bSwdenk		undefine this when you're short of memory.
3739c609719bSwdenk
37402fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
37412fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
37422fb2604dSPeter Tyser
37436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3744c609719bSwdenk		prompt for user input.
3745c609719bSwdenk
37466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3747c609719bSwdenk
37486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3749c609719bSwdenk
37506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3751c609719bSwdenk
37526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3753c609719bSwdenk		the application (usually a Linux kernel) when it is
3754c609719bSwdenk		booted
3755c609719bSwdenk
37566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3757c609719bSwdenk		List of legal baudrate settings for this board.
3758c609719bSwdenk
37596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3760c609719bSwdenk		Suppress display of console information at boot.
3761c609719bSwdenk
37626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3763c609719bSwdenk		If the board specific function
3764c609719bSwdenk			extern int overwrite_console (void);
3765c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3766c609719bSwdenk		serial port, else the settings in the environment are used.
3767c609719bSwdenk
37686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3769c609719bSwdenk		Enable the call to overwrite_console().
3770c609719bSwdenk
37716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3772c609719bSwdenk		Enable overwrite of previous console environment settings.
3773c609719bSwdenk
37746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3775c609719bSwdenk		Begin and End addresses of the area used by the
3776c609719bSwdenk		simple memory test.
3777c609719bSwdenk
37786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3779c609719bSwdenk		Enable an alternate, more extensive memory test.
3780c609719bSwdenk
37816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
37825f535fe1Swdenk		Scratch address used by the alternate memory test
37835f535fe1Swdenk		You only need to set this if address zero isn't writeable
37845f535fe1Swdenk
3785e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE
3786e8149522SYork Sun		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3787e8149522SYork Sun		is substracted from total RAM and won't be reported to OS.
3788e8149522SYork Sun		This memory can be used as secure memory. A variable
3789e8149522SYork Sun		gd->secure_ram is used to track the location. In systems
3790e8149522SYork Sun		the RAM base is not zero, or RAM is divided into banks,
3791e8149522SYork Sun		this variable needs to be recalcuated to get the address.
3792e8149522SYork Sun
3793aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE:
37946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
379514f73ca6SStefan Roese		this specified memory area will get subtracted from the top
379611ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
379714f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
379814f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
379914f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
38005e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
380114f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
38025e12e75dSStefan Roese		will have to get fixed in Linux additionally.
380314f73ca6SStefan Roese
380414f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
380514f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
380614f73ca6SStefan Roese		be touched.
380714f73ca6SStefan Roese
380814f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
380914f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
381014f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
381114f73ca6SStefan Roese		non page size aligned address and this could cause major
381214f73ca6SStefan Roese		problems.
381314f73ca6SStefan Roese
38146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3815c609719bSwdenk		Enable temporary baudrate change while serial download
3816c609719bSwdenk
38176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3818c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3819c609719bSwdenk
38206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3821c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3822c609719bSwdenk		Cogent motherboard)
3823c609719bSwdenk
38246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3825c609719bSwdenk		Physical start address of Flash memory.
3826c609719bSwdenk
38276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3828c609719bSwdenk		Physical start address of boot monitor code (set by
3829c609719bSwdenk		make config files to be same as the text base address
383014d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
38316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3832c609719bSwdenk
38336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
38343b57fe0aSwdenk		Size of memory reserved for monitor code, used to
38353b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
38363b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
38373b57fe0aSwdenk		flash sector.
3838c609719bSwdenk
38396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3840c609719bSwdenk		Size of DRAM reserved for malloc() use.
3841c609719bSwdenk
3842d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3843d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3844d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3845d59476b6SSimon Glass		will become available before relocation. The address is just
3846d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3847d59476b6SSimon Glass		space.
3848d59476b6SSimon Glass
3849d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3850d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3851d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3852b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
3853d59476b6SSimon Glass		U-Boot relocates itself.
3854d59476b6SSimon Glass
3855e7b14e9aSSimon Glass		Pre-relocation malloc() is only supported on ARM and sandbox
385629afe9e6SSimon Glass		at present but is fairly easy to enable for other archs.
385729afe9e6SSimon Glass
385838687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
385938687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
386038687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
386138687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
386238687ae6SSimon Glass
38631dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
38641dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
38651dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
38661dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
38671dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
38681dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
38691dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
38701dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
38711dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
38721dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
38731dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
38741dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
38751dfdd9baSThierry Reding		written to another region in the same cache-line. This can
38761dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
38771dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
38781dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
38791dfdd9baSThierry Reding
38801dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
38811dfdd9baSThierry Reding
38826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
388315940c9aSStefan Roese		Normally compressed uImages are limited to an
388415940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
38856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
388615940c9aSStefan Roese		to adjust this setting to your needs.
3887c609719bSwdenk
38886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3889c609719bSwdenk		Maximum size of memory mapped by the startup code of
3890c609719bSwdenk		the Linux kernel; all data that must be processed by
38917d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
38927d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
38931bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
38947d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3895c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3896c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3897c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3898c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3899c609719bSwdenk
3900fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3901fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3902fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3903fca43cc8SJohn Rigby		is enabled.
3904fca43cc8SJohn Rigby
3905fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3906fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3907fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3908fca43cc8SJohn Rigby
3909fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3910fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3911fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3912fca43cc8SJohn Rigby
39136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3914c609719bSwdenk		Max number of Flash memory banks
3915c609719bSwdenk
39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3917c609719bSwdenk		Max number of sectors on a Flash chip
3918c609719bSwdenk
39196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3920c609719bSwdenk		Timeout for Flash erase operations (in ms)
3921c609719bSwdenk
39226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3923c609719bSwdenk		Timeout for Flash write operations (in ms)
3924c609719bSwdenk
39256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
39268564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
39278564acf9Swdenk
39286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
39298564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
39308564acf9Swdenk
39316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
39328564acf9Swdenk		If defined, hardware flash sectors protection is used
39338564acf9Swdenk		instead of U-Boot software protection.
39348564acf9Swdenk
39356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3936c609719bSwdenk
3937c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3938c609719bSwdenk		without this option such a download has to be
3939c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3940c609719bSwdenk		copy from RAM to flash.
3941c609719bSwdenk
3942c609719bSwdenk		The two-step approach is usually more reliable, since
3943c609719bSwdenk		you can check if the download worked before you erase
394411ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
394511ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3946c609719bSwdenk		downloaded image) this option may be very useful.
3947c609719bSwdenk
39486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3949c609719bSwdenk		Define if the flash driver uses extra elements in the
39505653fc33Swdenk		common flash structure for storing flash geometry.
39515653fc33Swdenk
395200b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
39535653fc33Swdenk		This option also enables the building of the cfi_flash driver
39545653fc33Swdenk		in the drivers directory
395553cf9435Sstroese
395691809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
395791809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
395891809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
395991809ed5SPiotr Ziecik		to the MTD layer.
396091809ed5SPiotr Ziecik
39616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
396296ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
396396ef831fSGuennadi Liakhovetski
396496ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
396596ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
396696ef831fSGuennadi Liakhovetski		write commands.
396796ef831fSGuennadi Liakhovetski
39686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
39695568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
39705568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
39715568e613SStefan Roese		is useful, if some of the configured banks are only
39725568e613SStefan Roese		optionally available.
39735568e613SStefan Roese
39749a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
39759a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
39769a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
39779a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
39789a042e9cSJerry Van Baren
3979352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3980352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3981352ef3f1SStefan Roese		against the source after the write operation. An error message
3982352ef3f1SStefan Roese		will be printed when the contents are not identical.
3983352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3984352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3985352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3986352ef3f1SStefan Roese		this option if you really know what you are doing.
3987352ef3f1SStefan Roese
39886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
398911ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
399011ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
399153cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
399253cf9435Sstroese		buffers can be full shortly after enabling the interface
399311ccc33fSMarcel Ziswiler		on high Ethernet traffic.
399453cf9435Sstroese		Defaults to 4 if not defined.
3995c609719bSwdenk
3996ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3997ea882bafSWolfgang Denk
3998ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3999ea882bafSWolfgang Denk	internally to store the environment settings. The default
4000ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
4001ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
4002ea882bafSWolfgang Denk	lib/hashtable.c for details.
4003ea882bafSWolfgang Denk
40042598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
40052598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
40061bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
40072598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
40082598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
40092598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
40102598090bSJoe Hershberger
40112598090bSJoe Hershberger	The format of the list is:
40122598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
4013b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
4014b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
40152598090bSJoe Hershberger		entry = variable_name[:attributes]
40162598090bSJoe Hershberger		list = entry[,list]
40172598090bSJoe Hershberger
40182598090bSJoe Hershberger	The type attributes are:
40192598090bSJoe Hershberger		s - String (default)
40202598090bSJoe Hershberger		d - Decimal
40212598090bSJoe Hershberger		x - Hexadecimal
40222598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
40232598090bSJoe Hershberger		i - IP address
40242598090bSJoe Hershberger		m - MAC address
40252598090bSJoe Hershberger
4026267541f7SJoe Hershberger	The access attributes are:
4027267541f7SJoe Hershberger		a - Any (default)
4028267541f7SJoe Hershberger		r - Read-only
4029267541f7SJoe Hershberger		o - Write-once
4030267541f7SJoe Hershberger		c - Change-default
4031267541f7SJoe Hershberger
40322598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
40332598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
4034b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
40352598090bSJoe Hershberger
40362598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
40372598090bSJoe Hershberger		Define this to a list (string) to define validation that
40382598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
40392598090bSJoe Hershberger		environment variable.  To override a setting in the static
40402598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
40412598090bSJoe Hershberger		".flags" variable.
40422598090bSJoe Hershberger
4043bdf1fe4eSJoe Hershberger	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4044bdf1fe4eSJoe Hershberger	regular expression. This allows multiple variables to define the same
4045bdf1fe4eSJoe Hershberger	flags without explicitly listing them for each variable.
4046bdf1fe4eSJoe Hershberger
4047267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
4048267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
4049267541f7SJoe Hershberger	access flags.
4050267541f7SJoe Hershberger
40515c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
40525c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
40535c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
40545c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
40555c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
40565c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
40570a12e687SMasahiro Yamada	must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
40580a12e687SMasahiro Yamada	If you find problems enabling this option on your board please report
40590a12e687SMasahiro Yamada	the problem and send patches!
40605c1a7ea6SSimon Glass
40610b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
40620b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
40630b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
4064b445bbb4SJeremiah Mahler	the value can be calculated on a given board.
4065632efa74SSimon Glass
40660d296cc2SGabe Black- CONFIG_USE_STDINT
40670d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
40680d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
40690d296cc2SGabe Black	building U-Boot to enable this.
40700d296cc2SGabe Black
4071c609719bSwdenkThe following definitions that deal with the placement and management
4072c609719bSwdenkof environment data (variable area); in general, we support the
4073c609719bSwdenkfollowing configurations:
4074c609719bSwdenk
4075c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
4076c3eb3fe4SMike Frysinger
4077c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
4078c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
4079c3eb3fe4SMike Frysinger
40805a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
4081c609719bSwdenk
4082c609719bSwdenk	Define this if the environment is in flash memory.
4083c609719bSwdenk
4084c609719bSwdenk	a) The environment occupies one whole flash sector, which is
4085c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
4086c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
4087c609719bSwdenk	   sector" type flash chips, which have several smaller
4088c609719bSwdenk	   sectors at the start or the end. For instance, such a
4089c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4090c609719bSwdenk	   such a case you would place the environment in one of the
4091c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
4092c609719bSwdenk	   "top boot sector" type flash chips, you would put the
4093c609719bSwdenk	   environment in one of the last sectors, leaving a gap
4094c609719bSwdenk	   between U-Boot and the environment.
4095c609719bSwdenk
40960e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4097c609719bSwdenk
4098c609719bSwdenk	   Offset of environment data (variable area) to the
4099c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
4100c609719bSwdenk	   type flash chips the second sector can be used: the offset
4101c609719bSwdenk	   for this sector is given here.
4102c609719bSwdenk
41036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4104c609719bSwdenk
41050e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4106c609719bSwdenk
4107c609719bSwdenk	   This is just another way to specify the start address of
4108c609719bSwdenk	   the flash sector containing the environment (instead of
41090e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
4110c609719bSwdenk
41110e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
4112c609719bSwdenk
4113c609719bSwdenk	   Size of the sector containing the environment.
4114c609719bSwdenk
4115c609719bSwdenk
4116c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
4117c609719bSwdenk	   In such a case you don't want to spend a whole sector for
4118c609719bSwdenk	   the environment.
4119c609719bSwdenk
41200e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4121c609719bSwdenk
41225a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
41230e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4124c609719bSwdenk	   of this flash sector for the environment. This saves
4125c609719bSwdenk	   memory for the RAM copy of the environment.
4126c609719bSwdenk
4127c609719bSwdenk	   It may also save flash memory if you decide to use this
4128c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
4129c609719bSwdenk	   since then the remainder of the flash sector could be used
4130c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4131c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4132c609719bSwdenk	   updating the environment in flash makes it always
4133c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4134c609719bSwdenk	   wrong before the contents has been restored from a copy in
4135c609719bSwdenk	   RAM, your target system will be dead.
4136c609719bSwdenk
41370e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
41380e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4139c609719bSwdenk
4140c609719bSwdenk	   These settings describe a second storage area used to hold
414111ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
41423e38691eSwdenk	   a valid backup copy in case there is a power failure during
4143c609719bSwdenk	   a "saveenv" operation.
4144c609719bSwdenk
4145c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4146c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4147c609719bSwdenkaccordingly!
4148c609719bSwdenk
4149c609719bSwdenk
41509314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4151c609719bSwdenk
4152c609719bSwdenk	Define this if you have some non-volatile memory device
4153c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4154c609719bSwdenk	environment.
4155c609719bSwdenk
41560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
41570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4158c609719bSwdenk
415911ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4160c609719bSwdenk	  want to use for environment. It is assumed that this memory
4161c609719bSwdenk	  can just be read and written to, without any special
4162c609719bSwdenk	  provision.
4163c609719bSwdenk
4164c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4165b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
416611ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4167c609719bSwdenkU-Boot will hang.
4168c609719bSwdenk
4169c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4170c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4171c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4172c609719bSwdenkto save the current settings.
4173c609719bSwdenk
4174c609719bSwdenk
4175bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4176c609719bSwdenk
4177c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4178c609719bSwdenk	device and a driver for it.
4179c609719bSwdenk
41800e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
41810e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4182c609719bSwdenk
4183c609719bSwdenk	  These two #defines specify the offset and size of the
4184c609719bSwdenk	  environment area within the total memory of your EEPROM.
4185c609719bSwdenk
41866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4187c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4188c609719bSwdenk	  The default address is zero.
4189c609719bSwdenk
4190189d257bSChristian Gmeiner	- CONFIG_SYS_I2C_EEPROM_BUS:
4191189d257bSChristian Gmeiner	  If defined, specified the i2c bus of the EEPROM device.
4192189d257bSChristian Gmeiner
41936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4194c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4195c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4196c609719bSwdenk	  would require six bits.
4197c609719bSwdenk
41986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4199c609719bSwdenk	  If defined, the number of milliseconds to delay between
4200c609719bSwdenk	  page writes.	The default is zero milliseconds.
4201c609719bSwdenk
42026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4203c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4204c609719bSwdenk	  that this is NOT the chip address length!
4205c609719bSwdenk
42066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
42075cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
42085cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
42095cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
42105cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
42115cf91d6bSwdenk	  byte chips.
42125cf91d6bSwdenk
42135cf91d6bSwdenk	  Note that we consider the length of the address field to
42145cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
42155cf91d6bSwdenk	  in the chip address.
42165cf91d6bSwdenk
42176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4218c609719bSwdenk	  The size in bytes of the EEPROM device.
4219c609719bSwdenk
4220548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4221548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4222548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4223548738b4SHeiko Schocher
4224548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4225548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4226548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4227548738b4SHeiko Schocher	  EEPROM. For example:
4228548738b4SHeiko Schocher
4229ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4230548738b4SHeiko Schocher
4231548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4232548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4233c609719bSwdenk
4234057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
42355779d8d9Swdenk
42365779d8d9Swdenk	Define this if you have a DataFlash memory device which you
42375779d8d9Swdenk	want to use for the environment.
42385779d8d9Swdenk
42390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
42400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
42410e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
42425779d8d9Swdenk
42435779d8d9Swdenk	  These three #defines specify the offset and size of the
42445779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
42455779d8d9Swdenk	  at the specified address.
42465779d8d9Swdenk
4247bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4248bd83b592SWu, Josh
4249bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4250bd83b592SWu, Josh	want to use for the environment.
4251bd83b592SWu, Josh
4252bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4253bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4254bd83b592SWu, Josh
4255bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4256bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4257bd83b592SWu, Josh	  aligned to an erase sector boundary.
4258bd83b592SWu, Josh
4259bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4260bd83b592SWu, Josh
4261bd83b592SWu, Josh	  Define the SPI flash's sector size.
4262bd83b592SWu, Josh
4263bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4264bd83b592SWu, Josh
4265bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4266bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4267bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
4268bd83b592SWu, Josh	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4269bd83b592SWu, Josh	  aligned to an erase sector boundary.
4270bd83b592SWu, Josh
4271bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4272bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4273bd83b592SWu, Josh
4274bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4275bd83b592SWu, Josh
4276bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4277bd83b592SWu, Josh
4278bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4279bd83b592SWu, Josh
4280bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4281bd83b592SWu, Josh
4282bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4283bd83b592SWu, Josh
42840a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
42850a85a9e7SLiu Gang
42860a85a9e7SLiu Gang	Define this if you have a remote memory space which you
42870a85a9e7SLiu Gang	want to use for the local device's environment.
42880a85a9e7SLiu Gang
42890a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
42900a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
42910a85a9e7SLiu Gang
42920a85a9e7SLiu Gang	  These two #defines specify the address and size of the
42930a85a9e7SLiu Gang	  environment area within the remote memory space. The
42940a85a9e7SLiu Gang	  local device can get the environment from remote memory
4295fc54c7faSLiu Gang	  space by SRIO or PCIE links.
42960a85a9e7SLiu Gang
42970a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
42980a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4299fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4300fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
43010a85a9e7SLiu Gang
430251bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
430313a5695bSwdenk
430413a5695bSwdenk	Define this if you have a NAND device which you want to use
430513a5695bSwdenk	for the environment.
430613a5695bSwdenk
43070e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
43080e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
430913a5695bSwdenk
431013a5695bSwdenk	  These two #defines specify the offset and size of the environment
4311fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4312fdd813deSScott Wood	  aligned to an erase block boundary.
43135779d8d9Swdenk
4314fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4315e443c944SMarkus Klotzbuecher
43160e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4317fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4318fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4319fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4320fdd813deSScott Wood	  aligned to an erase block boundary.
4321e443c944SMarkus Klotzbuecher
4322fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4323fdd813deSScott Wood
4324fdd813deSScott Wood	  Specifies the length of the region in which the environment
4325fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4326fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4327fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4328fdd813deSScott Wood	  the range to be avoided.
4329fdd813deSScott Wood
4330fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4331fdd813deSScott Wood
4332fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4333fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4334fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4335fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4336fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4337e443c944SMarkus Klotzbuecher
4338b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4339b74ab737SGuennadi Liakhovetski
4340b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4341b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4342b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4343b74ab737SGuennadi Liakhovetski
43442b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
43452b74433fSJoe Hershberger
43462b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
43472b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
43482b74433fSJoe Hershberger	accesses, which is important on NAND.
43492b74433fSJoe Hershberger
43502b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
43512b74433fSJoe Hershberger
43522b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
43532b74433fSJoe Hershberger
43542b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
43552b74433fSJoe Hershberger
43562b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
43572b74433fSJoe Hershberger	  environment in.
43582b74433fSJoe Hershberger
4359785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4360785881f7SJoe Hershberger
4361785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4362785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4363785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4364785881f7SJoe Hershberger
43652b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
43662b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
43672b74433fSJoe Hershberger
43682b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
43692b74433fSJoe Hershberger	  when storing the env in UBI.
43702b74433fSJoe Hershberger
4371d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4372d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4373d1db76f1SWu, Josh
4374d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4375d1db76f1SWu, Josh
4376d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4377d1db76f1SWu, Josh
4378d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4379d1db76f1SWu, Josh
4380d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4381d1db76f1SWu, Josh         be as following:
4382d1db76f1SWu, Josh
4383d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4384d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4385d1db76f1SWu, Josh                        partition table.
4386d1db76f1SWu, Josh               - "D:0": device D.
4387d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4388d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4389d1db76f1SWu, Josh                              table.
4390d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4391b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
4392d1db76f1SWu, Josh                           partition table then means device D.
4393d1db76f1SWu, Josh
4394d1db76f1SWu, Josh       - FAT_ENV_FILE:
4395d1db76f1SWu, Josh
4396d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4397b445bbb4SJeremiah Mahler         environment.
4398d1db76f1SWu, Josh
4399d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4400b445bbb4SJeremiah Mahler         This should be defined. Otherwise it cannot save the environment file.
4401d1db76f1SWu, Josh
440206e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
440306e4ae5fSStephen Warren
440406e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
440506e4ae5fSStephen Warren	environment.
440606e4ae5fSStephen Warren
440706e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
440806e4ae5fSStephen Warren
440906e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
441006e4ae5fSStephen Warren
441106e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
441206e4ae5fSStephen Warren
441306e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
441406e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
441506e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
441606e4ae5fSStephen Warren
441706e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
441806e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
441906e4ae5fSStephen Warren
442006e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
442106e4ae5fSStephen Warren	  area within the specified MMC device.
442206e4ae5fSStephen Warren
44235c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
44245c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
44255c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
44265c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
44275c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
44285c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
44295c088ee8SStephen Warren	  maximum possible space before it, to store other data.
44305c088ee8SStephen Warren
443106e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
443206e4ae5fSStephen Warren	  MMC sector boundary.
443306e4ae5fSStephen Warren
443406e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
443506e4ae5fSStephen Warren
443606e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
443706e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
443806e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
443906e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
444006e4ae5fSStephen Warren
44415c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
44425c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
44435c088ee8SStephen Warren
444406e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
444506e4ae5fSStephen Warren	  an MMC sector boundary.
444606e4ae5fSStephen Warren
444706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
444806e4ae5fSStephen Warren
444906e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
445006e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
445106e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
445206e4ae5fSStephen Warren
44536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4454c609719bSwdenk
4455c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4456c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4457c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4458c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4459c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4460c609719bSwdenk	to be a good choice since it makes it far enough from the
4461c609719bSwdenk	start of the data area as well as from the stack pointer.
4462c609719bSwdenk
4463e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4464c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4465cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4466c609719bSwdenkuntil then to read environment variables.
4467c609719bSwdenk
446885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
446985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
447085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
447185ec0bccSwdenknecessary, because the first environment variable we need is the
447285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
447385ec0bccSwdenkhave any device yet where we could complain.]
4474c609719bSwdenk
4475c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4476c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
447785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4478c609719bSwdenk
44796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4480fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4481fc3e2165Swdenk
44826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4483fc3e2165Swdenk		      also needs to be defined.
4484fc3e2165Swdenk
44856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4486fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4487c609719bSwdenk
4488f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4489f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4490f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4491f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4492f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4493f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4494f5675aa5SRon Madrid
4495b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4496b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4497b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4498b2b92f53SSimon Glass		to do this.
4499b2b92f53SSimon Glass
4500e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4501e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4502e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4503e2e3e2b1SSimon Glass		present.
4504e2e3e2b1SSimon Glass
4505feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4506feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4507feb85801SSascha Silbe		build system checks that the actual size does not
4508feb85801SSascha Silbe		exceed it.
4509feb85801SSascha Silbe
4510c609719bSwdenkLow Level (hardware related) configuration options:
4511dc7c9a1aSwdenk---------------------------------------------------
4512c609719bSwdenk
45136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4514c609719bSwdenk		Cache Line Size of the CPU.
4515c609719bSwdenk
45166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4517c609719bSwdenk		Default address of the IMMR after system reset.
45182535d602Swdenk
45192535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
45202535d602Swdenk		and RPXsuper) to be able to adjust the position of
45212535d602Swdenk		the IMMR register after a reset.
4522c609719bSwdenk
4523e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4524e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4525e46fedfeSTimur Tabi		PowerPC SOCs.
4526e46fedfeSTimur Tabi
4527e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4528e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4529e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4530e46fedfeSTimur Tabi
4531e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4532e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4533e46fedfeSTimur Tabi
4534e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4535e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4536e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4537e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4538e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4539e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4540e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4541e46fedfeSTimur Tabi
4542e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4543e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4544e46fedfeSTimur Tabi
4545e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4546e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4547e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4548e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4549e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4550e46fedfeSTimur Tabi
4551e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4552e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4553e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4554e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4555e46fedfeSTimur Tabi
4556e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4557e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4558e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4559e46fedfeSTimur Tabi
45607f6c2cbcSwdenk- Floppy Disk Support:
45616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
45627f6c2cbcSwdenk
45637f6c2cbcSwdenk		the default drive number (default value 0)
45647f6c2cbcSwdenk
45656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
45667f6c2cbcSwdenk
456711ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
45687f6c2cbcSwdenk		(default value 1)
45697f6c2cbcSwdenk
45706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
45717f6c2cbcSwdenk
45727f6c2cbcSwdenk		defines the offset of register from address. It
45737f6c2cbcSwdenk		depends on which part of the data bus is connected to
457411ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
45757f6c2cbcSwdenk
45766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
45776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
45787f6c2cbcSwdenk		default value.
45797f6c2cbcSwdenk
45806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
45817f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
45827f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
4583b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
45847f6c2cbcSwdenk		initializations.
45857f6c2cbcSwdenk
45860abddf82SMacpaul Lin- CONFIG_IDE_AHB:
45870abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
45880abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
45890abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
45900abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
45910abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4592b445bbb4SJeremiah Mahler		is required.
45930abddf82SMacpaul Lin
45946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
459525d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
459625d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4597c609719bSwdenk
45986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4599c609719bSwdenk
46007152b1d0Swdenk		Start address of memory area that can be used for
4601c609719bSwdenk		initial data and stack; please note that this must be
4602c609719bSwdenk		writable memory that is working WITHOUT special
4603c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4604c609719bSwdenk		will become available only after programming the
4605c609719bSwdenk		memory controller and running certain initialization
4606c609719bSwdenk		sequences.
4607c609719bSwdenk
4608c609719bSwdenk		U-Boot uses the following memory types:
4609c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4610c609719bSwdenk		- MPC824X: data cache
4611c609719bSwdenk		- PPC4xx:  data cache
4612c609719bSwdenk
46136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4614c609719bSwdenk
4615c609719bSwdenk		Offset of the initial data structure in the memory
46166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
46176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4618c609719bSwdenk		data is located at the end of the available space
4619553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
46206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
46216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
46226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4623c609719bSwdenk
4624c609719bSwdenk	Note:
4625c609719bSwdenk		On the MPC824X (or other systems that use the data
4626c609719bSwdenk		cache for initial memory) the address chosen for
46276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4628c609719bSwdenk		point to an otherwise UNUSED address space between
4629c609719bSwdenk		the top of RAM and the start of the PCI space.
4630c609719bSwdenk
46316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4632c609719bSwdenk
46336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4634c609719bSwdenk
46356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4636c609719bSwdenk
46376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4638c609719bSwdenk
46396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4640c609719bSwdenk
46416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4642c609719bSwdenk
46436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4644c609719bSwdenk		SDRAM timing
4645c609719bSwdenk
46466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4647c609719bSwdenk		periodic timer for refresh
4648c609719bSwdenk
46496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4650c609719bSwdenk
46516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
46526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
46536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
46546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4655c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4656c609719bSwdenk
4657c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
46586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
46596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4660c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4661c609719bSwdenk
46626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
46636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4664c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4665c609719bSwdenk		Prescaler definitions (SDRAM timing)
4666c609719bSwdenk
46676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4668c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4669c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4670c609719bSwdenk
46716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4672b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4673b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4674b423d055SHeiko Schocher
46756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4676c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4677c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4678c609719bSwdenk
46796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4680c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4681c609719bSwdenk		wrong setting might damage your board. Read
4682c609719bSwdenk		doc/README.MBX before setting this variable!
4683c609719bSwdenk
46846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4685ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4686ea909b76Swdenk		(Power On Self Tests). This definition overrides
4687ea909b76Swdenk		#define'd default value in commproc.h resp.
4688ea909b76Swdenk		cpm_8260.h.
4689ea909b76Swdenk
46906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
46916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
46926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
46936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
46946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
46956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
46966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
46976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4698a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
46995d232d0eSwdenk
47009cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
47019cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
47029cacf4fcSDirk Eibach		required.
47039cacf4fcSDirk Eibach
470469fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4705b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
470669fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
470769fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
470869fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
470969fd2d3bSAndrew Sharp		by coreboot or similar.
471069fd2d3bSAndrew Sharp
4711842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4712842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4713842033e6SGabor Juhos
4714a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4715a09b9b68SKumar Gala		Chip has SRIO or not
4716a09b9b68SKumar Gala
4717a09b9b68SKumar Gala- CONFIG_SRIO1:
4718a09b9b68SKumar Gala		Board has SRIO 1 port available
4719a09b9b68SKumar Gala
4720a09b9b68SKumar Gala- CONFIG_SRIO2:
4721a09b9b68SKumar Gala		Board has SRIO 2 port available
4722a09b9b68SKumar Gala
4723c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4724c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4725c8b28152SLiu Gang
4726a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4727a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4728a09b9b68SKumar Gala
4729a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4730a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4731a09b9b68SKumar Gala
4732a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4733a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4734a09b9b68SKumar Gala
473566bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
473666bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
473766bd1846SFabio Estevam		a 16 bit bus.
473866bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4739a430e916SFabio Estevam		Example of drivers that use it:
474066bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4741a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4742eced4626SAlex Waterman
4743eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4744eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4745eced4626SAlex Waterman		a default value will be used.
4746eced4626SAlex Waterman
4747bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4748218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4749218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4750218ca724SWolfgang Denk
4751bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4752bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4753bb99ad6dSBen Warren
47546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4755218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4756218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4757218ca724SWolfgang Denk		to something your driver can deal with.
4758bb99ad6dSBen Warren
47591b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
47601b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
47611b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
47621b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
47631b3e3c4fSYork Sun		header files or board specific files.
47641b3e3c4fSYork Sun
47656f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
47666f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
47676f5e1dc5SYork Sun
4768e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
4769e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
4770e32d59a2SYork Sun
47714516ff81SYork Sun- CONFIG_FSL_DDR_BIST
47724516ff81SYork Sun		Enable built-in memory test for Freescale DDR controllers.
47734516ff81SYork Sun
47746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4775218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4776218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
47772ad6b513STimur Tabi
4778c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4779c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4780c26e454dSwdenk
4781c26e454dSwdenk- CONFIG_FEC[12]_PHY
4782c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
47836e592385Swdenk		to the given FEC; i. e.
4784c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4785c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4786c26e454dSwdenk
4787c26e454dSwdenk		When set to -1, means to probe for first available.
4788c26e454dSwdenk
4789c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4790c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4791c26e454dSwdenk		(so program the FEC to ignore it).
4792c26e454dSwdenk
4793c26e454dSwdenk- CONFIG_RMII
4794c26e454dSwdenk		Enable RMII mode for all FECs.
4795c26e454dSwdenk		Note that this is a global option, we can't
4796c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4797c26e454dSwdenk
47985cf91d6bSwdenk- CONFIG_CRC32_VERIFY
47995cf91d6bSwdenk		Add a verify option to the crc32 command.
48005cf91d6bSwdenk		The syntax is:
48015cf91d6bSwdenk
48025cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
48035cf91d6bSwdenk
48045cf91d6bSwdenk		Where address/count indicate a memory area
48055cf91d6bSwdenk		and crc32 is the correct crc32 which the
48065cf91d6bSwdenk		area should have.
48075cf91d6bSwdenk
480856523f12Swdenk- CONFIG_LOOPW
480956523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4810602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
481156523f12Swdenk
48127b466641Sstroese- CONFIG_MX_CYCLIC
48137b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
48147b466641Sstroese		"md/mw" commands.
48157b466641Sstroese		Examples:
48167b466641Sstroese
48177b466641Sstroese		=> mdc.b 10 4 500
48187b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
48197b466641Sstroese
48207b466641Sstroese		=> mwc.l 100 12345678 10
48217b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
48227b466641Sstroese
48237b466641Sstroese		This only takes effect if the memory commands are activated
4824602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
48257b466641Sstroese
48268aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4827afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4828e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4829e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4830e03f3169SWolfgang Denk		relocate itself into RAM.
48318aa1a2d1Swdenk
4832e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4833e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4834e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4835e03f3169SWolfgang Denk		these initializations itself.
48368aa1a2d1Swdenk
4837401bb30bSAneesh V- CONFIG_SPL_BUILD
4838df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4839df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4840df81238bSMagnus Lilja		compiling a NAND SPL.
4841400558b5Swdenk
48423aa29de0SYing Zhang- CONFIG_TPL_BUILD
48433aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
48443aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
48453aa29de0SYing Zhang		It is loaded by the SPL.
48463aa29de0SYing Zhang
48475df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
48485df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
48495df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
48505df572f0SYing Zhang		previous 4k of the .text section.
48515df572f0SYing Zhang
48524213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
48534213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
48544213fc29SSimon Glass		effective address. It is therefore not necessary to regard
48554213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
48564213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
48574213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
48584213fc29SSimon Glass		addressable memory. This option causes some memory accesses
48594213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
48604213fc29SSimon Glass
4861d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4862d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4863d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4864d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4865d8834a13SMatthias Weisser		conditions but may increase the binary size.
4866d8834a13SMatthias Weisser
4867588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4868588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4869588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4870b16f521aSGabe Black
4871fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4872fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4873fc33705eSMark Jackson
4874fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
48755b5ece9eSGabe Black
487616678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
487716678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
487816678eb4SHeiko Schocher
4879999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4880999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4881999d7d32SKaricheri, Muralidharan		driver that uses this:
4882999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4883999d7d32SKaricheri, Muralidharan
4884f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4885f2717b47STimur Tabi-----------------------------------
4886f2717b47STimur Tabi
4887f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4888f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4889f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4890f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4891f2717b47STimur Tabiwithin that device.
4892f2717b47STimur Tabi
4893dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4894dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4895dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4896dcf1d774SZhao Qiang	is also specified.
4897dcf1d774SZhao Qiang
4898dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4899dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4900f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4901f2717b47STimur Tabi	is also specified.
4902f2717b47STimur Tabi
4903f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4904f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4905f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4906f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4907f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4908f2717b47STimur Tabi
4909f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4910f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4911f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4912f2717b47STimur Tabi	virtual address in NOR flash.
4913f2717b47STimur Tabi
4914f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4915f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4916f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4917f2717b47STimur Tabi
4918f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4919f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4920f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4921f2717b47STimur Tabi
4922f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4923f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4924f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4925f2717b47STimur Tabi
4926292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4927292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4928292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4929fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4930fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4931fc54c7faSLiu Gang	master's memory space.
4932f2717b47STimur Tabi
4933b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
4934b940ca64SJ. German Rivera---------------------------------------------------------
4935b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
4936b940ca64SJ. German Rivera"firmware".
4937b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
4938b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
4939b940ca64SJ. German Riverawithin that device.
4940b940ca64SJ. German Rivera
4941b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
4942b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
4943b940ca64SJ. German Rivera
4944b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR
4945b940ca64SJ. German Rivera	The address in the storage device where the firmware is located.  The
4946b940ca64SJ. German Rivera	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4947b940ca64SJ. German Rivera	is also specified.
4948b940ca64SJ. German Rivera
4949b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH
4950b940ca64SJ. German Rivera	The maximum possible size of the firmware.  The firmware binary format
4951b940ca64SJ. German Rivera	has a field that specifies the actual size of the firmware, but it
4952b940ca64SJ. German Rivera	might not be possible to read any part of the firmware unless some
4953b940ca64SJ. German Rivera	local storage is allocated to hold the entire firmware first.
4954b940ca64SJ. German Rivera
4955b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR
4956b940ca64SJ. German Rivera	Specifies that MC firmware is located in NOR flash, mapped as
4957b940ca64SJ. German Rivera	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4958b940ca64SJ. German Rivera	virtual address in NOR flash.
4959b940ca64SJ. German Rivera
49605c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support:
49615c055089SPrabhakar Kushwaha-------------------------------------------
49625c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of
49635c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom.
49645c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting.
49655c055089SPrabhakar Kushwaha
49665c055089SPrabhakar Kushwaha- CONFIG_FSL_DEBUG_SERVER
49675c055089SPrabhakar Kushwaha	Enable the Debug Server for Layerscape SoCs.
49685c055089SPrabhakar Kushwaha
49695c055089SPrabhakar Kushwaha- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
49705c055089SPrabhakar Kushwaha	Define minimum DDR size required for debug server image
49715c055089SPrabhakar Kushwaha
4972c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN
4973c0492141SYork Sun	Define alignment of reserved memory MC requires
49745c055089SPrabhakar Kushwaha
4975f3f431a7SPaul KocialkowskiReproducible builds
4976f3f431a7SPaul Kocialkowski-------------------
4977f3f431a7SPaul Kocialkowski
4978f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build
4979f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value.
4980f3f431a7SPaul Kocialkowski
4981f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable.
4982f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4983f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot.
4984f3f431a7SPaul Kocialkowski
4985f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4986f3f431a7SPaul Kocialkowski
4987c609719bSwdenkBuilding the Software:
4988c609719bSwdenk======================
4989c609719bSwdenk
4990218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4991218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4992218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4993218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4994218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4995218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4996c609719bSwdenk
4997218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4998218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4999218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
5000218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
5001218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
5002c609719bSwdenk
5003218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
5004218ca724SWolfgang Denk	$ export CROSS_COMPILE
5005c609719bSwdenk
50062f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
50072f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
50082f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
50092f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
50102f8d396bSPeter Tyser
50112f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
50122f8d396bSPeter Tyser
50132f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
50142f8d396bSPeter Tyser      be executed on computers running Windows.
50152f8d396bSPeter Tyser
5016c609719bSwdenkU-Boot is intended to be simple to build. After installing the
5017c609719bSwdenksources you must configure U-Boot for one specific board type. This
5018c609719bSwdenkis done by typing:
5019c609719bSwdenk
5020ab584d67SHolger Freyther	make NAME_defconfig
5021c609719bSwdenk
5022ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
50234d675ae6SMichael Jonesrations; see boards.cfg for supported names.
502454387ac9Swdenk
5025c609719bSwdenkNote: for some board special configuration names may exist; check if
5026c609719bSwdenk      additional information is available from the board vendor; for
50272729af9dSwdenk      instance, the TQM823L systems are available without (standard)
50282729af9dSwdenk      or with LCD support. You can select such additional "features"
502911ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
5030c609719bSwdenk
5031ab584d67SHolger Freyther      make TQM823L_defconfig
50322729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
5033c609719bSwdenk
5034ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
5035c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
5036c609719bSwdenk
5037c609719bSwdenk      etc.
5038c609719bSwdenk
5039c609719bSwdenk
5040c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
50417152b1d0Swdenkimages ready for download to / installation on your system:
5042c609719bSwdenk
5043c609719bSwdenk- "u-boot.bin" is a raw binary image
5044c609719bSwdenk- "u-boot" is an image in ELF binary format
5045c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
5046c609719bSwdenk
5047baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
5048baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
5049baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
5050baf31249SMarian Balakowicz
5051baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
5052baf31249SMarian Balakowicz
5053baf31249SMarian Balakowicz	make O=/tmp/build distclean
5054ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
5055baf31249SMarian Balakowicz	make O=/tmp/build all
5056baf31249SMarian Balakowicz
5057adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
5058baf31249SMarian Balakowicz
5059adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
5060baf31249SMarian Balakowicz	make distclean
5061ab584d67SHolger Freyther	make NAME_defconfig
5062baf31249SMarian Balakowicz	make all
5063baf31249SMarian Balakowicz
5064adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
5065baf31249SMarian Balakowiczvariable.
5066baf31249SMarian Balakowicz
5067c609719bSwdenk
5068c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
5069c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
5070c609719bSwdenknative "make".
5071c609719bSwdenk
5072c609719bSwdenk
5073c609719bSwdenkIf the system board that you have is not listed, then you will need
5074c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
5075c609719bSwdenksteps:
5076c609719bSwdenk
50773c1496cdSPhil Sutter1.  Create a new directory to hold your board specific code. Add any
507885ec0bccSwdenk    files you need. In your board directory, you will need at least
50793c1496cdSPhil Sutter    the "Makefile" and a "<board>.c".
50803c1496cdSPhil Sutter2.  Create a new configuration file "include/configs/<board>.h" for
50813c1496cdSPhil Sutter    your board.
5082c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
5083c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
5084ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
5085c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
5086c609719bSwdenk    to be installed on your target system.
508785ec0bccSwdenk6.  Debug and solve any problems that might arise.
5088c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
5089c609719bSwdenk
5090c609719bSwdenk
5091c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
5092c609719bSwdenk==============================================================
5093c609719bSwdenk
5094c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
5095c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
5096c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
5097c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
5098218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
5099c609719bSwdenk
5100c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
5101c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
5102c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
5103c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
5104c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
51057152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
5106218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
5107218ca724SWolfgang Denkyou can type
5108c609719bSwdenk
5109c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
5110c609719bSwdenk
5111c609719bSwdenkor to build on a native PowerPC system you can type
5112c609719bSwdenk
5113c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
5114c609719bSwdenk
5115218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
5116218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
5117218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
5118218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
5119218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
5120218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
5121218ca724SWolfgang Denkvariable. For example:
5122baf31249SMarian Balakowicz
5123baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
5124baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
5125baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
5126baf31249SMarian Balakowicz
5127218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
5128218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
5129218ca724SWolfgang Denkduring the whole build process.
5130baf31249SMarian Balakowicz
5131baf31249SMarian Balakowicz
5132c609719bSwdenkSee also "U-Boot Porting Guide" below.
5133c609719bSwdenk
5134c609719bSwdenk
5135c609719bSwdenkMonitor Commands - Overview:
5136c609719bSwdenk============================
5137c609719bSwdenk
5138c609719bSwdenkgo	- start application at address 'addr'
5139c609719bSwdenkrun	- run commands in an environment variable
5140c609719bSwdenkbootm	- boot application image from memory
5141c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
514244f074c7SMarek Vasutbootz   - boot zImage from memory
5143c609719bSwdenktftpboot- boot image via network using TFTP protocol
5144c609719bSwdenk	       and env variables "ipaddr" and "serverip"
5145c609719bSwdenk	       (and eventually "gatewayip")
51461fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
5147c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
5148c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5149c609719bSwdenkloads	- load S-Record file over serial line
5150c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
5151c609719bSwdenkmd	- memory display
5152c609719bSwdenkmm	- memory modify (auto-incrementing)
5153c609719bSwdenknm	- memory modify (constant address)
5154c609719bSwdenkmw	- memory write (fill)
5155c609719bSwdenkcp	- memory copy
5156c609719bSwdenkcmp	- memory compare
5157c609719bSwdenkcrc32	- checksum calculation
51580f89c54bSPeter Tyseri2c	- I2C sub-system
5159c609719bSwdenksspi	- SPI utility commands
5160c609719bSwdenkbase	- print or set address offset
5161c609719bSwdenkprintenv- print environment variables
5162c609719bSwdenksetenv	- set environment variables
5163c609719bSwdenksaveenv - save environment variables to persistent storage
5164c609719bSwdenkprotect - enable or disable FLASH write protection
5165c609719bSwdenkerase	- erase FLASH memory
5166c609719bSwdenkflinfo	- print FLASH memory information
516710635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
5168c609719bSwdenkbdinfo	- print Board Info structure
5169c609719bSwdenkiminfo	- print header information for application image
5170c609719bSwdenkconinfo - print console devices and informations
5171c609719bSwdenkide	- IDE sub-system
5172c609719bSwdenkloop	- infinite loop on address range
517356523f12Swdenkloopw	- infinite write loop on address range
5174c609719bSwdenkmtest	- simple RAM test
5175c609719bSwdenkicache	- enable or disable instruction cache
5176c609719bSwdenkdcache	- enable or disable data cache
5177c609719bSwdenkreset	- Perform RESET of the CPU
5178c609719bSwdenkecho	- echo args to console
5179c609719bSwdenkversion - print monitor version
5180c609719bSwdenkhelp	- print online help
5181c609719bSwdenk?	- alias for 'help'
5182c609719bSwdenk
5183c609719bSwdenk
5184c609719bSwdenkMonitor Commands - Detailed Description:
5185c609719bSwdenk========================================
5186c609719bSwdenk
5187c609719bSwdenkTODO.
5188c609719bSwdenk
5189c609719bSwdenkFor now: just type "help <command>".
5190c609719bSwdenk
5191c609719bSwdenk
5192c609719bSwdenkEnvironment Variables:
5193c609719bSwdenk======================
5194c609719bSwdenk
5195c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5196c609719bSwdenkcan be made persistent by saving to Flash memory.
5197c609719bSwdenk
5198c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5199c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5200c609719bSwdenkwithout a value can be used to delete a variable from the
5201c609719bSwdenkenvironment. As long as you don't save the environment you are
5202c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5203c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5204c609719bSwdenk
5205c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5206c96f86eeSWolfgang Denk
5207c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5208c609719bSwdenk
5209c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5210c609719bSwdenk
5211c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5212c609719bSwdenk
5213c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5214c609719bSwdenk
5215c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5216c609719bSwdenk
5217c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5218c609719bSwdenk
52197d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
52207d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
52217d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
52227d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
52237d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
52247d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5225c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5226c3624e6eSGrant Likely		  bootm_mapsize.
5227c3624e6eSGrant Likely
5228c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5229c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5230c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5231c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5232c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5233c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5234c3624e6eSGrant Likely		  used otherwise.
52357d721e34SBartlomiej Sieka
52367d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
52377d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
52387d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
52397d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
52407d721e34SBartlomiej Sieka		  environment variable.
52417d721e34SBartlomiej Sieka
52424bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
52434bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
52444bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
52454bae9090SBartlomiej Sieka
5246c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5247c609719bSwdenk		  "bootp" will just load perform a lookup of the
5248c609719bSwdenk		  configuration from the BOOTP server, but not try to
5249c609719bSwdenk		  load any image using TFTP
5250c609719bSwdenk
5251c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5252c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5253c609719bSwdenk		  be automatically started (by internally calling
5254c609719bSwdenk		  "bootm")
5255c609719bSwdenk
52564a6fd34bSwdenk		  If set to "no", a standalone image passed to the
52574a6fd34bSwdenk		  "bootm" command will be copied to the load address
52584a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
52594a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
52604a6fd34bSwdenk		  data.
52614a6fd34bSwdenk
5262a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5263a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5264fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5265fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5266fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5267fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5268fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5269fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5270fa34f6b2SShawn Guo		  access it during the boot procedure.
5271fa34f6b2SShawn Guo
5272a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5273a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5274a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5275a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5276a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5277a28afca5SDavid A. Long		  must be accessible by the kernel.
5278a28afca5SDavid A. Long
5279eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5280eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5281eea63e05SSimon Glass		  defined.
5282eea63e05SSimon Glass
528317ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
528417ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
528517ea1177Swdenk		  mode (400kHZ). This environment variable is used in
528617ea1177Swdenk		  initialization code. So, for changes to be effective
528717ea1177Swdenk		  it must be saved and board must be reset.
528817ea1177Swdenk
5289c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5290c609719bSwdenk		  If this variable is not set, initrd images will be
5291c609719bSwdenk		  copied to the highest possible address in RAM; this
5292c609719bSwdenk		  is usually what you want since it allows for
5293c609719bSwdenk		  maximum initrd size. If for some reason you want to
5294c609719bSwdenk		  make sure that the initrd image is loaded below the
52956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5296c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5297c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5298c609719bSwdenk		  address to use (U-Boot will still check that it
5299c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5300c609719bSwdenk
5301c609719bSwdenk		  For instance, when you have a system with 16 MB
53027152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5303c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5304c609719bSwdenk		  the "bootargs" variable. However, now you must make
53057152b1d0Swdenk		  sure that the initrd image is placed in the first
5306c609719bSwdenk		  12 MB as well - this can be done with
5307c609719bSwdenk
5308c609719bSwdenk		  setenv initrd_high 00c00000
5309c609719bSwdenk
531038b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
531138b99261Swdenk		  indication to U-Boot that all addresses are legal
531238b99261Swdenk		  for the Linux kernel, including addresses in flash
531338b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
531438b99261Swdenk		  ramdisk at all. This may be useful to reduce the
531538b99261Swdenk		  boot time on your system, but requires that this
531638b99261Swdenk		  feature is supported by your Linux kernel.
531738b99261Swdenk
5318c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5319c609719bSwdenk
5320c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5321dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5322c609719bSwdenk
5323c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5324c609719bSwdenk
5325c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5326c609719bSwdenk
5327c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5328c609719bSwdenk
5329c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5330c609719bSwdenk
5331c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5332c609719bSwdenk
5333e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5334a3d991bdSwdenk
5335e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5336e2a53458SMike Frysinger		  For example you can do the following
5337a3d991bdSwdenk
533848690d80SHeiko Schocher		  => setenv ethact FEC
533948690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
534048690d80SHeiko Schocher		  => setenv ethact SCC
534148690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5342a3d991bdSwdenk
5343e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5344e1692577SMatthias Fuchs		  available network interfaces.
5345e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5346e1692577SMatthias Fuchs
5347a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5348a3d991bdSwdenk		  either succeed or fail without retrying.
53496e592385Swdenk		  When set to "once" the network operation will
53506e592385Swdenk		  fail when all the available network interfaces
53516e592385Swdenk		  are tried once without success.
5352a3d991bdSwdenk		  Useful on scripts which control the retry operation
5353a3d991bdSwdenk		  themselves.
5354a3d991bdSwdenk
5355b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5356a1cf027aSJean-Christophe PLAGNIOL-VILLARD
5357b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
53588d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
53598d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
53608d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
53618d51aacdSSimon Glass		  is silent.
53628d51aacdSSimon Glass
5363f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpsrcp	- If this is set, the value is used for TFTP's
5364ecb0ccd9SWolfgang Denk		  UDP source port.
5365ecb0ccd9SWolfgang Denk
5366f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpdstp	- If this is set, the value is used for TFTP's UDP
536728cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
536828cb9375SWolfgang Denk
5369c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5370c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5371c96f86eeSWolfgang Denk
5372c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5373c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5374c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5375c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5376c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5377c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5378c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5379c96f86eeSWolfgang Denk
5380f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
5381f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unit, minimum value = 0). Defines how many timeouts
5382f5fb7346SAlbert ARIBAUD \(3ADEV\)		  can happen during a single file transfer before that
5383f5fb7346SAlbert ARIBAUD \(3ADEV\)		  transfer is aborted. The default is 10, and 0 means
5384f5fb7346SAlbert ARIBAUD \(3ADEV\)		  'no timeouts allowed'. Increasing this value may help
5385f5fb7346SAlbert ARIBAUD \(3ADEV\)		  downloads succeed with high packet loss rates, or with
5386f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unreliable TFTP servers or client hardware.
5387f5fb7346SAlbert ARIBAUD \(3ADEV\)
5388a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
538911ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5390a3d991bdSwdenk		  VLAN tagged frames.
5391c609719bSwdenk
539250768f5bSAlexandre Messier  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
539350768f5bSAlexandre Messier		  Unsigned value, in milliseconds. If not set, the period will
539450768f5bSAlexandre Messier		  be either the default (28000), or a value based on
539550768f5bSAlexandre Messier		  CONFIG_NET_RETRY_COUNT, if defined. This value has
539650768f5bSAlexandre Messier		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
539750768f5bSAlexandre Messier
5398dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5399dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5400dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5401dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5402dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5403dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5404dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5405dc0b7b0eSJason Hobbs
5406dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5407aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some
5408dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5409dc0b7b0eSJason Hobbs
5410dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5411dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5412dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5413dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5414dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5415dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5416dc0b7b0eSJason Hobbs
5417c609719bSwdenkThe following environment variables may be used and automatically
5418c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5419c609719bSwdenkdepending the information provided by your boot server:
5420c609719bSwdenk
5421c609719bSwdenk  bootfile	- see above
5422c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5423fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5424c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5425c609719bSwdenk  hostname	- Target hostname
5426c609719bSwdenk  ipaddr	- see above
5427c609719bSwdenk  netmask	- Subnet Mask
5428c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5429c609719bSwdenk  serverip	- see above
5430c609719bSwdenk
5431c609719bSwdenk
5432c609719bSwdenkThere are two special Environment Variables:
5433c609719bSwdenk
5434c609719bSwdenk  serial#	- contains hardware identification information such
5435c609719bSwdenk		  as type string and/or serial number
5436c609719bSwdenk  ethaddr	- Ethernet address
5437c609719bSwdenk
5438c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5439c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5440c609719bSwdenkonce they have been set once.
5441c609719bSwdenk
5442c609719bSwdenk
5443c1551ea8SstroeseFurther special Environment Variables:
5444c1551ea8Sstroese
5445c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5446c1551ea8Sstroese		  with the "version" command. This variable is
5447c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5448c1551ea8Sstroese
5449c1551ea8Sstroese
5450c609719bSwdenkPlease note that changes to some configuration parameters may take
5451c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5452c609719bSwdenk
5453c609719bSwdenk
5454170ab110SJoe HershbergerCallback functions for environment variables:
5455170ab110SJoe Hershberger---------------------------------------------
5456170ab110SJoe Hershberger
5457170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5458b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
5459170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5460170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5461170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5462170ab110SJoe Hershberger
5463170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5464170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5465170ab110SJoe Hershberger
5466170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5467170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5468170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5469170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5470170ab110SJoe Hershberger
5471170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5472170ab110SJoe Hershberger	list = entry[,list]
5473170ab110SJoe Hershberger
5474170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5475170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5476170ab110SJoe Hershberger
5477170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5478170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5479170ab110SJoe Hershbergeroverride any association in the static list. You can define
5480170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5481b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
5482170ab110SJoe Hershberger
5483bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a
5484bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to
5485bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out.
5486bdf1fe4eSJoe Hershberger
5487170ab110SJoe Hershberger
5488f07771ccSwdenkCommand Line Parsing:
5489f07771ccSwdenk=====================
5490f07771ccSwdenk
5491f07771ccSwdenkThere are two different command line parsers available with U-Boot:
54927152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5493f07771ccSwdenk
5494f07771ccSwdenkOld, simple command line parser:
5495f07771ccSwdenk--------------------------------
5496f07771ccSwdenk
5497f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5498f07771ccSwdenk- several commands on one line, separated by ';'
5499fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5500f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5501f07771ccSwdenk  for example:
5502fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5503f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5504f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5505f07771ccSwdenk
5506f07771ccSwdenkHush shell:
5507f07771ccSwdenk-----------
5508f07771ccSwdenk
5509f07771ccSwdenk- similar to Bourne shell, with control structures like
5510f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5511f07771ccSwdenk  until...do...done, ...
5512f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5513f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5514f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5515f07771ccSwdenk  command
5516f07771ccSwdenk
5517f07771ccSwdenkGeneral rules:
5518f07771ccSwdenk--------------
5519f07771ccSwdenk
5520f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5521f07771ccSwdenk    command) contains several commands separated by semicolon, and
5522f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5523f07771ccSwdenk    executed anyway.
5524f07771ccSwdenk
5525f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
552611ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5527f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5528f07771ccSwdenk    variables are not executed.
5529f07771ccSwdenk
5530c609719bSwdenkNote for Redundant Ethernet Interfaces:
5531c609719bSwdenk=======================================
5532c609719bSwdenk
553311ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5534c609719bSwdenksuch configurations and is capable of automatic selection of a
55357152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5536c609719bSwdenk
5537c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5538c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5539c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5540c609719bSwdenk
5541c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5542c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5543c609719bSwdenkding setting in the environment; if the corresponding environment
5544c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5545c609719bSwdenk
5546c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5547c609719bSwdenk  environment, the SROM's address is used.
5548c609719bSwdenk
5549c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5550c609719bSwdenk  environment exists, then the value from the environment variable is
5551c609719bSwdenk  used.
5552c609719bSwdenk
5553c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5554c609719bSwdenk  both addresses are the same, this MAC address is used.
5555c609719bSwdenk
5556c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5557c609719bSwdenk  addresses differ, the value from the environment is used and a
5558c609719bSwdenk  warning is printed.
5559c609719bSwdenk
5560c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5561bef1014bSJoe Hershberger  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5562bef1014bSJoe Hershberger  a random, locally-assigned MAC is used.
5563c609719bSwdenk
5564ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5565ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5566ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5567ecee9324SBen WarrenThe naming convention is as follows:
5568ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5569c609719bSwdenk
5570c609719bSwdenkImage Formats:
5571c609719bSwdenk==============
5572c609719bSwdenk
55733310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
55743310c549SMarian Balakowiczimages in two formats:
55753310c549SMarian Balakowicz
55763310c549SMarian BalakowiczNew uImage format (FIT)
55773310c549SMarian Balakowicz-----------------------
55783310c549SMarian Balakowicz
55793310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
55803310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
55813310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
55823310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
55833310c549SMarian Balakowicz
55843310c549SMarian Balakowicz
55853310c549SMarian BalakowiczOld uImage format
55863310c549SMarian Balakowicz-----------------
55873310c549SMarian Balakowicz
55883310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
55893310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
55903310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5591c609719bSwdenk
5592c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5593c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5594f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5595f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5596f5ed9e39SPeter Tyser  INTEGRITY).
55977b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5598afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5599afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5600c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5601c609719bSwdenk* Load Address
5602c609719bSwdenk* Entry Point
5603c609719bSwdenk* Image Name
5604c609719bSwdenk* Image Timestamp
5605c609719bSwdenk
5606c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5607c609719bSwdenkand the data portions of the image are secured against corruption by
5608c609719bSwdenkCRC32 checksums.
5609c609719bSwdenk
5610c609719bSwdenk
5611c609719bSwdenkLinux Support:
5612c609719bSwdenk==============
5613c609719bSwdenk
5614c609719bSwdenkAlthough U-Boot should support any OS or standalone application
56157152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5616c609719bSwdenkU-Boot.
5617c609719bSwdenk
5618c609719bSwdenkU-Boot includes many features that so far have been part of some
5619c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5620c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5621c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
56227152b1d0Swdenkserves several purposes:
5623c609719bSwdenk
5624c609719bSwdenk- the same features can be used for other OS or standalone
5625c609719bSwdenk  applications (for instance: using compressed images to reduce the
5626c609719bSwdenk  Flash memory footprint)
5627c609719bSwdenk
5628c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
56297152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5630c609719bSwdenk
5631c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5632c609719bSwdenk  images; of course this also means that different kernel images can
5633c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5634c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5635c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5636c609719bSwdenk  software is easier now.
5637c609719bSwdenk
5638c609719bSwdenk
5639c609719bSwdenkLinux HOWTO:
5640c609719bSwdenk============
5641c609719bSwdenk
5642c609719bSwdenkPorting Linux to U-Boot based systems:
5643c609719bSwdenk---------------------------------------
5644c609719bSwdenk
5645c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5646c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5647c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5648c609719bSwdenkLinux :-).
5649c609719bSwdenk
5650a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5651c609719bSwdenk
5652c609719bSwdenkJust make sure your machine specific header file (for instance
5653c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
56541dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
56551dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
56566d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5657c609719bSwdenk
56582eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
56592eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
56602eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
56612eb31b13SSimon Glassdoc/driver-model.
56622eb31b13SSimon Glass
5663c609719bSwdenk
5664c609719bSwdenkConfiguring the Linux kernel:
5665c609719bSwdenk-----------------------------
5666c609719bSwdenk
5667c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5668c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5669c609719bSwdenk
5670c609719bSwdenk
5671c609719bSwdenkBuilding a Linux Image:
5672c609719bSwdenk-----------------------
5673c609719bSwdenk
567424ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
567524ee89b9Swdenknot used. If you use recent kernel source, a new build target
567624ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
567724ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
567824ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
567924ee89b9Swdenk100% compatible format.
5680c609719bSwdenk
5681c609719bSwdenkExample:
5682c609719bSwdenk
5683ab584d67SHolger Freyther	make TQM850L_defconfig
5684c609719bSwdenk	make oldconfig
5685c609719bSwdenk	make dep
568624ee89b9Swdenk	make uImage
5687c609719bSwdenk
568824ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
568924ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
569024ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5691c609719bSwdenk
569224ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
569324ee89b9Swdenk
569424ee89b9Swdenk* convert the kernel into a raw binary image:
569524ee89b9Swdenk
569624ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
569724ee89b9Swdenk				 -R .note -R .comment \
569824ee89b9Swdenk				 -S vmlinux linux.bin
569924ee89b9Swdenk
570024ee89b9Swdenk* compress the binary image:
570124ee89b9Swdenk
570224ee89b9Swdenk	gzip -9 linux.bin
570324ee89b9Swdenk
570424ee89b9Swdenk* package compressed binary image for U-Boot:
570524ee89b9Swdenk
570624ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
570724ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
570824ee89b9Swdenk		-d linux.bin.gz uImage
570924ee89b9Swdenk
571024ee89b9Swdenk
571124ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
571224ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
571324ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
571424ee89b9Swdenkbyte header containing information about target architecture,
571524ee89b9Swdenkoperating system, image type, compression method, entry points, time
571624ee89b9Swdenkstamp, CRC32 checksums, etc.
571724ee89b9Swdenk
571824ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
571924ee89b9Swdenkprint the header information, or to build new images.
5720c609719bSwdenk
5721c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5722c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5723c609719bSwdenkchecksum verification:
5724c609719bSwdenk
5725c609719bSwdenk	tools/mkimage -l image
5726c609719bSwdenk	  -l ==> list image header information
5727c609719bSwdenk
5728c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5729c609719bSwdenkfrom a "data file" which is used as image payload:
5730c609719bSwdenk
5731c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5732c609719bSwdenk		      -n name -d data_file image
5733c609719bSwdenk	  -A ==> set architecture to 'arch'
5734c609719bSwdenk	  -O ==> set operating system to 'os'
5735c609719bSwdenk	  -T ==> set image type to 'type'
5736c609719bSwdenk	  -C ==> set compression type 'comp'
5737c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5738c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5739c609719bSwdenk	  -n ==> set image name to 'name'
5740c609719bSwdenk	  -d ==> use image data from 'datafile'
5741c609719bSwdenk
574269459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
574369459791Swdenkaddress (0x00000000), but the entry point address depends on the
574469459791Swdenkkernel version:
5745c609719bSwdenk
5746c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
574724ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5748c609719bSwdenk
5749c609719bSwdenkSo a typical call to build a U-Boot image would read:
5750c609719bSwdenk
575124ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
575224ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5753a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
575424ee89b9Swdenk	> examples/uImage.TQM850L
575524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5756c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5757c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5758c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5759c609719bSwdenk	Load Address: 0x00000000
576024ee89b9Swdenk	Entry Point:  0x00000000
5761c609719bSwdenk
5762c609719bSwdenkTo verify the contents of the image (or check for corruption):
5763c609719bSwdenk
576424ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
576524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5766c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5767c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5768c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5769c609719bSwdenk	Load Address: 0x00000000
577024ee89b9Swdenk	Entry Point:  0x00000000
5771c609719bSwdenk
5772c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5773c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5774c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5775c609719bSwdenkneed to be uncompressed:
5776c609719bSwdenk
5777a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
577824ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
577924ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5780a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
578124ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
578224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5783c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5784c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5785c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5786c609719bSwdenk	Load Address: 0x00000000
578724ee89b9Swdenk	Entry Point:  0x00000000
5788c609719bSwdenk
5789c609719bSwdenk
5790c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5791c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5792c609719bSwdenk
5793c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5794c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5795c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5796c609719bSwdenk	Image Name:   Simple Ramdisk Image
5797c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5798c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5799c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5800c609719bSwdenk	Load Address: 0x00000000
5801c609719bSwdenk	Entry Point:  0x00000000
5802c609719bSwdenk
5803a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5804a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5805a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5806a804b5ceSGuilherme Maciel Ferreirafrom the image:
5807a804b5ceSGuilherme Maciel Ferreira
5808f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5809f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5810f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5811f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5812a804b5ceSGuilherme Maciel Ferreira
5813c609719bSwdenk
5814c609719bSwdenkInstalling a Linux Image:
5815c609719bSwdenk-------------------------
5816c609719bSwdenk
5817c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5818c609719bSwdenkyou must convert the image to S-Record format:
5819c609719bSwdenk
5820c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5821c609719bSwdenk
5822c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5823c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5824c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5825c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5826c609719bSwdenkcommand.
5827c609719bSwdenk
5828c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5829c609719bSwdenkTQM8xxL is in the first Flash bank):
5830c609719bSwdenk
5831c609719bSwdenk	=> erase 40100000 401FFFFF
5832c609719bSwdenk
5833c609719bSwdenk	.......... done
5834c609719bSwdenk	Erased 8 sectors
5835c609719bSwdenk
5836c609719bSwdenk	=> loads 40100000
5837c609719bSwdenk	## Ready for S-Record download ...
5838c609719bSwdenk	~>examples/image.srec
5839c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5840c609719bSwdenk	...
5841c609719bSwdenk	15989 15990 15991 15992
5842c609719bSwdenk	[file transfer complete]
5843c609719bSwdenk	[connected]
5844c609719bSwdenk	## Start Addr = 0x00000000
5845c609719bSwdenk
5846c609719bSwdenk
5847c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5848c609719bSwdenkthis includes a checksum verification so you can be sure no data
5849c609719bSwdenkcorruption happened:
5850c609719bSwdenk
5851c609719bSwdenk	=> imi 40100000
5852c609719bSwdenk
5853c609719bSwdenk	## Checking Image at 40100000 ...
5854c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5855c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5856c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5857c609719bSwdenk	   Load Address: 00000000
5858c609719bSwdenk	   Entry Point:	 0000000c
5859c609719bSwdenk	   Verifying Checksum ... OK
5860c609719bSwdenk
5861c609719bSwdenk
5862c609719bSwdenkBoot Linux:
5863c609719bSwdenk-----------
5864c609719bSwdenk
5865c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5866c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5867c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5868c609719bSwdenkparameters. You can check and modify this variable using the
5869c609719bSwdenk"printenv" and "setenv" commands:
5870c609719bSwdenk
5871c609719bSwdenk
5872c609719bSwdenk	=> printenv bootargs
5873c609719bSwdenk	bootargs=root=/dev/ram
5874c609719bSwdenk
5875c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5876c609719bSwdenk
5877c609719bSwdenk	=> printenv bootargs
5878c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5879c609719bSwdenk
5880c609719bSwdenk	=> bootm 40020000
5881c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5882c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5883c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5884c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5885c609719bSwdenk	   Load Address: 00000000
5886c609719bSwdenk	   Entry Point:	 0000000c
5887c609719bSwdenk	   Verifying Checksum ... OK
5888c609719bSwdenk	   Uncompressing Kernel Image ... OK
5889c609719bSwdenk	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
5890c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5891c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5892c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5893c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5894c609719bSwdenk	...
5895c609719bSwdenk
589611ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
58977152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5898c609719bSwdenkformat!) to the "bootm" command:
5899c609719bSwdenk
5900c609719bSwdenk	=> imi 40100000 40200000
5901c609719bSwdenk
5902c609719bSwdenk	## Checking Image at 40100000 ...
5903c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5904c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5905c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5906c609719bSwdenk	   Load Address: 00000000
5907c609719bSwdenk	   Entry Point:	 0000000c
5908c609719bSwdenk	   Verifying Checksum ... OK
5909c609719bSwdenk
5910c609719bSwdenk	## Checking Image at 40200000 ...
5911c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5912c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5913c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5914c609719bSwdenk	   Load Address: 00000000
5915c609719bSwdenk	   Entry Point:	 00000000
5916c609719bSwdenk	   Verifying Checksum ... OK
5917c609719bSwdenk
5918c609719bSwdenk	=> bootm 40100000 40200000
5919c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5920c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5921c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5922c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5923c609719bSwdenk	   Load Address: 00000000
5924c609719bSwdenk	   Entry Point:	 0000000c
5925c609719bSwdenk	   Verifying Checksum ... OK
5926c609719bSwdenk	   Uncompressing Kernel Image ... OK
5927c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5928c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5929c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5930c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5931c609719bSwdenk	   Load Address: 00000000
5932c609719bSwdenk	   Entry Point:	 00000000
5933c609719bSwdenk	   Verifying Checksum ... OK
5934c609719bSwdenk	   Loading Ramdisk ... OK
5935c609719bSwdenk	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
5936c609719bSwdenk	Boot arguments: root=/dev/ram
5937c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5938c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5939c609719bSwdenk	...
5940c609719bSwdenk	RAMDISK: Compressed image found at block 0
5941c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5942c609719bSwdenk
5943c609719bSwdenk	bash#
5944c609719bSwdenk
59450267768eSMatthew McClintockBoot Linux and pass a flat device tree:
59460267768eSMatthew McClintock-----------
59470267768eSMatthew McClintock
59480267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
59490267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
59500267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
59510267768eSMatthew McClintockflat device tree:
59520267768eSMatthew McClintock
59530267768eSMatthew McClintock=> print oftaddr
59540267768eSMatthew McClintockoftaddr=0x300000
59550267768eSMatthew McClintock=> print oft
59560267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
59570267768eSMatthew McClintock=> tftp $oftaddr $oft
59580267768eSMatthew McClintockSpeed: 1000, full duplex
59590267768eSMatthew McClintockUsing TSEC0 device
59600267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
59610267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
59620267768eSMatthew McClintockLoad address: 0x300000
59630267768eSMatthew McClintockLoading: #
59640267768eSMatthew McClintockdone
59650267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
59660267768eSMatthew McClintock=> tftp $loadaddr $bootfile
59670267768eSMatthew McClintockSpeed: 1000, full duplex
59680267768eSMatthew McClintockUsing TSEC0 device
59690267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
59700267768eSMatthew McClintockFilename 'uImage'.
59710267768eSMatthew McClintockLoad address: 0x200000
59720267768eSMatthew McClintockLoading:############
59730267768eSMatthew McClintockdone
59740267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
59750267768eSMatthew McClintock=> print loadaddr
59760267768eSMatthew McClintockloadaddr=200000
59770267768eSMatthew McClintock=> print oftaddr
59780267768eSMatthew McClintockoftaddr=0x300000
59790267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
59800267768eSMatthew McClintock## Booting image at 00200000 ...
59810267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
59820267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
59830267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
59840267768eSMatthew McClintock   Load Address: 00000000
59850267768eSMatthew McClintock   Entry Point:	 00000000
59860267768eSMatthew McClintock   Verifying Checksum ... OK
59870267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
59880267768eSMatthew McClintockBooting using flat device tree at 0x300000
59890267768eSMatthew McClintockUsing MPC85xx ADS machine description
59900267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
59910267768eSMatthew McClintock[snip]
59920267768eSMatthew McClintock
59930267768eSMatthew McClintock
59946069ff26SwdenkMore About U-Boot Image Types:
59956069ff26Swdenk------------------------------
59966069ff26Swdenk
59976069ff26SwdenkU-Boot supports the following image types:
59986069ff26Swdenk
59996069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
60006069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
60016069ff26Swdenk	well) you can continue to work in U-Boot after return from
60026069ff26Swdenk	the Standalone Program.
60036069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
60046069ff26Swdenk	will take over control completely. Usually these programs
60056069ff26Swdenk	will install their own set of exception handlers, device
60066069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
60076069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
60086069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
60096069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
60106069ff26Swdenk	being started.
60116069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
60126069ff26Swdenk	(Linux) kernel image and one or more data images like
60136069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
60146069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
60156069ff26Swdenk	server provides just a single image file, but you want to get
60166069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
60176069ff26Swdenk
60186069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
60196069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
60206069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
60216069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
60226069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
60236069ff26Swdenk	a multiple of 4 bytes).
60246069ff26Swdenk
60256069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
60266069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
60276069ff26Swdenk	flash memory.
60286069ff26Swdenk
60296069ff26Swdenk   "Script files" are command sequences that will be executed by
60306069ff26Swdenk	U-Boot's command interpreter; this feature is especially
60316069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
60326069ff26Swdenk	as command interpreter.
60336069ff26Swdenk
603444f074c7SMarek VasutBooting the Linux zImage:
603544f074c7SMarek Vasut-------------------------
603644f074c7SMarek Vasut
603744f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
603844f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
603944f074c7SMarek Vasutas the syntax of "bootm" command.
604044f074c7SMarek Vasut
60418ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
6042017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
6043017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
6044017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
6045017e1f3fSMarek Vasut
6046c609719bSwdenk
6047c609719bSwdenkStandalone HOWTO:
6048c609719bSwdenk=================
6049c609719bSwdenk
6050c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
6051c609719bSwdenkrun "standalone" applications, which can use some resources of
6052c609719bSwdenkU-Boot like console I/O functions or interrupt services.
6053c609719bSwdenk
6054c609719bSwdenkTwo simple examples are included with the sources:
6055c609719bSwdenk
6056c609719bSwdenk"Hello World" Demo:
6057c609719bSwdenk-------------------
6058c609719bSwdenk
6059c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
6060c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
6061c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
6062c609719bSwdenklike that:
6063c609719bSwdenk
6064c609719bSwdenk	=> loads
6065c609719bSwdenk	## Ready for S-Record download ...
6066c609719bSwdenk	~>examples/hello_world.srec
6067c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6068c609719bSwdenk	[file transfer complete]
6069c609719bSwdenk	[connected]
6070c609719bSwdenk	## Start Addr = 0x00040004
6071c609719bSwdenk
6072c609719bSwdenk	=> go 40004 Hello World! This is a test.
6073c609719bSwdenk	## Starting application at 0x00040004 ...
6074c609719bSwdenk	Hello World
6075c609719bSwdenk	argc = 7
6076c609719bSwdenk	argv[0] = "40004"
6077c609719bSwdenk	argv[1] = "Hello"
6078c609719bSwdenk	argv[2] = "World!"
6079c609719bSwdenk	argv[3] = "This"
6080c609719bSwdenk	argv[4] = "is"
6081c609719bSwdenk	argv[5] = "a"
6082c609719bSwdenk	argv[6] = "test."
6083c609719bSwdenk	argv[7] = "<NULL>"
6084c609719bSwdenk	Hit any key to exit ...
6085c609719bSwdenk
6086c609719bSwdenk	## Application terminated, rc = 0x0
6087c609719bSwdenk
6088c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
6089c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
6090c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
6091c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
6092c609719bSwdenkcharacter, but this is just a demo program. The application can be
6093c609719bSwdenkcontrolled by the following keys:
6094c609719bSwdenk
6095c609719bSwdenk	? - print current values og the CPM Timer registers
6096c609719bSwdenk	b - enable interrupts and start timer
6097c609719bSwdenk	e - stop timer and disable interrupts
6098c609719bSwdenk	q - quit application
6099c609719bSwdenk
6100c609719bSwdenk	=> loads
6101c609719bSwdenk	## Ready for S-Record download ...
6102c609719bSwdenk	~>examples/timer.srec
6103c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6104c609719bSwdenk	[file transfer complete]
6105c609719bSwdenk	[connected]
6106c609719bSwdenk	## Start Addr = 0x00040004
6107c609719bSwdenk
6108c609719bSwdenk	=> go 40004
6109c609719bSwdenk	## Starting application at 0x00040004 ...
6110c609719bSwdenk	TIMERS=0xfff00980
6111c609719bSwdenk	Using timer 1
6112c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6113c609719bSwdenk
6114c609719bSwdenkHit 'b':
6115c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
6116c609719bSwdenk	Enabling timer
6117c609719bSwdenkHit '?':
6118c609719bSwdenk	[q, b, e, ?] ........
6119c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6120c609719bSwdenkHit '?':
6121c609719bSwdenk	[q, b, e, ?] .
6122c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6123c609719bSwdenkHit '?':
6124c609719bSwdenk	[q, b, e, ?] .
6125c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6126c609719bSwdenkHit '?':
6127c609719bSwdenk	[q, b, e, ?] .
6128c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6129c609719bSwdenkHit 'e':
6130c609719bSwdenk	[q, b, e, ?] ...Stopping timer
6131c609719bSwdenkHit 'q':
6132c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
6133c609719bSwdenk
6134c609719bSwdenk
613585ec0bccSwdenkMinicom warning:
613685ec0bccSwdenk================
613785ec0bccSwdenk
61387152b1d0SwdenkOver time, many people have reported problems when trying to use the
613985ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
614085ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
6141f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
614285ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
6143e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
6144e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6145e53515a2SKarl O. Pincfor help with kermit.
6146e53515a2SKarl O. Pinc
614785ec0bccSwdenk
614852f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
614952f52c14Swdenkconfiguration to your "File transfer protocols" section:
615052f52c14Swdenk
615152f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
615252f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
615352f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
615452f52c14Swdenk
615552f52c14Swdenk
6156c609719bSwdenkNetBSD Notes:
6157c609719bSwdenk=============
6158c609719bSwdenk
6159c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
6160c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
6161c609719bSwdenk
6162c609719bSwdenkBuilding requires a cross environment; it is known to work on
6163c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6164c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
6165c609719bSwdenkNote that the cross-powerpc package does not install include files;
6166c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
6167c609719bSwdenkmissing.  This file has to be installed and patched manually:
6168c609719bSwdenk
6169c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
6170c609719bSwdenk	# mkdir powerpc
6171c609719bSwdenk	# ln -s powerpc machine
6172c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6173c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6174c609719bSwdenk
6175c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6176c609719bSwdenkand U-Boot include files.
6177c609719bSwdenk
6178c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6179c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6180c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6181c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
61822a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6183c609719bSwdenk
6184c609719bSwdenk
6185c609719bSwdenkImplementation Internals:
6186c609719bSwdenk=========================
6187c609719bSwdenk
6188c609719bSwdenkThe following is not intended to be a complete description of every
6189c609719bSwdenkimplementation detail. However, it should help to understand the
6190c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6191c609719bSwdenkhardware.
6192c609719bSwdenk
6193c609719bSwdenk
6194c609719bSwdenkInitial Stack, Global Data:
6195c609719bSwdenk---------------------------
6196c609719bSwdenk
6197c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6198c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6199c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6200c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6201c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6202c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6203c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6204c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6205c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6206c609719bSwdenklocked as (mis-) used as memory, etc.
6207c609719bSwdenk
62087152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
62090668236bSWolfgang Denk	U-Boot mailing list:
621043d9616cSwdenk
621143d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
621243d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
621343d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
621443d9616cSwdenk	...
621543d9616cSwdenk
621643d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
621743d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
621843d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
621943d9616cSwdenk	is that the cache is being used as a temporary supply of
622043d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
622111ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
622243d9616cSwdenk	can see how this works by studying the cache architecture and
622343d9616cSwdenk	operation in the architecture and processor-specific manuals.
622443d9616cSwdenk
622543d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
622643d9616cSwdenk	is another option for the system designer to use as an
622711ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
622843d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
622943d9616cSwdenk	board designers haven't used it for something that would
623043d9616cSwdenk	cause you grief during the initial boot! It is frequently not
623143d9616cSwdenk	used.
623243d9616cSwdenk
62336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
623443d9616cSwdenk	with your processor/board/system design. The default value
623543d9616cSwdenk	you will find in any recent u-boot distribution in
62368a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
623743d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
623843d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
623943d9616cSwdenk	that are supposed to respond to that address! That code in
624043d9616cSwdenk	start.S has been around a while and should work as is when
624143d9616cSwdenk	you get the config right.
624243d9616cSwdenk
624343d9616cSwdenk	-Chris Hallinan
624443d9616cSwdenk	DS4.COM, Inc.
624543d9616cSwdenk
6246c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6247c609719bSwdenkcode for the initialization procedures:
6248c609719bSwdenk
6249c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6250c609719bSwdenk  to write it.
6251c609719bSwdenk
6252b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
6253c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
62547152b1d0Swdenk  zation is performed later (when relocating to RAM).
6255c609719bSwdenk
6256c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6257c609719bSwdenk  that.
6258c609719bSwdenk
6259c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6260b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
6261c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6262c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6263c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6264c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6265c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6266c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6267c609719bSwdenkreserve for this purpose.
6268c609719bSwdenk
62697152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6270c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6271c609719bSwdenkGCC's implementation.
6272c609719bSwdenk
6273c609719bSwdenkFor PowerPC, the following registers have specific use:
6274c609719bSwdenk	R1:	stack pointer
6275e7670f6cSWolfgang Denk	R2:	reserved for system use
6276c609719bSwdenk	R3-R4:	parameter passing and return values
6277c609719bSwdenk	R5-R10: parameter passing
6278c609719bSwdenk	R13:	small data area pointer
6279c609719bSwdenk	R30:	GOT pointer
6280c609719bSwdenk	R31:	frame pointer
6281c609719bSwdenk
6282e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6283e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6284e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6285c609719bSwdenk
6286e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6287c609719bSwdenk
6288c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6289c609719bSwdenk    address of the global data structure is known at compile time),
6290c609719bSwdenk    but it turned out that reserving a register results in somewhat
6291c609719bSwdenk    smaller code - although the code savings are not that big (on
6292c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6293c609719bSwdenk    624 text + 127 data).
6294c609719bSwdenk
6295c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
62964c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
62974c58eb55SMike Frysinger
6298c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
62994c58eb55SMike Frysinger
6300c609719bSwdenkOn ARM, the following registers are used:
6301c609719bSwdenk
6302c609719bSwdenk	R0:	function argument word/integer result
6303c609719bSwdenk	R1-R3:	function argument word
630412eba1b4SJeroen Hofstee	R9:	platform specific
630512eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6306c609719bSwdenk	R11:	argument (frame) pointer
6307c609719bSwdenk	R12:	temporary workspace
6308c609719bSwdenk	R13:	stack pointer
6309c609719bSwdenk	R14:	link register
6310c609719bSwdenk	R15:	program counter
6311c609719bSwdenk
631212eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
631312eba1b4SJeroen Hofstee
631412eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6315c609719bSwdenk
63160df01fd3SThomas ChouOn Nios II, the ABI is documented here:
63170df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
63180df01fd3SThomas Chou
63190df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
63200df01fd3SThomas Chou
63210df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
63220df01fd3SThomas Chou    to access small data sections, so gp is free.
63230df01fd3SThomas Chou
6324afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6325afc1ce82SMacpaul Lin
6326afc1ce82SMacpaul Lin	R0-R1:	argument/return
6327afc1ce82SMacpaul Lin	R2-R5:	argument
6328afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6329afc1ce82SMacpaul Lin	R16:	trampoline register
6330afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6331afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6332afc1ce82SMacpaul Lin	R30:	link register (LP)
6333afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6334afc1ce82SMacpaul Lin	PC:	program counter (PC)
6335afc1ce82SMacpaul Lin
6336afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6337afc1ce82SMacpaul Lin
6338d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6339d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6340c609719bSwdenk
6341c609719bSwdenkMemory Management:
6342c609719bSwdenk------------------
6343c609719bSwdenk
6344c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6345c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6346c609719bSwdenk
6347c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6348c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6349c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6350c609719bSwdenkphysical memory banks.
6351c609719bSwdenk
6352c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6353c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6354c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6355c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
63566d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6357c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6358c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6359c609719bSwdenk
6360c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6361c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6362c609719bSwdenk
6363c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6364c609719bSwdenkthis:
6365c609719bSwdenk
6366c609719bSwdenk	0x0000 0000	Exception Vector code
6367c609719bSwdenk	      :
6368c609719bSwdenk	0x0000 1FFF
6369c609719bSwdenk	0x0000 2000	Free for Application Use
6370c609719bSwdenk	      :
6371c609719bSwdenk	      :
6372c609719bSwdenk
6373c609719bSwdenk	      :
6374c609719bSwdenk	      :
6375c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6376c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6377c609719bSwdenk	0x00FC 0000	Malloc Arena
6378c609719bSwdenk	      :
6379c609719bSwdenk	0x00FD FFFF
6380c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6381c609719bSwdenk	...		eventually: LCD or video framebuffer
6382c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6383c609719bSwdenk	0x00FF FFFF	[End of RAM]
6384c609719bSwdenk
6385c609719bSwdenk
6386c609719bSwdenkSystem Initialization:
6387c609719bSwdenk----------------------
6388c609719bSwdenk
6389c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
639011ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6391c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
63927152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6393c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6394c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6395c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6396c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6397c609719bSwdenkthe caches and the SIU.
6398c609719bSwdenk
6399c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6400c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6401c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6402c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6403c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6404c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6405c609719bSwdenkbanks.
6406c609719bSwdenk
6407c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
64087152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6409c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6410c609719bSwdenk0x00000000, with any additional banks following immediately to create
6411c609719bSwdenkcontiguous memory starting from 0.
6412c609719bSwdenk
6413c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6414c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6415c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6416c609719bSwdenkpages, and the final stack is set up.
6417c609719bSwdenk
6418c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6419c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6420c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6421c609719bSwdenknew address in RAM.
6422c609719bSwdenk
6423c609719bSwdenk
6424c609719bSwdenkU-Boot Porting Guide:
6425c609719bSwdenk----------------------
6426c609719bSwdenk
6427c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
64286aff3115Swdenklist, October 2002]
6429c609719bSwdenk
6430c609719bSwdenk
6431c609719bSwdenkint main(int argc, char *argv[])
6432c609719bSwdenk{
6433c609719bSwdenk	sighandler_t no_more_time;
6434c609719bSwdenk
6435c609719bSwdenk	signal(SIGALRM, no_more_time);
6436c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6437c609719bSwdenk
6438c609719bSwdenk	if (available_money > available_manpower) {
64396c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6440c609719bSwdenk		return 0;
6441c609719bSwdenk	}
6442c609719bSwdenk
6443c609719bSwdenk	Download latest U-Boot source;
6444c609719bSwdenk
64450668236bSWolfgang Denk	Subscribe to u-boot mailing list;
64466aff3115Swdenk
64476c3fef28SJerry Van Baren	if (clueless)
6448c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6449c609719bSwdenk
6450c609719bSwdenk	while (learning) {
6451c609719bSwdenk		Read the README file in the top level directory;
64527cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
64536c3fef28SJerry Van Baren		Read applicable doc/*.README;
6454c609719bSwdenk		Read the source, Luke;
64556c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6456c609719bSwdenk	}
6457c609719bSwdenk
64586c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
64596c3fef28SJerry Van Baren		Buy a BDI3000;
64606c3fef28SJerry Van Baren	else
6461c609719bSwdenk		Add a lot of aggravation and time;
6462c609719bSwdenk
64636c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
64646c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
64656c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
64666c3fef28SJerry Van Baren	} else {
6467c609719bSwdenk		Create your own board support subdirectory;
64686c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
64696c3fef28SJerry Van Baren	}
64706c3fef28SJerry Van Baren	Edit new board/<myboard> files
64716c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6472c609719bSwdenk
64736c3fef28SJerry Van Baren	while (!accepted) {
6474c609719bSwdenk		while (!running) {
6475c609719bSwdenk			do {
6476c609719bSwdenk				Add / modify source code;
6477c609719bSwdenk			} until (compiles);
6478c609719bSwdenk			Debug;
6479c609719bSwdenk			if (clueless)
6480c609719bSwdenk				email("Hi, I am having problems...");
6481c609719bSwdenk		}
64826c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
64836c3fef28SJerry Van Baren		if (reasonable critiques)
64846c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
64856c3fef28SJerry Van Baren		else
64866c3fef28SJerry Van Baren			Defend code as written;
64876c3fef28SJerry Van Baren	}
6488c609719bSwdenk
6489c609719bSwdenk	return 0;
6490c609719bSwdenk}
6491c609719bSwdenk
6492c609719bSwdenkvoid no_more_time (int sig)
6493c609719bSwdenk{
6494c609719bSwdenk      hire_a_guru();
6495c609719bSwdenk}
6496c609719bSwdenk
6497c609719bSwdenk
6498c609719bSwdenkCoding Standards:
6499c609719bSwdenk-----------------
6500c609719bSwdenk
6501c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
65022c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
65037ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6504c609719bSwdenk
65052c051651SDetlev ZundelSource files originating from a different project (for example the
65062c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
6507b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
65082c051651SDetlev Zundelsources.
65092c051651SDetlev Zundel
65102c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
65112c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
65122c051651SDetlev Zundelin your code.
6513c609719bSwdenk
6514c178d3daSwdenkPlease also stick to the following formatting rules:
6515180d3f74Swdenk- remove any trailing white space
65167ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6517180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
65187ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6519180d3f74Swdenk- do not add trailing empty lines to source files
6520180d3f74Swdenk
6521c609719bSwdenkSubmissions which do not conform to the standards may be returned
6522c609719bSwdenkwith a request to reformat the changes.
6523c609719bSwdenk
6524c609719bSwdenk
6525c609719bSwdenkSubmitting Patches:
6526c609719bSwdenk-------------------
6527c609719bSwdenk
6528c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6529c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6530c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6531c609719bSwdenk
65320d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6533218ca724SWolfgang Denk
65340668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
65350668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
65360668236bSWolfgang Denk
6537c609719bSwdenkWhen you send a patch, please include the following information with
6538c609719bSwdenkit:
6539c609719bSwdenk
6540c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6541c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6542c609719bSwdenk  patch actually fixes something.
6543c609719bSwdenk
6544c609719bSwdenk* For new features: a description of the feature and your
6545c609719bSwdenk  implementation.
6546c609719bSwdenk
6547c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6548c609719bSwdenk
65497207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your
65507207b366SRobert P. J. Day  information and associated file and directory references.
6551c609719bSwdenk
655227af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
655327af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6554c609719bSwdenk
6555c609719bSwdenk* If your patch adds new configuration options, don't forget to
6556c609719bSwdenk  document these in the README file.
6557c609719bSwdenk
6558218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6559218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
65607ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6561218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6562218ca724SWolfgang Denk  with some other mail clients.
6563c609719bSwdenk
6564218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6565218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6566218ca724SWolfgang Denk  GNU diff.
65676dff5529Swdenk
6568218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6569218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6570218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6571218ca724SWolfgang Denk  affected files).
6572218ca724SWolfgang Denk
6573218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6574218ca724SWolfgang Denk  and compressed attachments must not be used.
6575c609719bSwdenk
657652f52c14Swdenk* If one logical set of modifications affects or creates several
657752f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
657852f52c14Swdenk
657952f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
658052f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
658152f52c14Swdenk
658252f52c14Swdenk
6583c609719bSwdenkNotes:
6584c609719bSwdenk
6585c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6586c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6587c609719bSwdenk  for any of the boards.
6588c609719bSwdenk
6589c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6590c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6591c609719bSwdenk  returned with a request to re-formatting / split it.
6592c609719bSwdenk
6593c609719bSwdenk* If you modify existing code, make sure that your new code does not
6594c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6595c609719bSwdenk  When adding new features, these should compile conditionally only
6596c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6597c609719bSwdenk  disabled must not need more memory than the old code without your
6598c609719bSwdenk  modification.
659990dc6704Swdenk
66000668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
66010668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
66020668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
66030668236bSWolfgang Denk  bigger than the size limit should be avoided.
6604