xref: /openbmc/u-boot/README (revision b6dd69a4)
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
154740f7e5cSXu Ziyuan/cmd			U-Boot commands functions
1558d321b81SPeter Tyser/common			Misc architecture independent functions
1567207b366SRobert P. J. Day/configs		Board default configuration files
1578d321b81SPeter Tyser/disk			Code for disk drive partition handling
1588d321b81SPeter Tyser/doc			Documentation (don't expect too much)
1598d321b81SPeter Tyser/drivers		Commonly used device drivers
16033c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
1618d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
1628d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
1638d321b81SPeter Tyser/include		Header Files
1647207b366SRobert P. J. Day/lib			Library routines generic to all architectures
1657207b366SRobert P. J. Day/Licenses		Various license files
1668d321b81SPeter Tyser/net			Networking code
1678d321b81SPeter Tyser/post			Power On Self Test
1687207b366SRobert P. J. Day/scripts		Various build scripts and Makefiles
1697207b366SRobert P. J. Day/test			Various unit test files
1708d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
171c609719bSwdenk
172c609719bSwdenkSoftware Configuration:
173c609719bSwdenk=======================
174c609719bSwdenk
175c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
176c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
177c609719bSwdenk
178c609719bSwdenkThere are two classes of configuration variables:
179c609719bSwdenk
180c609719bSwdenk* Configuration _OPTIONS_:
181c609719bSwdenk  These are selectable by the user and have names beginning with
182c609719bSwdenk  "CONFIG_".
183c609719bSwdenk
184c609719bSwdenk* Configuration _SETTINGS_:
185c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
186c609719bSwdenk  you don't know what you're doing; they have names beginning with
1876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
188c609719bSwdenk
1897207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating
1907207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently,
1917207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel,
1927207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your
1937207b366SRobert P. J. Daybuild.
194c609719bSwdenk
195c609719bSwdenk
196c609719bSwdenkSelection of Processor Architecture and Board Type:
197c609719bSwdenk---------------------------------------------------
198c609719bSwdenk
199c609719bSwdenkFor all supported boards there are ready-to-use default
200ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
201c609719bSwdenk
202c609719bSwdenkExample: For a TQM823L module type:
203c609719bSwdenk
204c609719bSwdenk	cd u-boot
205ab584d67SHolger Freyther	make TQM823L_defconfig
206c609719bSwdenk
2077207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board
2087207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file
2097207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards.
210c609719bSwdenk
21175b3c3aaSSimon GlassSandbox Environment:
21275b3c3aaSSimon Glass--------------------
21375b3c3aaSSimon Glass
21475b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
21575b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
21675b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
21775b3c3aaSSimon Glassrun some of U-Boot's tests.
21875b3c3aaSSimon Glass
2196b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
22075b3c3aaSSimon Glass
22175b3c3aaSSimon Glass
222db910353SSimon GlassBoard Initialisation Flow:
223db910353SSimon Glass--------------------------
224db910353SSimon Glass
225db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both
2267207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules).
227db910353SSimon Glass
2287207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in
2297207b366SRobert P. J. Daymore detail later in this file.
2307207b366SRobert P. J. Day
2317207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names
2327207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures
2337207b366SRobert P. J. Daymay not conform to this.  At least most ARM boards which use
2347207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this.
2357207b366SRobert P. J. Day
2367207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly
2377207b366SRobert P. J. DayCPU-specific) start.S file, such as:
2387207b366SRobert P. J. Day
2397207b366SRobert P. J. Day	- arch/arm/cpu/armv7/start.S
2407207b366SRobert P. J. Day	- arch/powerpc/cpu/mpc83xx/start.S
2417207b366SRobert P. J. Day	- arch/mips/cpu/start.S
2427207b366SRobert P. J. Day
2437207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and
2447207b366SRobert P. J. Daylimitations of each of these functions are described below.
245db910353SSimon Glass
246db910353SSimon Glasslowlevel_init():
247db910353SSimon Glass	- purpose: essential init to permit execution to reach board_init_f()
248db910353SSimon Glass	- no global_data or BSS
249db910353SSimon Glass	- there is no stack (ARMv7 may have one but it will soon be removed)
250db910353SSimon Glass	- must not set up SDRAM or use console
251db910353SSimon Glass	- must only do the bare minimum to allow execution to continue to
252db910353SSimon Glass		board_init_f()
253db910353SSimon Glass	- this is almost never needed
254db910353SSimon Glass	- return normally from this function
255db910353SSimon Glass
256db910353SSimon Glassboard_init_f():
257db910353SSimon Glass	- purpose: set up the machine ready for running board_init_r():
258db910353SSimon Glass		i.e. SDRAM and serial UART
259db910353SSimon Glass	- global_data is available
260db910353SSimon Glass	- stack is in SRAM
261db910353SSimon Glass	- BSS is not available, so you cannot use global/static variables,
262db910353SSimon Glass		only stack variables and global_data
263db910353SSimon Glass
264db910353SSimon Glass	Non-SPL-specific notes:
265db910353SSimon Glass	- dram_init() is called to set up DRAM. If already done in SPL this
266db910353SSimon Glass		can do nothing
267db910353SSimon Glass
268db910353SSimon Glass	SPL-specific notes:
269db910353SSimon Glass	- you can override the entire board_init_f() function with your own
270db910353SSimon Glass		version as needed.
271db910353SSimon Glass	- preloader_console_init() can be called here in extremis
272db910353SSimon Glass	- should set up SDRAM, and anything needed to make the UART work
273db910353SSimon Glass	- these is no need to clear BSS, it will be done by crt0.S
274db910353SSimon Glass	- must return normally from this function (don't call board_init_r()
275db910353SSimon Glass		directly)
276db910353SSimon Glass
277db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
278db910353SSimon Glassthis point the stack and global_data are relocated to below
279db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
280db910353SSimon Glassmemory.
281db910353SSimon Glass
282db910353SSimon Glassboard_init_r():
283db910353SSimon Glass	- purpose: main execution, common code
284db910353SSimon Glass	- global_data is available
285db910353SSimon Glass	- SDRAM is available
286db910353SSimon Glass	- BSS is available, all static/global variables can be used
287db910353SSimon Glass	- execution eventually continues to main_loop()
288db910353SSimon Glass
289db910353SSimon Glass	Non-SPL-specific notes:
290db910353SSimon Glass	- U-Boot is relocated to the top of memory and is now running from
291db910353SSimon Glass		there.
292db910353SSimon Glass
293db910353SSimon Glass	SPL-specific notes:
294db910353SSimon Glass	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
295db910353SSimon Glass		CONFIG_SPL_STACK_R_ADDR points into SDRAM
296db910353SSimon Glass	- preloader_console_init() can be called here - typically this is
297db910353SSimon Glass		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
298db910353SSimon Glass		spl_board_init() function containing this call
299db910353SSimon Glass	- loads U-Boot or (in falcon mode) Linux
300db910353SSimon Glass
301db910353SSimon Glass
302db910353SSimon Glass
303c609719bSwdenkConfiguration Options:
304c609719bSwdenk----------------------
305c609719bSwdenk
306c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
307c609719bSwdenksuch information is kept in a configuration file
308c609719bSwdenk"include/configs/<board_name>.h".
309c609719bSwdenk
310c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
311c609719bSwdenk"include/configs/TQM823L.h".
312c609719bSwdenk
313c609719bSwdenk
3147f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
3157f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
3167f6c2cbcSwdenkbuild a config tool - later.
3177f6c2cbcSwdenk
3187f6c2cbcSwdenk
319c609719bSwdenkThe following options need to be configured:
320c609719bSwdenk
3212628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
322c609719bSwdenk
3232628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
3246ccec449SWolfgang Denk
3256ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
32609ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
327c609719bSwdenk
328c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
329c609719bSwdenk		Define exactly one of
330c609719bSwdenk		CONFIG_CMA286_60_OLD
331c609719bSwdenk--- FIXME --- not tested yet:
332c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
333c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
334c609719bSwdenk
335c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
336c609719bSwdenk		Define exactly one of
337c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
338c609719bSwdenk
339c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
340c609719bSwdenk		Define one or more of
341c609719bSwdenk		CONFIG_CMA302
342c609719bSwdenk
343c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
344c609719bSwdenk		Define one or more of
345c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
34611ccc33fSMarcel Ziswiler					  the LCD display every second with
347c609719bSwdenk					  a "rotator" |\-/|\-/
348c609719bSwdenk
349cf946c6dSLei Wen- Marvell Family Member
350cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
351cf946c6dSLei Wen					  multiple fs option at one time
352cf946c6dSLei Wen					  for marvell soc family
353cf946c6dSLei Wen
35411ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
35566ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
35666ca92a5Swdenk					  get_gclk_freq() cannot work
3575da627a4Swdenk					  e.g. if there is no 32KHz
3585da627a4Swdenk					  reference PIT/RTC clock
35966ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
36066ca92a5Swdenk					  or XTAL/EXTAL)
361c609719bSwdenk
36266ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
36566ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
36675d1ea7fSwdenk			See doc/README.MPC866
36775d1ea7fSwdenk
3686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
36975d1ea7fSwdenk
37075d1ea7fSwdenk		Define this to measure the actual CPU clock instead
37175d1ea7fSwdenk		of relying on the correctness of the configured
37275d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
37375d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
37475d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
37675d1ea7fSwdenk
377506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
378506f3918SHeiko Schocher
379506f3918SHeiko Schocher		Define this option if you want to enable the
380506f3918SHeiko Schocher		ICache only when Code runs from RAM.
381506f3918SHeiko Schocher
38266412c63SKumar Gala- 85xx CPU Options:
383ffd06e02SYork Sun		CONFIG_SYS_PPC64
384ffd06e02SYork Sun
385ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
386ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
387ffd06e02SYork Sun		compliance, among other possible reasons.
388ffd06e02SYork Sun
38966412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
39066412c63SKumar Gala
39166412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
39266412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
39366412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
39466412c63SKumar Gala
3958f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3968f29084aSKumar Gala
3978f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3988f29084aSKumar Gala		tree nodes for the given platform.
3998f29084aSKumar Gala
400afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
401afa6b551SPrabhakar Kushwaha
402afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
403afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
404afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
405afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
406afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
407afa6b551SPrabhakar Kushwaha		purpose.
408afa6b551SPrabhakar Kushwaha
40933eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
41033eee330SScott Wood
41133eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
41233eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
41333eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
41433eee330SScott Wood
41533eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
41633eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
41733eee330SScott Wood
41833eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
41933eee330SScott Wood		for which the A004510 workaround should be applied.
42033eee330SScott Wood
42133eee330SScott Wood		The rest of SVR is either not relevant to the decision
42233eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
42333eee330SScott Wood		p2041) or is implied by the build target, which controls
42433eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
42533eee330SScott Wood
42633eee330SScott Wood		See Freescale App Note 4493 for more information about
42733eee330SScott Wood		this erratum.
42833eee330SScott Wood
42974fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
43074fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
431b445bbb4SJeremiah Mahler		required during NOR boot.
43274fa22edSPrabhakar Kushwaha
4339f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
4349f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
435b445bbb4SJeremiah Mahler		required during NAND boot and valid for Rev 1.0 SoC revision
4369f074e67SPrabhakar Kushwaha
43733eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
43833eee330SScott Wood
43933eee330SScott Wood		This is the value to write into CCSR offset 0x18600
44033eee330SScott Wood		according to the A004510 workaround.
44133eee330SScott Wood
44264501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
44364501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
44464501c66SPriyanka Jain		connected exclusively to the DSP cores.
44564501c66SPriyanka Jain
446765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
447765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
448765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
449765b0bdbSPriyanka Jain
45064501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
45164501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
45264501c66SPriyanka Jain		connected to the DSP core.
45364501c66SPriyanka Jain
454765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
455765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
456765b0bdbSPriyanka Jain
457b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
458b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
459b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
460b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
461b135991aSPriyanka Jain
462fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
463fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
464a187559eSBin Meng		time of U-Boot entry and is required to be re-initialized.
465fb4a2409SAneesh Bansal
466aade2004STang Yuantian		CONFIG_DEEP_SLEEP
467b445bbb4SJeremiah Mahler		Indicates this SoC supports deep sleep feature. If deep sleep is
468aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
469aade2004STang Yuantian
4706cb461b4SDaniel Schwierzeck- Generic CPU options:
4712a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4722a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4732a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4742a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4752a1680e3SYork Sun		should initialize global data before calling board_init_f().
4762a1680e3SYork Sun
4776cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4786cb461b4SDaniel Schwierzeck
4796cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4806cb461b4SDaniel Schwierzeck		values is arch specific.
4816cb461b4SDaniel Schwierzeck
4825614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4835614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4845614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4855614e71bSYork Sun		SoCs.
4865614e71bSYork Sun
4875614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4885614e71bSYork Sun		Freescale DDR memory-mapped register base.
4895614e71bSYork Sun
4905614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4915614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4925614e71bSYork Sun		deskew training are not available.
4935614e71bSYork Sun
4945614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4955614e71bSYork Sun		Freescale DDR1 controller.
4965614e71bSYork Sun
4975614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4985614e71bSYork Sun		Freescale DDR2 controller.
4995614e71bSYork Sun
5005614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
5015614e71bSYork Sun		Freescale DDR3 controller.
5025614e71bSYork Sun
50334e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
50434e026f9SYork Sun		Freescale DDR4 controller.
50534e026f9SYork Sun
5069ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
5079ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
5089ac4ffbdSYork Sun
5095614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
5105614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
5115614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
5125614e71bSYork Sun		implemetation.
5135614e71bSYork Sun
5145614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
51562a3b7ddSRobert P. J. Day		Board config to use DDR2. It can be enabled for SoCs with
5165614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
5175614e71bSYork Sun		implementation.
5185614e71bSYork Sun
5195614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
5205614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
52134e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
52234e026f9SYork Sun
52334e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
52434e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
52534e026f9SYork Sun		DDR3L controllers.
52634e026f9SYork Sun
52734e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
52834e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
52934e026f9SYork Sun		DDR4 controllers.
5305614e71bSYork Sun
5311b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5321b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5331b4175d6SPrabhakar Kushwaha
5341b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5351b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5361b4175d6SPrabhakar Kushwaha
537690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
538690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
539690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
540690e4258SPrabhakar Kushwaha
541690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
542690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
543690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
544690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
545690e4258SPrabhakar Kushwaha
54689ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
54789ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
54889ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
54989ad7be8SPrabhakar Kushwaha
5504e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5514e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5524e5b1bd0SYork Sun
5534e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5544e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5554e5b1bd0SYork Sun
5566b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5576b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5586b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5596b9e309aSYork Sun		it could be different for ARM SoCs.
5606b9e309aSYork Sun
5616b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5626b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5636b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5646b1e1254SYork Sun		SoCs with ARM core.
5656b1e1254SYork Sun
5661d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
5671d71efbbSYork Sun		Number of controllers used as main memory.
5681d71efbbSYork Sun
5691d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
5701d71efbbSYork Sun		Number of controllers used for other than main memory.
5711d71efbbSYork Sun
57244937214SPrabhakar Kushwaha		CONFIG_SYS_FSL_HAS_DP_DDR
57344937214SPrabhakar Kushwaha		Defines the SoC has DP-DDR used for DPAA.
57444937214SPrabhakar Kushwaha
575028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
576028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
577028dbb8dSRuchika Gupta
578028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
579028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
580028dbb8dSRuchika Gupta
5810b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5830b953ffcSMarkus Klotzbuecher
5840b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5850b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5860b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5870b953ffcSMarkus Klotzbuecher
5886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5890b953ffcSMarkus Klotzbuecher
5900b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5910b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5920b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5930b953ffcSMarkus Klotzbuecher		by this value.
5940b953ffcSMarkus Klotzbuecher
59592bbd64eSDaniel Schwierzeck- MIPS CPU options:
59692bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
59792bbd64eSDaniel Schwierzeck
59892bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
59992bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
60092bbd64eSDaniel Schwierzeck		relocation.
60192bbd64eSDaniel Schwierzeck
60292bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
60392bbd64eSDaniel Schwierzeck
60492bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
60592bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
60692bbd64eSDaniel Schwierzeck		Possible values are:
60792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
60892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
60992bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
61092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
61192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
61292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
61392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
61492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
61592bbd64eSDaniel Schwierzeck
61692bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
61792bbd64eSDaniel Schwierzeck
61892bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
61992bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
62092bbd64eSDaniel Schwierzeck
62192bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
62292bbd64eSDaniel Schwierzeck
62392bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
62492bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
62592bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
62692bbd64eSDaniel Schwierzeck
627b67d8816SChristian Riesch- ARM options:
628b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
629b67d8816SChristian Riesch
630b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
631b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
632b67d8816SChristian Riesch
6335356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
6345356f545SAneesh V
6355356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6365356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6375356f545SAneesh V		better code density. For ARM architectures that support
6385356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6395356f545SAneesh V		GCC.
6405356f545SAneesh V
641c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6420678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6430678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6440678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
645b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
646e392b923SIan Campbell		CONFIG_ARM_ERRATA_773022
647e392b923SIan Campbell		CONFIG_ARM_ERRATA_774769
648e392b923SIan Campbell		CONFIG_ARM_ERRATA_794072
6490678587fSStephen Warren
6500678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6510678587fSStephen Warren		during U-Boot startup. Note that these options force the
6520678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6530678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6540678587fSStephen Warren		set these options unless they apply!
6550678587fSStephen Warren
656207774b2SYork Sun		COUNTER_FREQUENCY
657207774b2SYork Sun		Generic timer clock source frequency.
658207774b2SYork Sun
659207774b2SYork Sun		COUNTER_FREQUENCY_REAL
660207774b2SYork Sun		Generic timer clock source frequency if the real clock is
661207774b2SYork Sun		different from COUNTER_FREQUENCY, and can only be determined
662207774b2SYork Sun		at run time.
663207774b2SYork Sun
664c616a0dfSNishanth Menon		NOTE: The following can be machine specific errata. These
665c616a0dfSNishanth Menon		do have ability to provide rudimentary version and machine
666c616a0dfSNishanth Menon		specific checks, but expect no product checks.
6675902f4ceSNishanth Menon		CONFIG_ARM_ERRATA_430973
668b45c48a7SNishanth Menon		CONFIG_ARM_ERRATA_454179
6699b4d65f9SNishanth Menon		CONFIG_ARM_ERRATA_621766
670c616a0dfSNishanth Menon		CONFIG_ARM_ERRATA_798870
671a615d0beSNishanth Menon		CONFIG_ARM_ERRATA_801819
672c616a0dfSNishanth Menon
67373c38934SStephen Warren- Tegra SoC options:
67473c38934SStephen Warren		CONFIG_TEGRA_SUPPORT_NON_SECURE
67573c38934SStephen Warren
67673c38934SStephen Warren		Support executing U-Boot in non-secure (NS) mode. Certain
67773c38934SStephen Warren		impossible actions will be skipped if the CPU is in NS mode,
67873c38934SStephen Warren		such as ARM architectural timer initialization.
67973c38934SStephen Warren
6805da627a4Swdenk- Linux Kernel Interface:
681c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
682c609719bSwdenk
683c609719bSwdenk		U-Boot stores all clock information in Hz
684c609719bSwdenk		internally. For binary compatibility with older Linux
685c609719bSwdenk		kernels (which expect the clocks passed in the
686c609719bSwdenk		bd_info data to be in MHz) the environment variable
687c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
688c609719bSwdenk		converts clock data to MHZ before passing it to the
689c609719bSwdenk		Linux kernel.
690c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
691c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
692c609719bSwdenk		default environment.
693c609719bSwdenk
6945da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
6955da627a4Swdenk
696b445bbb4SJeremiah Mahler		When transferring memsize parameter to Linux, some versions
6975da627a4Swdenk		expect it to be in bytes, others in MB.
6985da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6995da627a4Swdenk
700fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
701f57f70aaSWolfgang Denk
702f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
703213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
704213bf8c8SGerald Van Baren		concepts).
705213bf8c8SGerald Van Baren
706213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
707213bf8c8SGerald Van Baren		 * New libfdt-based support
708213bf8c8SGerald Van Baren		 * Adds the "fdt" command
7093bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
710213bf8c8SGerald Van Baren
711b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
712b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
713b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
714b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
715f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
716c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
717f57f70aaSWolfgang Denk
71811ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
71911ccc33fSMarcel Ziswiler		addresses
7203bb342fcSKim Phillips
7214e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
7224e253137SKumar Gala
7234e253137SKumar Gala		Board code has addition modification that it wants to make
7244e253137SKumar Gala		to the flat device tree before handing it off to the kernel
7256705d81eSwdenk
726c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
727c654b517SSimon Glass
728c654b517SSimon Glass		Other code has addition modification that it wants to make
729c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
730c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
731c654b517SSimon Glass		the kernel.
732c654b517SSimon Glass
7330267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
7340267768eSMatthew McClintock
73511ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
7360267768eSMatthew McClintock		param header, the default value is zero if undefined.
7370267768eSMatthew McClintock
7383887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
7393887c3fbSHeiko Schocher
7403887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
7413887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
7423887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
7433887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
7443887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
7453887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
7463887c3fbSHeiko Schocher
7477eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
7487eb29398SIgor Grinberg
7497eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
7507eb29398SIgor Grinberg		machine type and must be used to specify the machine type
7517eb29398SIgor Grinberg		number as it appears in the ARM machine registry
7527eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
7537eb29398SIgor Grinberg		Only boards that have multiple machine types supported
7547eb29398SIgor Grinberg		in a single configuration file and the machine type is
7557eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
7567eb29398SIgor Grinberg
7570b2f4ecaSNiklaus Giger- vxWorks boot parameters:
7580b2f4ecaSNiklaus Giger
7590b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
7609e98b7e3SBin Meng		environments variables: bootdev, bootfile, ipaddr, netmask,
7619e98b7e3SBin Meng		serverip, gatewayip, hostname, othbootargs.
7620b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
7630b2f4ecaSNiklaus Giger
7640b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
7650b2f4ecaSNiklaus Giger		the defaults discussed just above.
7660b2f4ecaSNiklaus Giger
7672c451f78SAneesh V- Cache Configuration:
7682c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
7692c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
7702c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
7712c451f78SAneesh V
77293bc2193SAneesh V- Cache Configuration for ARM:
77393bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
77493bc2193SAneesh V				      controller
77593bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
77693bc2193SAneesh V					controller register space
77793bc2193SAneesh V
7786705d81eSwdenk- Serial Ports:
77948d0192fSAndreas Engel		CONFIG_PL010_SERIAL
7806705d81eSwdenk
7816705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
7826705d81eSwdenk
78348d0192fSAndreas Engel		CONFIG_PL011_SERIAL
7846705d81eSwdenk
7856705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
7866705d81eSwdenk
7876705d81eSwdenk		CONFIG_PL011_CLOCK
7886705d81eSwdenk
7896705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
7906705d81eSwdenk		the clock speed of the UARTs.
7916705d81eSwdenk
7926705d81eSwdenk		CONFIG_PL01x_PORTS
7936705d81eSwdenk
7946705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
7956705d81eSwdenk		define this to a list of base addresses for each (supported)
7966705d81eSwdenk		port. See e.g. include/configs/versatile.h
7976705d81eSwdenk
798d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
799d57dee57SKaricheri, Muralidharan
800d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
801d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
8026705d81eSwdenk
803c609719bSwdenk- Console Interface:
804c609719bSwdenk		Depending on board, define exactly one serial port
805c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
806c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
807c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
808c609719bSwdenk
809c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
810c609719bSwdenk		port routines must be defined elsewhere
811c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
812c609719bSwdenk
813c609719bSwdenk		CONFIG_CFB_CONSOLE
814c609719bSwdenk		Enables console device for a color framebuffer. Needs following
815c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
816c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
817c609719bSwdenk						(default big endian)
818c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
819c609719bSwdenk						rectangle fill
820c609719bSwdenk						(cf. smiLynxEM)
821c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
822c609719bSwdenk						bit-blit (cf. smiLynxEM)
823c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
824c609719bSwdenk						(cols=pitch)
825c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
826c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
827c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
828c609719bSwdenk						(0-5, cf. cfb_console.c)
829c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
830c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
83139f615edSSimon Glass						(i.e. rx51_kp_init())
832c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
83339f615edSSimon Glass						(i.e. rx51_kp_tstc)
834c609719bSwdenk			VIDEO_GETC_FCT		get char fct
83539f615edSSimon Glass						(i.e. rx51_kp_getc)
836c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
837c609719bSwdenk						upper left corner
838a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
839a6c7ad2fSwdenk						linux_logo.h for logo.
840a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
841c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
84211ccc33fSMarcel Ziswiler						additional board info beside
843c609719bSwdenk						the logo
844adde435fSTim Harvey			CONFIG_HIDE_LOGO_VERSION
845adde435fSTim Harvey						do not display bootloader
846adde435fSTim Harvey						version string
847c609719bSwdenk
84833a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
84933a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
85033a35bbbSPali Rohár		erase functions and limited graphics rendition control).
85133a35bbbSPali Rohár
852c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
853c609719bSwdenk		default i/o. Serial console can be forced with
854c609719bSwdenk		environment 'console=serial'.
855c609719bSwdenk
856a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
857a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
858a3ad8e26Swdenk		the "silent" environment variable. See
859a3ad8e26Swdenk		doc/README.silent for more information.
860a3ad8e26Swdenk
86145ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
86245ae2546SHeiko Schocher			is 0x00.
86345ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
86445ae2546SHeiko Schocher			is 0xa0.
86545ae2546SHeiko Schocher
866c609719bSwdenk- Console Baudrate:
867c609719bSwdenk		CONFIG_BAUDRATE - in bps
868c609719bSwdenk		Select one of the baudrates listed in
8696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
8706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
871c609719bSwdenk
872c92fac91SHeiko Schocher- Console Rx buffer length
873c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
874c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
8752b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
876c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
877c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
878c92fac91SHeiko Schocher		the SMC.
879c92fac91SHeiko Schocher
8809558b48aSGraeme Russ- Pre-Console Buffer:
8819558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
8829558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
8839558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8849558b48aSGraeme Russ		buffer any console messages prior to the console being
8859558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8869558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8879558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8889558b48aSGraeme Russ		bytes are output before the console is initialised, the
8899558b48aSGraeme Russ		earlier bytes are discarded.
8909558b48aSGraeme Russ
891a8552c7cSHans de Goede		Note that when printing the buffer a copy is made on the
892a8552c7cSHans de Goede		stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
893a8552c7cSHans de Goede
8949558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8959558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8969558b48aSGraeme Russ
897c609719bSwdenk- Autoboot Command:
898c609719bSwdenk		CONFIG_BOOTCOMMAND
899c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
900c609719bSwdenk		define a command string that is automatically executed
901c609719bSwdenk		when no character is read on the console interface
902c609719bSwdenk		within "Boot Delay" after reset.
903c609719bSwdenk
904c609719bSwdenk		CONFIG_BOOTARGS
905c609719bSwdenk		This can be used to pass arguments to the bootm
906c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
907c609719bSwdenk		environment value "bootargs".
908c609719bSwdenk
909c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
910c609719bSwdenk		The value of these goes into the environment as
911c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
912c609719bSwdenk		as a convenience, when switching between booting from
91311ccc33fSMarcel Ziswiler		RAM and NFS.
914c609719bSwdenk
915eda0ba38SHeiko Schocher- Bootcount:
916eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
917eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
918eda0ba38SHeiko Schocher		cycle, see:
919eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
920eda0ba38SHeiko Schocher
921eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
922eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
923eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
924eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
925eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
926eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
927eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
928eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
929eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
930eda0ba38SHeiko Schocher
931c609719bSwdenk- Pre-Boot Commands:
932c609719bSwdenk		CONFIG_PREBOOT
933c609719bSwdenk
934c609719bSwdenk		When this option is #defined, the existence of the
935c609719bSwdenk		environment variable "preboot" will be checked
936c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
937c609719bSwdenk		countdown and/or running the auto-boot command resp.
938c609719bSwdenk		entering interactive mode.
939c609719bSwdenk
940c609719bSwdenk		This feature is especially useful when "preboot" is
941c609719bSwdenk		automatically generated or modified. For an example
942c609719bSwdenk		see the LWMON board specific code: here "preboot" is
943c609719bSwdenk		modified when the user holds down a certain
944c609719bSwdenk		combination of keys on the (special) keyboard when
945c609719bSwdenk		booting the systems
946c609719bSwdenk
947c609719bSwdenk- Serial Download Echo Mode:
948c609719bSwdenk		CONFIG_LOADS_ECHO
949c609719bSwdenk		If defined to 1, all characters received during a
950c609719bSwdenk		serial download (using the "loads" command) are
951c609719bSwdenk		echoed back. This might be needed by some terminal
952c609719bSwdenk		emulations (like "cu"), but may as well just take
953c609719bSwdenk		time on others. This setting #define's the initial
954c609719bSwdenk		value of the "loads_echo" environment variable.
955c609719bSwdenk
956602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
957c609719bSwdenk		CONFIG_KGDB_BAUDRATE
958c609719bSwdenk		Select one of the baudrates listed in
9596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
960c609719bSwdenk
961c609719bSwdenk- Monitor Functions:
962602ad3b3SJon Loeliger		Monitor commands can be included or excluded
963602ad3b3SJon Loeliger		from the build by using the #include files
964c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
965ef0f2f57SJoe Hershberger		commands, or adding #define's for wanted commands.
966c609719bSwdenk
967602ad3b3SJon Loeliger		The default command configuration includes all commands
968602ad3b3SJon Loeliger		except those marked below with a "*".
969602ad3b3SJon Loeliger
970b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
971602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
972602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
973602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
974602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
975602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
976602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
977d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
978602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
97908d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
980602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
981710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
982602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
983602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
984602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
985a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
986a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
987a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
988a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
989602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
990602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
991246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
992602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
993aa9e6044SNikita Kiryanov		CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
994602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9955e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
996fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
99788733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9980c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
99903e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
100003e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
100116f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
100216f4d933SStephen Warren					  that work for multiple fs types
100359e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
1004bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
1005602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
100603e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
1007602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
1008602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
10094d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
101053fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1011a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1012a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1013bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1014602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1015602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1016602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
10178fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
10184d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1019602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
1020aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
10210c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1022c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1023602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1024602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1025602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1026602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
10274d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1028d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1029d22c338eSJoe Hershberger					  (169.254.*.*)
1030602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1031602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
10324d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
103302c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
103415a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1035602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1036a2681707SWolfgang Denk					  loop, loopw
10374d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1038602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1039602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1040602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
104168d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1042602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1043602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
10444d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1045e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1046e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1047602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1048602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1049602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1050602ad3b3SJon Loeliger					  host
1051602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1052ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1053602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1054602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1055d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1056602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1057c649e3c9SSimon Glass		CONFIG_SCSI		* SCSI Support
1058602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1059602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1060602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1061602ad3b3SJon Loeliger					  (4xx only)
1062f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10634d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
106402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10657d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
106674de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1067602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10687a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10691fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1070da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1071da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1072602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1073602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1074c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10754d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
107689c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1077c609719bSwdenk
1078c609719bSwdenk		EXAMPLE: If you want all functions except of network
1079c609719bSwdenk		support you can write:
1080c609719bSwdenk
1081602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1082602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1083c609719bSwdenk
1084213bf8c8SGerald Van Baren	Other Commands:
1085213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1086c609719bSwdenk
1087c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1088602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1089c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1090c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1091c609719bSwdenk		8260 (where accesses to the IMMR region must be
1092c609719bSwdenk		uncached), and it cannot be disabled on all other
1093c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1094c609719bSwdenk		initial stack and some data.
1095c609719bSwdenk
1096c609719bSwdenk
1097c609719bSwdenk		XXX - this list needs to get updated!
1098c609719bSwdenk
1099302a6487SSimon Glass- Removal of commands
1100302a6487SSimon Glass		If no commands are needed to boot, you can disable
1101302a6487SSimon Glass		CONFIG_CMDLINE to remove them. In this case, the command line
1102302a6487SSimon Glass		will not be available, and when U-Boot wants to execute the
1103302a6487SSimon Glass		boot command (on start-up) it will call board_run_command()
1104302a6487SSimon Glass		instead. This can reduce image size significantly for very
1105302a6487SSimon Glass		simple boot procedures.
1106302a6487SSimon Glass
1107a5ecbe62SWolfgang Denk- Regular expression support:
1108a5ecbe62SWolfgang Denk		CONFIG_REGEX
1109a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1110a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1111a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1112a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1113a5ecbe62SWolfgang Denk
111445ba8077SSimon Glass- Device tree:
111545ba8077SSimon Glass		CONFIG_OF_CONTROL
111645ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
111745ba8077SSimon Glass		to configure its devices, instead of relying on statically
111845ba8077SSimon Glass		compiled #defines in the board file. This option is
111945ba8077SSimon Glass		experimental and only available on a few boards. The device
112045ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
112145ba8077SSimon Glass
11222c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
11232c0f79e4SSimon Glass		be done using one of the two options below:
1124bbb0b128SSimon Glass
1125bbb0b128SSimon Glass		CONFIG_OF_EMBED
1126bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1127bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1128bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1129bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1130bbb0b128SSimon Glass		the global data structure as gd->blob.
113145ba8077SSimon Glass
11322c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
11332c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
11342c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
11352c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
11362c0f79e4SSimon Glass
11372c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
11382c0f79e4SSimon Glass
11392c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
11402c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
11412c0f79e4SSimon Glass		still use the individual files if you need something more
11422c0f79e4SSimon Glass		exotic.
11432c0f79e4SSimon Glass
1144c609719bSwdenk- Watchdog:
1145c609719bSwdenk		CONFIG_WATCHDOG
1146c609719bSwdenk		If this variable is defined, it enables watchdog
11476abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
11486abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
11496abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
11506abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
11516abe6fb6SDetlev Zundel		available, then no further board specific code should
11526abe6fb6SDetlev Zundel		be needed to use it.
11536abe6fb6SDetlev Zundel
11546abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
11556abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
11566abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
11576abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1158c609719bSwdenk
11597bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
11607bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
11617bae0d6fSHeiko Schocher
1162c1551ea8Sstroese- U-Boot Version:
1163c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1164c1551ea8Sstroese		If this variable is defined, an environment variable
1165c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1166c1551ea8Sstroese		version as printed by the "version" command.
1167a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1168a1ea8e51SBenoît Thébaudeau		next reset.
1169c1551ea8Sstroese
1170c609719bSwdenk- Real-Time Clock:
1171c609719bSwdenk
1172602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1173c609719bSwdenk		has to be selected, too. Define exactly one of the
1174c609719bSwdenk		following options:
1175c609719bSwdenk
1176c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1177c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11784e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1179c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11801cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1181c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11827f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1183412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
11843bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11859536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11864c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
118871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
118971d19f30SHeiko Schocher					  RV3029 RTC.
1190c609719bSwdenk
1191b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1192b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1193b37c7e5eSwdenk
1194e92739d3SPeter Tyser- GPIO Support:
1195e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1196e92739d3SPeter Tyser
11975dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11985dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11995dec49caSChris Packham		pins supported by a particular chip.
12005dec49caSChris Packham
1201e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1202e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1203e92739d3SPeter Tyser
1204aa53233aSSimon Glass- I/O tracing:
1205aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1206aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1207aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1208aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1209aa53233aSSimon Glass		the driver behaves the same way before and after a code
1210aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1211aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1212aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1213aa53233aSSimon Glass
1214aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1215aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1216aa53233aSSimon Glass		still continue to operate.
1217aa53233aSSimon Glass
1218aa53233aSSimon Glass			iotrace is enabled
1219aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1220aa53233aSSimon Glass			Size:   00010000	(buffer size)
1221aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1222aa53233aSSimon Glass			Output: 10000120	(start + offset)
1223aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1224aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1225aa53233aSSimon Glass
1226c609719bSwdenk- Timestamp Support:
1227c609719bSwdenk
1228c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1229c609719bSwdenk		(date and time) of an image is printed by image
1230c609719bSwdenk		commands like bootm or iminfo. This option is
1231602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1232c609719bSwdenk
1233923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1234923c46f9SKarl O. Pinc		Zero or more of the following:
1235923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1236923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1237923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1238923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1239923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1240923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1241923c46f9SKarl O. Pinc				       disk/part_efi.c
1242923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1243c609719bSwdenk
1244602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1245c649e3c9SSimon Glass		CONFIG_SCSI) you must configure support for at
1246923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1247c609719bSwdenk
1248c609719bSwdenk- IDE Reset method:
12494d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
12504d13cbadSwdenk		board configurations files but used nowhere!
1251c609719bSwdenk
12524d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
12534d13cbadSwdenk		be performed by calling the function
12544d13cbadSwdenk			ide_set_reset(int reset)
12554d13cbadSwdenk		which has to be defined in a board specific file
1256c609719bSwdenk
1257c609719bSwdenk- ATAPI Support:
1258c609719bSwdenk		CONFIG_ATAPI
1259c609719bSwdenk
1260c609719bSwdenk		Set this to enable ATAPI support.
1261c609719bSwdenk
1262c40b2956Swdenk- LBA48 Support
1263c40b2956Swdenk		CONFIG_LBA48
1264c40b2956Swdenk
1265c40b2956Swdenk		Set this to enable support for disks larger than 137GB
12664b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1267c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1268c40b2956Swdenk		support disks up to 2.1TB.
1269c40b2956Swdenk
12706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1271c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1272c40b2956Swdenk			Default is 32bit.
1273c40b2956Swdenk
1274c609719bSwdenk- SCSI Support:
1275c609719bSwdenk		At the moment only there is only support for the
1276c609719bSwdenk		SYM53C8XX SCSI controller; define
1277c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1278c609719bSwdenk
12796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
12806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
12816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1282c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1283c609719bSwdenk		devices.
12846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1285c609719bSwdenk
1286447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1287447c031bSStefan Reinauer		SCSI devices found during the last scan.
1288447c031bSStefan Reinauer
1289c609719bSwdenk- NETWORK Support (PCI):
1290682011ffSwdenk		CONFIG_E1000
1291ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1292ce5207e1SKyle Moffett
1293ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1294ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1295ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1296ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1297ce5207e1SKyle Moffett
1298ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1299ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1300ce5207e1SKyle Moffett		example with the "sspi" command.
1301ce5207e1SKyle Moffett
1302ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1303ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1304ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1305682011ffSwdenk
1306c609719bSwdenk		CONFIG_EEPRO100
1307c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
130811ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1309c609719bSwdenk		write routine for first time initialisation.
1310c609719bSwdenk
1311c609719bSwdenk		CONFIG_TULIP
1312c609719bSwdenk		Support for Digital 2114x chips.
1313c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1314c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1315c609719bSwdenk
1316c609719bSwdenk		CONFIG_NATSEMI
1317c609719bSwdenk		Support for National dp83815 chips.
1318c609719bSwdenk
1319c609719bSwdenk		CONFIG_NS8382X
1320c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1321c609719bSwdenk
132245219c46Swdenk- NETWORK Support (other):
132345219c46Swdenk
1324c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1325c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1326c041e9d2SJens Scharsig
1327c041e9d2SJens Scharsig			CONFIG_RMII
1328c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1329c041e9d2SJens Scharsig
1330c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1331c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1332c041e9d2SJens Scharsig			The driver doen't show link status messages.
1333c041e9d2SJens Scharsig
1334efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1335efdd7319SRob Herring		Support for the Calxeda XGMAC device
1336efdd7319SRob Herring
13373bb46d23SAshok		CONFIG_LAN91C96
133845219c46Swdenk		Support for SMSC's LAN91C96 chips.
133945219c46Swdenk
134045219c46Swdenk			CONFIG_LAN91C96_BASE
134145219c46Swdenk			Define this to hold the physical address
134245219c46Swdenk			of the LAN91C96's I/O space
134345219c46Swdenk
134445219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
134545219c46Swdenk			Define this to enable 32 bit addressing
134645219c46Swdenk
13473bb46d23SAshok		CONFIG_SMC91111
1348f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1349f39748aeSwdenk
1350f39748aeSwdenk			CONFIG_SMC91111_BASE
1351f39748aeSwdenk			Define this to hold the physical address
1352f39748aeSwdenk			of the device (I/O space)
1353f39748aeSwdenk
1354f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1355f39748aeSwdenk			Define this if data bus is 32 bits
1356f39748aeSwdenk
1357f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1358f39748aeSwdenk			Define this to use i/o functions instead of macros
1359f39748aeSwdenk			(some hardware wont work with macros)
1360f39748aeSwdenk
1361dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1362dc02badaSHeiko Schocher		Support for davinci emac
1363dc02badaSHeiko Schocher
1364dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1365dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1366dc02badaSHeiko Schocher
1367b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1368b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1369b3dbf4a5SMacpaul Lin
1370b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1371b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1372b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1373b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1374b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1375b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1376b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1377b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1378b3dbf4a5SMacpaul Lin
1379c2fff331SMike Rapoport		CONFIG_SMC911X
1380557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1381557b377dSJens Gehrlein
1382c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1383557b377dSJens Gehrlein			Define this to hold the physical address
1384557b377dSJens Gehrlein			of the device (I/O space)
1385557b377dSJens Gehrlein
1386c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1387557b377dSJens Gehrlein			Define this if data bus is 32 bits
1388557b377dSJens Gehrlein
1389c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1390557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1391557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1392c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1393557b377dSJens Gehrlein
13943d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
13953d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
13963d0075faSYoshihiro Shimoda
13973d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
13983d0075faSYoshihiro Shimoda			Define the number of ports to be used
13993d0075faSYoshihiro Shimoda
14003d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
14013d0075faSYoshihiro Shimoda			Define the ETH PHY's address
14023d0075faSYoshihiro Shimoda
140368260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
140468260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
140568260aabSYoshihiro Shimoda
1406b2f97cf2SHeiko Schocher- PWM Support:
1407b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1408b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1409b2f97cf2SHeiko Schocher
14105e124724SVadim Bendebury- TPM Support:
141190899cc0SChe-liang Chiou		CONFIG_TPM
141290899cc0SChe-liang Chiou		Support TPM devices.
141390899cc0SChe-liang Chiou
14140766ad2fSChristophe Ricard		CONFIG_TPM_TIS_INFINEON
14150766ad2fSChristophe Ricard		Support for Infineon i2c bus TPM devices. Only one device
14161b393db5STom Wai-Hong Tam		per system is supported at this time.
14171b393db5STom Wai-Hong Tam
14181b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
14191b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
14201b393db5STom Wai-Hong Tam
14213aa74088SChristophe Ricard		CONFIG_TPM_ST33ZP24
14223aa74088SChristophe Ricard		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
14233aa74088SChristophe Ricard
14243aa74088SChristophe Ricard			CONFIG_TPM_ST33ZP24_I2C
14253aa74088SChristophe Ricard			Support for STMicroelectronics ST33ZP24 I2C devices.
14263aa74088SChristophe Ricard			Requires TPM_ST33ZP24 and I2C.
14273aa74088SChristophe Ricard
1428b75fdc11SChristophe Ricard			CONFIG_TPM_ST33ZP24_SPI
1429b75fdc11SChristophe Ricard			Support for STMicroelectronics ST33ZP24 SPI devices.
1430b75fdc11SChristophe Ricard			Requires TPM_ST33ZP24 and SPI.
1431b75fdc11SChristophe Ricard
1432c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1433c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1434c01939c7SDirk Eibach
143590899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
14365e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
14375e124724SVadim Bendebury		per system is supported at this time.
14385e124724SVadim Bendebury
14395e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
14405e124724SVadim Bendebury			Base address where the generic TPM device is mapped
14415e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
14425e124724SVadim Bendebury			0xfed40000.
14435e124724SVadim Bendebury
1444be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1445be6c1529SReinhard Pfau		Add tpm monitor functions.
1446be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1447be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1448be6c1529SReinhard Pfau
1449be6c1529SReinhard Pfau		CONFIG_TPM
1450be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1451be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1452be6c1529SReinhard Pfau		Requires support for a TPM device.
1453be6c1529SReinhard Pfau
1454be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1455be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1456be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1457be6c1529SReinhard Pfau
1458c609719bSwdenk- USB Support:
1459c609719bSwdenk		At the moment only the UHCI host controller is
14604d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1461c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1462c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
146330d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1464c609719bSwdenk		storage devices.
1465c609719bSwdenk		Note:
1466c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1467c609719bSwdenk		(TEAC FD-05PUB).
14684d13cbadSwdenk		MPC5200 USB requires additional defines:
14694d13cbadSwdenk			CONFIG_USB_CLOCK
14704d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1471307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1472307ecb6dSEric Millbrandt				for USB on PSC3
14734d13cbadSwdenk			CONFIG_USB_CONFIG
14744d13cbadSwdenk				for differential drivers: 0x00001000
14754d13cbadSwdenk				for single ended drivers: 0x00005000
1476307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1477307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
14786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1479fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1480fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
14814d13cbadSwdenk
14829ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
14839ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
14849ab4ce22SSimon Glass
14856e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
14866e9e0626SOleksandr Tymoshenko		HW module registers.
14876e9e0626SOleksandr Tymoshenko
148816c8d5e7SWolfgang Denk- USB Device:
148916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
149016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
149116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
149211ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
149316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
149416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
149516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
149616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
149716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
149816c8d5e7SWolfgang Denk		a Linux host by
149916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
150016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
150116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
150216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
150316c8d5e7SWolfgang Denk
150416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
150516c8d5e7SWolfgang Denk			Define this to build a UDC device
150616c8d5e7SWolfgang Denk
150716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
150816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
150916c8d5e7SWolfgang Denk			talk to the UDC device
151016c8d5e7SWolfgang Denk
1511f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1512f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1513f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1514f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1515f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1516f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1517f9da0f89SVipin KUMAR			speed.
1518f9da0f89SVipin KUMAR
15196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
152016c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
152116c8d5e7SWolfgang Denk			be set to usbtty.
152216c8d5e7SWolfgang Denk
152316c8d5e7SWolfgang Denk			mpc8xx:
15246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
152516c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
15266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
152716c8d5e7SWolfgang Denk
15286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
152916c8d5e7SWolfgang Denk				Derive USB clock from brgclk
15306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
153116c8d5e7SWolfgang Denk
153216c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
153316c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
153416c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
153516c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
153616c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
153716c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
153816c8d5e7SWolfgang Denk
153916c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
154016c8d5e7SWolfgang Denk			Define this string as the name of your company for
154116c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
154216c8d5e7SWolfgang Denk
154316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
154416c8d5e7SWolfgang Denk			Define this string as the name of your product
154516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
154616c8d5e7SWolfgang Denk
154716c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
154816c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
154916c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
155016c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
155116c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
155216c8d5e7SWolfgang Denk
155316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
155416c8d5e7SWolfgang Denk			Define this as the unique Product ID
155516c8d5e7SWolfgang Denk			for your device
155616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1557c609719bSwdenk
1558d70a560fSIgor Grinberg- ULPI Layer Support:
1559d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1560d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1561d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1562d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1563d70a560fSIgor Grinberg		viewport is supported.
1564d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1565d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
15666d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
15676d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
15686d365ea0SLucas Stach		the appropriate value in Hz.
1569c609719bSwdenk
1570c609719bSwdenk- MMC Support:
1571c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1572c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1573c609719bSwdenk		accessed from the boot prompt by mapping the device
1574c609719bSwdenk		to physical memory similar to flash. Command line is
1575602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1576602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1577c609719bSwdenk
1578afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1579afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1580afb35666SYoshihiro Shimoda
1581afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1582afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1583afb35666SYoshihiro Shimoda
1584afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1585afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1586afb35666SYoshihiro Shimoda
15871fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
15881fd93c6eSPierre Aubert		Enable the generic MMC driver
15891fd93c6eSPierre Aubert
15901fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
15911fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
15921fd93c6eSPierre Aubert
15931fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
15941fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
15951fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
15961fd93c6eSPierre Aubert
1597b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
159801acd6abSPaul Kocialkowski		CONFIG_USB_FUNCTION_DFU
1599b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1600b3ba6e94STom Rini
1601b3ba6e94STom Rini		CONFIG_CMD_DFU
1602b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1603b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1604b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1605b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1606b3ba6e94STom Rini
1607b3ba6e94STom Rini		CONFIG_DFU_MMC
1608b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1609b3ba6e94STom Rini
1610c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1611c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1612c6631764SPantelis Antoniou
1613a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1614a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1615a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1616a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1617a9479f04SAfzal Mohammed		one that would help mostly the developer.
1618a9479f04SAfzal Mohammed
1619e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1620e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1621e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1622e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1623e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1624e7e75c70SHeiko Schocher
1625ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1626ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1627ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1628ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1629ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1630ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1631ea2453d5SPantelis Antoniou
1632001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1633001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1634001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1635001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1636001a8319SHeiko Schocher
1637001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1638001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1639001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1640001a8319SHeiko Schocher		sending again an USB request to the device.
1641001a8319SHeiko Schocher
16423aab70afSSebastian Siewior- USB Device Android Fastboot support:
164317da3c0cSPaul Kocialkowski		CONFIG_USB_FUNCTION_FASTBOOT
164417da3c0cSPaul Kocialkowski		This enables the USB part of the fastboot gadget
164517da3c0cSPaul Kocialkowski
16463aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
16473aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
16483aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
16493aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
16503aab70afSSebastian Siewior		used on Android devices.
16513aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
16523aab70afSSebastian Siewior
16533aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
16543aab70afSSebastian Siewior		This enables support for booting images which use the Android
16553aab70afSSebastian Siewior		image format header.
16563aab70afSSebastian Siewior
1657a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_ADDR
16583aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
16593aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
16603aab70afSSebastian Siewior		downloaded images.
16613aab70afSSebastian Siewior
1662a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_SIZE
16633aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
16643aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
16653aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
16663aab70afSSebastian Siewior
1667d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1668d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1669d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1670d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1671d1b5ed07SSteve Rae
1672d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1673d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1674d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1675d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1676d1b5ed07SSteve Rae
16770ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
16780ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
16790ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
16800ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
16810ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
16820ff7e585SSteve Rae		This occurs when the specified "partition name" on the
16830ff7e585SSteve Rae		"fastboot flash" command line matches this value.
16840ff7e585SSteve Rae		Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
16850ff7e585SSteve Rae
1686*b6dd69a4SPetr Kulhavy		CONFIG_FASTBOOT_MBR_NAME
1687*b6dd69a4SPetr Kulhavy		The fastboot "flash" command supports writing the downloaded
1688*b6dd69a4SPetr Kulhavy		image to DOS MBR.
1689*b6dd69a4SPetr Kulhavy		This occurs when the "partition name" specified on the
1690*b6dd69a4SPetr Kulhavy		"fastboot flash" command line matches this value.
1691*b6dd69a4SPetr Kulhavy		If not defined the default value "mbr" is used.
1692*b6dd69a4SPetr Kulhavy
16936705d81eSwdenk- Journaling Flash filesystem support:
16946705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
16956705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
16966705d81eSwdenk		Define these for a default partition on a NAND device
16976705d81eSwdenk
16986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
16996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
17006705d81eSwdenk		Define these for a default partition on a NOR device
17016705d81eSwdenk
17026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
17036705d81eSwdenk		Define this to create an own partition. You have to provide a
17046705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
17056705d81eSwdenk
17066705d81eSwdenk		If you define only one JFFS2 partition you may also want to
17076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
17086705d81eSwdenk		to disable the command chpart. This is the default when you
17096705d81eSwdenk		have not defined a custom partition
17106705d81eSwdenk
1711c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1712c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1713656f4c65SDonggeun Kim
1714656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1715656f4c65SDonggeun Kim		file in FAT formatted partition.
1716656f4c65SDonggeun Kim
1717656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1718656f4c65SDonggeun Kim		user to write files to FAT.
1719c30a15e5SDonggeun Kim
172084cd9327SGabe BlackCBFS (Coreboot Filesystem) support
172184cd9327SGabe Black		CONFIG_CMD_CBFS
172284cd9327SGabe Black
172384cd9327SGabe Black		Define this to enable support for reading from a Coreboot
172484cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
172584cd9327SGabe Black		and cbfsload.
172684cd9327SGabe Black
17274f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
17284f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
17294f0d1a2aSSiva Durga Prasad Paladugu
17304f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
17314f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
17324f0d1a2aSSiva Durga Prasad Paladugu
1733c609719bSwdenk- Keyboard Support:
173439f615edSSimon Glass		See Kconfig help for available keyboard drivers.
173539f615edSSimon Glass
173639f615edSSimon Glass		CONFIG_KEYBOARD
173739f615edSSimon Glass
173839f615edSSimon Glass		Define this to enable a custom keyboard support.
173939f615edSSimon Glass		This simply calls drv_keyboard_init() which must be
174039f615edSSimon Glass		defined in your board-specific files. This option is deprecated
174139f615edSSimon Glass		and is only used by novena. For new boards, use driver model
174239f615edSSimon Glass		instead.
1743c609719bSwdenk
1744c609719bSwdenk- Video support:
1745c609719bSwdenk		CONFIG_VIDEO
1746c609719bSwdenk
1747c609719bSwdenk		Define this to enable video support (for output to
1748c609719bSwdenk		video).
1749c609719bSwdenk
1750c609719bSwdenk		CONFIG_VIDEO_CT69000
1751c609719bSwdenk
1752c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1753c609719bSwdenk
1754c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1755eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1756eeb1b77bSwdenk		video output is selected via environment 'videoout'
1757eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1758eeb1b77bSwdenk		assumed.
1759c609719bSwdenk
1760eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
176111ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1762eeb1b77bSwdenk		are possible:
1763eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1764eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1765eeb1b77bSwdenk
1766eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1767eeb1b77bSwdenk		-------------+---------------------------------------------
1768eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1769eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1770eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1771eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1772eeb1b77bSwdenk		-------------+---------------------------------------------
1773c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1774c609719bSwdenk
1775eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
17767817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1777eeb1b77bSwdenk
1778eeb1b77bSwdenk
1779a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1780a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1781a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1782a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1783a6c7ad2fSwdenk
17847d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
17857d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
17867d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
17877d3053fbSTimur Tabi		support, and should also define these other macros:
17887d3053fbSTimur Tabi
17897d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
17907d3053fbSTimur Tabi			CONFIG_VIDEO
17917d3053fbSTimur Tabi			CONFIG_CMD_BMP
17927d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
17937d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
17947d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
17957d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
17967d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
17977d3053fbSTimur Tabi
1798ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1799ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
18008eca9439SFabio Estevam		boot.  See the documentation file doc/README.video for a
1801ba8e76bdSTimur Tabi		description of this variable.
18027d3053fbSTimur Tabi
1803c609719bSwdenk- LCD Support:	CONFIG_LCD
1804c609719bSwdenk
1805c609719bSwdenk		Define this to enable LCD support (for output to LCD
1806c609719bSwdenk		display); also select one of the supported displays
1807c609719bSwdenk		by defining one of these:
1808c609719bSwdenk
180939cf4804SStelian Pop		CONFIG_ATMEL_LCD:
181039cf4804SStelian Pop
181139cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
181239cf4804SStelian Pop
1813fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1814c609719bSwdenk
1815fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1816c609719bSwdenk
1817fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1818c609719bSwdenk
1819fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1820fd3103bbSwdenk			Active, color, single scan.
1821fd3103bbSwdenk
1822fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1823fd3103bbSwdenk
1824fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1825c609719bSwdenk			Active, color, single scan.
1826c609719bSwdenk
1827c609719bSwdenk		CONFIG_SHARP_16x9
1828c609719bSwdenk
1829c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1830c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1831c609719bSwdenk
1832c609719bSwdenk		CONFIG_SHARP_LQ64D341
1833c609719bSwdenk
1834c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1835c609719bSwdenk			Active, color, single scan.
1836c609719bSwdenk
1837c609719bSwdenk		CONFIG_HLD1045
1838c609719bSwdenk
1839c609719bSwdenk			HLD1045 display, 640x480.
1840c609719bSwdenk			Active, color, single scan.
1841c609719bSwdenk
1842c609719bSwdenk		CONFIG_OPTREX_BW
1843c609719bSwdenk
1844c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1845c609719bSwdenk			or
1846c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1847c609719bSwdenk			or
1848c609719bSwdenk			Hitachi	 SP14Q002
1849c609719bSwdenk
1850c609719bSwdenk			320x240. Black & white.
1851c609719bSwdenk
1852c609719bSwdenk		Normally display is black on white background; define
18536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1854c609719bSwdenk
1855676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1856676d319eSSimon Glass
1857b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1858676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1859676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1860676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1861676d319eSSimon Glass		a per-section basis.
1862676d319eSSimon Glass
18630d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
18640d89efefSSimon Glass
18650d89efefSSimon Glass		When the console need to be scrolled, this is the number of
18660d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
18670d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
18680d89efefSSimon Glass		is slow.
1869676d319eSSimon Glass
1870604c7d4aSHannes Petermaier		CONFIG_LCD_ROTATION
1871604c7d4aSHannes Petermaier
1872604c7d4aSHannes Petermaier		Sometimes, for example if the display is mounted in portrait
1873604c7d4aSHannes Petermaier		mode or even if it's mounted landscape but rotated by 180degree,
1874604c7d4aSHannes Petermaier		we need to rotate our content of the display relative to the
1875604c7d4aSHannes Petermaier		framebuffer, so that user can read the messages which are
1876604c7d4aSHannes Petermaier		printed out.
1877604c7d4aSHannes Petermaier		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1878604c7d4aSHannes Petermaier		initialized with a given rotation from "vl_rot" out of
1879604c7d4aSHannes Petermaier		"vidinfo_t" which is provided by the board specific code.
1880604c7d4aSHannes Petermaier		The value for vl_rot is coded as following (matching to
1881604c7d4aSHannes Petermaier		fbcon=rotate:<n> linux-kernel commandline):
1882604c7d4aSHannes Petermaier		0 = no rotation respectively 0 degree
1883604c7d4aSHannes Petermaier		1 = 90 degree rotation
1884604c7d4aSHannes Petermaier		2 = 180 degree rotation
1885604c7d4aSHannes Petermaier		3 = 270 degree rotation
1886604c7d4aSHannes Petermaier
1887604c7d4aSHannes Petermaier		If CONFIG_LCD_ROTATION is not defined, the console will be
1888604c7d4aSHannes Petermaier		initialized with 0degree rotation.
1889604c7d4aSHannes Petermaier
189045d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
189145d7f525STom Wai-Hong Tam
189245d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
189345d7f525STom Wai-Hong Tam
1894735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1895735987c5STom Wai-Hong Tam
1896735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1897735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1898735987c5STom Wai-Hong Tam
18997152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1900d791b1dcSwdenk
1901d791b1dcSwdenk		If this option is set, the environment is checked for
1902d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1903d791b1dcSwdenk		of logo, copyright and system information on the LCD
1904e94d2cd9Swdenk		is suppressed and the BMP image at the address
1905d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1906d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1907d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1908d791b1dcSwdenk		loaded very quickly after power-on.
1909d791b1dcSwdenk
1910c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1911c0880485SNikita Kiryanov
1912c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1913c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1914ab5645f1SFabio Estevam		(see doc/README.displaying-bmps).
1915c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1916c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1917c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1918c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1919c0880485SNikita Kiryanov		there is no need to set this option.
1920c0880485SNikita Kiryanov
19211ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
19221ca298ceSMatthias Weisser
19231ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
19241ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
19251ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
19261ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
19271ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
19281ca298ceSMatthias Weisser		specify 'm' for centering the image.
19291ca298ceSMatthias Weisser
19301ca298ceSMatthias Weisser		Example:
19311ca298ceSMatthias Weisser		setenv splashpos m,m
19321ca298ceSMatthias Weisser			=> image at center of screen
19331ca298ceSMatthias Weisser
19341ca298ceSMatthias Weisser		setenv splashpos 30,20
19351ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
19361ca298ceSMatthias Weisser
19371ca298ceSMatthias Weisser		setenv splashpos -10,m
19381ca298ceSMatthias Weisser			=> vertically centered image
19391ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
19401ca298ceSMatthias Weisser
194198f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
194298f4a3dfSStefan Roese
194398f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
194498f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
194598f4a3dfSStefan Roese		splashscreen support or the bmp command.
194698f4a3dfSStefan Roese
1947d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1948d5011762SAnatolij Gustschin
1949d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1950d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1951d5011762SAnatolij Gustschin		bmp command.
1952d5011762SAnatolij Gustschin
1953b445bbb4SJeremiah Mahler- Do compressing for memory range:
1954f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1955f2b96dfbSLei Wen
1956f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1957f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1958f2b96dfbSLei Wen
1959c29fdfc1Swdenk- Compression support:
19608ef70478SKees Cook		CONFIG_GZIP
19618ef70478SKees Cook
19628ef70478SKees Cook		Enabled by default to support gzip compressed images.
19638ef70478SKees Cook
1964c29fdfc1Swdenk		CONFIG_BZIP2
1965c29fdfc1Swdenk
1966c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1967c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1968c29fdfc1Swdenk		compressed images are supported.
1969c29fdfc1Swdenk
1970c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
19716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1972c29fdfc1Swdenk		be at least 4MB.
1973d791b1dcSwdenk
1974fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1975fc9c1727SLuigi 'Comio' Mantellini
1976fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1977fc9c1727SLuigi 'Comio' Mantellini		images is included.
1978fc9c1727SLuigi 'Comio' Mantellini
1979fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1980fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1981fc9c1727SLuigi 'Comio' Mantellini		formula:
1982fc9c1727SLuigi 'Comio' Mantellini
1983fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1984fc9c1727SLuigi 'Comio' Mantellini
1985fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1986fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1987fc9c1727SLuigi 'Comio' Mantellini
1988fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1989fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1990fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1991fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1992fc9c1727SLuigi 'Comio' Mantellini
1993fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1994fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
19956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1996fc9c1727SLuigi 'Comio' Mantellini
19978ef70478SKees Cook		CONFIG_LZO
19988ef70478SKees Cook
19998ef70478SKees Cook		If this option is set, support for LZO compressed images
20008ef70478SKees Cook		is included.
20018ef70478SKees Cook
200217ea1177Swdenk- MII/PHY support:
200317ea1177Swdenk		CONFIG_PHY_ADDR
200417ea1177Swdenk
200517ea1177Swdenk		The address of PHY on MII bus.
200617ea1177Swdenk
200717ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
200817ea1177Swdenk
200917ea1177Swdenk		The clock frequency of the MII bus
201017ea1177Swdenk
201117ea1177Swdenk		CONFIG_PHY_GIGE
201217ea1177Swdenk
201317ea1177Swdenk		If this option is set, support for speed/duplex
201411ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
201517ea1177Swdenk
201617ea1177Swdenk		CONFIG_PHY_RESET_DELAY
201717ea1177Swdenk
201817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
201917ea1177Swdenk		reset before any MII register access is possible.
202017ea1177Swdenk		For such PHY, set this option to the usec delay
202117ea1177Swdenk		required. (minimum 300usec for LXT971A)
202217ea1177Swdenk
202317ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
202417ea1177Swdenk
202517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
202617ea1177Swdenk		command issued before MII status register can be read
202717ea1177Swdenk
2028c609719bSwdenk- IP address:
2029c609719bSwdenk		CONFIG_IPADDR
2030c609719bSwdenk
2031c609719bSwdenk		Define a default value for the IP address to use for
203211ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
2033c609719bSwdenk		determined through e.g. bootp.
20341ebcd654SWolfgang Denk		(Environment variable "ipaddr")
2035c609719bSwdenk
2036c609719bSwdenk- Server IP address:
2037c609719bSwdenk		CONFIG_SERVERIP
2038c609719bSwdenk
2039c609719bSwdenk		Defines a default value for the IP address of a TFTP
2040c609719bSwdenk		server to contact when using the "tftboot" command.
20411ebcd654SWolfgang Denk		(Environment variable "serverip")
2042c609719bSwdenk
204397cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
204497cfe861SRobin Getz
204597cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
204697cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
204797cfe861SRobin Getz
20481ebcd654SWolfgang Denk- Gateway IP address:
20491ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
20501ebcd654SWolfgang Denk
20511ebcd654SWolfgang Denk		Defines a default value for the IP address of the
20521ebcd654SWolfgang Denk		default router where packets to other networks are
20531ebcd654SWolfgang Denk		sent to.
20541ebcd654SWolfgang Denk		(Environment variable "gatewayip")
20551ebcd654SWolfgang Denk
20561ebcd654SWolfgang Denk- Subnet mask:
20571ebcd654SWolfgang Denk		CONFIG_NETMASK
20581ebcd654SWolfgang Denk
20591ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
20601ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
20611ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
20621ebcd654SWolfgang Denk		forwarded through a router.
20631ebcd654SWolfgang Denk		(Environment variable "netmask")
20641ebcd654SWolfgang Denk
206553a5c424SDavid Updegraff- Multicast TFTP Mode:
206653a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
206753a5c424SDavid Updegraff
206853a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
206953a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
207011ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
207153a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
207253a5c424SDavid Updegraff		multicast group.
207353a5c424SDavid Updegraff
2074c609719bSwdenk- BOOTP Recovery Mode:
2075c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2076c609719bSwdenk
2077c609719bSwdenk		If you have many targets in a network that try to
2078c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2079c609719bSwdenk		systems send out BOOTP requests at precisely the same
2080c609719bSwdenk		moment (which would happen for instance at recovery
2081c609719bSwdenk		from a power failure, when all systems will try to
2082c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2083c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2084c609719bSwdenk		inserted before sending out BOOTP requests. The
20856c33c785SWolfgang Denk		following delays are inserted then:
2086c609719bSwdenk
2087c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2088c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2089c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2090c609719bSwdenk		4th and following
2091c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2092c609719bSwdenk
209392ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
209492ac8accSThierry Reding
209592ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
209692ac8accSThierry Reding		server will copy the ID from client requests to responses and
209792ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
209892ac8accSThierry Reding		an incoming response. Some servers will check that addresses
209992ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
210092ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
210192ac8accSThierry Reding		respond. Network congestion may also influence the time it
210292ac8accSThierry Reding		takes for a response to make it back to the client. If that
210392ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
210492ac8accSThierry Reding		to allow earlier responses to still be accepted after these
210592ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
210692ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
210792ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
210892ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
210992ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
211092ac8accSThierry Reding
2111fe389a82Sstroese- DHCP Advanced Options:
21121fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
21131fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2114fe389a82Sstroese
21151fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
21161fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
21171fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
21181fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
21191fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
21201fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
21211fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
21221fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
21231fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
21241fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
21251fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
21261fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
21272c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2128fe389a82Sstroese
21295d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
21305d110f0aSWilson Callan		environment variable, not the BOOTP server.
2131fe389a82Sstroese
21322c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
21332c00e099SJoe Hershberger		after the configured retry count, the call will fail
21342c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
21352c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
21362c00e099SJoe Hershberger		is not available.
21372c00e099SJoe Hershberger
2138fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2139fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2140fe389a82Sstroese		than one DNS serverip is offered to the client.
2141fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2142fe389a82Sstroese		serverip will be stored in the additional environment
2143fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2144fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
21451fe80d79SJon Loeliger		is defined.
2146fe389a82Sstroese
2147fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2148fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2149fe389a82Sstroese		need the hostname of the DHCP requester.
21505d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
21511fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
21521fe80d79SJon Loeliger		option 12 to the DHCP server.
2153fe389a82Sstroese
2154d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2155d9a2f416SAras Vaichas
2156d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2157d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2158d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2159d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2160d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2161d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2162d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2163d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2164d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2165d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2166d9a2f416SAras Vaichas		this delay.
2167d9a2f416SAras Vaichas
2168d22c338eSJoe Hershberger - Link-local IP address negotiation:
2169d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2170d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2171d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2172d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2173d22c338eSJoe Hershberger
2174d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2175d22c338eSJoe Hershberger
2176a3d991bdSwdenk - CDP Options:
2177a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2178a3d991bdSwdenk
2179a3d991bdSwdenk		The device id used in CDP trigger frames.
2180a3d991bdSwdenk
2181a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2182a3d991bdSwdenk
2183a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2184a3d991bdSwdenk		of the device.
2185a3d991bdSwdenk
2186a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2187a3d991bdSwdenk
2188a3d991bdSwdenk		A printf format string which contains the ascii name of
2189a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
219011ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2191a3d991bdSwdenk
2192a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2193a3d991bdSwdenk
2194a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2195a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2196a3d991bdSwdenk
2197a3d991bdSwdenk		CONFIG_CDP_VERSION
2198a3d991bdSwdenk
2199a3d991bdSwdenk		An ascii string containing the version of the software.
2200a3d991bdSwdenk
2201a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2202a3d991bdSwdenk
2203a3d991bdSwdenk		An ascii string containing the name of the platform.
2204a3d991bdSwdenk
2205a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2206a3d991bdSwdenk
2207a3d991bdSwdenk		A 32bit integer sent on the trigger.
2208a3d991bdSwdenk
2209a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2210a3d991bdSwdenk
2211a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2212a3d991bdSwdenk		device in .1 of milliwatts.
2213a3d991bdSwdenk
2214a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2215a3d991bdSwdenk
2216a3d991bdSwdenk		A byte containing the id of the VLAN.
2217a3d991bdSwdenk
2218c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2219c609719bSwdenk
2220c609719bSwdenk		Several configurations allow to display the current
2221c609719bSwdenk		status using a LED. For instance, the LED will blink
2222c609719bSwdenk		fast while running U-Boot code, stop blinking as
2223c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2224c609719bSwdenk		start blinking slow once the Linux kernel is running
2225c609719bSwdenk		(supported by a status LED driver in the Linux
2226c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2227c609719bSwdenk		feature in U-Boot.
2228c609719bSwdenk
22291df7bbbaSIgor Grinberg		Additional options:
22301df7bbbaSIgor Grinberg
22311df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
22321df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
22331df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
22341df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
22351df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
22361df7bbbaSIgor Grinberg
22379dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
22389dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
22399dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
22409dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
22419dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
22429dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
22439dfdcdfeSIgor Grinberg
2244c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2245c609719bSwdenk
2246c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2247c609719bSwdenk		on those systems that support this (optional)
2248c609719bSwdenk		feature, like the TQM8xxL modules.
2249c609719bSwdenk
22503f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2251c609719bSwdenk
22523f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
22533f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
22543f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
22553f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
22563f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
22573f4978c7SHeiko Schocher		interface.
22583f4978c7SHeiko Schocher
22593f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2260ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2261ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2262ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2263ea818dbbSHeiko Schocher		    for defining speed and slave address
2264ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2265ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2266ea818dbbSHeiko Schocher		    for defining speed and slave address
2267ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2268ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2269ea818dbbSHeiko Schocher		    for defining speed and slave address
2270ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2271ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2272ea818dbbSHeiko Schocher		    for defining speed and slave address
22733f4978c7SHeiko Schocher
227400f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
227500f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
227600f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
227700f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
227800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
227900f792e0SHeiko Schocher		    bus.
228000f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
228100f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
228200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
228300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
228400f792e0SHeiko Schocher		    second bus.
228500f792e0SHeiko Schocher
22861f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
22871f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
22881f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
22891f2ba722SSimon Glass		    100000 and the slave addr 0!
22901f2ba722SSimon Glass
2291880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2292880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2293880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2294880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2295880540deSDirk Eibach
2296fac96408Strem		- drivers/i2c/i2c_mxc.c
2297fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
229803544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
229903544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
230003544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
230103544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
2302fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2303fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2304fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2305fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2306fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2307fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
230803544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
230903544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
2310b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
2311fac96408Strem		for speed, and 0 for slave.
2312fac96408Strem
23131086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
23141086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
23151086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
23161086bfa9SNobuhiro Iwamatsu
23171086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
23181086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
23191086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
23201086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
23211086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
23221086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
23231086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
23241086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
23251086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
23261086bfa9SNobuhiro Iwamatsu
23272035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
23282035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
23292035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
23302035d77dSNobuhiro Iwamatsu
23312035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
23322035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
23332035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
23342035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
23352035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
23362035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
23372035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
23382035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
23392035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
23402035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
23412035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
23422035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2343b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
23442035d77dSNobuhiro Iwamatsu
23456789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
23466789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
23476789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
23486789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
23496789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
23506789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
23516789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
23526789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
23536789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
23546789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
23556789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
23566789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
23576789e84eSHeiko Schocher
23580bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
23590bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
23600bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
23610bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
23620bdffe71SHeiko Schocher
2363e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2364e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2365e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2366e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2367e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2368e717fc6dSNaveen Krishna Ch
2369b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2370b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2371b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2372b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2373b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2374b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2375b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2376b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2377b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2378b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2379b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2380b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2381b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2382b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2383071be896SDirk Eibach		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2384071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2385071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2386071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2387071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2388071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2389071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2390071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2391071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
2392b46226bdSDirk Eibach
23933f4978c7SHeiko Schocher		additional defines:
23943f4978c7SHeiko Schocher
23953f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2396b445bbb4SJeremiah Mahler		Hold the number of i2c buses you want to use. If you
23973f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
23983f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
23993f4978c7SHeiko Schocher		omit this define.
24003f4978c7SHeiko Schocher
24013f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
24023f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
24033f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
24043f4978c7SHeiko Schocher		omit this define.
24053f4978c7SHeiko Schocher
24063f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
24073f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
24083f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
24093f4978c7SHeiko Schocher		define.
24103f4978c7SHeiko Schocher
24113f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2412b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
24133f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
24143f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
24153f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
24163f4978c7SHeiko Schocher
24173f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
24183f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
24193f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
24203f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
24213f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
24223f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
24233f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
24243f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
24253f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
24263f4978c7SHeiko Schocher					}
24273f4978c7SHeiko Schocher
24283f4978c7SHeiko Schocher		which defines
24293f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2430ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2431ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2432ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2433ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2434ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
24353f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2436ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2437ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
24383f4978c7SHeiko Schocher
24393f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
24403f4978c7SHeiko Schocher
2441ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
24423f4978c7SHeiko Schocher
24433f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
24443f4978c7SHeiko Schocher		provides the following compelling advantages:
24453f4978c7SHeiko Schocher
24463f4978c7SHeiko Schocher		- more than one i2c adapter is usable
24473f4978c7SHeiko Schocher		- approved multibus support
24483f4978c7SHeiko Schocher		- better i2c mux support
24493f4978c7SHeiko Schocher
24503f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
24513f4978c7SHeiko Schocher
2452ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2453ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2454ea818dbbSHeiko Schocher		for the selected CPU.
2455c609719bSwdenk
2456b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2457602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2458b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2459b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2460c609719bSwdenk		command line interface.
2461c609719bSwdenk
2462bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2463c609719bSwdenk
2464b37c7e5eSwdenk		There are several other quantities that must also be
2465ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2466c609719bSwdenk
24676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2468b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
24696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
247011ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2471c609719bSwdenk
24728d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2473a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
24748d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
24758d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
24768d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2477b37c7e5eSwdenk
24785da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
24795da71efaSEric Millbrandt
24805da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
24815da71efaSEric Millbrandt		chips might think that the current transfer is still
24825da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
24835da71efaSEric Millbrandt		commands until the slave device responds.
24845da71efaSEric Millbrandt
2485b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2486b37c7e5eSwdenk
2487ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2488b37c7e5eSwdenk		then the following macros need to be defined (examples are
2489b37c7e5eSwdenk		from include/configs/lwmon.h):
2490c609719bSwdenk
2491c609719bSwdenk		I2C_INIT
2492c609719bSwdenk
2493b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2494c609719bSwdenk		controller or configure ports.
2495c609719bSwdenk
2496b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2497b37c7e5eSwdenk
2498c609719bSwdenk		I2C_PORT
2499c609719bSwdenk
2500c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2501c609719bSwdenk		assumes both bits are on the same port). Valid values
2502c609719bSwdenk		are 0..3 for ports A..D.
2503c609719bSwdenk
2504c609719bSwdenk		I2C_ACTIVE
2505c609719bSwdenk
2506c609719bSwdenk		The code necessary to make the I2C data line active
2507c609719bSwdenk		(driven).  If the data line is open collector, this
2508c609719bSwdenk		define can be null.
2509c609719bSwdenk
2510b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2511b37c7e5eSwdenk
2512c609719bSwdenk		I2C_TRISTATE
2513c609719bSwdenk
2514c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2515c609719bSwdenk		(inactive).  If the data line is open collector, this
2516c609719bSwdenk		define can be null.
2517c609719bSwdenk
2518b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2519b37c7e5eSwdenk
2520c609719bSwdenk		I2C_READ
2521c609719bSwdenk
2522472d5460SYork Sun		Code that returns true if the I2C data line is high,
2523472d5460SYork Sun		false if it is low.
2524c609719bSwdenk
2525b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2526b37c7e5eSwdenk
2527c609719bSwdenk		I2C_SDA(bit)
2528c609719bSwdenk
2529472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2530472d5460SYork Sun		is false, it clears it (low).
2531c609719bSwdenk
2532b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2533b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2534b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2535b37c7e5eSwdenk
2536c609719bSwdenk		I2C_SCL(bit)
2537c609719bSwdenk
2538472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2539472d5460SYork Sun		is false, it clears it (low).
2540c609719bSwdenk
2541b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2542b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2543b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2544b37c7e5eSwdenk
2545c609719bSwdenk		I2C_DELAY
2546c609719bSwdenk
2547c609719bSwdenk		This delay is invoked four times per clock cycle so this
2548c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2549b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2550b37c7e5eSwdenk		like:
2551b37c7e5eSwdenk
2552b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2553c609719bSwdenk
2554793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2555793b5726SMike Frysinger
2556793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2557793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2558793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2559793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2560793b5726SMike Frysinger
2561793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2562793b5726SMike Frysinger		the generic GPIO functions.
2563793b5726SMike Frysinger
25646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
256547cd00faSwdenk
256647cd00faSwdenk		When a board is reset during an i2c bus transfer
256747cd00faSwdenk		chips might think that the current transfer is still
256847cd00faSwdenk		in progress. On some boards it is possible to access
256947cd00faSwdenk		the i2c SCLK line directly, either by using the
257047cd00faSwdenk		processor pin as a GPIO or by having a second pin
257147cd00faSwdenk		connected to the bus. If this option is defined a
257247cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
257347cd00faSwdenk		is run early in the boot sequence.
257447cd00faSwdenk
257526a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
257626a33504SRichard Retanubun
257726a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
257826a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
257926a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
258026a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
258126a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
258226a33504SRichard Retanubun		controller provide such a method. It is called at the end of
258326a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
258426a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
258526a33504SRichard Retanubun
258617ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
258717ea1177Swdenk
258817ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
258917ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
259017ea1177Swdenk		variable "i2cfast". (see also i2cfast)
259117ea1177Swdenk
2592bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2593bb99ad6dSBen Warren
2594bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2595bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2596bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2597bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2598bb99ad6dSBen Warren
25996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2600bb99ad6dSBen Warren
2601bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
26020f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
26030f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
26040f89c54bSPeter Tyser		a 1D array of device addresses
2605bb99ad6dSBen Warren
2606bb99ad6dSBen Warren		e.g.
2607bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
26086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2609bb99ad6dSBen Warren
2610bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2611bb99ad6dSBen Warren
2612bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
26136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2614bb99ad6dSBen Warren
2615bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2616bb99ad6dSBen Warren
26176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2618be5e6181STimur Tabi
2619be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2620be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2621be5e6181STimur Tabi
26226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
26230dc018ecSStefan Roese
26240dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
26250dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
26260dc018ecSStefan Roese
26276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
26280dc018ecSStefan Roese
26290dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
26300dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
26310dc018ecSStefan Roese
26326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
26339ebbb54fSVictor Gallardo
26349ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
26359ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
26369ebbb54fSVictor Gallardo		specified DTT device.
26379ebbb54fSVictor Gallardo
26382ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
26392ac6985aSAndrew Dyer
26402ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
26412ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
26422ac6985aSAndrew Dyer		between writing the address pointer and reading the
26432ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
26442ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
26452ac6985aSAndrew Dyer		devices can use either method, but some require one or
26462ac6985aSAndrew Dyer		the other.
2647be5e6181STimur Tabi
2648c609719bSwdenk- SPI Support:	CONFIG_SPI
2649c609719bSwdenk
2650c609719bSwdenk		Enables SPI driver (so far only tested with
2651c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2652c609719bSwdenk		D/As on the SACSng board)
2653c609719bSwdenk
26546639562eSYoshihiro Shimoda		CONFIG_SH_SPI
26556639562eSYoshihiro Shimoda
26566639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
26576639562eSYoshihiro Shimoda		only SH7757 is supported.
26586639562eSYoshihiro Shimoda
2659c609719bSwdenk		CONFIG_SOFT_SPI
2660c609719bSwdenk
2661c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2662c609719bSwdenk		using hardware support. This is a general purpose
2663c609719bSwdenk		driver that only requires three general I/O port pins
2664c609719bSwdenk		(two outputs, one input) to function. If this is
2665c609719bSwdenk		defined, the board configuration must define several
2666c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2667c609719bSwdenk		an example, see include/configs/sacsng.h.
2668c609719bSwdenk
266904a9e118SBen Warren		CONFIG_HARD_SPI
267004a9e118SBen Warren
267104a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
267204a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
267304a9e118SBen Warren		must define a list of chip-select function pointers.
267404a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
267504a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
267604a9e118SBen Warren
267738254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
267838254f45SGuennadi Liakhovetski
267938254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
26802e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
268138254f45SGuennadi Liakhovetski
2682f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2683f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2684f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2685f659b573SHeiko Schocher
26860133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
26870133502eSMatthias Fuchs
26880133502eSMatthias Fuchs		Enables FPGA subsystem.
26890133502eSMatthias Fuchs
26900133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
26910133502eSMatthias Fuchs
26920133502eSMatthias Fuchs		Enables support for specific chip vendors.
26930133502eSMatthias Fuchs		(ALTERA, XILINX)
26940133502eSMatthias Fuchs
26950133502eSMatthias Fuchs		CONFIG_FPGA_<family>
26960133502eSMatthias Fuchs
26970133502eSMatthias Fuchs		Enables support for FPGA family.
26980133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
26990133502eSMatthias Fuchs
27000133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2701c609719bSwdenk
2702c609719bSwdenk		Specify the number of FPGA devices to support.
2703c609719bSwdenk
270464e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
270564e809afSSiva Durga Prasad Paladugu
270664e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
270764e809afSSiva Durga Prasad Paladugu
270867193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
270967193864SMichal Simek
271067193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
271167193864SMichal Simek
271267193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
271367193864SMichal Simek
271467193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
271567193864SMichal Simek		(Xilinx only)
271667193864SMichal Simek
27176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2718c609719bSwdenk
2719c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2720c609719bSwdenk
27216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2722c609719bSwdenk
2723c609719bSwdenk		Enable checks on FPGA configuration interface busy
2724c609719bSwdenk		status by the configuration function. This option
2725c609719bSwdenk		will require a board or device specific function to
2726c609719bSwdenk		be written.
2727c609719bSwdenk
2728c609719bSwdenk		CONFIG_FPGA_DELAY
2729c609719bSwdenk
2730c609719bSwdenk		If defined, a function that provides delays in the FPGA
2731c609719bSwdenk		configuration driver.
2732c609719bSwdenk
27336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2734c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2735c609719bSwdenk
27366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2737c609719bSwdenk
2738c609719bSwdenk		Check for configuration errors during FPGA bitfile
2739c609719bSwdenk		loading. For example, abort during Virtex II
2740c609719bSwdenk		configuration if the INIT_B line goes low (which
2741c609719bSwdenk		indicated a CRC error).
2742c609719bSwdenk
27436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2744c609719bSwdenk
2745b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2746b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2747c609719bSwdenk		FPGA configuration sequence. The default time is 500
274811ccc33fSMarcel Ziswiler		ms.
2749c609719bSwdenk
27506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2751c609719bSwdenk
2752b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
275311ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2754c609719bSwdenk
27556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2756c609719bSwdenk
2757c609719bSwdenk		Time to wait after FPGA configuration. The default is
275811ccc33fSMarcel Ziswiler		200 ms.
2759c609719bSwdenk
2760c609719bSwdenk- Configuration Management:
2761b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2762b2b8a696SStefan Roese
2763b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2764b2b8a696SStefan Roese		with a special header) as build targets. By defining
2765b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2766b2b8a696SStefan Roese		special image will be automatically built upon calling
27676de80f21SSimon Glass		make / buildman.
2768b2b8a696SStefan Roese
2769c609719bSwdenk		CONFIG_IDENT_STRING
2770c609719bSwdenk
2771c609719bSwdenk		If defined, this string will be added to the U-Boot
2772c609719bSwdenk		version information (U_BOOT_VERSION)
2773c609719bSwdenk
2774c609719bSwdenk- Vendor Parameter Protection:
2775c609719bSwdenk
2776c609719bSwdenk		U-Boot considers the values of the environment
2777c609719bSwdenk		variables "serial#" (Board Serial Number) and
27787152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2779c609719bSwdenk		are set once by the board vendor / manufacturer, and
2780c609719bSwdenk		protects these variables from casual modification by
2781c609719bSwdenk		the user. Once set, these variables are read-only,
2782c609719bSwdenk		and write or delete attempts are rejected. You can
278311ccc33fSMarcel Ziswiler		change this behaviour:
2784c609719bSwdenk
2785c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2786c609719bSwdenk		file, the write protection for vendor parameters is
278747cd00faSwdenk		completely disabled. Anybody can change or delete
2788c609719bSwdenk		these parameters.
2789c609719bSwdenk
279092ac5208SJoe Hershberger		Alternatively, if you define _both_ an ethaddr in the
279192ac5208SJoe Hershberger		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
279211ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2793c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2794c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2795c609719bSwdenk		read-only.]
2796c609719bSwdenk
27972598090bSJoe Hershberger		The same can be accomplished in a more flexible way
27982598090bSJoe Hershberger		for any variable by configuring the type of access
27992598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
28002598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
28012598090bSJoe Hershberger
2802c609719bSwdenk- Protected RAM:
2803c609719bSwdenk		CONFIG_PRAM
2804c609719bSwdenk
2805c609719bSwdenk		Define this variable to enable the reservation of
2806c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2807c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2808c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2809c609719bSwdenk		this default value by defining an environment
2810c609719bSwdenk		variable "pram" to the number of kB you want to
2811c609719bSwdenk		reserve. Note that the board info structure will
2812c609719bSwdenk		still show the full amount of RAM. If pRAM is
2813c609719bSwdenk		reserved, a new environment variable "mem" will
2814c609719bSwdenk		automatically be defined to hold the amount of
2815c609719bSwdenk		remaining RAM in a form that can be passed as boot
2816c609719bSwdenk		argument to Linux, for instance like that:
2817c609719bSwdenk
2818fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2819c609719bSwdenk			saveenv
2820c609719bSwdenk
2821c609719bSwdenk		This way you can tell Linux not to use this memory,
2822c609719bSwdenk		either, which results in a memory region that will
2823c609719bSwdenk		not be affected by reboots.
2824c609719bSwdenk
2825c609719bSwdenk		*WARNING* If your board configuration uses automatic
2826c609719bSwdenk		detection of the RAM size, you must make sure that
2827c609719bSwdenk		this memory test is non-destructive. So far, the
2828c609719bSwdenk		following board configurations are known to be
2829c609719bSwdenk		"pRAM-clean":
2830c609719bSwdenk
28311b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
28321b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2833544d97e9SWolfgang Denk			FLAGADM, TQM8260
2834c609719bSwdenk
283540fef049SGabe Black- Access to physical memory region (> 4GB)
283640fef049SGabe Black		Some basic support is provided for operations on memory not
283740fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
283840fef049SGabe Black		support access to more than 4GB of memory on 32-bit
283940fef049SGabe Black		machines using physical address extension or similar.
284040fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
284140fef049SGabe Black		currently only supports clearing the memory.
284240fef049SGabe Black
2843c609719bSwdenk- Error Recovery:
2844c609719bSwdenk		CONFIG_PANIC_HANG
2845c609719bSwdenk
2846c609719bSwdenk		Define this variable to stop the system in case of a
2847c609719bSwdenk		fatal error, so that you have to reset it manually.
2848c609719bSwdenk		This is probably NOT a good idea for an embedded
284911ccc33fSMarcel Ziswiler		system where you want the system to reboot
2850c609719bSwdenk		automatically as fast as possible, but it may be
2851c609719bSwdenk		useful during development since you can try to debug
2852c609719bSwdenk		the conditions that lead to the situation.
2853c609719bSwdenk
2854c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2855c609719bSwdenk
2856c609719bSwdenk		This variable defines the number of retries for
2857c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2858c609719bSwdenk		before giving up the operation. If not defined, a
2859c609719bSwdenk		default value of 5 is used.
2860c609719bSwdenk
286140cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
286240cb90eeSGuennadi Liakhovetski
286340cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
286440cb90eeSGuennadi Liakhovetski
286548a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
286648a3e999STetsuyuki Kobayashi
286748a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
286848a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
286948a3e999STetsuyuki Kobayashi		try longer timeout such as
287048a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
287148a3e999STetsuyuki Kobayashi
2872c609719bSwdenk- Command Interpreter:
28738078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
287404a85b3bSwdenk
287504a85b3bSwdenk		Enable auto completion of commands using TAB.
287604a85b3bSwdenk
28776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2878c609719bSwdenk
2879c609719bSwdenk		This defines the secondary prompt string, which is
2880c609719bSwdenk		printed when the command interpreter needs more input
2881c609719bSwdenk		to complete a command. Usually "> ".
2882c609719bSwdenk
2883c609719bSwdenk	Note:
2884c609719bSwdenk
2885c609719bSwdenk		In the current implementation, the local variables
2886c609719bSwdenk		space and global environment variables space are
2887c609719bSwdenk		separated. Local variables are those you define by
28883b57fe0aSwdenk		simply typing `name=value'. To access a local
2889c609719bSwdenk		variable later on, you have write `$name' or
28903b57fe0aSwdenk		`${name}'; to execute the contents of a variable
28913b57fe0aSwdenk		directly type `$name' at the command prompt.
2892c609719bSwdenk
2893c609719bSwdenk		Global environment variables are those you use
2894c609719bSwdenk		setenv/printenv to work with. To run a command stored
2895c609719bSwdenk		in such a variable, you need to use the run command,
2896c609719bSwdenk		and you must not use the '$' sign to access them.
2897c609719bSwdenk
2898c609719bSwdenk		To store commands and special characters in a
2899c609719bSwdenk		variable, please use double quotation marks
2900c609719bSwdenk		surrounding the whole text of the variable, instead
2901c609719bSwdenk		of the backslashes before semicolons and special
2902c609719bSwdenk		symbols.
2903c609719bSwdenk
2904b445bbb4SJeremiah Mahler- Command Line Editing and History:
2905aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2906aa0c71acSWolfgang Denk
290711ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2908aa0c71acSWolfgang Denk		command line input operations
2909aa0c71acSWolfgang Denk
2910f3b267b3SMarek Vasut- Command Line PS1/PS2 support:
2911f3b267b3SMarek Vasut		CONFIG_CMDLINE_PS_SUPPORT
2912f3b267b3SMarek Vasut
2913f3b267b3SMarek Vasut		Enable support for changing the command prompt string
2914f3b267b3SMarek Vasut		at run-time. Only static string is supported so far.
2915f3b267b3SMarek Vasut		The string is obtained from environment variables PS1
2916f3b267b3SMarek Vasut		and PS2.
2917f3b267b3SMarek Vasut
2918a8c7c708Swdenk- Default Environment:
2919c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2920c609719bSwdenk
2921c609719bSwdenk		Define this to contain any number of null terminated
2922c609719bSwdenk		strings (variable = value pairs) that will be part of
29237152b1d0Swdenk		the default environment compiled into the boot image.
29242262cfeeSwdenk
2925c609719bSwdenk		For example, place something like this in your
2926c609719bSwdenk		board's config file:
2927c609719bSwdenk
2928c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2929c609719bSwdenk			"myvar1=value1\0" \
2930c609719bSwdenk			"myvar2=value2\0"
2931c609719bSwdenk
2932c609719bSwdenk		Warning: This method is based on knowledge about the
2933c609719bSwdenk		internal format how the environment is stored by the
29342262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2935c609719bSwdenk		interface! Although it is unlikely that this format
29367152b1d0Swdenk		will change soon, there is no guarantee either.
2937c609719bSwdenk		You better know what you are doing here.
2938c609719bSwdenk
2939c609719bSwdenk		Note: overly (ab)use of the default environment is
2940c609719bSwdenk		discouraged. Make sure to check other ways to preset
294174de7aefSWolfgang Denk		the environment like the "source" command or the
2942c609719bSwdenk		boot command first.
2943c609719bSwdenk
29445e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
29455e724ca2SStephen Warren
29465e724ca2SStephen Warren		Define this in order to add variables describing the
29475e724ca2SStephen Warren		U-Boot build configuration to the default environment.
29485e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
29495e724ca2SStephen Warren
29505e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
29515e724ca2SStephen Warren
29525e724ca2SStephen Warren		- CONFIG_SYS_ARCH
29535e724ca2SStephen Warren		- CONFIG_SYS_CPU
29545e724ca2SStephen Warren		- CONFIG_SYS_BOARD
29555e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
29565e724ca2SStephen Warren		- CONFIG_SYS_SOC
29575e724ca2SStephen Warren
29587e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
29597e27f89fSTom Rini
29607e27f89fSTom Rini		Define this in order to add variables describing certain
29617e27f89fSTom Rini		run-time determined information about the hardware to the
29627e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
29637e27f89fSTom Rini
296406fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
296506fd8538SSimon Glass
296606fd8538SSimon Glass		Normally the environment is loaded when the board is
2967b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
296806fd8538SSimon Glass		that so that the environment is not available until
296906fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
297006fd8538SSimon Glass		this is instead controlled by the value of
297106fd8538SSimon Glass		/config/load-environment.
297206fd8538SSimon Glass
29733b10cf12SChris Packham- Parallel Flash support:
29743b10cf12SChris Packham		CONFIG_SYS_NO_FLASH
29753b10cf12SChris Packham
2976a187559eSBin Meng		Traditionally U-Boot was run on systems with parallel NOR
29773b10cf12SChris Packham		flash. This option is used to disable support for parallel NOR
29783b10cf12SChris Packham		flash. This option should be defined if the board does not have
29793b10cf12SChris Packham		parallel flash.
29803b10cf12SChris Packham
29813b10cf12SChris Packham		If this option is not defined one of the generic flash drivers
29823b10cf12SChris Packham		(e.g.  CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
29833b10cf12SChris Packham		selected or the board must provide an implementation of the
29843b10cf12SChris Packham		flash API (see include/flash.h).
29853b10cf12SChris Packham
2986a8c7c708Swdenk- DataFlash Support:
29872abbe075Swdenk		CONFIG_HAS_DATAFLASH
29882abbe075Swdenk
29892abbe075Swdenk		Defining this option enables DataFlash features and
29902abbe075Swdenk		allows to read/write in Dataflash via the standard
29912abbe075Swdenk		commands cp, md...
29922abbe075Swdenk
2993f61ec45eSEric Nelson- Serial Flash support
2994f61ec45eSEric Nelson		CONFIG_CMD_SF
2995f61ec45eSEric Nelson
2996f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2997f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2998f61ec45eSEric Nelson
2999f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
3000f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
3001f61ec45eSEric Nelson		commands.
3002f61ec45eSEric Nelson
3003f61ec45eSEric Nelson		The following defaults may be provided by the platform
3004f61ec45eSEric Nelson		to handle the common case when only a single serial
3005f61ec45eSEric Nelson		flash is present on the system.
3006f61ec45eSEric Nelson
3007f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
3008f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
3009f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
3010f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
3011f61ec45eSEric Nelson
301224007273SSimon Glass		CONFIG_CMD_SF_TEST
301324007273SSimon Glass
301424007273SSimon Glass		Define this option to include a destructive SPI flash
301524007273SSimon Glass		test ('sf test').
301624007273SSimon Glass
3017b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
3018b902e07cSJagannadha Sutradharudu Teki
3019b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
3020b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
3021b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
3022b902e07cSJagannadha Sutradharudu Teki
30233f85ce27Swdenk- SystemACE Support:
30243f85ce27Swdenk		CONFIG_SYSTEMACE
30253f85ce27Swdenk
30263f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
30273f85ce27Swdenk		chips attached via some sort of local bus. The address
302811ccc33fSMarcel Ziswiler		of the chip must also be defined in the
30296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
30303f85ce27Swdenk
30313f85ce27Swdenk		#define CONFIG_SYSTEMACE
30326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
30333f85ce27Swdenk
30343f85ce27Swdenk		When SystemACE support is added, the "ace" device type
30353f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
30363f85ce27Swdenk
3037ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
3038ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
3039ecb0ccd9SWolfgang Denk
304028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
3041ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
304228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
3043ecb0ccd9SWolfgang Denk		number generator is used.
3044ecb0ccd9SWolfgang Denk
304528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
304628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
304728cb9375SWolfgang Denk		defined, the normal port 69 is used.
304828cb9375SWolfgang Denk
304928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
3050ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
3051ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
3052ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
3053ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
3054ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
3055ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
3056ecb0ccd9SWolfgang Denk
3057bf36c5d5SSimon Glass- Hashing support:
3058bf36c5d5SSimon Glass		CONFIG_CMD_HASH
3059bf36c5d5SSimon Glass
3060bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
3061bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3062bf36c5d5SSimon Glass
3063bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3064bf36c5d5SSimon Glass
3065bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3066bf36c5d5SSimon Glass		size a little.
3067bf36c5d5SSimon Glass
306894e3c8c4Sgaurav rana		CONFIG_SHA1 - This option enables support of hashing using SHA1
306994e3c8c4Sgaurav rana		algorithm. The hash is calculated in software.
307094e3c8c4Sgaurav rana		CONFIG_SHA256 - This option enables support of hashing using
307194e3c8c4Sgaurav rana		SHA256 algorithm. The hash is calculated in software.
307294e3c8c4Sgaurav rana		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
307394e3c8c4Sgaurav rana		for SHA1/SHA256 hashing.
307494e3c8c4Sgaurav rana		This affects the 'hash' command and also the
307594e3c8c4Sgaurav rana		hash_lookup_algo() function.
307694e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL - This option enables
307794e3c8c4Sgaurav rana		hardware-acceleration for SHA1/SHA256 progressive hashing.
307894e3c8c4Sgaurav rana		Data can be streamed in a block at a time and the hashing
307994e3c8c4Sgaurav rana		is performed in hardware.
3080bf36c5d5SSimon Glass
3081bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3082bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3083bf36c5d5SSimon Glass
3084a11f1873SRobert Winkler- Freescale i.MX specific commands:
3085a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3086a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3087a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3088a11f1873SRobert Winkler
3089a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3090a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3091a11f1873SRobert Winkler		a boot from specific media.
3092a11f1873SRobert Winkler
3093a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3094a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3095a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3096a11f1873SRobert Winkler		will set it back to normal.  This command currently
3097a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3098a11f1873SRobert Winkler
30999e50c406SHeiko Schocher- bootcount support:
31009e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
31019e50c406SHeiko Schocher
31029e50c406SHeiko Schocher		This enables the bootcounter support, see:
31039e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
31049e50c406SHeiko Schocher
31059e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
31069e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
31079e50c406SHeiko Schocher		CONFIG_BLACKFIN
31089e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
31099e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
31109e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
31119e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
31129e50c406SHeiko Schocher		enable support for the bootcounter in RAM
31139e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
31149e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
31159e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
31169e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
31179e50c406SHeiko Schocher						    the bootcounter.
31189e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
311919c402afSSimon Glass
3120a8c7c708Swdenk- Show boot progress:
3121c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3122c609719bSwdenk
3123c609719bSwdenk		Defining this option allows to add some board-
3124c609719bSwdenk		specific code (calling a user-provided function
3125c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3126c609719bSwdenk		the system's boot progress on some display (for
3127c609719bSwdenk		example, some LED's) on your board. At the moment,
3128c609719bSwdenk		the following checkpoints are implemented:
3129c609719bSwdenk
313094fd1316SSimon Glass
31311372cce2SMarian BalakowiczLegacy uImage format:
31321372cce2SMarian Balakowicz
3133c609719bSwdenk  Arg	Where			When
3134c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3135c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3136c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3137c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3138c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3139c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3140c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3141c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3142c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
31431372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3144c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3145c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3146c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3147c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
31481372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3149c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
31501372cce2SMarian Balakowicz
31511372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
31521372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
31531372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
31541372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
31551372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
31561372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
31571372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
315811ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
31591372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
31601372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
31611372cce2SMarian Balakowicz
3162ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3163c609719bSwdenk
3164a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
316563e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
316663e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
316763e73c9aSwdenk
3168566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3169566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3170566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3171566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3172566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3173566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3174566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3175566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3176566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3177566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3178566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3179566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3180566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3181566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3182566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3183566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3184566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3185566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3186566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3187566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3188566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3189566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3190566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3191566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3192566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3193566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3194566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3195566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3196566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3197566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3198566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3199566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3200566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3201566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3202566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3203566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3204566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3205566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3206566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3207566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3208566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3209566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3210566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3211566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3212566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3213566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3214566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3215c609719bSwdenk
3216566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3217c609719bSwdenk
3218566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3219566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3220566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3221206c60cbSwdenk
3222566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3223bc0571fcSJoe Hershberger   80	common/cmd_net.c	before calling net_loop()
3224bc0571fcSJoe Hershberger  -81	common/cmd_net.c	some error in net_loop() occurred
3225bc0571fcSJoe Hershberger   81	common/cmd_net.c	net_loop() back without error
3226566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3227566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
322874de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
322974de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3230566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3231c609719bSwdenk
32321372cce2SMarian BalakowiczFIT uImage format:
32331372cce2SMarian Balakowicz
32341372cce2SMarian Balakowicz  Arg	Where			When
32351372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
32361372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
32371372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
32381372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
32391372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
32401372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3241f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
32421372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
32431372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
32441372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
32451372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
32461372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
324711ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
324811ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
32491372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
32501372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
32511372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
32521372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
32531372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
32541372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
32551372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
32561372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
32571372cce2SMarian Balakowicz
32581372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
32591372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
32601372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
326111ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
32621372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
32631372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
32641372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
32651372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
32661372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
32671372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
32681372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
32691372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
32701372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
32711372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
32721372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
32731372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
32741372cce2SMarian Balakowicz
327511ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
32761372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
32771372cce2SMarian Balakowicz
327811ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
32791372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
32801372cce2SMarian Balakowicz
328111ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
32821372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
32831372cce2SMarian Balakowicz
328421d29f7fSHeiko Schocher- legacy image format:
328521d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
328621d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
328721d29f7fSHeiko Schocher
328821d29f7fSHeiko Schocher		Default:
328921d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
329021d29f7fSHeiko Schocher
329121d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
329221d29f7fSHeiko Schocher		disable the legacy image format
329321d29f7fSHeiko Schocher
329421d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
329521d29f7fSHeiko Schocher		enabled per default for backward compatibility.
329621d29f7fSHeiko Schocher
3297d95f6ec7SGabe Black- FIT image support:
32989a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
32999a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
33009a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
33019a4f479bSDirk Eibach		with this option.
33029a4f479bSDirk Eibach
330373223f0eSSimon Glass		TODO(sjg@chromium.org): Adjust this option to be positive,
330473223f0eSSimon Glass		and move it to Kconfig
330573223f0eSSimon Glass
33064cf2609bSWolfgang Denk- Standalone program support:
33074cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
33084cf2609bSWolfgang Denk
33096feff899SWolfgang Denk		This option defines a board specific value for the
33106feff899SWolfgang Denk		address where standalone program gets loaded, thus
33116feff899SWolfgang Denk		overwriting the architecture dependent default
33124cf2609bSWolfgang Denk		settings.
33134cf2609bSWolfgang Denk
33144cf2609bSWolfgang Denk- Frame Buffer Address:
33154cf2609bSWolfgang Denk		CONFIG_FB_ADDR
33164cf2609bSWolfgang Denk
33174cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
331844a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
331944a53b57SWolfgang Denk		when using a graphics controller has separate video
332044a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
332144a53b57SWolfgang Denk		the given address instead of dynamically reserving it
332244a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
332344a53b57SWolfgang Denk		the memory for the frame buffer depending on the
332444a53b57SWolfgang Denk		configured panel size.
33254cf2609bSWolfgang Denk
33264cf2609bSWolfgang Denk		Please see board_init_f function.
33274cf2609bSWolfgang Denk
3328cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3329cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3330cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3331cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3332cccfc2abSDetlev Zundel
3333cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3334cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3335cccfc2abSDetlev Zundel
3336cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3337cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3338cccfc2abSDetlev Zundel
3339cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3340cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3341cccfc2abSDetlev Zundel
3342cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3343cccfc2abSDetlev Zundel
3344cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3345cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3346cccfc2abSDetlev Zundel
334770c219cdSJoe Hershberger- UBI support
334870c219cdSJoe Hershberger		CONFIG_CMD_UBI
334970c219cdSJoe Hershberger
335070c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
335170c219cdSJoe Hershberger		with the UBI flash translation layer
335270c219cdSJoe Hershberger
335370c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
335470c219cdSJoe Hershberger
3355147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3356147162daSJoe Hershberger
3357147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3358147162daSJoe Hershberger		warnings and errors enabled.
3359147162daSJoe Hershberger
3360ff94bc40SHeiko Schocher
3361ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3362ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3363ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3364ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3365ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3366ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3367ff94bc40SHeiko Schocher
3368ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3369ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3370ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3371ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3372ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3373ff94bc40SHeiko Schocher
3374ff94bc40SHeiko Schocher		default: 4096
3375ff94bc40SHeiko Schocher
3376ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3377ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3378ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3379ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3380ff94bc40SHeiko Schocher		flash), this value is ignored.
3381ff94bc40SHeiko Schocher
3382ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3383ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3384ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3385ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3386ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3387ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3388ff94bc40SHeiko Schocher
3389ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3390ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3391ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3392ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3393ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3394ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3395ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3396ff94bc40SHeiko Schocher		partition.
3397ff94bc40SHeiko Schocher
3398ff94bc40SHeiko Schocher		default: 20
3399ff94bc40SHeiko Schocher
3400ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3401ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3402ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3403ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3404ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3405ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3406ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3407ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3408ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3409ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3410ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3411ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3412ff94bc40SHeiko Schocher
3413ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3414ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3415ff94bc40SHeiko Schocher		without a fastmap.
3416ff94bc40SHeiko Schocher		default: 0
3417ff94bc40SHeiko Schocher
34180195a7bbSHeiko Schocher		CONFIG_MTD_UBI_FM_DEBUG
34190195a7bbSHeiko Schocher		Enable UBI fastmap debug
34200195a7bbSHeiko Schocher		default: 0
34210195a7bbSHeiko Schocher
342270c219cdSJoe Hershberger- UBIFS support
342370c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
342470c219cdSJoe Hershberger
342570c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
342670c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
342770c219cdSJoe Hershberger
342870c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
342970c219cdSJoe Hershberger
3430147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3431147162daSJoe Hershberger
3432147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3433147162daSJoe Hershberger		warnings and errors enabled.
3434147162daSJoe Hershberger
34356a11cf48SDaniel Schwierzeck- SPL framework
34366a11cf48SDaniel Schwierzeck		CONFIG_SPL
34376a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
34386a11cf48SDaniel Schwierzeck
343995579793STom Rini		CONFIG_SPL_LDSCRIPT
344095579793STom Rini		LDSCRIPT for linking the SPL binary.
344195579793STom Rini
34426ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
34436ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
34446ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
34456ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
34468960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
34476ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
34486ebc3461SAlbert ARIBAUD
344995579793STom Rini		CONFIG_SPL_MAX_SIZE
34506ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
34516ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
34526ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
34536ebc3461SAlbert ARIBAUD		not exceed it.
345495579793STom Rini
34556a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
34566a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
34576a11cf48SDaniel Schwierzeck
345894a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
345994a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
346094a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
346194a45bb1SScott Wood
346295579793STom Rini		CONFIG_SPL_BSS_START_ADDR
346395579793STom Rini		Link address for the BSS within the SPL binary.
346495579793STom Rini
346595579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
34666ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
34676ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
34686ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
34698960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
34706ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
347195579793STom Rini
347295579793STom Rini		CONFIG_SPL_STACK
347395579793STom Rini		Adress of the start of the stack SPL will use
347495579793STom Rini
34758c80eb3bSAlbert ARIBAUD \(3ADEV\)		CONFIG_SPL_PANIC_ON_RAW_IMAGE
34768c80eb3bSAlbert ARIBAUD \(3ADEV\)		When defined, SPL will panic() if the image it has
34778c80eb3bSAlbert ARIBAUD \(3ADEV\)		loaded does not have a signature.
34788c80eb3bSAlbert ARIBAUD \(3ADEV\)		Defining this is useful when code which loads images
34798c80eb3bSAlbert ARIBAUD \(3ADEV\)		in SPL cannot guarantee that absolutely all read errors
34808c80eb3bSAlbert ARIBAUD \(3ADEV\)		will be caught.
34818c80eb3bSAlbert ARIBAUD \(3ADEV\)		An example is the LPC32XX MLC NAND driver, which will
34828c80eb3bSAlbert ARIBAUD \(3ADEV\)		consider that a completely unreadable NAND block is bad,
34838c80eb3bSAlbert ARIBAUD \(3ADEV\)		and thus should be skipped silently.
34848c80eb3bSAlbert ARIBAUD \(3ADEV\)
3485e0727515SMarek Vasut		CONFIG_SPL_ABORT_ON_RAW_IMAGE
3486e0727515SMarek Vasut		When defined, SPL will proceed to another boot method
3487e0727515SMarek Vasut		if the image it has loaded does not have a signature.
3488e0727515SMarek Vasut
348994a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
349094a45bb1SScott Wood		Adress of the start of the stack SPL will use after
349194a45bb1SScott Wood		relocation.  If unspecified, this is equal to
349294a45bb1SScott Wood		CONFIG_SPL_STACK.
349394a45bb1SScott Wood
349495579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
349595579793STom Rini		Starting address of the malloc pool used in SPL.
34969ac4fc82SFabio Estevam		When this option is set the full malloc is used in SPL and
34979ac4fc82SFabio Estevam		it is set up by spl_init() and before that, the simple malloc()
34989ac4fc82SFabio Estevam		can be used if CONFIG_SYS_MALLOC_F is defined.
349995579793STom Rini
350095579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
350195579793STom Rini		The size of the malloc pool used in SPL.
35026a11cf48SDaniel Schwierzeck
350347f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
350447f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
350547f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
350647f7bcaeSTom Rini		NAND loading of the Linux Kernel.
350747f7bcaeSTom Rini
35089607faf2STom Rini		CONFIG_SPL_OS_BOOT
35099607faf2STom Rini		Enable booting directly to an OS from SPL.
35109607faf2STom Rini		See also: doc/README.falcon
35119607faf2STom Rini
3512861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3513861a86f4STom Rini		For ARM, enable an optional function to print more information
3514861a86f4STom Rini		about the running system.
3515861a86f4STom Rini
35164b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
35174b919725SScott Wood		Arch init code should be built for a very small image
35184b919725SScott Wood
351995579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
352095579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3521e2ccdf89SPaul Kocialkowski		Address and partition on the MMC to load U-Boot from
352295579793STom Rini		when the MMC is being used in raw mode.
352395579793STom Rini
3524b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3525b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3526b97300b6SPaul Kocialkowski		used in raw mode
3527b97300b6SPaul Kocialkowski
35282b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
35292b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
35302b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
35312b75b0adSPeter Korsgaard
35322b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
35332b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
35342b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
35352b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
35362b75b0adSPeter Korsgaard		(for falcon mode)
35372b75b0adSPeter Korsgaard
3538e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3539e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3540e2ccdf89SPaul Kocialkowski		used in fs mode
3541e2ccdf89SPaul Kocialkowski
3542fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3543fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3544fae81c72SGuillaume GARDET
3545fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
35467ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3547fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
35487ad2cc79SPeter Korsgaard
3549fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
35507ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3551fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
35527ad2cc79SPeter Korsgaard
355306f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
355406f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
355506f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
355606f60ae3SScott Wood		continuing (the hardware starts execution after just
355706f60ae3SScott Wood		loading the first page rather than the full 4K).
355806f60ae3SScott Wood
3559651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3560651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3561651fcf60SPrabhakar Kushwaha
35626f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
35636f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
35646f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
35656f2f01b9SScott Wood
35666f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
35676f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
35686f2f01b9SScott Wood
35696f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
35706f2f01b9SScott Wood		Include standard software ECC in the SPL
35716f2f01b9SScott Wood
357295579793STom Rini		CONFIG_SPL_NAND_SIMPLE
35737d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
35747d4b7955SScott Wood		expose the cmd_ctrl() interface.
357595579793STom Rini
35766f4e7d3cSThomas Gleixner		CONFIG_SPL_UBI
35776f4e7d3cSThomas Gleixner		Support for a lightweight UBI (fastmap) scanner and
35786f4e7d3cSThomas Gleixner		loader
35796f4e7d3cSThomas Gleixner
35800c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
35810c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
35820c3117b1SHeiko Schocher		if you need to save space.
35830c3117b1SHeiko Schocher
35847c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
35857c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
35867c8eea59SYing Zhang		SPL binary.
35877c8eea59SYing Zhang
358895579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
358995579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
359095579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
359195579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
359295579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
359395579793STom Rini		Defines the size and behavior of the NAND that SPL uses
35947d4b7955SScott Wood		to read U-Boot
359595579793STom Rini
3596fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3597fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3598fbe76ae4SPrabhakar Kushwaha
359995579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
36007d4b7955SScott Wood		Location in NAND to read U-Boot from
36017d4b7955SScott Wood
36027d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
36037d4b7955SScott Wood		Location in memory to load U-Boot to
36047d4b7955SScott Wood
36057d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
36067d4b7955SScott Wood		Size of image to load
360795579793STom Rini
360895579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
36097d4b7955SScott Wood		Entry point in loaded image to jump to
361095579793STom Rini
361195579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
361295579793STom Rini		Define this if you need to first read the OOB and then the
3613b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
361495579793STom Rini
361595579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
361695579793STom Rini		Support for an OMAP3-specific set of functions to return the
361795579793STom Rini		ID and MFR of the first attached NAND chip, if present.
361895579793STom Rini
3619c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3620c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3621c57b953dSPavel Machek
362274752baaSScott Wood		CONFIG_SPL_PAD_TO
36236113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
36246113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
36256113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
36266113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
36276113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
362874752baaSScott Wood
3629ca2fca22SScott Wood		CONFIG_SPL_TARGET
3630ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3631ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3632ca2fca22SScott Wood		example if more than one image needs to be produced.
3633ca2fca22SScott Wood
363487ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
363587ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
363687ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
363787ebee39SSimon Glass		option to re-enable it. This will affect the output of the
363887ebee39SSimon Glass		bootm command when booting a FIT image.
363987ebee39SSimon Glass
36403aa29de0SYing Zhang- TPL framework
36413aa29de0SYing Zhang		CONFIG_TPL
36423aa29de0SYing Zhang		Enable building of TPL globally.
36433aa29de0SYing Zhang
36443aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
36453aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
36463aa29de0SYing Zhang		the TPL payload. By default, this is defined as
36473aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
36483aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
36493aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
36503aa29de0SYing Zhang
3651a8c7c708Swdenk- Interrupt support (PPC):
3652a8c7c708Swdenk
3653a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3654a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
365511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3656a8c7c708Swdenk		should set decrementer_count to appropriate value. If
365711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3658a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
365911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3660a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3661a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3662a8c7c708Swdenk		general timer_interrupt().
3663a8c7c708Swdenk
3664c609719bSwdenk
36659660e442SHelmut RaigerBoard initialization settings:
36669660e442SHelmut Raiger------------------------------
36679660e442SHelmut Raiger
36689660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
36699660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
36709660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
36719660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
36729660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
36739660e442SHelmut Raigertypically in board_init_f() and board_init_r().
36749660e442SHelmut Raiger
36759660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
36769660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
36779660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
36789660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3679c609719bSwdenk
3680c609719bSwdenkConfiguration Settings:
3681c609719bSwdenk-----------------------
3682c609719bSwdenk
36834d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
36844d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
36854d1fd7f1SYork Sun
36866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3687c609719bSwdenk		undefine this when you're short of memory.
3688c609719bSwdenk
36892fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
36902fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
36912fb2604dSPeter Tyser
36926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3693c609719bSwdenk		prompt for user input.
3694c609719bSwdenk
36956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3696c609719bSwdenk
36976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3698c609719bSwdenk
36996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3700c609719bSwdenk
37016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3702c609719bSwdenk		the application (usually a Linux kernel) when it is
3703c609719bSwdenk		booted
3704c609719bSwdenk
37056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3706c609719bSwdenk		List of legal baudrate settings for this board.
3707c609719bSwdenk
37086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3709c609719bSwdenk		Suppress display of console information at boot.
3710c609719bSwdenk
37116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3712c609719bSwdenk		If the board specific function
3713c609719bSwdenk			extern int overwrite_console (void);
3714c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3715c609719bSwdenk		serial port, else the settings in the environment are used.
3716c609719bSwdenk
37176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3718c609719bSwdenk		Enable the call to overwrite_console().
3719c609719bSwdenk
37206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3721c609719bSwdenk		Enable overwrite of previous console environment settings.
3722c609719bSwdenk
37236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3724c609719bSwdenk		Begin and End addresses of the area used by the
3725c609719bSwdenk		simple memory test.
3726c609719bSwdenk
37276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3728c609719bSwdenk		Enable an alternate, more extensive memory test.
3729c609719bSwdenk
37306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
37315f535fe1Swdenk		Scratch address used by the alternate memory test
37325f535fe1Swdenk		You only need to set this if address zero isn't writeable
37335f535fe1Swdenk
3734e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE
3735e61a7534SYork Sun		Only implemented for ARMv8 for now.
3736e8149522SYork Sun		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3737e8149522SYork Sun		is substracted from total RAM and won't be reported to OS.
3738e8149522SYork Sun		This memory can be used as secure memory. A variable
3739e61a7534SYork Sun		gd->arch.secure_ram is used to track the location. In systems
3740e8149522SYork Sun		the RAM base is not zero, or RAM is divided into banks,
3741e8149522SYork Sun		this variable needs to be recalcuated to get the address.
3742e8149522SYork Sun
3743aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE:
37446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
374514f73ca6SStefan Roese		this specified memory area will get subtracted from the top
374611ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
374714f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
374814f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
374914f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
37505e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
375114f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
37525e12e75dSStefan Roese		will have to get fixed in Linux additionally.
375314f73ca6SStefan Roese
375414f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
375514f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
375614f73ca6SStefan Roese		be touched.
375714f73ca6SStefan Roese
375814f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
375914f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
376014f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
376114f73ca6SStefan Roese		non page size aligned address and this could cause major
376214f73ca6SStefan Roese		problems.
376314f73ca6SStefan Roese
37646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3765c609719bSwdenk		Enable temporary baudrate change while serial download
3766c609719bSwdenk
37676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3768c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3769c609719bSwdenk
37706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3771c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3772c609719bSwdenk		Cogent motherboard)
3773c609719bSwdenk
37746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3775c609719bSwdenk		Physical start address of Flash memory.
3776c609719bSwdenk
37776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3778c609719bSwdenk		Physical start address of boot monitor code (set by
3779c609719bSwdenk		make config files to be same as the text base address
378014d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
37816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3782c609719bSwdenk
37836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
37843b57fe0aSwdenk		Size of memory reserved for monitor code, used to
37853b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
37863b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
37873b57fe0aSwdenk		flash sector.
3788c609719bSwdenk
37896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3790c609719bSwdenk		Size of DRAM reserved for malloc() use.
3791c609719bSwdenk
3792d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3793d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3794d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3795d59476b6SSimon Glass		will become available before relocation. The address is just
3796d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3797d59476b6SSimon Glass		space.
3798d59476b6SSimon Glass
3799d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3800d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3801d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3802b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
3803d59476b6SSimon Glass		U-Boot relocates itself.
3804d59476b6SSimon Glass
380538687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
380638687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
380738687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
380838687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
380938687ae6SSimon Glass
38101dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
38111dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
38121dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
38131dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
38141dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
38151dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
38161dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
38171dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
38181dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
38191dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
38201dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
38211dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
38221dfdd9baSThierry Reding		written to another region in the same cache-line. This can
38231dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
38241dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
38251dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
38261dfdd9baSThierry Reding
38271dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
38281dfdd9baSThierry Reding
38296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
383015940c9aSStefan Roese		Normally compressed uImages are limited to an
383115940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
38326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
383315940c9aSStefan Roese		to adjust this setting to your needs.
3834c609719bSwdenk
38356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3836c609719bSwdenk		Maximum size of memory mapped by the startup code of
3837c609719bSwdenk		the Linux kernel; all data that must be processed by
38387d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
38397d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
38401bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
38417d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3842c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3843c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3844c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3845c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3846c609719bSwdenk
3847fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3848fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3849fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3850fca43cc8SJohn Rigby		is enabled.
3851fca43cc8SJohn Rigby
3852fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3853fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3854fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3855fca43cc8SJohn Rigby
3856fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3857fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3858fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3859fca43cc8SJohn Rigby
38606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3861c609719bSwdenk		Max number of Flash memory banks
3862c609719bSwdenk
38636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3864c609719bSwdenk		Max number of sectors on a Flash chip
3865c609719bSwdenk
38666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3867c609719bSwdenk		Timeout for Flash erase operations (in ms)
3868c609719bSwdenk
38696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3870c609719bSwdenk		Timeout for Flash write operations (in ms)
3871c609719bSwdenk
38726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
38738564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
38748564acf9Swdenk
38756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
38768564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
38778564acf9Swdenk
38786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
38798564acf9Swdenk		If defined, hardware flash sectors protection is used
38808564acf9Swdenk		instead of U-Boot software protection.
38818564acf9Swdenk
38826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3883c609719bSwdenk
3884c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3885c609719bSwdenk		without this option such a download has to be
3886c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3887c609719bSwdenk		copy from RAM to flash.
3888c609719bSwdenk
3889c609719bSwdenk		The two-step approach is usually more reliable, since
3890c609719bSwdenk		you can check if the download worked before you erase
389111ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
389211ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3893c609719bSwdenk		downloaded image) this option may be very useful.
3894c609719bSwdenk
38956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3896c609719bSwdenk		Define if the flash driver uses extra elements in the
38975653fc33Swdenk		common flash structure for storing flash geometry.
38985653fc33Swdenk
389900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
39005653fc33Swdenk		This option also enables the building of the cfi_flash driver
39015653fc33Swdenk		in the drivers directory
390253cf9435Sstroese
390391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
390491809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
390591809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
390691809ed5SPiotr Ziecik		to the MTD layer.
390791809ed5SPiotr Ziecik
39086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
390996ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
391096ef831fSGuennadi Liakhovetski
391196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
391296ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
391396ef831fSGuennadi Liakhovetski		write commands.
391496ef831fSGuennadi Liakhovetski
39156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
39165568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
39175568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
39185568e613SStefan Roese		is useful, if some of the configured banks are only
39195568e613SStefan Roese		optionally available.
39205568e613SStefan Roese
39219a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
39229a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
39239a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
39249a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
39259a042e9cSJerry Van Baren
3926352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3927352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3928352ef3f1SStefan Roese		against the source after the write operation. An error message
3929352ef3f1SStefan Roese		will be printed when the contents are not identical.
3930352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3931352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3932352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3933352ef3f1SStefan Roese		this option if you really know what you are doing.
3934352ef3f1SStefan Roese
39356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
393611ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
393711ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
393853cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
393953cf9435Sstroese		buffers can be full shortly after enabling the interface
394011ccc33fSMarcel Ziswiler		on high Ethernet traffic.
394153cf9435Sstroese		Defaults to 4 if not defined.
3942c609719bSwdenk
3943ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3944ea882bafSWolfgang Denk
3945ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3946ea882bafSWolfgang Denk	internally to store the environment settings. The default
3947ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3948ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3949ea882bafSWolfgang Denk	lib/hashtable.c for details.
3950ea882bafSWolfgang Denk
39512598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
39522598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
39531bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
39542598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
39552598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
39562598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
39572598090bSJoe Hershberger
39582598090bSJoe Hershberger	The format of the list is:
39592598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3960b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
3961b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
39622598090bSJoe Hershberger		entry = variable_name[:attributes]
39632598090bSJoe Hershberger		list = entry[,list]
39642598090bSJoe Hershberger
39652598090bSJoe Hershberger	The type attributes are:
39662598090bSJoe Hershberger		s - String (default)
39672598090bSJoe Hershberger		d - Decimal
39682598090bSJoe Hershberger		x - Hexadecimal
39692598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
39702598090bSJoe Hershberger		i - IP address
39712598090bSJoe Hershberger		m - MAC address
39722598090bSJoe Hershberger
3973267541f7SJoe Hershberger	The access attributes are:
3974267541f7SJoe Hershberger		a - Any (default)
3975267541f7SJoe Hershberger		r - Read-only
3976267541f7SJoe Hershberger		o - Write-once
3977267541f7SJoe Hershberger		c - Change-default
3978267541f7SJoe Hershberger
39792598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
39802598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
3981b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
39822598090bSJoe Hershberger
39832598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
39842598090bSJoe Hershberger		Define this to a list (string) to define validation that
39852598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
39862598090bSJoe Hershberger		environment variable.  To override a setting in the static
39872598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
39882598090bSJoe Hershberger		".flags" variable.
39892598090bSJoe Hershberger
3990bdf1fe4eSJoe Hershberger	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3991bdf1fe4eSJoe Hershberger	regular expression. This allows multiple variables to define the same
3992bdf1fe4eSJoe Hershberger	flags without explicitly listing them for each variable.
3993bdf1fe4eSJoe Hershberger
3994267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3995267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3996267541f7SJoe Hershberger	access flags.
3997267541f7SJoe Hershberger
39980b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
39990b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
40000b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
4001b445bbb4SJeremiah Mahler	the value can be calculated on a given board.
4002632efa74SSimon Glass
40030d296cc2SGabe Black- CONFIG_USE_STDINT
40040d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
40050d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
40060d296cc2SGabe Black	building U-Boot to enable this.
40070d296cc2SGabe Black
4008c609719bSwdenkThe following definitions that deal with the placement and management
4009c609719bSwdenkof environment data (variable area); in general, we support the
4010c609719bSwdenkfollowing configurations:
4011c609719bSwdenk
4012c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
4013c3eb3fe4SMike Frysinger
4014c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
4015c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
4016c3eb3fe4SMike Frysinger
40175a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
4018c609719bSwdenk
4019c609719bSwdenk	Define this if the environment is in flash memory.
4020c609719bSwdenk
4021c609719bSwdenk	a) The environment occupies one whole flash sector, which is
4022c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
4023c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
4024c609719bSwdenk	   sector" type flash chips, which have several smaller
4025c609719bSwdenk	   sectors at the start or the end. For instance, such a
4026c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4027c609719bSwdenk	   such a case you would place the environment in one of the
4028c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
4029c609719bSwdenk	   "top boot sector" type flash chips, you would put the
4030c609719bSwdenk	   environment in one of the last sectors, leaving a gap
4031c609719bSwdenk	   between U-Boot and the environment.
4032c609719bSwdenk
40330e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4034c609719bSwdenk
4035c609719bSwdenk	   Offset of environment data (variable area) to the
4036c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
4037c609719bSwdenk	   type flash chips the second sector can be used: the offset
4038c609719bSwdenk	   for this sector is given here.
4039c609719bSwdenk
40406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4041c609719bSwdenk
40420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4043c609719bSwdenk
4044c609719bSwdenk	   This is just another way to specify the start address of
4045c609719bSwdenk	   the flash sector containing the environment (instead of
40460e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
4047c609719bSwdenk
40480e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
4049c609719bSwdenk
4050c609719bSwdenk	   Size of the sector containing the environment.
4051c609719bSwdenk
4052c609719bSwdenk
4053c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
4054c609719bSwdenk	   In such a case you don't want to spend a whole sector for
4055c609719bSwdenk	   the environment.
4056c609719bSwdenk
40570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4058c609719bSwdenk
40595a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
40600e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4061c609719bSwdenk	   of this flash sector for the environment. This saves
4062c609719bSwdenk	   memory for the RAM copy of the environment.
4063c609719bSwdenk
4064c609719bSwdenk	   It may also save flash memory if you decide to use this
4065c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
4066c609719bSwdenk	   since then the remainder of the flash sector could be used
4067c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4068c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4069c609719bSwdenk	   updating the environment in flash makes it always
4070c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4071c609719bSwdenk	   wrong before the contents has been restored from a copy in
4072c609719bSwdenk	   RAM, your target system will be dead.
4073c609719bSwdenk
40740e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
40750e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4076c609719bSwdenk
4077c609719bSwdenk	   These settings describe a second storage area used to hold
407811ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
40793e38691eSwdenk	   a valid backup copy in case there is a power failure during
4080c609719bSwdenk	   a "saveenv" operation.
4081c609719bSwdenk
4082c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4083c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4084c609719bSwdenkaccordingly!
4085c609719bSwdenk
4086c609719bSwdenk
40879314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4088c609719bSwdenk
4089c609719bSwdenk	Define this if you have some non-volatile memory device
4090c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4091c609719bSwdenk	environment.
4092c609719bSwdenk
40930e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
40940e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4095c609719bSwdenk
409611ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4097c609719bSwdenk	  want to use for environment. It is assumed that this memory
4098c609719bSwdenk	  can just be read and written to, without any special
4099c609719bSwdenk	  provision.
4100c609719bSwdenk
4101c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4102b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
410311ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4104c609719bSwdenkU-Boot will hang.
4105c609719bSwdenk
4106c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4107c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4108c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4109c609719bSwdenkto save the current settings.
4110c609719bSwdenk
4111c609719bSwdenk
4112bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4113c609719bSwdenk
4114c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4115c609719bSwdenk	device and a driver for it.
4116c609719bSwdenk
41170e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
41180e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4119c609719bSwdenk
4120c609719bSwdenk	  These two #defines specify the offset and size of the
4121c609719bSwdenk	  environment area within the total memory of your EEPROM.
4122c609719bSwdenk
41236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4124c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4125c609719bSwdenk	  The default address is zero.
4126c609719bSwdenk
4127189d257bSChristian Gmeiner	- CONFIG_SYS_I2C_EEPROM_BUS:
4128189d257bSChristian Gmeiner	  If defined, specified the i2c bus of the EEPROM device.
4129189d257bSChristian Gmeiner
41306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4131c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4132c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4133c609719bSwdenk	  would require six bits.
4134c609719bSwdenk
41356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4136c609719bSwdenk	  If defined, the number of milliseconds to delay between
4137c609719bSwdenk	  page writes.	The default is zero milliseconds.
4138c609719bSwdenk
41396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4140c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4141c609719bSwdenk	  that this is NOT the chip address length!
4142c609719bSwdenk
41436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
41445cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
41455cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
41465cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
41475cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
41485cf91d6bSwdenk	  byte chips.
41495cf91d6bSwdenk
41505cf91d6bSwdenk	  Note that we consider the length of the address field to
41515cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
41525cf91d6bSwdenk	  in the chip address.
41535cf91d6bSwdenk
41546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4155c609719bSwdenk	  The size in bytes of the EEPROM device.
4156c609719bSwdenk
4157548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4158548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4159548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4160548738b4SHeiko Schocher
4161548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4162548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4163548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4164548738b4SHeiko Schocher	  EEPROM. For example:
4165548738b4SHeiko Schocher
4166ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4167548738b4SHeiko Schocher
4168548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4169548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4170c609719bSwdenk
4171057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
41725779d8d9Swdenk
41735779d8d9Swdenk	Define this if you have a DataFlash memory device which you
41745779d8d9Swdenk	want to use for the environment.
41755779d8d9Swdenk
41760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
41770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
41780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
41795779d8d9Swdenk
41805779d8d9Swdenk	  These three #defines specify the offset and size of the
41815779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
41825779d8d9Swdenk	  at the specified address.
41835779d8d9Swdenk
4184bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4185bd83b592SWu, Josh
4186bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4187bd83b592SWu, Josh	want to use for the environment.
4188bd83b592SWu, Josh
4189bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4190bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4191bd83b592SWu, Josh
4192bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4193bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4194bd83b592SWu, Josh	  aligned to an erase sector boundary.
4195bd83b592SWu, Josh
4196bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4197bd83b592SWu, Josh
4198bd83b592SWu, Josh	  Define the SPI flash's sector size.
4199bd83b592SWu, Josh
4200bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4201bd83b592SWu, Josh
4202bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4203bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4204bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
4205bd83b592SWu, Josh	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4206bd83b592SWu, Josh	  aligned to an erase sector boundary.
4207bd83b592SWu, Josh
4208bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4209bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4210bd83b592SWu, Josh
4211bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4212bd83b592SWu, Josh
4213bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4214bd83b592SWu, Josh
4215bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4216bd83b592SWu, Josh
4217bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4218bd83b592SWu, Josh
4219bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4220bd83b592SWu, Josh
42210a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
42220a85a9e7SLiu Gang
42230a85a9e7SLiu Gang	Define this if you have a remote memory space which you
42240a85a9e7SLiu Gang	want to use for the local device's environment.
42250a85a9e7SLiu Gang
42260a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
42270a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
42280a85a9e7SLiu Gang
42290a85a9e7SLiu Gang	  These two #defines specify the address and size of the
42300a85a9e7SLiu Gang	  environment area within the remote memory space. The
42310a85a9e7SLiu Gang	  local device can get the environment from remote memory
4232fc54c7faSLiu Gang	  space by SRIO or PCIE links.
42330a85a9e7SLiu Gang
42340a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
42350a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4236fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4237fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
42380a85a9e7SLiu Gang
423951bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
424013a5695bSwdenk
424113a5695bSwdenk	Define this if you have a NAND device which you want to use
424213a5695bSwdenk	for the environment.
424313a5695bSwdenk
42440e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
42450e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
424613a5695bSwdenk
424713a5695bSwdenk	  These two #defines specify the offset and size of the environment
4248fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4249fdd813deSScott Wood	  aligned to an erase block boundary.
42505779d8d9Swdenk
4251fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4252e443c944SMarkus Klotzbuecher
42530e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4254fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4255fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4256fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4257fdd813deSScott Wood	  aligned to an erase block boundary.
4258e443c944SMarkus Klotzbuecher
4259fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4260fdd813deSScott Wood
4261fdd813deSScott Wood	  Specifies the length of the region in which the environment
4262fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4263fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4264fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4265fdd813deSScott Wood	  the range to be avoided.
4266fdd813deSScott Wood
4267fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4268fdd813deSScott Wood
4269fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4270fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4271fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4272fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4273fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4274e443c944SMarkus Klotzbuecher
4275b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4276b74ab737SGuennadi Liakhovetski
4277b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4278b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4279b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4280b74ab737SGuennadi Liakhovetski
42812b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
42822b74433fSJoe Hershberger
42832b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
42842b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
42852b74433fSJoe Hershberger	accesses, which is important on NAND.
42862b74433fSJoe Hershberger
42872b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
42882b74433fSJoe Hershberger
42892b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
42902b74433fSJoe Hershberger
42912b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
42922b74433fSJoe Hershberger
42932b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
42942b74433fSJoe Hershberger	  environment in.
42952b74433fSJoe Hershberger
4296785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4297785881f7SJoe Hershberger
4298785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4299785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4300785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4301785881f7SJoe Hershberger
43022b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
43032b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
43042b74433fSJoe Hershberger
43052b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
43062b74433fSJoe Hershberger	  when storing the env in UBI.
43072b74433fSJoe Hershberger
4308d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4309d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4310d1db76f1SWu, Josh
4311d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4312d1db76f1SWu, Josh
4313d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4314d1db76f1SWu, Josh
4315d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4316d1db76f1SWu, Josh
4317d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4318d1db76f1SWu, Josh         be as following:
4319d1db76f1SWu, Josh
4320d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4321d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4322d1db76f1SWu, Josh                        partition table.
4323d1db76f1SWu, Josh               - "D:0": device D.
4324d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4325d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4326d1db76f1SWu, Josh                              table.
4327d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4328b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
4329d1db76f1SWu, Josh                           partition table then means device D.
4330d1db76f1SWu, Josh
4331d1db76f1SWu, Josh       - FAT_ENV_FILE:
4332d1db76f1SWu, Josh
4333d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4334b445bbb4SJeremiah Mahler         environment.
4335d1db76f1SWu, Josh
4336d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4337b445bbb4SJeremiah Mahler         This should be defined. Otherwise it cannot save the environment file.
4338d1db76f1SWu, Josh
433906e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
434006e4ae5fSStephen Warren
434106e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
434206e4ae5fSStephen Warren	environment.
434306e4ae5fSStephen Warren
434406e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
434506e4ae5fSStephen Warren
434606e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
434706e4ae5fSStephen Warren
434806e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
434906e4ae5fSStephen Warren
435006e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
435106e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
435206e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
435306e4ae5fSStephen Warren
435406e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
435506e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
435606e4ae5fSStephen Warren
435706e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
435806e4ae5fSStephen Warren	  area within the specified MMC device.
435906e4ae5fSStephen Warren
43605c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
43615c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
43625c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
43635c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
43645c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
43655c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
43665c088ee8SStephen Warren	  maximum possible space before it, to store other data.
43675c088ee8SStephen Warren
436806e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
436906e4ae5fSStephen Warren	  MMC sector boundary.
437006e4ae5fSStephen Warren
437106e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
437206e4ae5fSStephen Warren
437306e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
437406e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
437506e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
437606e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
437706e4ae5fSStephen Warren
43785c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
43795c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
43805c088ee8SStephen Warren
438106e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
438206e4ae5fSStephen Warren	  an MMC sector boundary.
438306e4ae5fSStephen Warren
438406e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
438506e4ae5fSStephen Warren
438606e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
438706e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
438806e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
438906e4ae5fSStephen Warren
43906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4391c609719bSwdenk
4392c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4393c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4394c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4395c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4396c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4397c609719bSwdenk	to be a good choice since it makes it far enough from the
4398c609719bSwdenk	start of the data area as well as from the stack pointer.
4399c609719bSwdenk
4400e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4401c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4402cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4403c609719bSwdenkuntil then to read environment variables.
4404c609719bSwdenk
440585ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
440685ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
440785ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
440885ec0bccSwdenknecessary, because the first environment variable we need is the
440985ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
441085ec0bccSwdenkhave any device yet where we could complain.]
4411c609719bSwdenk
4412c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4413c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
441485ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4415c609719bSwdenk
44166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4417fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4418fc3e2165Swdenk
44196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4420fc3e2165Swdenk		      also needs to be defined.
4421fc3e2165Swdenk
44226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4423fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4424c609719bSwdenk
4425f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4426f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4427f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4428f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4429f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4430f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4431f5675aa5SRon Madrid
4432b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4433b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4434b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4435b2b92f53SSimon Glass		to do this.
4436b2b92f53SSimon Glass
4437e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4438e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4439e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4440e2e3e2b1SSimon Glass		present.
4441e2e3e2b1SSimon Glass
4442feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4443feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4444feb85801SSascha Silbe		build system checks that the actual size does not
4445feb85801SSascha Silbe		exceed it.
4446feb85801SSascha Silbe
4447c609719bSwdenkLow Level (hardware related) configuration options:
4448dc7c9a1aSwdenk---------------------------------------------------
4449c609719bSwdenk
44506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4451c609719bSwdenk		Cache Line Size of the CPU.
4452c609719bSwdenk
44536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4454c609719bSwdenk		Default address of the IMMR after system reset.
44552535d602Swdenk
44562535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
44572535d602Swdenk		and RPXsuper) to be able to adjust the position of
44582535d602Swdenk		the IMMR register after a reset.
4459c609719bSwdenk
4460e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4461e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4462e46fedfeSTimur Tabi		PowerPC SOCs.
4463e46fedfeSTimur Tabi
4464e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4465e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4466e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4467e46fedfeSTimur Tabi
4468e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4469e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4470e46fedfeSTimur Tabi
4471e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4472e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4473e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4474e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4475e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4476e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4477e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4478e46fedfeSTimur Tabi
4479e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4480e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4481e46fedfeSTimur Tabi
4482e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4483e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4484e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4485e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4486e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4487e46fedfeSTimur Tabi
4488e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4489e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4490e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4491e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4492e46fedfeSTimur Tabi
4493e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4494e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4495e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4496e46fedfeSTimur Tabi
44977f6c2cbcSwdenk- Floppy Disk Support:
44986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
44997f6c2cbcSwdenk
45007f6c2cbcSwdenk		the default drive number (default value 0)
45017f6c2cbcSwdenk
45026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
45037f6c2cbcSwdenk
450411ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
45057f6c2cbcSwdenk		(default value 1)
45067f6c2cbcSwdenk
45076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
45087f6c2cbcSwdenk
45097f6c2cbcSwdenk		defines the offset of register from address. It
45107f6c2cbcSwdenk		depends on which part of the data bus is connected to
451111ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
45127f6c2cbcSwdenk
45136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
45146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
45157f6c2cbcSwdenk		default value.
45167f6c2cbcSwdenk
45176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
45187f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
45197f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
4520b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
45217f6c2cbcSwdenk		initializations.
45227f6c2cbcSwdenk
45230abddf82SMacpaul Lin- CONFIG_IDE_AHB:
45240abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
45250abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
45260abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
45270abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
45280abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4529b445bbb4SJeremiah Mahler		is required.
45300abddf82SMacpaul Lin
45316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
453225d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
453325d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4534c609719bSwdenk
45356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4536c609719bSwdenk
45377152b1d0Swdenk		Start address of memory area that can be used for
4538c609719bSwdenk		initial data and stack; please note that this must be
4539c609719bSwdenk		writable memory that is working WITHOUT special
4540c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4541c609719bSwdenk		will become available only after programming the
4542c609719bSwdenk		memory controller and running certain initialization
4543c609719bSwdenk		sequences.
4544c609719bSwdenk
4545c609719bSwdenk		U-Boot uses the following memory types:
4546c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4547c609719bSwdenk		- MPC824X: data cache
4548c609719bSwdenk		- PPC4xx:  data cache
4549c609719bSwdenk
45506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4551c609719bSwdenk
4552c609719bSwdenk		Offset of the initial data structure in the memory
45536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
45546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4555c609719bSwdenk		data is located at the end of the available space
4556553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
45576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
45586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
45596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4560c609719bSwdenk
4561c609719bSwdenk	Note:
4562c609719bSwdenk		On the MPC824X (or other systems that use the data
4563c609719bSwdenk		cache for initial memory) the address chosen for
45646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4565c609719bSwdenk		point to an otherwise UNUSED address space between
4566c609719bSwdenk		the top of RAM and the start of the PCI space.
4567c609719bSwdenk
45686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4569c609719bSwdenk
45706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4571c609719bSwdenk
45726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4573c609719bSwdenk
45746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4575c609719bSwdenk
45766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4577c609719bSwdenk
45786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4579c609719bSwdenk
45806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4581c609719bSwdenk		SDRAM timing
4582c609719bSwdenk
45836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4584c609719bSwdenk		periodic timer for refresh
4585c609719bSwdenk
45866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4587c609719bSwdenk
45886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
45896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
45906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
45916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4592c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4593c609719bSwdenk
4594c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
45956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
45966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4597c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4598c609719bSwdenk
45996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
46006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4601c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4602c609719bSwdenk		Prescaler definitions (SDRAM timing)
4603c609719bSwdenk
46046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4605c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4606c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4607c609719bSwdenk
46086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4609b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4610b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4611b423d055SHeiko Schocher
46126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4613c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4614c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4615c609719bSwdenk
46166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4617c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4618c609719bSwdenk		wrong setting might damage your board. Read
4619c609719bSwdenk		doc/README.MBX before setting this variable!
4620c609719bSwdenk
46216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4622ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4623ea909b76Swdenk		(Power On Self Tests). This definition overrides
4624ea909b76Swdenk		#define'd default value in commproc.h resp.
4625ea909b76Swdenk		cpm_8260.h.
4626ea909b76Swdenk
46276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
46286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
46296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
46306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
46316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
46326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
46336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
46346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4635a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
46365d232d0eSwdenk
46379cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
46389cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
46399cacf4fcSDirk Eibach		required.
46409cacf4fcSDirk Eibach
464169fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4642b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
464369fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
464469fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
464569fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
464669fd2d3bSAndrew Sharp		by coreboot or similar.
464769fd2d3bSAndrew Sharp
4648842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4649842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4650842033e6SGabor Juhos
4651a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4652a09b9b68SKumar Gala		Chip has SRIO or not
4653a09b9b68SKumar Gala
4654a09b9b68SKumar Gala- CONFIG_SRIO1:
4655a09b9b68SKumar Gala		Board has SRIO 1 port available
4656a09b9b68SKumar Gala
4657a09b9b68SKumar Gala- CONFIG_SRIO2:
4658a09b9b68SKumar Gala		Board has SRIO 2 port available
4659a09b9b68SKumar Gala
4660c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4661c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4662c8b28152SLiu Gang
4663a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4664a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4665a09b9b68SKumar Gala
4666a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4667a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4668a09b9b68SKumar Gala
4669a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4670a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4671a09b9b68SKumar Gala
467266bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
467366bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
467466bd1846SFabio Estevam		a 16 bit bus.
467566bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4676a430e916SFabio Estevam		Example of drivers that use it:
467766bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4678a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4679eced4626SAlex Waterman
4680eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4681eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4682eced4626SAlex Waterman		a default value will be used.
4683eced4626SAlex Waterman
4684bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4685218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4686218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4687218ca724SWolfgang Denk
4688bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4689bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4690bb99ad6dSBen Warren
46916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4692218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4693218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4694218ca724SWolfgang Denk		to something your driver can deal with.
4695bb99ad6dSBen Warren
46961b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
46971b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
46981b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
46991b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
47001b3e3c4fSYork Sun		header files or board specific files.
47011b3e3c4fSYork Sun
47026f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
47036f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
47046f5e1dc5SYork Sun
4705e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
4706e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
4707e32d59a2SYork Sun
47084516ff81SYork Sun- CONFIG_FSL_DDR_BIST
47094516ff81SYork Sun		Enable built-in memory test for Freescale DDR controllers.
47104516ff81SYork Sun
47116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4712218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4713218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
47142ad6b513STimur Tabi
4715c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4716c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4717c26e454dSwdenk
4718c26e454dSwdenk- CONFIG_FEC[12]_PHY
4719c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
47206e592385Swdenk		to the given FEC; i. e.
4721c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4722c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4723c26e454dSwdenk
4724c26e454dSwdenk		When set to -1, means to probe for first available.
4725c26e454dSwdenk
4726c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4727c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4728c26e454dSwdenk		(so program the FEC to ignore it).
4729c26e454dSwdenk
4730c26e454dSwdenk- CONFIG_RMII
4731c26e454dSwdenk		Enable RMII mode for all FECs.
4732c26e454dSwdenk		Note that this is a global option, we can't
4733c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4734c26e454dSwdenk
47355cf91d6bSwdenk- CONFIG_CRC32_VERIFY
47365cf91d6bSwdenk		Add a verify option to the crc32 command.
47375cf91d6bSwdenk		The syntax is:
47385cf91d6bSwdenk
47395cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
47405cf91d6bSwdenk
47415cf91d6bSwdenk		Where address/count indicate a memory area
47425cf91d6bSwdenk		and crc32 is the correct crc32 which the
47435cf91d6bSwdenk		area should have.
47445cf91d6bSwdenk
474556523f12Swdenk- CONFIG_LOOPW
474656523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4747602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
474856523f12Swdenk
47497b466641Sstroese- CONFIG_MX_CYCLIC
47507b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
47517b466641Sstroese		"md/mw" commands.
47527b466641Sstroese		Examples:
47537b466641Sstroese
47547b466641Sstroese		=> mdc.b 10 4 500
47557b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
47567b466641Sstroese
47577b466641Sstroese		=> mwc.l 100 12345678 10
47587b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
47597b466641Sstroese
47607b466641Sstroese		This only takes effect if the memory commands are activated
4761602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
47627b466641Sstroese
47638aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4764afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4765e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4766e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4767e03f3169SWolfgang Denk		relocate itself into RAM.
47688aa1a2d1Swdenk
4769e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4770e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4771e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4772e03f3169SWolfgang Denk		these initializations itself.
47738aa1a2d1Swdenk
4774b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4775b5bd0982SSimon Glass		[ARM926EJ-S only] This allows just the call to lowlevel_init()
477690211f77Syeongjun Kim		to be skipped. The normal CP15 init (such as enabling the
4777b5bd0982SSimon Glass		instruction cache) is still performed.
4778b5bd0982SSimon Glass
4779401bb30bSAneesh V- CONFIG_SPL_BUILD
4780df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4781df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4782df81238bSMagnus Lilja		compiling a NAND SPL.
4783400558b5Swdenk
47843aa29de0SYing Zhang- CONFIG_TPL_BUILD
47853aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
47863aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
47873aa29de0SYing Zhang		It is loaded by the SPL.
47883aa29de0SYing Zhang
47895df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
47905df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
47915df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
47925df572f0SYing Zhang		previous 4k of the .text section.
47935df572f0SYing Zhang
47944213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
47954213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
47964213fc29SSimon Glass		effective address. It is therefore not necessary to regard
47974213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
47984213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
47994213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
48004213fc29SSimon Glass		addressable memory. This option causes some memory accesses
48014213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
48024213fc29SSimon Glass
4803d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4804d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4805d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4806d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4807d8834a13SMatthias Weisser		conditions but may increase the binary size.
4808d8834a13SMatthias Weisser
4809588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4810588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4811588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4812b16f521aSGabe Black
4813fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4814fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4815fc33705eSMark Jackson
4816fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
48175b5ece9eSGabe Black
481816678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
481916678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
482016678eb4SHeiko Schocher
4821999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4822999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4823999d7d32SKaricheri, Muralidharan		driver that uses this:
4824999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4825999d7d32SKaricheri, Muralidharan
4826f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4827f2717b47STimur Tabi-----------------------------------
4828f2717b47STimur Tabi
4829f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4830f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4831f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4832f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4833f2717b47STimur Tabiwithin that device.
4834f2717b47STimur Tabi
4835dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4836dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4837dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4838dcf1d774SZhao Qiang	is also specified.
4839dcf1d774SZhao Qiang
4840dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4841dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4842f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4843f2717b47STimur Tabi	is also specified.
4844f2717b47STimur Tabi
4845f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4846f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4847f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4848f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4849f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4850f2717b47STimur Tabi
4851f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4852f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4853f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4854f2717b47STimur Tabi	virtual address in NOR flash.
4855f2717b47STimur Tabi
4856f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4857f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4858f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4859f2717b47STimur Tabi
4860f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4861f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4862f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4863f2717b47STimur Tabi
4864f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4865f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4866f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4867f2717b47STimur Tabi
4868292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4869292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4870292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4871fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4872fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4873fc54c7faSLiu Gang	master's memory space.
4874f2717b47STimur Tabi
4875b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
4876b940ca64SJ. German Rivera---------------------------------------------------------
4877b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
4878b940ca64SJ. German Rivera"firmware".
4879b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
4880b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
4881b940ca64SJ. German Riverawithin that device.
4882b940ca64SJ. German Rivera
4883b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
4884b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
4885b940ca64SJ. German Rivera
4886b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR
4887b940ca64SJ. German Rivera	The address in the storage device where the firmware is located.  The
4888b940ca64SJ. German Rivera	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4889b940ca64SJ. German Rivera	is also specified.
4890b940ca64SJ. German Rivera
4891b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH
4892b940ca64SJ. German Rivera	The maximum possible size of the firmware.  The firmware binary format
4893b940ca64SJ. German Rivera	has a field that specifies the actual size of the firmware, but it
4894b940ca64SJ. German Rivera	might not be possible to read any part of the firmware unless some
4895b940ca64SJ. German Rivera	local storage is allocated to hold the entire firmware first.
4896b940ca64SJ. German Rivera
4897b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR
4898b940ca64SJ. German Rivera	Specifies that MC firmware is located in NOR flash, mapped as
4899b940ca64SJ. German Rivera	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4900b940ca64SJ. German Rivera	virtual address in NOR flash.
4901b940ca64SJ. German Rivera
49025c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support:
49035c055089SPrabhakar Kushwaha-------------------------------------------
49045c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of
49055c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom.
49065c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting.
49075c055089SPrabhakar Kushwaha
4908c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN
4909c0492141SYork Sun	Define alignment of reserved memory MC requires
49105c055089SPrabhakar Kushwaha
4911f3f431a7SPaul KocialkowskiReproducible builds
4912f3f431a7SPaul Kocialkowski-------------------
4913f3f431a7SPaul Kocialkowski
4914f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build
4915f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value.
4916f3f431a7SPaul Kocialkowski
4917f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable.
4918f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4919f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot.
4920f3f431a7SPaul Kocialkowski
4921f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4922f3f431a7SPaul Kocialkowski
4923c609719bSwdenkBuilding the Software:
4924c609719bSwdenk======================
4925c609719bSwdenk
4926218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4927218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4928218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4929218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4930218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4931218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4932c609719bSwdenk
4933218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4934218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4935218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4936218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4937218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4938c609719bSwdenk
4939218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4940218ca724SWolfgang Denk	$ export CROSS_COMPILE
4941c609719bSwdenk
49422f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
49432f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
49442f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
49452f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
49462f8d396bSPeter Tyser
49472f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
49482f8d396bSPeter Tyser
49492f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
49502f8d396bSPeter Tyser      be executed on computers running Windows.
49512f8d396bSPeter Tyser
4952c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4953c609719bSwdenksources you must configure U-Boot for one specific board type. This
4954c609719bSwdenkis done by typing:
4955c609719bSwdenk
4956ab584d67SHolger Freyther	make NAME_defconfig
4957c609719bSwdenk
4958ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
49594d675ae6SMichael Jonesrations; see boards.cfg for supported names.
496054387ac9Swdenk
4961c609719bSwdenkNote: for some board special configuration names may exist; check if
4962c609719bSwdenk      additional information is available from the board vendor; for
49632729af9dSwdenk      instance, the TQM823L systems are available without (standard)
49642729af9dSwdenk      or with LCD support. You can select such additional "features"
496511ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4966c609719bSwdenk
4967ab584d67SHolger Freyther      make TQM823L_defconfig
49682729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4969c609719bSwdenk
4970ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
4971c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4972c609719bSwdenk
4973c609719bSwdenk      etc.
4974c609719bSwdenk
4975c609719bSwdenk
4976c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
49777152b1d0Swdenkimages ready for download to / installation on your system:
4978c609719bSwdenk
4979c609719bSwdenk- "u-boot.bin" is a raw binary image
4980c609719bSwdenk- "u-boot" is an image in ELF binary format
4981c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4982c609719bSwdenk
4983baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4984baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4985baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4986baf31249SMarian Balakowicz
4987baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4988baf31249SMarian Balakowicz
4989baf31249SMarian Balakowicz	make O=/tmp/build distclean
4990ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
4991baf31249SMarian Balakowicz	make O=/tmp/build all
4992baf31249SMarian Balakowicz
4993adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
4994baf31249SMarian Balakowicz
4995adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
4996baf31249SMarian Balakowicz	make distclean
4997ab584d67SHolger Freyther	make NAME_defconfig
4998baf31249SMarian Balakowicz	make all
4999baf31249SMarian Balakowicz
5000adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
5001baf31249SMarian Balakowiczvariable.
5002baf31249SMarian Balakowicz
5003c609719bSwdenk
5004c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
5005c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
5006c609719bSwdenknative "make".
5007c609719bSwdenk
5008c609719bSwdenk
5009c609719bSwdenkIf the system board that you have is not listed, then you will need
5010c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
5011c609719bSwdenksteps:
5012c609719bSwdenk
50133c1496cdSPhil Sutter1.  Create a new directory to hold your board specific code. Add any
501485ec0bccSwdenk    files you need. In your board directory, you will need at least
50153c1496cdSPhil Sutter    the "Makefile" and a "<board>.c".
50163c1496cdSPhil Sutter2.  Create a new configuration file "include/configs/<board>.h" for
50173c1496cdSPhil Sutter    your board.
5018c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
5019c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
5020ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
5021c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
5022c609719bSwdenk    to be installed on your target system.
502385ec0bccSwdenk6.  Debug and solve any problems that might arise.
5024c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
5025c609719bSwdenk
5026c609719bSwdenk
5027c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
5028c609719bSwdenk==============================================================
5029c609719bSwdenk
5030c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
5031c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
5032c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
5033c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
5034218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
5035c609719bSwdenk
5036c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
5037c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
5038c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
50396de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will
50406de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this
50416de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H'
50426de80f21SSimon Glassfor documentation.
5043baf31249SMarian Balakowicz
5044baf31249SMarian Balakowicz
5045c609719bSwdenkSee also "U-Boot Porting Guide" below.
5046c609719bSwdenk
5047c609719bSwdenk
5048c609719bSwdenkMonitor Commands - Overview:
5049c609719bSwdenk============================
5050c609719bSwdenk
5051c609719bSwdenkgo	- start application at address 'addr'
5052c609719bSwdenkrun	- run commands in an environment variable
5053c609719bSwdenkbootm	- boot application image from memory
5054c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
505544f074c7SMarek Vasutbootz   - boot zImage from memory
5056c609719bSwdenktftpboot- boot image via network using TFTP protocol
5057c609719bSwdenk	       and env variables "ipaddr" and "serverip"
5058c609719bSwdenk	       (and eventually "gatewayip")
50591fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
5060c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
5061c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5062c609719bSwdenkloads	- load S-Record file over serial line
5063c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
5064c609719bSwdenkmd	- memory display
5065c609719bSwdenkmm	- memory modify (auto-incrementing)
5066c609719bSwdenknm	- memory modify (constant address)
5067c609719bSwdenkmw	- memory write (fill)
5068c609719bSwdenkcp	- memory copy
5069c609719bSwdenkcmp	- memory compare
5070c609719bSwdenkcrc32	- checksum calculation
50710f89c54bSPeter Tyseri2c	- I2C sub-system
5072c609719bSwdenksspi	- SPI utility commands
5073c609719bSwdenkbase	- print or set address offset
5074c609719bSwdenkprintenv- print environment variables
5075c609719bSwdenksetenv	- set environment variables
5076c609719bSwdenksaveenv - save environment variables to persistent storage
5077c609719bSwdenkprotect - enable or disable FLASH write protection
5078c609719bSwdenkerase	- erase FLASH memory
5079c609719bSwdenkflinfo	- print FLASH memory information
508010635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
5081c609719bSwdenkbdinfo	- print Board Info structure
5082c609719bSwdenkiminfo	- print header information for application image
5083c609719bSwdenkconinfo - print console devices and informations
5084c609719bSwdenkide	- IDE sub-system
5085c609719bSwdenkloop	- infinite loop on address range
508656523f12Swdenkloopw	- infinite write loop on address range
5087c609719bSwdenkmtest	- simple RAM test
5088c609719bSwdenkicache	- enable or disable instruction cache
5089c609719bSwdenkdcache	- enable or disable data cache
5090c609719bSwdenkreset	- Perform RESET of the CPU
5091c609719bSwdenkecho	- echo args to console
5092c609719bSwdenkversion - print monitor version
5093c609719bSwdenkhelp	- print online help
5094c609719bSwdenk?	- alias for 'help'
5095c609719bSwdenk
5096c609719bSwdenk
5097c609719bSwdenkMonitor Commands - Detailed Description:
5098c609719bSwdenk========================================
5099c609719bSwdenk
5100c609719bSwdenkTODO.
5101c609719bSwdenk
5102c609719bSwdenkFor now: just type "help <command>".
5103c609719bSwdenk
5104c609719bSwdenk
5105c609719bSwdenkEnvironment Variables:
5106c609719bSwdenk======================
5107c609719bSwdenk
5108c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5109c609719bSwdenkcan be made persistent by saving to Flash memory.
5110c609719bSwdenk
5111c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5112c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5113c609719bSwdenkwithout a value can be used to delete a variable from the
5114c609719bSwdenkenvironment. As long as you don't save the environment you are
5115c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5116c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5117c609719bSwdenk
5118c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5119c96f86eeSWolfgang Denk
5120c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5121c609719bSwdenk
5122c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5123c609719bSwdenk
5124c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5125c609719bSwdenk
5126c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5127c609719bSwdenk
5128c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5129c609719bSwdenk
5130c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5131c609719bSwdenk
51327d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
51337d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
51347d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
51357d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
51367d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
51377d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5138c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5139c3624e6eSGrant Likely		  bootm_mapsize.
5140c3624e6eSGrant Likely
5141c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5142c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5143c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5144c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5145c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5146c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5147c3624e6eSGrant Likely		  used otherwise.
51487d721e34SBartlomiej Sieka
51497d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
51507d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
51517d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
51527d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
51537d721e34SBartlomiej Sieka		  environment variable.
51547d721e34SBartlomiej Sieka
51554bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
51564bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
51574bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
51584bae9090SBartlomiej Sieka
5159c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5160c609719bSwdenk		  "bootp" will just load perform a lookup of the
5161c609719bSwdenk		  configuration from the BOOTP server, but not try to
5162c609719bSwdenk		  load any image using TFTP
5163c609719bSwdenk
5164c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5165c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5166c609719bSwdenk		  be automatically started (by internally calling
5167c609719bSwdenk		  "bootm")
5168c609719bSwdenk
51694a6fd34bSwdenk		  If set to "no", a standalone image passed to the
51704a6fd34bSwdenk		  "bootm" command will be copied to the load address
51714a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
51724a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
51734a6fd34bSwdenk		  data.
51744a6fd34bSwdenk
5175a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5176a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5177fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5178fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5179fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5180fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5181fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5182fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5183fa34f6b2SShawn Guo		  access it during the boot procedure.
5184fa34f6b2SShawn Guo
5185a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5186a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5187a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5188a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5189a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5190a28afca5SDavid A. Long		  must be accessible by the kernel.
5191a28afca5SDavid A. Long
5192eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5193eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5194eea63e05SSimon Glass		  defined.
5195eea63e05SSimon Glass
519617ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
519717ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
519817ea1177Swdenk		  mode (400kHZ). This environment variable is used in
519917ea1177Swdenk		  initialization code. So, for changes to be effective
520017ea1177Swdenk		  it must be saved and board must be reset.
520117ea1177Swdenk
5202c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5203c609719bSwdenk		  If this variable is not set, initrd images will be
5204c609719bSwdenk		  copied to the highest possible address in RAM; this
5205c609719bSwdenk		  is usually what you want since it allows for
5206c609719bSwdenk		  maximum initrd size. If for some reason you want to
5207c609719bSwdenk		  make sure that the initrd image is loaded below the
52086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5209c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5210c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5211c609719bSwdenk		  address to use (U-Boot will still check that it
5212c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5213c609719bSwdenk
5214c609719bSwdenk		  For instance, when you have a system with 16 MB
52157152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5216c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5217c609719bSwdenk		  the "bootargs" variable. However, now you must make
52187152b1d0Swdenk		  sure that the initrd image is placed in the first
5219c609719bSwdenk		  12 MB as well - this can be done with
5220c609719bSwdenk
5221c609719bSwdenk		  setenv initrd_high 00c00000
5222c609719bSwdenk
522338b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
522438b99261Swdenk		  indication to U-Boot that all addresses are legal
522538b99261Swdenk		  for the Linux kernel, including addresses in flash
522638b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
522738b99261Swdenk		  ramdisk at all. This may be useful to reduce the
522838b99261Swdenk		  boot time on your system, but requires that this
522938b99261Swdenk		  feature is supported by your Linux kernel.
523038b99261Swdenk
5231c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5232c609719bSwdenk
5233c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5234dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5235c609719bSwdenk
5236c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5237c609719bSwdenk
5238c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5239c609719bSwdenk
5240c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5241c609719bSwdenk
5242c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5243c609719bSwdenk
5244c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5245c609719bSwdenk
5246e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5247a3d991bdSwdenk
5248e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5249e2a53458SMike Frysinger		  For example you can do the following
5250a3d991bdSwdenk
525148690d80SHeiko Schocher		  => setenv ethact FEC
525248690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
525348690d80SHeiko Schocher		  => setenv ethact SCC
525448690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5255a3d991bdSwdenk
5256e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5257e1692577SMatthias Fuchs		  available network interfaces.
5258e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5259e1692577SMatthias Fuchs
5260a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5261a3d991bdSwdenk		  either succeed or fail without retrying.
52626e592385Swdenk		  When set to "once" the network operation will
52636e592385Swdenk		  fail when all the available network interfaces
52646e592385Swdenk		  are tried once without success.
5265a3d991bdSwdenk		  Useful on scripts which control the retry operation
5266a3d991bdSwdenk		  themselves.
5267a3d991bdSwdenk
5268b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5269a1cf027aSJean-Christophe PLAGNIOL-VILLARD
5270b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
52718d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
52728d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
52738d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
52748d51aacdSSimon Glass		  is silent.
52758d51aacdSSimon Glass
5276f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpsrcp	- If this is set, the value is used for TFTP's
5277ecb0ccd9SWolfgang Denk		  UDP source port.
5278ecb0ccd9SWolfgang Denk
5279f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpdstp	- If this is set, the value is used for TFTP's UDP
528028cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
528128cb9375SWolfgang Denk
5282c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5283c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5284c96f86eeSWolfgang Denk
5285c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5286c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5287c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5288c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5289c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5290c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5291c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5292c96f86eeSWolfgang Denk
5293f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
5294f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unit, minimum value = 0). Defines how many timeouts
5295f5fb7346SAlbert ARIBAUD \(3ADEV\)		  can happen during a single file transfer before that
5296f5fb7346SAlbert ARIBAUD \(3ADEV\)		  transfer is aborted. The default is 10, and 0 means
5297f5fb7346SAlbert ARIBAUD \(3ADEV\)		  'no timeouts allowed'. Increasing this value may help
5298f5fb7346SAlbert ARIBAUD \(3ADEV\)		  downloads succeed with high packet loss rates, or with
5299f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unreliable TFTP servers or client hardware.
5300f5fb7346SAlbert ARIBAUD \(3ADEV\)
5301a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
530211ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5303a3d991bdSwdenk		  VLAN tagged frames.
5304c609719bSwdenk
530550768f5bSAlexandre Messier  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
530650768f5bSAlexandre Messier		  Unsigned value, in milliseconds. If not set, the period will
530750768f5bSAlexandre Messier		  be either the default (28000), or a value based on
530850768f5bSAlexandre Messier		  CONFIG_NET_RETRY_COUNT, if defined. This value has
530950768f5bSAlexandre Messier		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
531050768f5bSAlexandre Messier
5311dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5312dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5313dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5314dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5315dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5316dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5317dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5318dc0b7b0eSJason Hobbs
5319dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5320aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some
5321dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5322dc0b7b0eSJason Hobbs
5323dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5324dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5325dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5326dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5327dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5328dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5329dc0b7b0eSJason Hobbs
5330c609719bSwdenkThe following environment variables may be used and automatically
5331c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5332c609719bSwdenkdepending the information provided by your boot server:
5333c609719bSwdenk
5334c609719bSwdenk  bootfile	- see above
5335c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5336fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5337c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5338c609719bSwdenk  hostname	- Target hostname
5339c609719bSwdenk  ipaddr	- see above
5340c609719bSwdenk  netmask	- Subnet Mask
5341c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5342c609719bSwdenk  serverip	- see above
5343c609719bSwdenk
5344c609719bSwdenk
5345c609719bSwdenkThere are two special Environment Variables:
5346c609719bSwdenk
5347c609719bSwdenk  serial#	- contains hardware identification information such
5348c609719bSwdenk		  as type string and/or serial number
5349c609719bSwdenk  ethaddr	- Ethernet address
5350c609719bSwdenk
5351c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5352c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5353c609719bSwdenkonce they have been set once.
5354c609719bSwdenk
5355c609719bSwdenk
5356c1551ea8SstroeseFurther special Environment Variables:
5357c1551ea8Sstroese
5358c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5359c1551ea8Sstroese		  with the "version" command. This variable is
5360c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5361c1551ea8Sstroese
5362c1551ea8Sstroese
5363c609719bSwdenkPlease note that changes to some configuration parameters may take
5364c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5365c609719bSwdenk
5366c609719bSwdenk
5367170ab110SJoe HershbergerCallback functions for environment variables:
5368170ab110SJoe Hershberger---------------------------------------------
5369170ab110SJoe Hershberger
5370170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5371b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
5372170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5373170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5374170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5375170ab110SJoe Hershberger
5376170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5377170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5378170ab110SJoe Hershberger
5379170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5380170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5381170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5382170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5383170ab110SJoe Hershberger
5384170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5385170ab110SJoe Hershberger	list = entry[,list]
5386170ab110SJoe Hershberger
5387170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5388170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5389170ab110SJoe Hershberger
5390170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5391170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5392170ab110SJoe Hershbergeroverride any association in the static list. You can define
5393170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5394b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
5395170ab110SJoe Hershberger
5396bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a
5397bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to
5398bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out.
5399bdf1fe4eSJoe Hershberger
5400170ab110SJoe Hershberger
5401f07771ccSwdenkCommand Line Parsing:
5402f07771ccSwdenk=====================
5403f07771ccSwdenk
5404f07771ccSwdenkThere are two different command line parsers available with U-Boot:
54057152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5406f07771ccSwdenk
5407f07771ccSwdenkOld, simple command line parser:
5408f07771ccSwdenk--------------------------------
5409f07771ccSwdenk
5410f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5411f07771ccSwdenk- several commands on one line, separated by ';'
5412fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5413f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5414f07771ccSwdenk  for example:
5415fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5416f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5417f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5418f07771ccSwdenk
5419f07771ccSwdenkHush shell:
5420f07771ccSwdenk-----------
5421f07771ccSwdenk
5422f07771ccSwdenk- similar to Bourne shell, with control structures like
5423f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5424f07771ccSwdenk  until...do...done, ...
5425f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5426f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5427f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5428f07771ccSwdenk  command
5429f07771ccSwdenk
5430f07771ccSwdenkGeneral rules:
5431f07771ccSwdenk--------------
5432f07771ccSwdenk
5433f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5434f07771ccSwdenk    command) contains several commands separated by semicolon, and
5435f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5436f07771ccSwdenk    executed anyway.
5437f07771ccSwdenk
5438f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
543911ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5440f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5441f07771ccSwdenk    variables are not executed.
5442f07771ccSwdenk
5443c609719bSwdenkNote for Redundant Ethernet Interfaces:
5444c609719bSwdenk=======================================
5445c609719bSwdenk
544611ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5447c609719bSwdenksuch configurations and is capable of automatic selection of a
54487152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5449c609719bSwdenk
5450c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5451c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5452c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5453c609719bSwdenk
5454c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5455c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5456c609719bSwdenkding setting in the environment; if the corresponding environment
5457c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5458c609719bSwdenk
5459c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5460c609719bSwdenk  environment, the SROM's address is used.
5461c609719bSwdenk
5462c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5463c609719bSwdenk  environment exists, then the value from the environment variable is
5464c609719bSwdenk  used.
5465c609719bSwdenk
5466c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5467c609719bSwdenk  both addresses are the same, this MAC address is used.
5468c609719bSwdenk
5469c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5470c609719bSwdenk  addresses differ, the value from the environment is used and a
5471c609719bSwdenk  warning is printed.
5472c609719bSwdenk
5473c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5474bef1014bSJoe Hershberger  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5475bef1014bSJoe Hershberger  a random, locally-assigned MAC is used.
5476c609719bSwdenk
5477ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5478ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5479ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5480ecee9324SBen WarrenThe naming convention is as follows:
5481ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5482c609719bSwdenk
5483c609719bSwdenkImage Formats:
5484c609719bSwdenk==============
5485c609719bSwdenk
54863310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
54873310c549SMarian Balakowiczimages in two formats:
54883310c549SMarian Balakowicz
54893310c549SMarian BalakowiczNew uImage format (FIT)
54903310c549SMarian Balakowicz-----------------------
54913310c549SMarian Balakowicz
54923310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
54933310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
54943310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
54953310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
54963310c549SMarian Balakowicz
54973310c549SMarian Balakowicz
54983310c549SMarian BalakowiczOld uImage format
54993310c549SMarian Balakowicz-----------------
55003310c549SMarian Balakowicz
55013310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
55023310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
55033310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5504c609719bSwdenk
5505c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5506c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5507f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5508f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5509f5ed9e39SPeter Tyser  INTEGRITY).
55107b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5511afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5512afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5513c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5514c609719bSwdenk* Load Address
5515c609719bSwdenk* Entry Point
5516c609719bSwdenk* Image Name
5517c609719bSwdenk* Image Timestamp
5518c609719bSwdenk
5519c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5520c609719bSwdenkand the data portions of the image are secured against corruption by
5521c609719bSwdenkCRC32 checksums.
5522c609719bSwdenk
5523c609719bSwdenk
5524c609719bSwdenkLinux Support:
5525c609719bSwdenk==============
5526c609719bSwdenk
5527c609719bSwdenkAlthough U-Boot should support any OS or standalone application
55287152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5529c609719bSwdenkU-Boot.
5530c609719bSwdenk
5531c609719bSwdenkU-Boot includes many features that so far have been part of some
5532c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5533c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5534c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
55357152b1d0Swdenkserves several purposes:
5536c609719bSwdenk
5537c609719bSwdenk- the same features can be used for other OS or standalone
5538c609719bSwdenk  applications (for instance: using compressed images to reduce the
5539c609719bSwdenk  Flash memory footprint)
5540c609719bSwdenk
5541c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
55427152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5543c609719bSwdenk
5544c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5545c609719bSwdenk  images; of course this also means that different kernel images can
5546c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5547c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5548c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5549c609719bSwdenk  software is easier now.
5550c609719bSwdenk
5551c609719bSwdenk
5552c609719bSwdenkLinux HOWTO:
5553c609719bSwdenk============
5554c609719bSwdenk
5555c609719bSwdenkPorting Linux to U-Boot based systems:
5556c609719bSwdenk---------------------------------------
5557c609719bSwdenk
5558c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5559c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5560c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5561c609719bSwdenkLinux :-).
5562c609719bSwdenk
5563a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5564c609719bSwdenk
5565c609719bSwdenkJust make sure your machine specific header file (for instance
5566c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
55671dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
55681dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
55696d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5570c609719bSwdenk
55712eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
55722eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
55732eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
55742eb31b13SSimon Glassdoc/driver-model.
55752eb31b13SSimon Glass
5576c609719bSwdenk
5577c609719bSwdenkConfiguring the Linux kernel:
5578c609719bSwdenk-----------------------------
5579c609719bSwdenk
5580c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5581c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5582c609719bSwdenk
5583c609719bSwdenk
5584c609719bSwdenkBuilding a Linux Image:
5585c609719bSwdenk-----------------------
5586c609719bSwdenk
558724ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
558824ee89b9Swdenknot used. If you use recent kernel source, a new build target
558924ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
559024ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
559124ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
559224ee89b9Swdenk100% compatible format.
5593c609719bSwdenk
5594c609719bSwdenkExample:
5595c609719bSwdenk
5596ab584d67SHolger Freyther	make TQM850L_defconfig
5597c609719bSwdenk	make oldconfig
5598c609719bSwdenk	make dep
559924ee89b9Swdenk	make uImage
5600c609719bSwdenk
560124ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
560224ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
560324ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5604c609719bSwdenk
560524ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
560624ee89b9Swdenk
560724ee89b9Swdenk* convert the kernel into a raw binary image:
560824ee89b9Swdenk
560924ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
561024ee89b9Swdenk				 -R .note -R .comment \
561124ee89b9Swdenk				 -S vmlinux linux.bin
561224ee89b9Swdenk
561324ee89b9Swdenk* compress the binary image:
561424ee89b9Swdenk
561524ee89b9Swdenk	gzip -9 linux.bin
561624ee89b9Swdenk
561724ee89b9Swdenk* package compressed binary image for U-Boot:
561824ee89b9Swdenk
561924ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
562024ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
562124ee89b9Swdenk		-d linux.bin.gz uImage
562224ee89b9Swdenk
562324ee89b9Swdenk
562424ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
562524ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
562624ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
562724ee89b9Swdenkbyte header containing information about target architecture,
562824ee89b9Swdenkoperating system, image type, compression method, entry points, time
562924ee89b9Swdenkstamp, CRC32 checksums, etc.
563024ee89b9Swdenk
563124ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
563224ee89b9Swdenkprint the header information, or to build new images.
5633c609719bSwdenk
5634c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5635c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5636c609719bSwdenkchecksum verification:
5637c609719bSwdenk
5638c609719bSwdenk	tools/mkimage -l image
5639c609719bSwdenk	  -l ==> list image header information
5640c609719bSwdenk
5641c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5642c609719bSwdenkfrom a "data file" which is used as image payload:
5643c609719bSwdenk
5644c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5645c609719bSwdenk		      -n name -d data_file image
5646c609719bSwdenk	  -A ==> set architecture to 'arch'
5647c609719bSwdenk	  -O ==> set operating system to 'os'
5648c609719bSwdenk	  -T ==> set image type to 'type'
5649c609719bSwdenk	  -C ==> set compression type 'comp'
5650c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5651c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5652c609719bSwdenk	  -n ==> set image name to 'name'
5653c609719bSwdenk	  -d ==> use image data from 'datafile'
5654c609719bSwdenk
565569459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
565669459791Swdenkaddress (0x00000000), but the entry point address depends on the
565769459791Swdenkkernel version:
5658c609719bSwdenk
5659c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
566024ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5661c609719bSwdenk
5662c609719bSwdenkSo a typical call to build a U-Boot image would read:
5663c609719bSwdenk
566424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
566524ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5666a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
566724ee89b9Swdenk	> examples/uImage.TQM850L
566824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5669c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5670c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5671c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5672c609719bSwdenk	Load Address: 0x00000000
567324ee89b9Swdenk	Entry Point:  0x00000000
5674c609719bSwdenk
5675c609719bSwdenkTo verify the contents of the image (or check for corruption):
5676c609719bSwdenk
567724ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
567824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5679c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5680c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5681c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5682c609719bSwdenk	Load Address: 0x00000000
568324ee89b9Swdenk	Entry Point:  0x00000000
5684c609719bSwdenk
5685c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5686c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5687c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5688c609719bSwdenkneed to be uncompressed:
5689c609719bSwdenk
5690a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
569124ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
569224ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5693a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
569424ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
569524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5696c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5697c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5698c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5699c609719bSwdenk	Load Address: 0x00000000
570024ee89b9Swdenk	Entry Point:  0x00000000
5701c609719bSwdenk
5702c609719bSwdenk
5703c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5704c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5705c609719bSwdenk
5706c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5707c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5708c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5709c609719bSwdenk	Image Name:   Simple Ramdisk Image
5710c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5711c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5712c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5713c609719bSwdenk	Load Address: 0x00000000
5714c609719bSwdenk	Entry Point:  0x00000000
5715c609719bSwdenk
5716a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5717a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5718a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5719a804b5ceSGuilherme Maciel Ferreirafrom the image:
5720a804b5ceSGuilherme Maciel Ferreira
5721f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5722f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5723f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5724f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5725a804b5ceSGuilherme Maciel Ferreira
5726c609719bSwdenk
5727c609719bSwdenkInstalling a Linux Image:
5728c609719bSwdenk-------------------------
5729c609719bSwdenk
5730c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5731c609719bSwdenkyou must convert the image to S-Record format:
5732c609719bSwdenk
5733c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5734c609719bSwdenk
5735c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5736c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5737c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5738c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5739c609719bSwdenkcommand.
5740c609719bSwdenk
5741c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5742c609719bSwdenkTQM8xxL is in the first Flash bank):
5743c609719bSwdenk
5744c609719bSwdenk	=> erase 40100000 401FFFFF
5745c609719bSwdenk
5746c609719bSwdenk	.......... done
5747c609719bSwdenk	Erased 8 sectors
5748c609719bSwdenk
5749c609719bSwdenk	=> loads 40100000
5750c609719bSwdenk	## Ready for S-Record download ...
5751c609719bSwdenk	~>examples/image.srec
5752c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5753c609719bSwdenk	...
5754c609719bSwdenk	15989 15990 15991 15992
5755c609719bSwdenk	[file transfer complete]
5756c609719bSwdenk	[connected]
5757c609719bSwdenk	## Start Addr = 0x00000000
5758c609719bSwdenk
5759c609719bSwdenk
5760c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5761c609719bSwdenkthis includes a checksum verification so you can be sure no data
5762c609719bSwdenkcorruption happened:
5763c609719bSwdenk
5764c609719bSwdenk	=> imi 40100000
5765c609719bSwdenk
5766c609719bSwdenk	## Checking Image at 40100000 ...
5767c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5768c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5769c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5770c609719bSwdenk	   Load Address: 00000000
5771c609719bSwdenk	   Entry Point:	 0000000c
5772c609719bSwdenk	   Verifying Checksum ... OK
5773c609719bSwdenk
5774c609719bSwdenk
5775c609719bSwdenkBoot Linux:
5776c609719bSwdenk-----------
5777c609719bSwdenk
5778c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5779c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5780c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5781c609719bSwdenkparameters. You can check and modify this variable using the
5782c609719bSwdenk"printenv" and "setenv" commands:
5783c609719bSwdenk
5784c609719bSwdenk
5785c609719bSwdenk	=> printenv bootargs
5786c609719bSwdenk	bootargs=root=/dev/ram
5787c609719bSwdenk
5788c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5789c609719bSwdenk
5790c609719bSwdenk	=> printenv bootargs
5791c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5792c609719bSwdenk
5793c609719bSwdenk	=> bootm 40020000
5794c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5795c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5796c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5797c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5798c609719bSwdenk	   Load Address: 00000000
5799c609719bSwdenk	   Entry Point:	 0000000c
5800c609719bSwdenk	   Verifying Checksum ... OK
5801c609719bSwdenk	   Uncompressing Kernel Image ... OK
5802c609719bSwdenk	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
5803c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5804c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5805c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5806c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5807c609719bSwdenk	...
5808c609719bSwdenk
580911ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
58107152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5811c609719bSwdenkformat!) to the "bootm" command:
5812c609719bSwdenk
5813c609719bSwdenk	=> imi 40100000 40200000
5814c609719bSwdenk
5815c609719bSwdenk	## Checking Image at 40100000 ...
5816c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5817c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5818c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5819c609719bSwdenk	   Load Address: 00000000
5820c609719bSwdenk	   Entry Point:	 0000000c
5821c609719bSwdenk	   Verifying Checksum ... OK
5822c609719bSwdenk
5823c609719bSwdenk	## Checking Image at 40200000 ...
5824c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5825c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5826c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5827c609719bSwdenk	   Load Address: 00000000
5828c609719bSwdenk	   Entry Point:	 00000000
5829c609719bSwdenk	   Verifying Checksum ... OK
5830c609719bSwdenk
5831c609719bSwdenk	=> bootm 40100000 40200000
5832c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5833c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5834c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5835c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5836c609719bSwdenk	   Load Address: 00000000
5837c609719bSwdenk	   Entry Point:	 0000000c
5838c609719bSwdenk	   Verifying Checksum ... OK
5839c609719bSwdenk	   Uncompressing Kernel Image ... OK
5840c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5841c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5842c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5843c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5844c609719bSwdenk	   Load Address: 00000000
5845c609719bSwdenk	   Entry Point:	 00000000
5846c609719bSwdenk	   Verifying Checksum ... OK
5847c609719bSwdenk	   Loading Ramdisk ... OK
5848c609719bSwdenk	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
5849c609719bSwdenk	Boot arguments: root=/dev/ram
5850c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5851c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5852c609719bSwdenk	...
5853c609719bSwdenk	RAMDISK: Compressed image found at block 0
5854c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5855c609719bSwdenk
5856c609719bSwdenk	bash#
5857c609719bSwdenk
58580267768eSMatthew McClintockBoot Linux and pass a flat device tree:
58590267768eSMatthew McClintock-----------
58600267768eSMatthew McClintock
58610267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
58620267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
58630267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
58640267768eSMatthew McClintockflat device tree:
58650267768eSMatthew McClintock
58660267768eSMatthew McClintock=> print oftaddr
58670267768eSMatthew McClintockoftaddr=0x300000
58680267768eSMatthew McClintock=> print oft
58690267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
58700267768eSMatthew McClintock=> tftp $oftaddr $oft
58710267768eSMatthew McClintockSpeed: 1000, full duplex
58720267768eSMatthew McClintockUsing TSEC0 device
58730267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
58740267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
58750267768eSMatthew McClintockLoad address: 0x300000
58760267768eSMatthew McClintockLoading: #
58770267768eSMatthew McClintockdone
58780267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
58790267768eSMatthew McClintock=> tftp $loadaddr $bootfile
58800267768eSMatthew McClintockSpeed: 1000, full duplex
58810267768eSMatthew McClintockUsing TSEC0 device
58820267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
58830267768eSMatthew McClintockFilename 'uImage'.
58840267768eSMatthew McClintockLoad address: 0x200000
58850267768eSMatthew McClintockLoading:############
58860267768eSMatthew McClintockdone
58870267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
58880267768eSMatthew McClintock=> print loadaddr
58890267768eSMatthew McClintockloadaddr=200000
58900267768eSMatthew McClintock=> print oftaddr
58910267768eSMatthew McClintockoftaddr=0x300000
58920267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
58930267768eSMatthew McClintock## Booting image at 00200000 ...
58940267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
58950267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
58960267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
58970267768eSMatthew McClintock   Load Address: 00000000
58980267768eSMatthew McClintock   Entry Point:	 00000000
58990267768eSMatthew McClintock   Verifying Checksum ... OK
59000267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
59010267768eSMatthew McClintockBooting using flat device tree at 0x300000
59020267768eSMatthew McClintockUsing MPC85xx ADS machine description
59030267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
59040267768eSMatthew McClintock[snip]
59050267768eSMatthew McClintock
59060267768eSMatthew McClintock
59076069ff26SwdenkMore About U-Boot Image Types:
59086069ff26Swdenk------------------------------
59096069ff26Swdenk
59106069ff26SwdenkU-Boot supports the following image types:
59116069ff26Swdenk
59126069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
59136069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
59146069ff26Swdenk	well) you can continue to work in U-Boot after return from
59156069ff26Swdenk	the Standalone Program.
59166069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
59176069ff26Swdenk	will take over control completely. Usually these programs
59186069ff26Swdenk	will install their own set of exception handlers, device
59196069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
59206069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
59216069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
59226069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
59236069ff26Swdenk	being started.
59246069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
59256069ff26Swdenk	(Linux) kernel image and one or more data images like
59266069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
59276069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
59286069ff26Swdenk	server provides just a single image file, but you want to get
59296069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
59306069ff26Swdenk
59316069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
59326069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
59336069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
59346069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
59356069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
59366069ff26Swdenk	a multiple of 4 bytes).
59376069ff26Swdenk
59386069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
59396069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
59406069ff26Swdenk	flash memory.
59416069ff26Swdenk
59426069ff26Swdenk   "Script files" are command sequences that will be executed by
59436069ff26Swdenk	U-Boot's command interpreter; this feature is especially
59446069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
59456069ff26Swdenk	as command interpreter.
59466069ff26Swdenk
594744f074c7SMarek VasutBooting the Linux zImage:
594844f074c7SMarek Vasut-------------------------
594944f074c7SMarek Vasut
595044f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
595144f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
595244f074c7SMarek Vasutas the syntax of "bootm" command.
595344f074c7SMarek Vasut
59548ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5955017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5956017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5957017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5958017e1f3fSMarek Vasut
5959c609719bSwdenk
5960c609719bSwdenkStandalone HOWTO:
5961c609719bSwdenk=================
5962c609719bSwdenk
5963c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5964c609719bSwdenkrun "standalone" applications, which can use some resources of
5965c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5966c609719bSwdenk
5967c609719bSwdenkTwo simple examples are included with the sources:
5968c609719bSwdenk
5969c609719bSwdenk"Hello World" Demo:
5970c609719bSwdenk-------------------
5971c609719bSwdenk
5972c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5973c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5974c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5975c609719bSwdenklike that:
5976c609719bSwdenk
5977c609719bSwdenk	=> loads
5978c609719bSwdenk	## Ready for S-Record download ...
5979c609719bSwdenk	~>examples/hello_world.srec
5980c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5981c609719bSwdenk	[file transfer complete]
5982c609719bSwdenk	[connected]
5983c609719bSwdenk	## Start Addr = 0x00040004
5984c609719bSwdenk
5985c609719bSwdenk	=> go 40004 Hello World! This is a test.
5986c609719bSwdenk	## Starting application at 0x00040004 ...
5987c609719bSwdenk	Hello World
5988c609719bSwdenk	argc = 7
5989c609719bSwdenk	argv[0] = "40004"
5990c609719bSwdenk	argv[1] = "Hello"
5991c609719bSwdenk	argv[2] = "World!"
5992c609719bSwdenk	argv[3] = "This"
5993c609719bSwdenk	argv[4] = "is"
5994c609719bSwdenk	argv[5] = "a"
5995c609719bSwdenk	argv[6] = "test."
5996c609719bSwdenk	argv[7] = "<NULL>"
5997c609719bSwdenk	Hit any key to exit ...
5998c609719bSwdenk
5999c609719bSwdenk	## Application terminated, rc = 0x0
6000c609719bSwdenk
6001c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
6002c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
6003c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
6004c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
6005c609719bSwdenkcharacter, but this is just a demo program. The application can be
6006c609719bSwdenkcontrolled by the following keys:
6007c609719bSwdenk
6008c609719bSwdenk	? - print current values og the CPM Timer registers
6009c609719bSwdenk	b - enable interrupts and start timer
6010c609719bSwdenk	e - stop timer and disable interrupts
6011c609719bSwdenk	q - quit application
6012c609719bSwdenk
6013c609719bSwdenk	=> loads
6014c609719bSwdenk	## Ready for S-Record download ...
6015c609719bSwdenk	~>examples/timer.srec
6016c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6017c609719bSwdenk	[file transfer complete]
6018c609719bSwdenk	[connected]
6019c609719bSwdenk	## Start Addr = 0x00040004
6020c609719bSwdenk
6021c609719bSwdenk	=> go 40004
6022c609719bSwdenk	## Starting application at 0x00040004 ...
6023c609719bSwdenk	TIMERS=0xfff00980
6024c609719bSwdenk	Using timer 1
6025c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6026c609719bSwdenk
6027c609719bSwdenkHit 'b':
6028c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
6029c609719bSwdenk	Enabling timer
6030c609719bSwdenkHit '?':
6031c609719bSwdenk	[q, b, e, ?] ........
6032c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6033c609719bSwdenkHit '?':
6034c609719bSwdenk	[q, b, e, ?] .
6035c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6036c609719bSwdenkHit '?':
6037c609719bSwdenk	[q, b, e, ?] .
6038c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6039c609719bSwdenkHit '?':
6040c609719bSwdenk	[q, b, e, ?] .
6041c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6042c609719bSwdenkHit 'e':
6043c609719bSwdenk	[q, b, e, ?] ...Stopping timer
6044c609719bSwdenkHit 'q':
6045c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
6046c609719bSwdenk
6047c609719bSwdenk
604885ec0bccSwdenkMinicom warning:
604985ec0bccSwdenk================
605085ec0bccSwdenk
60517152b1d0SwdenkOver time, many people have reported problems when trying to use the
605285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
605385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
6054f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
605585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
6056e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
6057e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6058e53515a2SKarl O. Pincfor help with kermit.
6059e53515a2SKarl O. Pinc
606085ec0bccSwdenk
606152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
606252f52c14Swdenkconfiguration to your "File transfer protocols" section:
606352f52c14Swdenk
606452f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
606552f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
606652f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
606752f52c14Swdenk
606852f52c14Swdenk
6069c609719bSwdenkNetBSD Notes:
6070c609719bSwdenk=============
6071c609719bSwdenk
6072c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
6073c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
6074c609719bSwdenk
6075c609719bSwdenkBuilding requires a cross environment; it is known to work on
6076c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6077c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
6078c609719bSwdenkNote that the cross-powerpc package does not install include files;
6079c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
6080c609719bSwdenkmissing.  This file has to be installed and patched manually:
6081c609719bSwdenk
6082c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
6083c609719bSwdenk	# mkdir powerpc
6084c609719bSwdenk	# ln -s powerpc machine
6085c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6086c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6087c609719bSwdenk
6088c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6089c609719bSwdenkand U-Boot include files.
6090c609719bSwdenk
6091c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6092c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6093c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6094c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
60952a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6096c609719bSwdenk
6097c609719bSwdenk
6098c609719bSwdenkImplementation Internals:
6099c609719bSwdenk=========================
6100c609719bSwdenk
6101c609719bSwdenkThe following is not intended to be a complete description of every
6102c609719bSwdenkimplementation detail. However, it should help to understand the
6103c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6104c609719bSwdenkhardware.
6105c609719bSwdenk
6106c609719bSwdenk
6107c609719bSwdenkInitial Stack, Global Data:
6108c609719bSwdenk---------------------------
6109c609719bSwdenk
6110c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6111c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6112c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6113c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6114c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6115c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6116c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6117c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6118c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6119c609719bSwdenklocked as (mis-) used as memory, etc.
6120c609719bSwdenk
61217152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
61220668236bSWolfgang Denk	U-Boot mailing list:
612343d9616cSwdenk
612443d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
612543d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
612643d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
612743d9616cSwdenk	...
612843d9616cSwdenk
612943d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
613043d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
613143d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
613243d9616cSwdenk	is that the cache is being used as a temporary supply of
613343d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
613411ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
613543d9616cSwdenk	can see how this works by studying the cache architecture and
613643d9616cSwdenk	operation in the architecture and processor-specific manuals.
613743d9616cSwdenk
613843d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
613943d9616cSwdenk	is another option for the system designer to use as an
614011ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
614143d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
614243d9616cSwdenk	board designers haven't used it for something that would
614343d9616cSwdenk	cause you grief during the initial boot! It is frequently not
614443d9616cSwdenk	used.
614543d9616cSwdenk
61466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
614743d9616cSwdenk	with your processor/board/system design. The default value
614843d9616cSwdenk	you will find in any recent u-boot distribution in
61498a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
615043d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
615143d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
615243d9616cSwdenk	that are supposed to respond to that address! That code in
615343d9616cSwdenk	start.S has been around a while and should work as is when
615443d9616cSwdenk	you get the config right.
615543d9616cSwdenk
615643d9616cSwdenk	-Chris Hallinan
615743d9616cSwdenk	DS4.COM, Inc.
615843d9616cSwdenk
6159c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6160c609719bSwdenkcode for the initialization procedures:
6161c609719bSwdenk
6162c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6163c609719bSwdenk  to write it.
6164c609719bSwdenk
6165b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
6166c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
61677152b1d0Swdenk  zation is performed later (when relocating to RAM).
6168c609719bSwdenk
6169c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6170c609719bSwdenk  that.
6171c609719bSwdenk
6172c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6173b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
6174c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6175c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6176c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6177c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6178c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6179c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6180c609719bSwdenkreserve for this purpose.
6181c609719bSwdenk
61827152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6183c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6184c609719bSwdenkGCC's implementation.
6185c609719bSwdenk
6186c609719bSwdenkFor PowerPC, the following registers have specific use:
6187c609719bSwdenk	R1:	stack pointer
6188e7670f6cSWolfgang Denk	R2:	reserved for system use
6189c609719bSwdenk	R3-R4:	parameter passing and return values
6190c609719bSwdenk	R5-R10: parameter passing
6191c609719bSwdenk	R13:	small data area pointer
6192c609719bSwdenk	R30:	GOT pointer
6193c609719bSwdenk	R31:	frame pointer
6194c609719bSwdenk
6195e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6196e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6197e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6198c609719bSwdenk
6199e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6200c609719bSwdenk
6201c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6202c609719bSwdenk    address of the global data structure is known at compile time),
6203c609719bSwdenk    but it turned out that reserving a register results in somewhat
6204c609719bSwdenk    smaller code - although the code savings are not that big (on
6205c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6206c609719bSwdenk    624 text + 127 data).
6207c609719bSwdenk
6208c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
62094c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
62104c58eb55SMike Frysinger
6211c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
62124c58eb55SMike Frysinger
6213c609719bSwdenkOn ARM, the following registers are used:
6214c609719bSwdenk
6215c609719bSwdenk	R0:	function argument word/integer result
6216c609719bSwdenk	R1-R3:	function argument word
621712eba1b4SJeroen Hofstee	R9:	platform specific
621812eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6219c609719bSwdenk	R11:	argument (frame) pointer
6220c609719bSwdenk	R12:	temporary workspace
6221c609719bSwdenk	R13:	stack pointer
6222c609719bSwdenk	R14:	link register
6223c609719bSwdenk	R15:	program counter
6224c609719bSwdenk
622512eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
622612eba1b4SJeroen Hofstee
622712eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6228c609719bSwdenk
62290df01fd3SThomas ChouOn Nios II, the ABI is documented here:
62300df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
62310df01fd3SThomas Chou
62320df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
62330df01fd3SThomas Chou
62340df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
62350df01fd3SThomas Chou    to access small data sections, so gp is free.
62360df01fd3SThomas Chou
6237afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6238afc1ce82SMacpaul Lin
6239afc1ce82SMacpaul Lin	R0-R1:	argument/return
6240afc1ce82SMacpaul Lin	R2-R5:	argument
6241afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6242afc1ce82SMacpaul Lin	R16:	trampoline register
6243afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6244afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6245afc1ce82SMacpaul Lin	R30:	link register (LP)
6246afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6247afc1ce82SMacpaul Lin	PC:	program counter (PC)
6248afc1ce82SMacpaul Lin
6249afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6250afc1ce82SMacpaul Lin
6251d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6252d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6253c609719bSwdenk
6254c609719bSwdenkMemory Management:
6255c609719bSwdenk------------------
6256c609719bSwdenk
6257c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6258c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6259c609719bSwdenk
6260c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6261c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6262c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6263c609719bSwdenkphysical memory banks.
6264c609719bSwdenk
6265c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6266c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6267c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6268c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
62696d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6270c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6271c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6272c609719bSwdenk
6273c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6274c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6275c609719bSwdenk
6276c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6277c609719bSwdenkthis:
6278c609719bSwdenk
6279c609719bSwdenk	0x0000 0000	Exception Vector code
6280c609719bSwdenk	      :
6281c609719bSwdenk	0x0000 1FFF
6282c609719bSwdenk	0x0000 2000	Free for Application Use
6283c609719bSwdenk	      :
6284c609719bSwdenk	      :
6285c609719bSwdenk
6286c609719bSwdenk	      :
6287c609719bSwdenk	      :
6288c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6289c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6290c609719bSwdenk	0x00FC 0000	Malloc Arena
6291c609719bSwdenk	      :
6292c609719bSwdenk	0x00FD FFFF
6293c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6294c609719bSwdenk	...		eventually: LCD or video framebuffer
6295c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6296c609719bSwdenk	0x00FF FFFF	[End of RAM]
6297c609719bSwdenk
6298c609719bSwdenk
6299c609719bSwdenkSystem Initialization:
6300c609719bSwdenk----------------------
6301c609719bSwdenk
6302c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
630311ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6304c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
63057152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6306c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6307c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6308c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6309c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6310c609719bSwdenkthe caches and the SIU.
6311c609719bSwdenk
6312c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6313c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6314c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6315c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6316c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6317c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6318c609719bSwdenkbanks.
6319c609719bSwdenk
6320c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
63217152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6322c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6323c609719bSwdenk0x00000000, with any additional banks following immediately to create
6324c609719bSwdenkcontiguous memory starting from 0.
6325c609719bSwdenk
6326c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6327c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6328c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6329c609719bSwdenkpages, and the final stack is set up.
6330c609719bSwdenk
6331c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6332c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6333c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6334c609719bSwdenknew address in RAM.
6335c609719bSwdenk
6336c609719bSwdenk
6337c609719bSwdenkU-Boot Porting Guide:
6338c609719bSwdenk----------------------
6339c609719bSwdenk
6340c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
63416aff3115Swdenklist, October 2002]
6342c609719bSwdenk
6343c609719bSwdenk
6344c609719bSwdenkint main(int argc, char *argv[])
6345c609719bSwdenk{
6346c609719bSwdenk	sighandler_t no_more_time;
6347c609719bSwdenk
6348c609719bSwdenk	signal(SIGALRM, no_more_time);
6349c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6350c609719bSwdenk
6351c609719bSwdenk	if (available_money > available_manpower) {
63526c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6353c609719bSwdenk		return 0;
6354c609719bSwdenk	}
6355c609719bSwdenk
6356c609719bSwdenk	Download latest U-Boot source;
6357c609719bSwdenk
63580668236bSWolfgang Denk	Subscribe to u-boot mailing list;
63596aff3115Swdenk
63606c3fef28SJerry Van Baren	if (clueless)
6361c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6362c609719bSwdenk
6363c609719bSwdenk	while (learning) {
6364c609719bSwdenk		Read the README file in the top level directory;
63657cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
63666c3fef28SJerry Van Baren		Read applicable doc/*.README;
6367c609719bSwdenk		Read the source, Luke;
63686c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6369c609719bSwdenk	}
6370c609719bSwdenk
63716c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
63726c3fef28SJerry Van Baren		Buy a BDI3000;
63736c3fef28SJerry Van Baren	else
6374c609719bSwdenk		Add a lot of aggravation and time;
6375c609719bSwdenk
63766c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
63776c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
63786c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
63796c3fef28SJerry Van Baren	} else {
6380c609719bSwdenk		Create your own board support subdirectory;
63816c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
63826c3fef28SJerry Van Baren	}
63836c3fef28SJerry Van Baren	Edit new board/<myboard> files
63846c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6385c609719bSwdenk
63866c3fef28SJerry Van Baren	while (!accepted) {
6387c609719bSwdenk		while (!running) {
6388c609719bSwdenk			do {
6389c609719bSwdenk				Add / modify source code;
6390c609719bSwdenk			} until (compiles);
6391c609719bSwdenk			Debug;
6392c609719bSwdenk			if (clueless)
6393c609719bSwdenk				email("Hi, I am having problems...");
6394c609719bSwdenk		}
63956c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
63966c3fef28SJerry Van Baren		if (reasonable critiques)
63976c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
63986c3fef28SJerry Van Baren		else
63996c3fef28SJerry Van Baren			Defend code as written;
64006c3fef28SJerry Van Baren	}
6401c609719bSwdenk
6402c609719bSwdenk	return 0;
6403c609719bSwdenk}
6404c609719bSwdenk
6405c609719bSwdenkvoid no_more_time (int sig)
6406c609719bSwdenk{
6407c609719bSwdenk      hire_a_guru();
6408c609719bSwdenk}
6409c609719bSwdenk
6410c609719bSwdenk
6411c609719bSwdenkCoding Standards:
6412c609719bSwdenk-----------------
6413c609719bSwdenk
6414c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
64152c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
64167ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6417c609719bSwdenk
64182c051651SDetlev ZundelSource files originating from a different project (for example the
64192c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
6420b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
64212c051651SDetlev Zundelsources.
64222c051651SDetlev Zundel
64232c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
64242c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
64252c051651SDetlev Zundelin your code.
6426c609719bSwdenk
6427c178d3daSwdenkPlease also stick to the following formatting rules:
6428180d3f74Swdenk- remove any trailing white space
64297ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6430180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
64317ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6432180d3f74Swdenk- do not add trailing empty lines to source files
6433180d3f74Swdenk
6434c609719bSwdenkSubmissions which do not conform to the standards may be returned
6435c609719bSwdenkwith a request to reformat the changes.
6436c609719bSwdenk
6437c609719bSwdenk
6438c609719bSwdenkSubmitting Patches:
6439c609719bSwdenk-------------------
6440c609719bSwdenk
6441c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6442c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6443c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6444c609719bSwdenk
64450d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6446218ca724SWolfgang Denk
64470668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
64480668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
64490668236bSWolfgang Denk
6450c609719bSwdenkWhen you send a patch, please include the following information with
6451c609719bSwdenkit:
6452c609719bSwdenk
6453c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6454c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6455c609719bSwdenk  patch actually fixes something.
6456c609719bSwdenk
6457c609719bSwdenk* For new features: a description of the feature and your
6458c609719bSwdenk  implementation.
6459c609719bSwdenk
6460c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6461c609719bSwdenk
64627207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your
64637207b366SRobert P. J. Day  information and associated file and directory references.
6464c609719bSwdenk
646527af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
646627af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6467c609719bSwdenk
6468c609719bSwdenk* If your patch adds new configuration options, don't forget to
6469c609719bSwdenk  document these in the README file.
6470c609719bSwdenk
6471218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6472218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
64737ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6474218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6475218ca724SWolfgang Denk  with some other mail clients.
6476c609719bSwdenk
6477218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6478218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6479218ca724SWolfgang Denk  GNU diff.
64806dff5529Swdenk
6481218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6482218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6483218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6484218ca724SWolfgang Denk  affected files).
6485218ca724SWolfgang Denk
6486218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6487218ca724SWolfgang Denk  and compressed attachments must not be used.
6488c609719bSwdenk
648952f52c14Swdenk* If one logical set of modifications affects or creates several
649052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
649152f52c14Swdenk
649252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
649352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
649452f52c14Swdenk
649552f52c14Swdenk
6496c609719bSwdenkNotes:
6497c609719bSwdenk
64986de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched
6499c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6500c609719bSwdenk  for any of the boards.
6501c609719bSwdenk
6502c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6503c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6504c609719bSwdenk  returned with a request to re-formatting / split it.
6505c609719bSwdenk
6506c609719bSwdenk* If you modify existing code, make sure that your new code does not
6507c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6508c609719bSwdenk  When adding new features, these should compile conditionally only
6509c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6510c609719bSwdenk  disabled must not need more memory than the old code without your
6511c609719bSwdenk  modification.
651290dc6704Swdenk
65130668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
65140668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
65150668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
65160668236bSWolfgang Denk  bigger than the size limit should be avoided.
6517