xref: /openbmc/u-boot/README (revision db910353a126d84fe8dff7a694ea792f50fcfb6a)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1356eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1366eae68e4SMasahiro Yamada    /cpu		CPU specific files
1376eae68e4SMasahiro Yamada      /arc700		Files specific to ARC 700 CPUs
1386eae68e4SMasahiro Yamada    /lib		Architecture specific library files
1398d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1408d321b81SPeter Tyser    /cpu		CPU specific files
1418d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1428d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1436eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1448d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1458d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1468d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1478d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1488d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1498d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser    /lib		Architecture specific library files
1578d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1588d321b81SPeter Tyser    /cpu		CPU specific files
1598d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1608d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1618d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1628d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1638d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
1678d321b81SPeter Tyser    /lib		Architecture specific library files
1688d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1698d321b81SPeter Tyser    /cpu		CPU specific files
17092bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
1716eae68e4SMasahiro Yamada      /mips64		Files specific to MIPS64 CPUs
1728d321b81SPeter Tyser    /lib		Architecture specific library files
173afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
174afc1ce82SMacpaul Lin    /cpu		CPU specific files
175afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
176afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1778d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1788d321b81SPeter Tyser    /cpu		CPU specific files
1798d321b81SPeter Tyser    /lib		Architecture specific library files
18033c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
18133c7731bSRobert P. J. Day    /cpu		CPU specific files
18233c7731bSRobert P. J. Day    /lib		Architecture specific library files
183a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1868d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1878d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1888d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1898d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1908d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1918d321b81SPeter Tyser    /lib		Architecture specific library files
1928d321b81SPeter Tyser  /sh			Files generic to SH architecture
1938d321b81SPeter Tyser    /cpu		CPU specific files
1948d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1958d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1968d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1978d321b81SPeter Tyser    /lib		Architecture specific library files
1988d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1998d321b81SPeter Tyser    /cpu		CPU specific files
2008d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2018d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2028d321b81SPeter Tyser    /lib		Architecture specific library files
20333c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20433c7731bSRobert P. J. Day    /cpu		CPU specific files
20533c7731bSRobert P. J. Day    /lib		Architecture specific library files
2068d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2078d321b81SPeter Tyser/board			Board dependent files
2088d321b81SPeter Tyser/common			Misc architecture independent functions
2098d321b81SPeter Tyser/disk			Code for disk drive partition handling
2108d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2118d321b81SPeter Tyser/drivers		Commonly used device drivers
21233c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2138d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2148d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2158d321b81SPeter Tyser/include		Header Files
2168d321b81SPeter Tyser/lib			Files generic to all architectures
2178d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2188d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2198d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2208d321b81SPeter Tyser/net			Networking code
2218d321b81SPeter Tyser/post			Power On Self Test
22233c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2238d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
224c609719bSwdenk
225c609719bSwdenkSoftware Configuration:
226c609719bSwdenk=======================
227c609719bSwdenk
228c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
229c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
230c609719bSwdenk
231c609719bSwdenkThere are two classes of configuration variables:
232c609719bSwdenk
233c609719bSwdenk* Configuration _OPTIONS_:
234c609719bSwdenk  These are selectable by the user and have names beginning with
235c609719bSwdenk  "CONFIG_".
236c609719bSwdenk
237c609719bSwdenk* Configuration _SETTINGS_:
238c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
239c609719bSwdenk  you don't know what you're doing; they have names beginning with
2406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
241c609719bSwdenk
242c609719bSwdenkLater we will add a configuration tool - probably similar to or even
243c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
244c609719bSwdenkdo the configuration by hand, which means creating some symbolic
245c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
246c609719bSwdenkas an example here.
247c609719bSwdenk
248c609719bSwdenk
249c609719bSwdenkSelection of Processor Architecture and Board Type:
250c609719bSwdenk---------------------------------------------------
251c609719bSwdenk
252c609719bSwdenkFor all supported boards there are ready-to-use default
253ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
254c609719bSwdenk
255c609719bSwdenkExample: For a TQM823L module type:
256c609719bSwdenk
257c609719bSwdenk	cd u-boot
258ab584d67SHolger Freyther	make TQM823L_defconfig
259c609719bSwdenk
26011ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
261ab584d67SHolger Freythere.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
262c609719bSwdenkdirectory according to the instructions in cogent/README.
263c609719bSwdenk
264c609719bSwdenk
26575b3c3aaSSimon GlassSandbox Environment:
26675b3c3aaSSimon Glass--------------------
26775b3c3aaSSimon Glass
26875b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
26975b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
27075b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
27175b3c3aaSSimon Glassrun some of U-Boot's tests.
27275b3c3aaSSimon Glass
2736b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
27475b3c3aaSSimon Glass
27575b3c3aaSSimon Glass
276*db910353SSimon GlassBoard Initialisation Flow:
277*db910353SSimon Glass--------------------------
278*db910353SSimon Glass
279*db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both
280*db910353SSimon GlassSPL and U-Boot proper (i.e. they both follow the same rules). At present SPL
281*db910353SSimon Glassmostly uses a separate code path, but the funtion names and roles of each
282*db910353SSimon Glassfunction are the same. Some boards or architectures may not conform to this.
283*db910353SSimon GlassAt least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this.
284*db910353SSimon Glass
285*db910353SSimon GlassExecution starts with start.S with three functions called during init after
286*db910353SSimon Glassthat. The purpose and limitations of each is described below.
287*db910353SSimon Glass
288*db910353SSimon Glasslowlevel_init():
289*db910353SSimon Glass	- purpose: essential init to permit execution to reach board_init_f()
290*db910353SSimon Glass	- no global_data or BSS
291*db910353SSimon Glass	- there is no stack (ARMv7 may have one but it will soon be removed)
292*db910353SSimon Glass	- must not set up SDRAM or use console
293*db910353SSimon Glass	- must only do the bare minimum to allow execution to continue to
294*db910353SSimon Glass		board_init_f()
295*db910353SSimon Glass	- this is almost never needed
296*db910353SSimon Glass	- return normally from this function
297*db910353SSimon Glass
298*db910353SSimon Glassboard_init_f():
299*db910353SSimon Glass	- purpose: set up the machine ready for running board_init_r():
300*db910353SSimon Glass		i.e. SDRAM and serial UART
301*db910353SSimon Glass	- global_data is available
302*db910353SSimon Glass	- stack is in SRAM
303*db910353SSimon Glass	- BSS is not available, so you cannot use global/static variables,
304*db910353SSimon Glass		only stack variables and global_data
305*db910353SSimon Glass
306*db910353SSimon Glass	Non-SPL-specific notes:
307*db910353SSimon Glass	- dram_init() is called to set up DRAM. If already done in SPL this
308*db910353SSimon Glass		can do nothing
309*db910353SSimon Glass
310*db910353SSimon Glass	SPL-specific notes:
311*db910353SSimon Glass	- you can override the entire board_init_f() function with your own
312*db910353SSimon Glass		version as needed.
313*db910353SSimon Glass	- preloader_console_init() can be called here in extremis
314*db910353SSimon Glass	- should set up SDRAM, and anything needed to make the UART work
315*db910353SSimon Glass	- these is no need to clear BSS, it will be done by crt0.S
316*db910353SSimon Glass	- must return normally from this function (don't call board_init_r()
317*db910353SSimon Glass		directly)
318*db910353SSimon Glass
319*db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
320*db910353SSimon Glassthis point the stack and global_data are relocated to below
321*db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
322*db910353SSimon Glassmemory.
323*db910353SSimon Glass
324*db910353SSimon Glassboard_init_r():
325*db910353SSimon Glass	- purpose: main execution, common code
326*db910353SSimon Glass	- global_data is available
327*db910353SSimon Glass	- SDRAM is available
328*db910353SSimon Glass	- BSS is available, all static/global variables can be used
329*db910353SSimon Glass	- execution eventually continues to main_loop()
330*db910353SSimon Glass
331*db910353SSimon Glass	Non-SPL-specific notes:
332*db910353SSimon Glass	- U-Boot is relocated to the top of memory and is now running from
333*db910353SSimon Glass		there.
334*db910353SSimon Glass
335*db910353SSimon Glass	SPL-specific notes:
336*db910353SSimon Glass	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
337*db910353SSimon Glass		CONFIG_SPL_STACK_R_ADDR points into SDRAM
338*db910353SSimon Glass	- preloader_console_init() can be called here - typically this is
339*db910353SSimon Glass		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
340*db910353SSimon Glass		spl_board_init() function containing this call
341*db910353SSimon Glass	- loads U-Boot or (in falcon mode) Linux
342*db910353SSimon Glass
343*db910353SSimon Glass
344*db910353SSimon Glass
345c609719bSwdenkConfiguration Options:
346c609719bSwdenk----------------------
347c609719bSwdenk
348c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
349c609719bSwdenksuch information is kept in a configuration file
350c609719bSwdenk"include/configs/<board_name>.h".
351c609719bSwdenk
352c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
353c609719bSwdenk"include/configs/TQM823L.h".
354c609719bSwdenk
355c609719bSwdenk
3567f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
3577f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
3587f6c2cbcSwdenkbuild a config tool - later.
3597f6c2cbcSwdenk
3607f6c2cbcSwdenk
361c609719bSwdenkThe following options need to be configured:
362c609719bSwdenk
3632628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
364c609719bSwdenk
3652628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
3666ccec449SWolfgang Denk
3676ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
36809ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
369c609719bSwdenk
370c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
371c609719bSwdenk		Define exactly one of
372c609719bSwdenk		CONFIG_CMA286_60_OLD
373c609719bSwdenk--- FIXME --- not tested yet:
374c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
375c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
376c609719bSwdenk
377c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
378c609719bSwdenk		Define exactly one of
379c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
380c609719bSwdenk
381c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
382c609719bSwdenk		Define one or more of
383c609719bSwdenk		CONFIG_CMA302
384c609719bSwdenk
385c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
386c609719bSwdenk		Define one or more of
387c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
38811ccc33fSMarcel Ziswiler					  the LCD display every second with
389c609719bSwdenk					  a "rotator" |\-/|\-/
390c609719bSwdenk
391cf946c6dSLei Wen- Marvell Family Member
392cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
393cf946c6dSLei Wen					  multiple fs option at one time
394cf946c6dSLei Wen					  for marvell soc family
395cf946c6dSLei Wen
39611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
39766ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
39866ca92a5Swdenk					  get_gclk_freq() cannot work
3995da627a4Swdenk					  e.g. if there is no 32KHz
4005da627a4Swdenk					  reference PIT/RTC clock
40166ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
40266ca92a5Swdenk					  or XTAL/EXTAL)
403c609719bSwdenk
40466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
4056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
4066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
40766ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
40875d1ea7fSwdenk			See doc/README.MPC866
40975d1ea7fSwdenk
4106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
41175d1ea7fSwdenk
41275d1ea7fSwdenk		Define this to measure the actual CPU clock instead
41375d1ea7fSwdenk		of relying on the correctness of the configured
41475d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
41575d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
41675d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
4176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
41875d1ea7fSwdenk
419506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
420506f3918SHeiko Schocher
421506f3918SHeiko Schocher		Define this option if you want to enable the
422506f3918SHeiko Schocher		ICache only when Code runs from RAM.
423506f3918SHeiko Schocher
42466412c63SKumar Gala- 85xx CPU Options:
425ffd06e02SYork Sun		CONFIG_SYS_PPC64
426ffd06e02SYork Sun
427ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
428ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
429ffd06e02SYork Sun		compliance, among other possible reasons.
430ffd06e02SYork Sun
43166412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
43266412c63SKumar Gala
43366412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
43466412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
43566412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
43666412c63SKumar Gala
4378f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
4388f29084aSKumar Gala
4398f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
4408f29084aSKumar Gala		tree nodes for the given platform.
4418f29084aSKumar Gala
442afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
443afa6b551SPrabhakar Kushwaha
444afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
445afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
446afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
447afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
448afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
449afa6b551SPrabhakar Kushwaha		purpose.
450afa6b551SPrabhakar Kushwaha
45133eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
45233eee330SScott Wood
45333eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
45433eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
45533eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
45633eee330SScott Wood
45733eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
45833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
45933eee330SScott Wood
46033eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
46133eee330SScott Wood		for which the A004510 workaround should be applied.
46233eee330SScott Wood
46333eee330SScott Wood		The rest of SVR is either not relevant to the decision
46433eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
46533eee330SScott Wood		p2041) or is implied by the build target, which controls
46633eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
46733eee330SScott Wood
46833eee330SScott Wood		See Freescale App Note 4493 for more information about
46933eee330SScott Wood		this erratum.
47033eee330SScott Wood
47174fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
47274fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
473b445bbb4SJeremiah Mahler		required during NOR boot.
47474fa22edSPrabhakar Kushwaha
4759f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
4769f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
477b445bbb4SJeremiah Mahler		required during NAND boot and valid for Rev 1.0 SoC revision
4789f074e67SPrabhakar Kushwaha
47933eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
48033eee330SScott Wood
48133eee330SScott Wood		This is the value to write into CCSR offset 0x18600
48233eee330SScott Wood		according to the A004510 workaround.
48333eee330SScott Wood
48464501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
48564501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
48664501c66SPriyanka Jain		connected exclusively to the DSP cores.
48764501c66SPriyanka Jain
488765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
489765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
490765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
491765b0bdbSPriyanka Jain
49264501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
49364501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
49464501c66SPriyanka Jain		connected to the DSP core.
49564501c66SPriyanka Jain
496765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
497765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
498765b0bdbSPriyanka Jain
499b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
500b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
501b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
502b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
503b135991aSPriyanka Jain
504fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
505fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
506fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
507fb4a2409SAneesh Bansal
508aade2004STang Yuantian		CONFIG_DEEP_SLEEP
509b445bbb4SJeremiah Mahler		Indicates this SoC supports deep sleep feature. If deep sleep is
510aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
511aade2004STang Yuantian
5126cb461b4SDaniel Schwierzeck- Generic CPU options:
5132a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
5142a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
5152a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
5162a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
5172a1680e3SYork Sun		should initialize global data before calling board_init_f().
5182a1680e3SYork Sun
5196cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
5206cb461b4SDaniel Schwierzeck
5216cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
5226cb461b4SDaniel Schwierzeck		values is arch specific.
5236cb461b4SDaniel Schwierzeck
5245614e71bSYork Sun		CONFIG_SYS_FSL_DDR
5255614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
5265614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
5275614e71bSYork Sun		SoCs.
5285614e71bSYork Sun
5295614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
5305614e71bSYork Sun		Freescale DDR memory-mapped register base.
5315614e71bSYork Sun
5325614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
5335614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
5345614e71bSYork Sun		deskew training are not available.
5355614e71bSYork Sun
5365614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
5375614e71bSYork Sun		Freescale DDR1 controller.
5385614e71bSYork Sun
5395614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
5405614e71bSYork Sun		Freescale DDR2 controller.
5415614e71bSYork Sun
5425614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
5435614e71bSYork Sun		Freescale DDR3 controller.
5445614e71bSYork Sun
54534e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
54634e026f9SYork Sun		Freescale DDR4 controller.
54734e026f9SYork Sun
5489ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
5499ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
5509ac4ffbdSYork Sun
5515614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
5525614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
5535614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
5545614e71bSYork Sun		implemetation.
5555614e71bSYork Sun
5565614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
5575614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
5585614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
5595614e71bSYork Sun		implementation.
5605614e71bSYork Sun
5615614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
5625614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
56334e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
56434e026f9SYork Sun
56534e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
56634e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
56734e026f9SYork Sun		DDR3L controllers.
56834e026f9SYork Sun
56934e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
57034e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
57134e026f9SYork Sun		DDR4 controllers.
5725614e71bSYork Sun
5731b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5741b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5751b4175d6SPrabhakar Kushwaha
5761b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5771b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5781b4175d6SPrabhakar Kushwaha
579690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
580690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
581690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
582690e4258SPrabhakar Kushwaha
583690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
584690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
585690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
586690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
587690e4258SPrabhakar Kushwaha
58889ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
58989ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
59089ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
59189ad7be8SPrabhakar Kushwaha
5924e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5934e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5944e5b1bd0SYork Sun
5954e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5964e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5974e5b1bd0SYork Sun
5986b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5996b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
6006b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
6016b9e309aSYork Sun		it could be different for ARM SoCs.
6026b9e309aSYork Sun
6036b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
6046b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
6056b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
6066b1e1254SYork Sun		SoCs with ARM core.
6076b1e1254SYork Sun
6081d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
6091d71efbbSYork Sun		Number of controllers used as main memory.
6101d71efbbSYork Sun
6111d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
6121d71efbbSYork Sun		Number of controllers used for other than main memory.
6131d71efbbSYork Sun
614028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
615028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
616028dbb8dSRuchika Gupta
617028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
618028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
619028dbb8dSRuchika Gupta
6200b953ffcSMarkus Klotzbuecher- Intel Monahans options:
6216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
6220b953ffcSMarkus Klotzbuecher
6230b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
6240b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
6250b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
6260b953ffcSMarkus Klotzbuecher
6276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
6280b953ffcSMarkus Klotzbuecher
6290b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
6300b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
6310b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
6320b953ffcSMarkus Klotzbuecher		by this value.
6330b953ffcSMarkus Klotzbuecher
63492bbd64eSDaniel Schwierzeck- MIPS CPU options:
63592bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
63692bbd64eSDaniel Schwierzeck
63792bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
63892bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
63992bbd64eSDaniel Schwierzeck		relocation.
64092bbd64eSDaniel Schwierzeck
64192bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
64292bbd64eSDaniel Schwierzeck
64392bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
64492bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
64592bbd64eSDaniel Schwierzeck		Possible values are:
64692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
64792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
64892bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
64992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
65092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
65192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
65292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
65392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
65492bbd64eSDaniel Schwierzeck
65592bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
65692bbd64eSDaniel Schwierzeck
65792bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
65892bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
65992bbd64eSDaniel Schwierzeck
66092bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
66192bbd64eSDaniel Schwierzeck
66292bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
66392bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
66492bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
66592bbd64eSDaniel Schwierzeck
666b67d8816SChristian Riesch- ARM options:
667b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
668b67d8816SChristian Riesch
669b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
670b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
671b67d8816SChristian Riesch
6725356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
6735356f545SAneesh V
6745356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6755356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6765356f545SAneesh V		better code density. For ARM architectures that support
6775356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6785356f545SAneesh V		GCC.
6795356f545SAneesh V
680c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6810678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6820678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6830678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
684f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
685b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
6860678587fSStephen Warren
6870678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6880678587fSStephen Warren		during U-Boot startup. Note that these options force the
6890678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6900678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6910678587fSStephen Warren		set these options unless they apply!
6920678587fSStephen Warren
69338687ae6SSimon Glass- Driver Model
69438687ae6SSimon Glass		Driver model is a new framework for devices in U-Boot
69538687ae6SSimon Glass		introduced in early 2014. U-Boot is being progressively
69638687ae6SSimon Glass		moved over to this. It offers a consistent device structure,
69738687ae6SSimon Glass		supports grouping devices into classes and has built-in
69838687ae6SSimon Glass		handling of platform data and device tree.
69938687ae6SSimon Glass
70038687ae6SSimon Glass		To enable transition to driver model in a relatively
70138687ae6SSimon Glass		painful fashion, each subsystem can be independently
70238687ae6SSimon Glass		switched between the legacy/ad-hoc approach and the new
70338687ae6SSimon Glass		driver model using the options below. Also, many uclass
70438687ae6SSimon Glass		interfaces include compatibility features which may be
70538687ae6SSimon Glass		removed once the conversion of that subsystem is complete.
70638687ae6SSimon Glass		As a result, the API provided by the subsystem may in fact
70738687ae6SSimon Glass		not change with driver model.
70838687ae6SSimon Glass
70938687ae6SSimon Glass		See doc/driver-model/README.txt for more information.
71038687ae6SSimon Glass
71138687ae6SSimon Glass		CONFIG_DM
71238687ae6SSimon Glass
71338687ae6SSimon Glass		Enable driver model. This brings in the core support,
71438687ae6SSimon Glass		including scanning of platform data on start-up. If
71538687ae6SSimon Glass		CONFIG_OF_CONTROL is enabled, the device tree will be
71638687ae6SSimon Glass		scanned also when available.
71738687ae6SSimon Glass
71838687ae6SSimon Glass		CONFIG_CMD_DM
71938687ae6SSimon Glass
72038687ae6SSimon Glass		Enable driver model test commands. These allow you to print
72138687ae6SSimon Glass		out the driver model tree and the uclasses.
72238687ae6SSimon Glass
72338687ae6SSimon Glass		CONFIG_DM_DEMO
72438687ae6SSimon Glass
72538687ae6SSimon Glass		Enable some demo devices and the 'demo' command. These are
72638687ae6SSimon Glass		really only useful for playing around while trying to
72738687ae6SSimon Glass		understand driver model in sandbox.
72838687ae6SSimon Glass
72938687ae6SSimon Glass		CONFIG_SPL_DM
73038687ae6SSimon Glass
73138687ae6SSimon Glass		Enable driver model in SPL. You will need to provide a
73238687ae6SSimon Glass		suitable malloc() implementation. If you are not using the
73338687ae6SSimon Glass		full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
73438687ae6SSimon Glass		consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
73538687ae6SSimon Glass		must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
73638687ae6SSimon Glass		In most cases driver model will only allocate a few uclasses
73738687ae6SSimon Glass		and devices in SPL, so 1KB should be enable. See
73838687ae6SSimon Glass		CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
73938687ae6SSimon Glass		it.
74038687ae6SSimon Glass
74138687ae6SSimon Glass		CONFIG_DM_SERIAL
74238687ae6SSimon Glass
74338687ae6SSimon Glass		Enable driver model for serial. This replaces
74438687ae6SSimon Glass		drivers/serial/serial.c with the serial uclass, which
74538687ae6SSimon Glass		implements serial_putc() etc. The uclass interface is
74638687ae6SSimon Glass		defined in include/serial.h.
74738687ae6SSimon Glass
74838687ae6SSimon Glass		CONFIG_DM_GPIO
74938687ae6SSimon Glass
75038687ae6SSimon Glass		Enable driver model for GPIO access. The standard GPIO
75138687ae6SSimon Glass		interface (gpio_get_value(), etc.) is then implemented by
75238687ae6SSimon Glass		the GPIO uclass. Drivers provide methods to query the
75338687ae6SSimon Glass		particular GPIOs that they provide. The uclass interface
75438687ae6SSimon Glass		is defined in include/asm-generic/gpio.h.
75538687ae6SSimon Glass
75638687ae6SSimon Glass		CONFIG_DM_SPI
75738687ae6SSimon Glass
75838687ae6SSimon Glass		Enable driver model for SPI. The SPI slave interface
75938687ae6SSimon Glass		(spi_setup_slave(), spi_xfer(), etc.) is then implemented by
76038687ae6SSimon Glass		the SPI uclass. Drivers provide methods to access the SPI
76138687ae6SSimon Glass		buses that they control. The uclass interface is defined in
76238687ae6SSimon Glass		include/spi.h. The existing spi_slave structure is attached
76338687ae6SSimon Glass		as 'parent data' to every slave on each bus. Slaves
76438687ae6SSimon Glass		typically use driver-private data instead of extending the
76538687ae6SSimon Glass		spi_slave structure.
76638687ae6SSimon Glass
76738687ae6SSimon Glass		CONFIG_DM_SPI_FLASH
76838687ae6SSimon Glass
76938687ae6SSimon Glass		Enable driver model for SPI flash. This SPI flash interface
77038687ae6SSimon Glass		(spi_flash_probe(), spi_flash_write(), etc.) is then
77138687ae6SSimon Glass		implemented by the SPI flash uclass. There is one standard
77238687ae6SSimon Glass		SPI flash driver which knows how to probe most chips
77338687ae6SSimon Glass		supported by U-Boot. The uclass interface is defined in
77438687ae6SSimon Glass		include/spi_flash.h, but is currently fully compatible
77538687ae6SSimon Glass		with the old interface to avoid confusion and duplication
77638687ae6SSimon Glass		during the transition parent. SPI and SPI flash must be
77738687ae6SSimon Glass		enabled together (it is not possible to use driver model
77838687ae6SSimon Glass		for one and not the other).
77938687ae6SSimon Glass
78038687ae6SSimon Glass		CONFIG_DM_CROS_EC
78138687ae6SSimon Glass
78238687ae6SSimon Glass		Enable driver model for the Chrome OS EC interface. This
78338687ae6SSimon Glass		allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
78438687ae6SSimon Glass		but otherwise makes few changes. Since cros_ec also supports
78538687ae6SSimon Glass		I2C and LPC (which don't support driver model yet), a full
78638687ae6SSimon Glass		conversion is not yet possible.
78738687ae6SSimon Glass
78838687ae6SSimon Glass
78938687ae6SSimon Glass		** Code size options: The following options are enabled by
79038687ae6SSimon Glass		default except in SPL. Enable them explicitly to get these
79138687ae6SSimon Glass		features in SPL.
79238687ae6SSimon Glass
79338687ae6SSimon Glass		CONFIG_DM_WARN
79438687ae6SSimon Glass
79538687ae6SSimon Glass		Enable the dm_warn() function. This can use up quite a bit
79638687ae6SSimon Glass		of space for its strings.
79738687ae6SSimon Glass
79838687ae6SSimon Glass		CONFIG_DM_STDIO
79938687ae6SSimon Glass
80038687ae6SSimon Glass		Enable registering a serial device with the stdio library.
80138687ae6SSimon Glass
80238687ae6SSimon Glass		CONFIG_DM_DEVICE_REMOVE
80338687ae6SSimon Glass
80438687ae6SSimon Glass		Enable removing of devices.
80538687ae6SSimon Glass
80638687ae6SSimon Glass
8075da627a4Swdenk- Linux Kernel Interface:
808c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
809c609719bSwdenk
810c609719bSwdenk		U-Boot stores all clock information in Hz
811c609719bSwdenk		internally. For binary compatibility with older Linux
812c609719bSwdenk		kernels (which expect the clocks passed in the
813c609719bSwdenk		bd_info data to be in MHz) the environment variable
814c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
815c609719bSwdenk		converts clock data to MHZ before passing it to the
816c609719bSwdenk		Linux kernel.
817c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
818c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
819c609719bSwdenk		default environment.
820c609719bSwdenk
8215da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
8225da627a4Swdenk
823b445bbb4SJeremiah Mahler		When transferring memsize parameter to Linux, some versions
8245da627a4Swdenk		expect it to be in bytes, others in MB.
8255da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
8265da627a4Swdenk
827fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
828f57f70aaSWolfgang Denk
829f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
830213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
831213bf8c8SGerald Van Baren		concepts).
832213bf8c8SGerald Van Baren
833213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
834213bf8c8SGerald Van Baren		 * New libfdt-based support
835213bf8c8SGerald Van Baren		 * Adds the "fdt" command
8363bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
837213bf8c8SGerald Van Baren
838b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
839b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
840b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
841b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
842f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
843c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
844f57f70aaSWolfgang Denk
84511ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
84611ccc33fSMarcel Ziswiler		addresses
8473bb342fcSKim Phillips
8484e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
8494e253137SKumar Gala
8504e253137SKumar Gala		Board code has addition modification that it wants to make
8514e253137SKumar Gala		to the flat device tree before handing it off to the kernel
8526705d81eSwdenk
853c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
854c654b517SSimon Glass
855c654b517SSimon Glass		Other code has addition modification that it wants to make
856c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
857c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
858c654b517SSimon Glass		the kernel.
859c654b517SSimon Glass
8600267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
8610267768eSMatthew McClintock
86211ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
8630267768eSMatthew McClintock		param header, the default value is zero if undefined.
8640267768eSMatthew McClintock
8653887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
8663887c3fbSHeiko Schocher
8673887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
8683887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
8693887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
8703887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
8713887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
8723887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
8733887c3fbSHeiko Schocher
8747eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
8757eb29398SIgor Grinberg
8767eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
8777eb29398SIgor Grinberg		machine type and must be used to specify the machine type
8787eb29398SIgor Grinberg		number as it appears in the ARM machine registry
8797eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
8807eb29398SIgor Grinberg		Only boards that have multiple machine types supported
8817eb29398SIgor Grinberg		in a single configuration file and the machine type is
8827eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
8837eb29398SIgor Grinberg
8840b2f4ecaSNiklaus Giger- vxWorks boot parameters:
8850b2f4ecaSNiklaus Giger
8860b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
8870b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
8880b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
8890b2f4ecaSNiklaus Giger
8900b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
8910b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
8920b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
8930b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
8940b2f4ecaSNiklaus Giger
8950b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
8960b2f4ecaSNiklaus Giger
8970b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
8980b2f4ecaSNiklaus Giger
8990b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
9000b2f4ecaSNiklaus Giger		the defaults discussed just above.
9010b2f4ecaSNiklaus Giger
9022c451f78SAneesh V- Cache Configuration:
9032c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
9042c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
9052c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
9062c451f78SAneesh V
90793bc2193SAneesh V- Cache Configuration for ARM:
90893bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
90993bc2193SAneesh V				      controller
91093bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
91193bc2193SAneesh V					controller register space
91293bc2193SAneesh V
9136705d81eSwdenk- Serial Ports:
91448d0192fSAndreas Engel		CONFIG_PL010_SERIAL
9156705d81eSwdenk
9166705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
9176705d81eSwdenk
91848d0192fSAndreas Engel		CONFIG_PL011_SERIAL
9196705d81eSwdenk
9206705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
9216705d81eSwdenk
9226705d81eSwdenk		CONFIG_PL011_CLOCK
9236705d81eSwdenk
9246705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
9256705d81eSwdenk		the clock speed of the UARTs.
9266705d81eSwdenk
9276705d81eSwdenk		CONFIG_PL01x_PORTS
9286705d81eSwdenk
9296705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
9306705d81eSwdenk		define this to a list of base addresses for each (supported)
9316705d81eSwdenk		port. See e.g. include/configs/versatile.h
9326705d81eSwdenk
933910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
934910f1ae3SJohn Rigby
935910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
936910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
937910f1ae3SJohn Rigby		this variable to initialize the extra register.
938910f1ae3SJohn Rigby
939910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
940910f1ae3SJohn Rigby
941910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
942910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
943910f1ae3SJohn Rigby		variable to flush the UART at init time.
944910f1ae3SJohn Rigby
945d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
946d57dee57SKaricheri, Muralidharan
947d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
948d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
9496705d81eSwdenk
950c609719bSwdenk- Console Interface:
951c609719bSwdenk		Depending on board, define exactly one serial port
952c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
953c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
954c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
955c609719bSwdenk
956c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
957c609719bSwdenk		port routines must be defined elsewhere
958c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
959c609719bSwdenk
960c609719bSwdenk		CONFIG_CFB_CONSOLE
961c609719bSwdenk		Enables console device for a color framebuffer. Needs following
962c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
963c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
964c609719bSwdenk						(default big endian)
965c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
966c609719bSwdenk						rectangle fill
967c609719bSwdenk						(cf. smiLynxEM)
968c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
969c609719bSwdenk						bit-blit (cf. smiLynxEM)
970c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
971c609719bSwdenk						(cols=pitch)
972c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
973c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
974c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
975c609719bSwdenk						(0-5, cf. cfb_console.c)
976c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
977c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
978c609719bSwdenk						(i.e. i8042_kbd_init())
979c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
980c609719bSwdenk						(i.e. i8042_tstc)
981c609719bSwdenk			VIDEO_GETC_FCT		get char fct
982c609719bSwdenk						(i.e. i8042_getc)
983c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
984c609719bSwdenk						(requires blink timer
985c609719bSwdenk						cf. i8042.c)
9866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
987c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
988c609719bSwdenk						upper right corner
989602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
990c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
991c609719bSwdenk						upper left corner
992a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
993a6c7ad2fSwdenk						linux_logo.h for logo.
994a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
995c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
99611ccc33fSMarcel Ziswiler						additional board info beside
997c609719bSwdenk						the logo
998c609719bSwdenk
99933a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
100033a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
100133a35bbbSPali Rohár		erase functions and limited graphics rendition control).
100233a35bbbSPali Rohár
1003c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
1004c609719bSwdenk		default i/o. Serial console can be forced with
1005c609719bSwdenk		environment 'console=serial'.
1006c609719bSwdenk
1007a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
1008a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
1009a3ad8e26Swdenk		the "silent" environment variable. See
1010a3ad8e26Swdenk		doc/README.silent for more information.
1011a3ad8e26Swdenk
101245ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
101345ae2546SHeiko Schocher			is 0x00.
101445ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
101545ae2546SHeiko Schocher			is 0xa0.
101645ae2546SHeiko Schocher
1017c609719bSwdenk- Console Baudrate:
1018c609719bSwdenk		CONFIG_BAUDRATE - in bps
1019c609719bSwdenk		Select one of the baudrates listed in
10206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
10216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
1022c609719bSwdenk
1023c92fac91SHeiko Schocher- Console Rx buffer length
1024c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
1025c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
10262b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
1027c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
1028c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
1029c92fac91SHeiko Schocher		the SMC.
1030c92fac91SHeiko Schocher
10319558b48aSGraeme Russ- Pre-Console Buffer:
10329558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
10339558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
10349558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
10359558b48aSGraeme Russ		buffer any console messages prior to the console being
10369558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
10379558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
10389558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
10399558b48aSGraeme Russ		bytes are output before the console is initialised, the
10409558b48aSGraeme Russ		earlier bytes are discarded.
10419558b48aSGraeme Russ
10429558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
10439558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
10449558b48aSGraeme Russ
1045046a37bdSSonny Rao- Safe printf() functions
1046046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
1047046a37bdSSonny Rao		the printf() functions. These are defined in
1048046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
1049046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
1050046a37bdSSonny Rao		If this option is not given then these functions will
1051046a37bdSSonny Rao		silently discard their buffer size argument - this means
1052046a37bdSSonny Rao		you are not getting any overflow checking in this case.
1053046a37bdSSonny Rao
1054c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
1055c609719bSwdenk		Delay before automatically booting the default image;
1056c609719bSwdenk		set to -1 to disable autoboot.
105793d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
105893d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
1059c609719bSwdenk
1060c609719bSwdenk		See doc/README.autoboot for these options that
1061c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
1062c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
1063c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
1064c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
1065c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
1066c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
1067c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
1068c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
1069c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
1070c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
1071c609719bSwdenk		CONFIG_RESET_TO_RETRY
1072c609719bSwdenk
1073c609719bSwdenk- Autoboot Command:
1074c609719bSwdenk		CONFIG_BOOTCOMMAND
1075c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
1076c609719bSwdenk		define a command string that is automatically executed
1077c609719bSwdenk		when no character is read on the console interface
1078c609719bSwdenk		within "Boot Delay" after reset.
1079c609719bSwdenk
1080c609719bSwdenk		CONFIG_BOOTARGS
1081c609719bSwdenk		This can be used to pass arguments to the bootm
1082c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
1083c609719bSwdenk		environment value "bootargs".
1084c609719bSwdenk
1085c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
1086c609719bSwdenk		The value of these goes into the environment as
1087c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
1088c609719bSwdenk		as a convenience, when switching between booting from
108911ccc33fSMarcel Ziswiler		RAM and NFS.
1090c609719bSwdenk
1091eda0ba38SHeiko Schocher- Bootcount:
1092eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
1093eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
1094eda0ba38SHeiko Schocher		cycle, see:
1095eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1096eda0ba38SHeiko Schocher
1097eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
1098eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
1099eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
1100eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
1101eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
1102eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
1103eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
1104eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
1105eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
1106eda0ba38SHeiko Schocher
1107c609719bSwdenk- Pre-Boot Commands:
1108c609719bSwdenk		CONFIG_PREBOOT
1109c609719bSwdenk
1110c609719bSwdenk		When this option is #defined, the existence of the
1111c609719bSwdenk		environment variable "preboot" will be checked
1112c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
1113c609719bSwdenk		countdown and/or running the auto-boot command resp.
1114c609719bSwdenk		entering interactive mode.
1115c609719bSwdenk
1116c609719bSwdenk		This feature is especially useful when "preboot" is
1117c609719bSwdenk		automatically generated or modified. For an example
1118c609719bSwdenk		see the LWMON board specific code: here "preboot" is
1119c609719bSwdenk		modified when the user holds down a certain
1120c609719bSwdenk		combination of keys on the (special) keyboard when
1121c609719bSwdenk		booting the systems
1122c609719bSwdenk
1123c609719bSwdenk- Serial Download Echo Mode:
1124c609719bSwdenk		CONFIG_LOADS_ECHO
1125c609719bSwdenk		If defined to 1, all characters received during a
1126c609719bSwdenk		serial download (using the "loads" command) are
1127c609719bSwdenk		echoed back. This might be needed by some terminal
1128c609719bSwdenk		emulations (like "cu"), but may as well just take
1129c609719bSwdenk		time on others. This setting #define's the initial
1130c609719bSwdenk		value of the "loads_echo" environment variable.
1131c609719bSwdenk
1132602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
1133c609719bSwdenk		CONFIG_KGDB_BAUDRATE
1134c609719bSwdenk		Select one of the baudrates listed in
11356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
1136c609719bSwdenk
1137c609719bSwdenk- Monitor Functions:
1138602ad3b3SJon Loeliger		Monitor commands can be included or excluded
1139602ad3b3SJon Loeliger		from the build by using the #include files
1140c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
1141c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
1142602ad3b3SJon Loeliger		and augmenting with additional #define's
1143602ad3b3SJon Loeliger		for wanted commands.
1144c609719bSwdenk
1145602ad3b3SJon Loeliger		The default command configuration includes all commands
1146602ad3b3SJon Loeliger		except those marked below with a "*".
1147602ad3b3SJon Loeliger
1148b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
1149602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
1150602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
1151602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
1152602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
1153602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
1154602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
1155d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
1156602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
115708d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
1158602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
1159710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
1160602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
1161602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
1162602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
1163a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
1164a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
1165a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
1166a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
1167602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
1168602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
1169246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
1170602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
1171602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
11725e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
1173fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
117488733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
11750c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
117603e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
117703e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
117816f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
117916f4d933SStephen Warren					  that work for multiple fs types
118059e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
1181bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
1182602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
118303e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
1184602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
1185602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
11864d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
118753fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1188a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1189a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1190bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1191602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
1192602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1193602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1194602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
11958fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
11964d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1197602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
1198aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
11990c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1200c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1201602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1202602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1203602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1204602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
12054d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1206d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1207d22c338eSJoe Hershberger					  (169.254.*.*)
1208602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1209602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
12104d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
121102c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
121215a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1213602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1214a2681707SWolfgang Denk					  loop, loopw
12154d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1216602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1217602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1218602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
121968d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1220602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1221602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
12224d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1223e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1224e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1225602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1226602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1227602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1228602ad3b3SJon Loeliger					  host
1229602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1230ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1231602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1232602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1233d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1234602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1235602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1236602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1237602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1238602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1239602ad3b3SJon Loeliger					  (4xx only)
1240f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
12414d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
124202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
12437d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
124474de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1245602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
12467a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
12471fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1248da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1249da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1250602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1251602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1252c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
12534d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
125489c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1255c609719bSwdenk
1256c609719bSwdenk		EXAMPLE: If you want all functions except of network
1257c609719bSwdenk		support you can write:
1258c609719bSwdenk
1259602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1260602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1261c609719bSwdenk
1262213bf8c8SGerald Van Baren	Other Commands:
1263213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1264c609719bSwdenk
1265c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1266602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1267c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1268c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1269c609719bSwdenk		8260 (where accesses to the IMMR region must be
1270c609719bSwdenk		uncached), and it cannot be disabled on all other
1271c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1272c609719bSwdenk		initial stack and some data.
1273c609719bSwdenk
1274c609719bSwdenk
1275c609719bSwdenk		XXX - this list needs to get updated!
1276c609719bSwdenk
1277a5ecbe62SWolfgang Denk- Regular expression support:
1278a5ecbe62SWolfgang Denk		CONFIG_REGEX
1279a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1280a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1281a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1282a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1283a5ecbe62SWolfgang Denk
128445ba8077SSimon Glass- Device tree:
128545ba8077SSimon Glass		CONFIG_OF_CONTROL
128645ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
128745ba8077SSimon Glass		to configure its devices, instead of relying on statically
128845ba8077SSimon Glass		compiled #defines in the board file. This option is
128945ba8077SSimon Glass		experimental and only available on a few boards. The device
129045ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
129145ba8077SSimon Glass
12922c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
12932c0f79e4SSimon Glass		be done using one of the two options below:
1294bbb0b128SSimon Glass
1295bbb0b128SSimon Glass		CONFIG_OF_EMBED
1296bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1297bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1298bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1299bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1300bbb0b128SSimon Glass		the global data structure as gd->blob.
130145ba8077SSimon Glass
13022c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
13032c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
13042c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
13052c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
13062c0f79e4SSimon Glass
13072c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
13082c0f79e4SSimon Glass
13092c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
13102c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
13112c0f79e4SSimon Glass		still use the individual files if you need something more
13122c0f79e4SSimon Glass		exotic.
13132c0f79e4SSimon Glass
1314c609719bSwdenk- Watchdog:
1315c609719bSwdenk		CONFIG_WATCHDOG
1316c609719bSwdenk		If this variable is defined, it enables watchdog
13176abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
13186abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
13196abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
13206abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
13216abe6fb6SDetlev Zundel		available, then no further board specific code should
13226abe6fb6SDetlev Zundel		be needed to use it.
13236abe6fb6SDetlev Zundel
13246abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
13256abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
13266abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
13276abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1328c609719bSwdenk
13297bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
13307bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
13317bae0d6fSHeiko Schocher
1332c1551ea8Sstroese- U-Boot Version:
1333c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1334c1551ea8Sstroese		If this variable is defined, an environment variable
1335c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1336c1551ea8Sstroese		version as printed by the "version" command.
1337a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1338a1ea8e51SBenoît Thébaudeau		next reset.
1339c1551ea8Sstroese
1340c609719bSwdenk- Real-Time Clock:
1341c609719bSwdenk
1342602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1343c609719bSwdenk		has to be selected, too. Define exactly one of the
1344c609719bSwdenk		following options:
1345c609719bSwdenk
1346c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1347c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
13484e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1349c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
13501cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1351c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
13527f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1353412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
13543bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
13559536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
13564c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
13576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
135871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
135971d19f30SHeiko Schocher					  RV3029 RTC.
1360c609719bSwdenk
1361b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1362b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1363b37c7e5eSwdenk
1364e92739d3SPeter Tyser- GPIO Support:
1365e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1366e92739d3SPeter Tyser
13675dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
13685dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
13695dec49caSChris Packham		pins supported by a particular chip.
13705dec49caSChris Packham
1371e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1372e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1373e92739d3SPeter Tyser
1374aa53233aSSimon Glass- I/O tracing:
1375aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1376aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1377aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1378aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1379aa53233aSSimon Glass		the driver behaves the same way before and after a code
1380aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1381aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1382aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1383aa53233aSSimon Glass
1384aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1385aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1386aa53233aSSimon Glass		still continue to operate.
1387aa53233aSSimon Glass
1388aa53233aSSimon Glass			iotrace is enabled
1389aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1390aa53233aSSimon Glass			Size:   00010000	(buffer size)
1391aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1392aa53233aSSimon Glass			Output: 10000120	(start + offset)
1393aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1394aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1395aa53233aSSimon Glass
1396c609719bSwdenk- Timestamp Support:
1397c609719bSwdenk
1398c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1399c609719bSwdenk		(date and time) of an image is printed by image
1400c609719bSwdenk		commands like bootm or iminfo. This option is
1401602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1402c609719bSwdenk
1403923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1404923c46f9SKarl O. Pinc		Zero or more of the following:
1405923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1406923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1407923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1408923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1409923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1410923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1411923c46f9SKarl O. Pinc				       disk/part_efi.c
1412923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1413c609719bSwdenk
1414602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1415218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1416923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1417c609719bSwdenk
1418c609719bSwdenk- IDE Reset method:
14194d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
14204d13cbadSwdenk		board configurations files but used nowhere!
1421c609719bSwdenk
14224d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
14234d13cbadSwdenk		be performed by calling the function
14244d13cbadSwdenk			ide_set_reset(int reset)
14254d13cbadSwdenk		which has to be defined in a board specific file
1426c609719bSwdenk
1427c609719bSwdenk- ATAPI Support:
1428c609719bSwdenk		CONFIG_ATAPI
1429c609719bSwdenk
1430c609719bSwdenk		Set this to enable ATAPI support.
1431c609719bSwdenk
1432c40b2956Swdenk- LBA48 Support
1433c40b2956Swdenk		CONFIG_LBA48
1434c40b2956Swdenk
1435c40b2956Swdenk		Set this to enable support for disks larger than 137GB
14364b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1437c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1438c40b2956Swdenk		support disks up to 2.1TB.
1439c40b2956Swdenk
14406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1441c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1442c40b2956Swdenk			Default is 32bit.
1443c40b2956Swdenk
1444c609719bSwdenk- SCSI Support:
1445c609719bSwdenk		At the moment only there is only support for the
1446c609719bSwdenk		SYM53C8XX SCSI controller; define
1447c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1448c609719bSwdenk
14496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
14506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
14516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1452c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1453c609719bSwdenk		devices.
14546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1455c609719bSwdenk
1456447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1457447c031bSStefan Reinauer		SCSI devices found during the last scan.
1458447c031bSStefan Reinauer
1459c609719bSwdenk- NETWORK Support (PCI):
1460682011ffSwdenk		CONFIG_E1000
1461ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1462ce5207e1SKyle Moffett
1463ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1464ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1465ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1466ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1467ce5207e1SKyle Moffett
1468ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1469ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1470ce5207e1SKyle Moffett		example with the "sspi" command.
1471ce5207e1SKyle Moffett
1472ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1473ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1474ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1475682011ffSwdenk
1476ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
147711ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1478ac3315c2SAndre Schwarz
1479c609719bSwdenk		CONFIG_EEPRO100
1480c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
148111ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1482c609719bSwdenk		write routine for first time initialisation.
1483c609719bSwdenk
1484c609719bSwdenk		CONFIG_TULIP
1485c609719bSwdenk		Support for Digital 2114x chips.
1486c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1487c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1488c609719bSwdenk
1489c609719bSwdenk		CONFIG_NATSEMI
1490c609719bSwdenk		Support for National dp83815 chips.
1491c609719bSwdenk
1492c609719bSwdenk		CONFIG_NS8382X
1493c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1494c609719bSwdenk
149545219c46Swdenk- NETWORK Support (other):
149645219c46Swdenk
1497c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1498c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1499c041e9d2SJens Scharsig
1500c041e9d2SJens Scharsig			CONFIG_RMII
1501c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1502c041e9d2SJens Scharsig
1503c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1504c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1505c041e9d2SJens Scharsig			The driver doen't show link status messages.
1506c041e9d2SJens Scharsig
1507efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1508efdd7319SRob Herring		Support for the Calxeda XGMAC device
1509efdd7319SRob Herring
15103bb46d23SAshok		CONFIG_LAN91C96
151145219c46Swdenk		Support for SMSC's LAN91C96 chips.
151245219c46Swdenk
151345219c46Swdenk			CONFIG_LAN91C96_BASE
151445219c46Swdenk			Define this to hold the physical address
151545219c46Swdenk			of the LAN91C96's I/O space
151645219c46Swdenk
151745219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
151845219c46Swdenk			Define this to enable 32 bit addressing
151945219c46Swdenk
15203bb46d23SAshok		CONFIG_SMC91111
1521f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1522f39748aeSwdenk
1523f39748aeSwdenk			CONFIG_SMC91111_BASE
1524f39748aeSwdenk			Define this to hold the physical address
1525f39748aeSwdenk			of the device (I/O space)
1526f39748aeSwdenk
1527f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1528f39748aeSwdenk			Define this if data bus is 32 bits
1529f39748aeSwdenk
1530f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1531f39748aeSwdenk			Define this to use i/o functions instead of macros
1532f39748aeSwdenk			(some hardware wont work with macros)
1533f39748aeSwdenk
1534dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1535dc02badaSHeiko Schocher		Support for davinci emac
1536dc02badaSHeiko Schocher
1537dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1538dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1539dc02badaSHeiko Schocher
1540b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1541b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1542b3dbf4a5SMacpaul Lin
1543b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1544b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1545b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1546b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1547b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1548b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1549b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1550b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1551b3dbf4a5SMacpaul Lin
1552c2fff331SMike Rapoport		CONFIG_SMC911X
1553557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1554557b377dSJens Gehrlein
1555c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1556557b377dSJens Gehrlein			Define this to hold the physical address
1557557b377dSJens Gehrlein			of the device (I/O space)
1558557b377dSJens Gehrlein
1559c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1560557b377dSJens Gehrlein			Define this if data bus is 32 bits
1561557b377dSJens Gehrlein
1562c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1563557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1564557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1565c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1566557b377dSJens Gehrlein
15673d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
15683d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
15693d0075faSYoshihiro Shimoda
15703d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
15713d0075faSYoshihiro Shimoda			Define the number of ports to be used
15723d0075faSYoshihiro Shimoda
15733d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
15743d0075faSYoshihiro Shimoda			Define the ETH PHY's address
15753d0075faSYoshihiro Shimoda
157668260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
157768260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
157868260aabSYoshihiro Shimoda
1579b2f97cf2SHeiko Schocher- PWM Support:
1580b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1581b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1582b2f97cf2SHeiko Schocher
15835e124724SVadim Bendebury- TPM Support:
158490899cc0SChe-liang Chiou		CONFIG_TPM
158590899cc0SChe-liang Chiou		Support TPM devices.
158690899cc0SChe-liang Chiou
15871b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
15881b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
15891b393db5STom Wai-Hong Tam		per system is supported at this time.
15901b393db5STom Wai-Hong Tam
15911b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
15921b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
15931b393db5STom Wai-Hong Tam
15941b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
15951b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
15961b393db5STom Wai-Hong Tam
15971b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
15981b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
15991b393db5STom Wai-Hong Tam
1600c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1601c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1602c01939c7SDirk Eibach
160390899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
16045e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
16055e124724SVadim Bendebury		per system is supported at this time.
16065e124724SVadim Bendebury
16075e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
16085e124724SVadim Bendebury			Base address where the generic TPM device is mapped
16095e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
16105e124724SVadim Bendebury			0xfed40000.
16115e124724SVadim Bendebury
1612be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1613be6c1529SReinhard Pfau		Add tpm monitor functions.
1614be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1615be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1616be6c1529SReinhard Pfau
1617be6c1529SReinhard Pfau		CONFIG_TPM
1618be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1619be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1620be6c1529SReinhard Pfau		Requires support for a TPM device.
1621be6c1529SReinhard Pfau
1622be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1623be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1624be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1625be6c1529SReinhard Pfau
1626c609719bSwdenk- USB Support:
1627c609719bSwdenk		At the moment only the UHCI host controller is
16284d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1629c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1630c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
163130d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1632c609719bSwdenk		storage devices.
1633c609719bSwdenk		Note:
1634c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1635c609719bSwdenk		(TEAC FD-05PUB).
16364d13cbadSwdenk		MPC5200 USB requires additional defines:
16374d13cbadSwdenk			CONFIG_USB_CLOCK
16384d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1639307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1640307ecb6dSEric Millbrandt				for USB on PSC3
16414d13cbadSwdenk			CONFIG_USB_CONFIG
16424d13cbadSwdenk				for differential drivers: 0x00001000
16434d13cbadSwdenk				for single ended drivers: 0x00005000
1644307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1645307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
16466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1647fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1648fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
16494d13cbadSwdenk
16509ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
16519ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
16529ab4ce22SSimon Glass
16536e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
16546e9e0626SOleksandr Tymoshenko		HW module registers.
16556e9e0626SOleksandr Tymoshenko
165616c8d5e7SWolfgang Denk- USB Device:
165716c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
165816c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
165916c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
166011ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
166116c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
166216c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
166316c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
166416c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
166516c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
166616c8d5e7SWolfgang Denk		a Linux host by
166716c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
166816c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
166916c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
167016c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
167116c8d5e7SWolfgang Denk
167216c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
167316c8d5e7SWolfgang Denk			Define this to build a UDC device
167416c8d5e7SWolfgang Denk
167516c8d5e7SWolfgang Denk			CONFIG_USB_TTY
167616c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
167716c8d5e7SWolfgang Denk			talk to the UDC device
167816c8d5e7SWolfgang Denk
1679f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1680f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1681f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1682f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1683f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1684f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1685f9da0f89SVipin KUMAR			speed.
1686f9da0f89SVipin KUMAR
16876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
168816c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
168916c8d5e7SWolfgang Denk			be set to usbtty.
169016c8d5e7SWolfgang Denk
169116c8d5e7SWolfgang Denk			mpc8xx:
16926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
169316c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
16946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
169516c8d5e7SWolfgang Denk
16966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
169716c8d5e7SWolfgang Denk				Derive USB clock from brgclk
16986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
169916c8d5e7SWolfgang Denk
170016c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
170116c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
170216c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
170316c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
170416c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
170516c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
170616c8d5e7SWolfgang Denk
170716c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
170816c8d5e7SWolfgang Denk			Define this string as the name of your company for
170916c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
171016c8d5e7SWolfgang Denk
171116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
171216c8d5e7SWolfgang Denk			Define this string as the name of your product
171316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
171416c8d5e7SWolfgang Denk
171516c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
171616c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
171716c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
171816c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
171916c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
172016c8d5e7SWolfgang Denk
172116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
172216c8d5e7SWolfgang Denk			Define this as the unique Product ID
172316c8d5e7SWolfgang Denk			for your device
172416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1725c609719bSwdenk
1726d70a560fSIgor Grinberg- ULPI Layer Support:
1727d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1728d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1729d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1730d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1731d70a560fSIgor Grinberg		viewport is supported.
1732d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1733d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
17346d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
17356d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
17366d365ea0SLucas Stach		the appropriate value in Hz.
1737c609719bSwdenk
1738c609719bSwdenk- MMC Support:
1739c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1740c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1741c609719bSwdenk		accessed from the boot prompt by mapping the device
1742c609719bSwdenk		to physical memory similar to flash. Command line is
1743602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1744602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1745c609719bSwdenk
1746afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1747afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1748afb35666SYoshihiro Shimoda
1749afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1750afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1751afb35666SYoshihiro Shimoda
1752afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1753afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1754afb35666SYoshihiro Shimoda
17551fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
17561fd93c6eSPierre Aubert		Enable the generic MMC driver
17571fd93c6eSPierre Aubert
17581fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
17591fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
17601fd93c6eSPierre Aubert
17611fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
17621fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
17631fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
17641fd93c6eSPierre Aubert
1765b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1766b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1767b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1768b3ba6e94STom Rini
1769b3ba6e94STom Rini		CONFIG_CMD_DFU
1770b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1771b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1772b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1773b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1774b3ba6e94STom Rini
1775b3ba6e94STom Rini		CONFIG_DFU_MMC
1776b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1777b3ba6e94STom Rini
1778c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1779c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1780c6631764SPantelis Antoniou
1781a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1782a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1783a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1784a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1785a9479f04SAfzal Mohammed		one that would help mostly the developer.
1786a9479f04SAfzal Mohammed
1787e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1788e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1789e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1790e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1791e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1792e7e75c70SHeiko Schocher
1793ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1794ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1795ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1796ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1797ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1798ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1799ea2453d5SPantelis Antoniou
1800001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1801001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1802001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1803001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1804001a8319SHeiko Schocher
1805001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1806001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1807001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1808001a8319SHeiko Schocher		sending again an USB request to the device.
1809001a8319SHeiko Schocher
18103aab70afSSebastian Siewior- USB Device Android Fastboot support:
18113aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
18123aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
18133aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
18143aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
18153aab70afSSebastian Siewior		used on Android devices.
18163aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
18173aab70afSSebastian Siewior
18183aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
18193aab70afSSebastian Siewior		This enables support for booting images which use the Android
18203aab70afSSebastian Siewior		image format header.
18213aab70afSSebastian Siewior
18223aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_ADDR
18233aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
18243aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
18253aab70afSSebastian Siewior		downloaded images.
18263aab70afSSebastian Siewior
18273aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_SIZE
18283aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
18293aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
18303aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
18313aab70afSSebastian Siewior
1832d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1833d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1834d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1835d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1836d1b5ed07SSteve Rae
1837d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1838d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1839d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1840d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1841d1b5ed07SSteve Rae
18420ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
18430ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
18440ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
18450ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
18460ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
18470ff7e585SSteve Rae		This occurs when the specified "partition name" on the
18480ff7e585SSteve Rae		"fastboot flash" command line matches this value.
18490ff7e585SSteve Rae		Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
18500ff7e585SSteve Rae
18516705d81eSwdenk- Journaling Flash filesystem support:
18526705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
18536705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
18546705d81eSwdenk		Define these for a default partition on a NAND device
18556705d81eSwdenk
18566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
18576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
18586705d81eSwdenk		Define these for a default partition on a NOR device
18596705d81eSwdenk
18606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
18616705d81eSwdenk		Define this to create an own partition. You have to provide a
18626705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
18636705d81eSwdenk
18646705d81eSwdenk		If you define only one JFFS2 partition you may also want to
18656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
18666705d81eSwdenk		to disable the command chpart. This is the default when you
18676705d81eSwdenk		have not defined a custom partition
18686705d81eSwdenk
1869c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1870c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1871656f4c65SDonggeun Kim
1872656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1873656f4c65SDonggeun Kim		file in FAT formatted partition.
1874656f4c65SDonggeun Kim
1875656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1876656f4c65SDonggeun Kim		user to write files to FAT.
1877c30a15e5SDonggeun Kim
187884cd9327SGabe BlackCBFS (Coreboot Filesystem) support
187984cd9327SGabe Black		CONFIG_CMD_CBFS
188084cd9327SGabe Black
188184cd9327SGabe Black		Define this to enable support for reading from a Coreboot
188284cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
188384cd9327SGabe Black		and cbfsload.
188484cd9327SGabe Black
18854f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
18864f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
18874f0d1a2aSSiva Durga Prasad Paladugu
18884f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
18894f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
18904f0d1a2aSSiva Durga Prasad Paladugu
1891c609719bSwdenk- Keyboard Support:
1892c609719bSwdenk		CONFIG_ISA_KEYBOARD
1893c609719bSwdenk
1894c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1895c609719bSwdenk		support
1896c609719bSwdenk
1897c609719bSwdenk		CONFIG_I8042_KBD
1898c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1899c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1900c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1901c609719bSwdenk		for cfb_console. Supports cursor blinking.
1902c609719bSwdenk
1903713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1904713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1905713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1906713cb680SHung-ying Tyan		which provides key scans on request.
1907713cb680SHung-ying Tyan
1908c609719bSwdenk- Video support:
1909c609719bSwdenk		CONFIG_VIDEO
1910c609719bSwdenk
1911c609719bSwdenk		Define this to enable video support (for output to
1912c609719bSwdenk		video).
1913c609719bSwdenk
1914c609719bSwdenk		CONFIG_VIDEO_CT69000
1915c609719bSwdenk
1916c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1917c609719bSwdenk
1918c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1919eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1920eeb1b77bSwdenk		video output is selected via environment 'videoout'
1921eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1922eeb1b77bSwdenk		assumed.
1923c609719bSwdenk
1924eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
192511ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1926eeb1b77bSwdenk		are possible:
1927eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1928eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1929eeb1b77bSwdenk
1930eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1931eeb1b77bSwdenk		-------------+---------------------------------------------
1932eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1933eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1934eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1935eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1936eeb1b77bSwdenk		-------------+---------------------------------------------
1937c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1938c609719bSwdenk
1939eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
19407817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1941eeb1b77bSwdenk
1942eeb1b77bSwdenk
1943a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1944a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1945a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1946a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1947a6c7ad2fSwdenk
19487d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
19497d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
19507d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
19517d3053fbSTimur Tabi		support, and should also define these other macros:
19527d3053fbSTimur Tabi
19537d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
19547d3053fbSTimur Tabi			CONFIG_VIDEO
19557d3053fbSTimur Tabi			CONFIG_CMD_BMP
19567d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
19577d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
19587d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
19597d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
19607d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
19617d3053fbSTimur Tabi
1962ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1963ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1964ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1965ba8e76bdSTimur Tabi		description of this variable.
19667d3053fbSTimur Tabi
1967058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1968058d59b0SSimon Glass
1969058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1970058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1971058d59b0SSimon Glass		driver.
1972058d59b0SSimon Glass
1973058d59b0SSimon Glass
1974682011ffSwdenk- Keyboard Support:
1975682011ffSwdenk		CONFIG_KEYBOARD
1976682011ffSwdenk
1977682011ffSwdenk		Define this to enable a custom keyboard support.
1978682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1979682011ffSwdenk		defined in your board-specific files.
1980682011ffSwdenk		The only board using this so far is RBC823.
1981a6c7ad2fSwdenk
1982c609719bSwdenk- LCD Support:	CONFIG_LCD
1983c609719bSwdenk
1984c609719bSwdenk		Define this to enable LCD support (for output to LCD
1985c609719bSwdenk		display); also select one of the supported displays
1986c609719bSwdenk		by defining one of these:
1987c609719bSwdenk
198839cf4804SStelian Pop		CONFIG_ATMEL_LCD:
198939cf4804SStelian Pop
199039cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
199139cf4804SStelian Pop
1992fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1993c609719bSwdenk
1994fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1995c609719bSwdenk
1996fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1997c609719bSwdenk
1998fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1999fd3103bbSwdenk			Active, color, single scan.
2000fd3103bbSwdenk
2001fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
2002fd3103bbSwdenk
2003fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
2004c609719bSwdenk			Active, color, single scan.
2005c609719bSwdenk
2006c609719bSwdenk		CONFIG_SHARP_16x9
2007c609719bSwdenk
2008c609719bSwdenk			Sharp 320x240. Active, color, single scan.
2009c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
2010c609719bSwdenk
2011c609719bSwdenk		CONFIG_SHARP_LQ64D341
2012c609719bSwdenk
2013c609719bSwdenk			Sharp LQ64D341 display, 640x480.
2014c609719bSwdenk			Active, color, single scan.
2015c609719bSwdenk
2016c609719bSwdenk		CONFIG_HLD1045
2017c609719bSwdenk
2018c609719bSwdenk			HLD1045 display, 640x480.
2019c609719bSwdenk			Active, color, single scan.
2020c609719bSwdenk
2021c609719bSwdenk		CONFIG_OPTREX_BW
2022c609719bSwdenk
2023c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
2024c609719bSwdenk			or
2025c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
2026c609719bSwdenk			or
2027c609719bSwdenk			Hitachi	 SP14Q002
2028c609719bSwdenk
2029c609719bSwdenk			320x240. Black & white.
2030c609719bSwdenk
2031c609719bSwdenk		Normally display is black on white background; define
20326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
2033c609719bSwdenk
2034676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
2035676d319eSSimon Glass
2036b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
2037676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
2038676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
2039676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
2040676d319eSSimon Glass		a per-section basis.
2041676d319eSSimon Glass
20420d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
20430d89efefSSimon Glass
20440d89efefSSimon Glass		When the console need to be scrolled, this is the number of
20450d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
20460d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
20470d89efefSSimon Glass		is slow.
2048676d319eSSimon Glass
204945d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
205045d7f525STom Wai-Hong Tam
205145d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
205245d7f525STom Wai-Hong Tam
2053735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
2054735987c5STom Wai-Hong Tam
2055735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
2056735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
2057735987c5STom Wai-Hong Tam
20587152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
2059d791b1dcSwdenk
2060d791b1dcSwdenk		If this option is set, the environment is checked for
2061d791b1dcSwdenk		a variable "splashimage". If found, the usual display
2062d791b1dcSwdenk		of logo, copyright and system information on the LCD
2063e94d2cd9Swdenk		is suppressed and the BMP image at the address
2064d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
2065d791b1dcSwdenk		console is redirected to the "nulldev", too. This
2066d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
2067d791b1dcSwdenk		loaded very quickly after power-on.
2068d791b1dcSwdenk
2069c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
2070c0880485SNikita Kiryanov
2071c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
2072c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
20731551df35STom Rini		(see README.displaying-bmps).
2074c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
2075c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
2076c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
2077c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
2078c0880485SNikita Kiryanov		there is no need to set this option.
2079c0880485SNikita Kiryanov
20801ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
20811ca298ceSMatthias Weisser
20821ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
20831ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
20841ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
20851ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
20861ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
20871ca298ceSMatthias Weisser		specify 'm' for centering the image.
20881ca298ceSMatthias Weisser
20891ca298ceSMatthias Weisser		Example:
20901ca298ceSMatthias Weisser		setenv splashpos m,m
20911ca298ceSMatthias Weisser			=> image at center of screen
20921ca298ceSMatthias Weisser
20931ca298ceSMatthias Weisser		setenv splashpos 30,20
20941ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
20951ca298ceSMatthias Weisser
20961ca298ceSMatthias Weisser		setenv splashpos -10,m
20971ca298ceSMatthias Weisser			=> vertically centered image
20981ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
20991ca298ceSMatthias Weisser
210098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
210198f4a3dfSStefan Roese
210298f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
210398f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
210498f4a3dfSStefan Roese		splashscreen support or the bmp command.
210598f4a3dfSStefan Roese
2106d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2107d5011762SAnatolij Gustschin
2108d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
2109d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
2110d5011762SAnatolij Gustschin		bmp command.
2111d5011762SAnatolij Gustschin
2112b445bbb4SJeremiah Mahler- Do compressing for memory range:
2113f2b96dfbSLei Wen		CONFIG_CMD_ZIP
2114f2b96dfbSLei Wen
2115f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
2116f2b96dfbSLei Wen		to compress the specified memory at its best effort.
2117f2b96dfbSLei Wen
2118c29fdfc1Swdenk- Compression support:
21198ef70478SKees Cook		CONFIG_GZIP
21208ef70478SKees Cook
21218ef70478SKees Cook		Enabled by default to support gzip compressed images.
21228ef70478SKees Cook
2123c29fdfc1Swdenk		CONFIG_BZIP2
2124c29fdfc1Swdenk
2125c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
2126c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
2127c29fdfc1Swdenk		compressed images are supported.
2128c29fdfc1Swdenk
2129c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
21306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
2131c29fdfc1Swdenk		be at least 4MB.
2132d791b1dcSwdenk
2133fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
2134fc9c1727SLuigi 'Comio' Mantellini
2135fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
2136fc9c1727SLuigi 'Comio' Mantellini		images is included.
2137fc9c1727SLuigi 'Comio' Mantellini
2138fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
2139fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
2140fc9c1727SLuigi 'Comio' Mantellini		formula:
2141fc9c1727SLuigi 'Comio' Mantellini
2142fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
2143fc9c1727SLuigi 'Comio' Mantellini
2144fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
2145fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
2146fc9c1727SLuigi 'Comio' Mantellini
2147fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
2148fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2149fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2150fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
2151fc9c1727SLuigi 'Comio' Mantellini
2152fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
2153fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
21546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
2155fc9c1727SLuigi 'Comio' Mantellini
21568ef70478SKees Cook		CONFIG_LZO
21578ef70478SKees Cook
21588ef70478SKees Cook		If this option is set, support for LZO compressed images
21598ef70478SKees Cook		is included.
21608ef70478SKees Cook
216117ea1177Swdenk- MII/PHY support:
216217ea1177Swdenk		CONFIG_PHY_ADDR
216317ea1177Swdenk
216417ea1177Swdenk		The address of PHY on MII bus.
216517ea1177Swdenk
216617ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
216717ea1177Swdenk
216817ea1177Swdenk		The clock frequency of the MII bus
216917ea1177Swdenk
217017ea1177Swdenk		CONFIG_PHY_GIGE
217117ea1177Swdenk
217217ea1177Swdenk		If this option is set, support for speed/duplex
217311ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
217417ea1177Swdenk
217517ea1177Swdenk		CONFIG_PHY_RESET_DELAY
217617ea1177Swdenk
217717ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
217817ea1177Swdenk		reset before any MII register access is possible.
217917ea1177Swdenk		For such PHY, set this option to the usec delay
218017ea1177Swdenk		required. (minimum 300usec for LXT971A)
218117ea1177Swdenk
218217ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
218317ea1177Swdenk
218417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
218517ea1177Swdenk		command issued before MII status register can be read
218617ea1177Swdenk
2187c609719bSwdenk- Ethernet address:
2188c609719bSwdenk		CONFIG_ETHADDR
2189c68a05feSrichardretanubun		CONFIG_ETH1ADDR
2190c609719bSwdenk		CONFIG_ETH2ADDR
2191c609719bSwdenk		CONFIG_ETH3ADDR
2192c68a05feSrichardretanubun		CONFIG_ETH4ADDR
2193c68a05feSrichardretanubun		CONFIG_ETH5ADDR
2194c609719bSwdenk
219511ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
219611ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
2197c609719bSwdenk		is not determined automatically.
2198c609719bSwdenk
2199c609719bSwdenk- IP address:
2200c609719bSwdenk		CONFIG_IPADDR
2201c609719bSwdenk
2202c609719bSwdenk		Define a default value for the IP address to use for
220311ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
2204c609719bSwdenk		determined through e.g. bootp.
22051ebcd654SWolfgang Denk		(Environment variable "ipaddr")
2206c609719bSwdenk
2207c609719bSwdenk- Server IP address:
2208c609719bSwdenk		CONFIG_SERVERIP
2209c609719bSwdenk
2210c609719bSwdenk		Defines a default value for the IP address of a TFTP
2211c609719bSwdenk		server to contact when using the "tftboot" command.
22121ebcd654SWolfgang Denk		(Environment variable "serverip")
2213c609719bSwdenk
221497cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
221597cfe861SRobin Getz
221697cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
221797cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
221897cfe861SRobin Getz
22191ebcd654SWolfgang Denk- Gateway IP address:
22201ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
22211ebcd654SWolfgang Denk
22221ebcd654SWolfgang Denk		Defines a default value for the IP address of the
22231ebcd654SWolfgang Denk		default router where packets to other networks are
22241ebcd654SWolfgang Denk		sent to.
22251ebcd654SWolfgang Denk		(Environment variable "gatewayip")
22261ebcd654SWolfgang Denk
22271ebcd654SWolfgang Denk- Subnet mask:
22281ebcd654SWolfgang Denk		CONFIG_NETMASK
22291ebcd654SWolfgang Denk
22301ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
22311ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
22321ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
22331ebcd654SWolfgang Denk		forwarded through a router.
22341ebcd654SWolfgang Denk		(Environment variable "netmask")
22351ebcd654SWolfgang Denk
223653a5c424SDavid Updegraff- Multicast TFTP Mode:
223753a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
223853a5c424SDavid Updegraff
223953a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
224053a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
224111ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
224253a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
224353a5c424SDavid Updegraff		multicast group.
224453a5c424SDavid Updegraff
2245c609719bSwdenk- BOOTP Recovery Mode:
2246c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2247c609719bSwdenk
2248c609719bSwdenk		If you have many targets in a network that try to
2249c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2250c609719bSwdenk		systems send out BOOTP requests at precisely the same
2251c609719bSwdenk		moment (which would happen for instance at recovery
2252c609719bSwdenk		from a power failure, when all systems will try to
2253c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2254c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2255c609719bSwdenk		inserted before sending out BOOTP requests. The
22566c33c785SWolfgang Denk		following delays are inserted then:
2257c609719bSwdenk
2258c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2259c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2260c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2261c609719bSwdenk		4th and following
2262c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2263c609719bSwdenk
226492ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
226592ac8accSThierry Reding
226692ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
226792ac8accSThierry Reding		server will copy the ID from client requests to responses and
226892ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
226992ac8accSThierry Reding		an incoming response. Some servers will check that addresses
227092ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
227192ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
227292ac8accSThierry Reding		respond. Network congestion may also influence the time it
227392ac8accSThierry Reding		takes for a response to make it back to the client. If that
227492ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
227592ac8accSThierry Reding		to allow earlier responses to still be accepted after these
227692ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
227792ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
227892ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
227992ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
228092ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
228192ac8accSThierry Reding
2282fe389a82Sstroese- DHCP Advanced Options:
22831fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
22841fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2285fe389a82Sstroese
22861fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
22871fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
22881fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
22891fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
22901fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
22911fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
22921fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
22931fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
22941fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
22951fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
22961fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
22971fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
22982c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2299fe389a82Sstroese
23005d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
23015d110f0aSWilson Callan		environment variable, not the BOOTP server.
2302fe389a82Sstroese
23032c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
23042c00e099SJoe Hershberger		after the configured retry count, the call will fail
23052c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
23062c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
23072c00e099SJoe Hershberger		is not available.
23082c00e099SJoe Hershberger
2309fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2310fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2311fe389a82Sstroese		than one DNS serverip is offered to the client.
2312fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2313fe389a82Sstroese		serverip will be stored in the additional environment
2314fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2315fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
23161fe80d79SJon Loeliger		is defined.
2317fe389a82Sstroese
2318fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2319fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2320fe389a82Sstroese		need the hostname of the DHCP requester.
23215d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
23221fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
23231fe80d79SJon Loeliger		option 12 to the DHCP server.
2324fe389a82Sstroese
2325d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2326d9a2f416SAras Vaichas
2327d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2328d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2329d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2330d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2331d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2332d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2333d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2334d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2335d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2336d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2337d9a2f416SAras Vaichas		this delay.
2338d9a2f416SAras Vaichas
2339d22c338eSJoe Hershberger - Link-local IP address negotiation:
2340d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2341d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2342d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2343d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2344d22c338eSJoe Hershberger
2345d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2346d22c338eSJoe Hershberger
2347a3d991bdSwdenk - CDP Options:
2348a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2349a3d991bdSwdenk
2350a3d991bdSwdenk		The device id used in CDP trigger frames.
2351a3d991bdSwdenk
2352a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2353a3d991bdSwdenk
2354a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2355a3d991bdSwdenk		of the device.
2356a3d991bdSwdenk
2357a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2358a3d991bdSwdenk
2359a3d991bdSwdenk		A printf format string which contains the ascii name of
2360a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
236111ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2362a3d991bdSwdenk
2363a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2364a3d991bdSwdenk
2365a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2366a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2367a3d991bdSwdenk
2368a3d991bdSwdenk		CONFIG_CDP_VERSION
2369a3d991bdSwdenk
2370a3d991bdSwdenk		An ascii string containing the version of the software.
2371a3d991bdSwdenk
2372a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2373a3d991bdSwdenk
2374a3d991bdSwdenk		An ascii string containing the name of the platform.
2375a3d991bdSwdenk
2376a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2377a3d991bdSwdenk
2378a3d991bdSwdenk		A 32bit integer sent on the trigger.
2379a3d991bdSwdenk
2380a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2381a3d991bdSwdenk
2382a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2383a3d991bdSwdenk		device in .1 of milliwatts.
2384a3d991bdSwdenk
2385a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2386a3d991bdSwdenk
2387a3d991bdSwdenk		A byte containing the id of the VLAN.
2388a3d991bdSwdenk
2389c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2390c609719bSwdenk
2391c609719bSwdenk		Several configurations allow to display the current
2392c609719bSwdenk		status using a LED. For instance, the LED will blink
2393c609719bSwdenk		fast while running U-Boot code, stop blinking as
2394c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2395c609719bSwdenk		start blinking slow once the Linux kernel is running
2396c609719bSwdenk		(supported by a status LED driver in the Linux
2397c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2398c609719bSwdenk		feature in U-Boot.
2399c609719bSwdenk
24001df7bbbaSIgor Grinberg		Additional options:
24011df7bbbaSIgor Grinberg
24021df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
24031df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
24041df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
24051df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
24061df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
24071df7bbbaSIgor Grinberg
24089dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
24099dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
24109dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
24119dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
24129dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
24139dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
24149dfdcdfeSIgor Grinberg
2415c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2416c609719bSwdenk
2417c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2418c609719bSwdenk		on those systems that support this (optional)
2419c609719bSwdenk		feature, like the TQM8xxL modules.
2420c609719bSwdenk
24213f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2422c609719bSwdenk
24233f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
24243f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
24253f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
24263f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
24273f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
24283f4978c7SHeiko Schocher		interface.
24293f4978c7SHeiko Schocher
24303f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2431ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2432ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2433ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2434ea818dbbSHeiko Schocher		    for defining speed and slave address
2435ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2436ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2437ea818dbbSHeiko Schocher		    for defining speed and slave address
2438ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2439ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2440ea818dbbSHeiko Schocher		    for defining speed and slave address
2441ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2442ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2443ea818dbbSHeiko Schocher		    for defining speed and slave address
24443f4978c7SHeiko Schocher
244500f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
244600f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
244700f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
244800f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
244900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
245000f792e0SHeiko Schocher		    bus.
245100f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
245200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
245300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
245400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
245500f792e0SHeiko Schocher		    second bus.
245600f792e0SHeiko Schocher
24571f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
24581f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
24591f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
24601f2ba722SSimon Glass		    100000 and the slave addr 0!
24611f2ba722SSimon Glass
2462880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2463880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2464880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2465880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2466880540deSDirk Eibach
2467fac96408Strem		- drivers/i2c/i2c_mxc.c
2468fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2469fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2470fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2471fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2472fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2473fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2474fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2475b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
2476fac96408Strem		for speed, and 0 for slave.
2477fac96408Strem
24781086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
24791086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
24801086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
24811086bfa9SNobuhiro Iwamatsu
24821086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
24831086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
24841086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
24851086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
24861086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
24871086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
24881086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
24891086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
24901086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
24911086bfa9SNobuhiro Iwamatsu
24922035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
24932035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
24942035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
24952035d77dSNobuhiro Iwamatsu
24962035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
24972035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
24982035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
24992035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
25002035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
25012035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
25022035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
25032035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
25042035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
25052035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
25062035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
25072035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2508b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
25092035d77dSNobuhiro Iwamatsu
25106789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
25116789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
25126789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
25136789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
25146789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
25156789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
25166789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
25176789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
25186789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
25196789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
25206789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
25216789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
25226789e84eSHeiko Schocher
25230bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
25240bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
25250bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
25260bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
25270bdffe71SHeiko Schocher
2528e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2529e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2530e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2531e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2532e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2533e717fc6dSNaveen Krishna Ch
2534b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2535b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2536b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2537b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2538b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2539b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2540b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2541b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2542b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2543b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2544b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2545b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2546b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2547b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2548b46226bdSDirk Eibach
25493f4978c7SHeiko Schocher		additional defines:
25503f4978c7SHeiko Schocher
25513f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2552b445bbb4SJeremiah Mahler		Hold the number of i2c buses you want to use. If you
25533f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
25543f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
25553f4978c7SHeiko Schocher		omit this define.
25563f4978c7SHeiko Schocher
25573f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
25583f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
25593f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
25603f4978c7SHeiko Schocher		omit this define.
25613f4978c7SHeiko Schocher
25623f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
25633f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
25643f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
25653f4978c7SHeiko Schocher		define.
25663f4978c7SHeiko Schocher
25673f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2568b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
25693f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
25703f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
25713f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
25723f4978c7SHeiko Schocher
25733f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
25743f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
25753f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
25763f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
25773f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
25783f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
25793f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
25803f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
25813f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
25823f4978c7SHeiko Schocher					}
25833f4978c7SHeiko Schocher
25843f4978c7SHeiko Schocher		which defines
25853f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2586ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2587ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2588ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2589ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2590ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
25913f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2592ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2593ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
25943f4978c7SHeiko Schocher
25953f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
25963f4978c7SHeiko Schocher
2597ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
25983f4978c7SHeiko Schocher
25993f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
26003f4978c7SHeiko Schocher		provides the following compelling advantages:
26013f4978c7SHeiko Schocher
26023f4978c7SHeiko Schocher		- more than one i2c adapter is usable
26033f4978c7SHeiko Schocher		- approved multibus support
26043f4978c7SHeiko Schocher		- better i2c mux support
26053f4978c7SHeiko Schocher
26063f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
26073f4978c7SHeiko Schocher
2608ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2609ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2610ea818dbbSHeiko Schocher		for the selected CPU.
2611c609719bSwdenk
2612b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2613602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2614b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2615b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2616c609719bSwdenk		command line interface.
2617c609719bSwdenk
2618bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2619c609719bSwdenk
2620b37c7e5eSwdenk		There are several other quantities that must also be
2621ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2622c609719bSwdenk
26236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2624b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
26256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
262611ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2627c609719bSwdenk
26288d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2629a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
26308d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
26318d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
26328d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2633b37c7e5eSwdenk
26345da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
26355da71efaSEric Millbrandt
26365da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
26375da71efaSEric Millbrandt		chips might think that the current transfer is still
26385da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
26395da71efaSEric Millbrandt		commands until the slave device responds.
26405da71efaSEric Millbrandt
2641b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2642b37c7e5eSwdenk
2643ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2644b37c7e5eSwdenk		then the following macros need to be defined (examples are
2645b37c7e5eSwdenk		from include/configs/lwmon.h):
2646c609719bSwdenk
2647c609719bSwdenk		I2C_INIT
2648c609719bSwdenk
2649b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2650c609719bSwdenk		controller or configure ports.
2651c609719bSwdenk
2652b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2653b37c7e5eSwdenk
2654c609719bSwdenk		I2C_PORT
2655c609719bSwdenk
2656c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2657c609719bSwdenk		assumes both bits are on the same port). Valid values
2658c609719bSwdenk		are 0..3 for ports A..D.
2659c609719bSwdenk
2660c609719bSwdenk		I2C_ACTIVE
2661c609719bSwdenk
2662c609719bSwdenk		The code necessary to make the I2C data line active
2663c609719bSwdenk		(driven).  If the data line is open collector, this
2664c609719bSwdenk		define can be null.
2665c609719bSwdenk
2666b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2667b37c7e5eSwdenk
2668c609719bSwdenk		I2C_TRISTATE
2669c609719bSwdenk
2670c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2671c609719bSwdenk		(inactive).  If the data line is open collector, this
2672c609719bSwdenk		define can be null.
2673c609719bSwdenk
2674b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2675b37c7e5eSwdenk
2676c609719bSwdenk		I2C_READ
2677c609719bSwdenk
2678472d5460SYork Sun		Code that returns true if the I2C data line is high,
2679472d5460SYork Sun		false if it is low.
2680c609719bSwdenk
2681b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2682b37c7e5eSwdenk
2683c609719bSwdenk		I2C_SDA(bit)
2684c609719bSwdenk
2685472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2686472d5460SYork Sun		is false, it clears it (low).
2687c609719bSwdenk
2688b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2689b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2690b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2691b37c7e5eSwdenk
2692c609719bSwdenk		I2C_SCL(bit)
2693c609719bSwdenk
2694472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2695472d5460SYork Sun		is false, it clears it (low).
2696c609719bSwdenk
2697b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2698b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2699b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2700b37c7e5eSwdenk
2701c609719bSwdenk		I2C_DELAY
2702c609719bSwdenk
2703c609719bSwdenk		This delay is invoked four times per clock cycle so this
2704c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2705b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2706b37c7e5eSwdenk		like:
2707b37c7e5eSwdenk
2708b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2709c609719bSwdenk
2710793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2711793b5726SMike Frysinger
2712793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2713793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2714793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2715793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2716793b5726SMike Frysinger
2717793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2718793b5726SMike Frysinger		the generic GPIO functions.
2719793b5726SMike Frysinger
27206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
272147cd00faSwdenk
272247cd00faSwdenk		When a board is reset during an i2c bus transfer
272347cd00faSwdenk		chips might think that the current transfer is still
272447cd00faSwdenk		in progress. On some boards it is possible to access
272547cd00faSwdenk		the i2c SCLK line directly, either by using the
272647cd00faSwdenk		processor pin as a GPIO or by having a second pin
272747cd00faSwdenk		connected to the bus. If this option is defined a
272847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
272947cd00faSwdenk		is run early in the boot sequence.
273047cd00faSwdenk
273126a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
273226a33504SRichard Retanubun
273326a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
273426a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
273526a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
273626a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
273726a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
273826a33504SRichard Retanubun		controller provide such a method. It is called at the end of
273926a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
274026a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
274126a33504SRichard Retanubun
274217ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
274317ea1177Swdenk
274417ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
274517ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
274617ea1177Swdenk		variable "i2cfast". (see also i2cfast)
274717ea1177Swdenk
2748bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2749bb99ad6dSBen Warren
2750bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2751bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2752bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2753bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2754bb99ad6dSBen Warren
27556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2756bb99ad6dSBen Warren
2757bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
27580f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
27590f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
27600f89c54bSPeter Tyser		a 1D array of device addresses
2761bb99ad6dSBen Warren
2762bb99ad6dSBen Warren		e.g.
2763bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
27646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2765bb99ad6dSBen Warren
2766bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2767bb99ad6dSBen Warren
2768bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
27696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2770bb99ad6dSBen Warren
2771bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2772bb99ad6dSBen Warren
27736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2774be5e6181STimur Tabi
2775be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2776be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2777be5e6181STimur Tabi
27786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
27790dc018ecSStefan Roese
27800dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
27810dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
27820dc018ecSStefan Roese
27836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
27840dc018ecSStefan Roese
27850dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
27860dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
27870dc018ecSStefan Roese
27886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
27899ebbb54fSVictor Gallardo
27909ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
27919ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
27929ebbb54fSVictor Gallardo		specified DTT device.
27939ebbb54fSVictor Gallardo
27942ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
27952ac6985aSAndrew Dyer
27962ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
27972ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
27982ac6985aSAndrew Dyer		between writing the address pointer and reading the
27992ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
28002ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
28012ac6985aSAndrew Dyer		devices can use either method, but some require one or
28022ac6985aSAndrew Dyer		the other.
2803be5e6181STimur Tabi
2804c609719bSwdenk- SPI Support:	CONFIG_SPI
2805c609719bSwdenk
2806c609719bSwdenk		Enables SPI driver (so far only tested with
2807c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2808c609719bSwdenk		D/As on the SACSng board)
2809c609719bSwdenk
28106639562eSYoshihiro Shimoda		CONFIG_SH_SPI
28116639562eSYoshihiro Shimoda
28126639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
28136639562eSYoshihiro Shimoda		only SH7757 is supported.
28146639562eSYoshihiro Shimoda
2815c609719bSwdenk		CONFIG_SPI_X
2816c609719bSwdenk
2817c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2818c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2819c609719bSwdenk
2820c609719bSwdenk		CONFIG_SOFT_SPI
2821c609719bSwdenk
2822c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2823c609719bSwdenk		using hardware support. This is a general purpose
2824c609719bSwdenk		driver that only requires three general I/O port pins
2825c609719bSwdenk		(two outputs, one input) to function. If this is
2826c609719bSwdenk		defined, the board configuration must define several
2827c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2828c609719bSwdenk		an example, see include/configs/sacsng.h.
2829c609719bSwdenk
283004a9e118SBen Warren		CONFIG_HARD_SPI
283104a9e118SBen Warren
283204a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
283304a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
283404a9e118SBen Warren		must define a list of chip-select function pointers.
283504a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
283604a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
283704a9e118SBen Warren
283838254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
283938254f45SGuennadi Liakhovetski
284038254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
28412e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
284238254f45SGuennadi Liakhovetski
2843f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2844f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2845f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2846f659b573SHeiko Schocher
28470133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
28480133502eSMatthias Fuchs
28490133502eSMatthias Fuchs		Enables FPGA subsystem.
28500133502eSMatthias Fuchs
28510133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
28520133502eSMatthias Fuchs
28530133502eSMatthias Fuchs		Enables support for specific chip vendors.
28540133502eSMatthias Fuchs		(ALTERA, XILINX)
28550133502eSMatthias Fuchs
28560133502eSMatthias Fuchs		CONFIG_FPGA_<family>
28570133502eSMatthias Fuchs
28580133502eSMatthias Fuchs		Enables support for FPGA family.
28590133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
28600133502eSMatthias Fuchs
28610133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2862c609719bSwdenk
2863c609719bSwdenk		Specify the number of FPGA devices to support.
2864c609719bSwdenk
286564e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
286664e809afSSiva Durga Prasad Paladugu
286764e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
286864e809afSSiva Durga Prasad Paladugu
286967193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
287067193864SMichal Simek
287167193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
287267193864SMichal Simek
287367193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
287467193864SMichal Simek
287567193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
287667193864SMichal Simek		(Xilinx only)
287767193864SMichal Simek
28786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2879c609719bSwdenk
2880c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2881c609719bSwdenk
28826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2883c609719bSwdenk
2884c609719bSwdenk		Enable checks on FPGA configuration interface busy
2885c609719bSwdenk		status by the configuration function. This option
2886c609719bSwdenk		will require a board or device specific function to
2887c609719bSwdenk		be written.
2888c609719bSwdenk
2889c609719bSwdenk		CONFIG_FPGA_DELAY
2890c609719bSwdenk
2891c609719bSwdenk		If defined, a function that provides delays in the FPGA
2892c609719bSwdenk		configuration driver.
2893c609719bSwdenk
28946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2895c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2896c609719bSwdenk
28976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2898c609719bSwdenk
2899c609719bSwdenk		Check for configuration errors during FPGA bitfile
2900c609719bSwdenk		loading. For example, abort during Virtex II
2901c609719bSwdenk		configuration if the INIT_B line goes low (which
2902c609719bSwdenk		indicated a CRC error).
2903c609719bSwdenk
29046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2905c609719bSwdenk
2906b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2907b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2908c609719bSwdenk		FPGA configuration sequence. The default time is 500
290911ccc33fSMarcel Ziswiler		ms.
2910c609719bSwdenk
29116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2912c609719bSwdenk
2913b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
291411ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2915c609719bSwdenk
29166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2917c609719bSwdenk
2918c609719bSwdenk		Time to wait after FPGA configuration. The default is
291911ccc33fSMarcel Ziswiler		200 ms.
2920c609719bSwdenk
2921c609719bSwdenk- Configuration Management:
2922b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2923b2b8a696SStefan Roese
2924b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2925b2b8a696SStefan Roese		with a special header) as build targets. By defining
2926b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2927b2b8a696SStefan Roese		special image will be automatically built upon calling
2928b2b8a696SStefan Roese		make / MAKEALL.
2929b2b8a696SStefan Roese
2930c609719bSwdenk		CONFIG_IDENT_STRING
2931c609719bSwdenk
2932c609719bSwdenk		If defined, this string will be added to the U-Boot
2933c609719bSwdenk		version information (U_BOOT_VERSION)
2934c609719bSwdenk
2935c609719bSwdenk- Vendor Parameter Protection:
2936c609719bSwdenk
2937c609719bSwdenk		U-Boot considers the values of the environment
2938c609719bSwdenk		variables "serial#" (Board Serial Number) and
29397152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2940c609719bSwdenk		are set once by the board vendor / manufacturer, and
2941c609719bSwdenk		protects these variables from casual modification by
2942c609719bSwdenk		the user. Once set, these variables are read-only,
2943c609719bSwdenk		and write or delete attempts are rejected. You can
294411ccc33fSMarcel Ziswiler		change this behaviour:
2945c609719bSwdenk
2946c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2947c609719bSwdenk		file, the write protection for vendor parameters is
294847cd00faSwdenk		completely disabled. Anybody can change or delete
2949c609719bSwdenk		these parameters.
2950c609719bSwdenk
2951c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2952c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
295311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2954c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2955c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2956c609719bSwdenk		read-only.]
2957c609719bSwdenk
29582598090bSJoe Hershberger		The same can be accomplished in a more flexible way
29592598090bSJoe Hershberger		for any variable by configuring the type of access
29602598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
29612598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
29622598090bSJoe Hershberger
2963c609719bSwdenk- Protected RAM:
2964c609719bSwdenk		CONFIG_PRAM
2965c609719bSwdenk
2966c609719bSwdenk		Define this variable to enable the reservation of
2967c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2968c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2969c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2970c609719bSwdenk		this default value by defining an environment
2971c609719bSwdenk		variable "pram" to the number of kB you want to
2972c609719bSwdenk		reserve. Note that the board info structure will
2973c609719bSwdenk		still show the full amount of RAM. If pRAM is
2974c609719bSwdenk		reserved, a new environment variable "mem" will
2975c609719bSwdenk		automatically be defined to hold the amount of
2976c609719bSwdenk		remaining RAM in a form that can be passed as boot
2977c609719bSwdenk		argument to Linux, for instance like that:
2978c609719bSwdenk
2979fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2980c609719bSwdenk			saveenv
2981c609719bSwdenk
2982c609719bSwdenk		This way you can tell Linux not to use this memory,
2983c609719bSwdenk		either, which results in a memory region that will
2984c609719bSwdenk		not be affected by reboots.
2985c609719bSwdenk
2986c609719bSwdenk		*WARNING* If your board configuration uses automatic
2987c609719bSwdenk		detection of the RAM size, you must make sure that
2988c609719bSwdenk		this memory test is non-destructive. So far, the
2989c609719bSwdenk		following board configurations are known to be
2990c609719bSwdenk		"pRAM-clean":
2991c609719bSwdenk
29921b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
29931b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2994544d97e9SWolfgang Denk			FLAGADM, TQM8260
2995c609719bSwdenk
299640fef049SGabe Black- Access to physical memory region (> 4GB)
299740fef049SGabe Black		Some basic support is provided for operations on memory not
299840fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
299940fef049SGabe Black		support access to more than 4GB of memory on 32-bit
300040fef049SGabe Black		machines using physical address extension or similar.
300140fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
300240fef049SGabe Black		currently only supports clearing the memory.
300340fef049SGabe Black
3004c609719bSwdenk- Error Recovery:
3005c609719bSwdenk		CONFIG_PANIC_HANG
3006c609719bSwdenk
3007c609719bSwdenk		Define this variable to stop the system in case of a
3008c609719bSwdenk		fatal error, so that you have to reset it manually.
3009c609719bSwdenk		This is probably NOT a good idea for an embedded
301011ccc33fSMarcel Ziswiler		system where you want the system to reboot
3011c609719bSwdenk		automatically as fast as possible, but it may be
3012c609719bSwdenk		useful during development since you can try to debug
3013c609719bSwdenk		the conditions that lead to the situation.
3014c609719bSwdenk
3015c609719bSwdenk		CONFIG_NET_RETRY_COUNT
3016c609719bSwdenk
3017c609719bSwdenk		This variable defines the number of retries for
3018c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
3019c609719bSwdenk		before giving up the operation. If not defined, a
3020c609719bSwdenk		default value of 5 is used.
3021c609719bSwdenk
302240cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
302340cb90eeSGuennadi Liakhovetski
302440cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
302540cb90eeSGuennadi Liakhovetski
302648a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
302748a3e999STetsuyuki Kobayashi
302848a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
302948a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
303048a3e999STetsuyuki Kobayashi		try longer timeout such as
303148a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
303248a3e999STetsuyuki Kobayashi
3033c609719bSwdenk- Command Interpreter:
30348078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
303504a85b3bSwdenk
303604a85b3bSwdenk		Enable auto completion of commands using TAB.
303704a85b3bSwdenk
30386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
3039c609719bSwdenk
3040c609719bSwdenk		This defines the secondary prompt string, which is
3041c609719bSwdenk		printed when the command interpreter needs more input
3042c609719bSwdenk		to complete a command. Usually "> ".
3043c609719bSwdenk
3044c609719bSwdenk	Note:
3045c609719bSwdenk
3046c609719bSwdenk		In the current implementation, the local variables
3047c609719bSwdenk		space and global environment variables space are
3048c609719bSwdenk		separated. Local variables are those you define by
30493b57fe0aSwdenk		simply typing `name=value'. To access a local
3050c609719bSwdenk		variable later on, you have write `$name' or
30513b57fe0aSwdenk		`${name}'; to execute the contents of a variable
30523b57fe0aSwdenk		directly type `$name' at the command prompt.
3053c609719bSwdenk
3054c609719bSwdenk		Global environment variables are those you use
3055c609719bSwdenk		setenv/printenv to work with. To run a command stored
3056c609719bSwdenk		in such a variable, you need to use the run command,
3057c609719bSwdenk		and you must not use the '$' sign to access them.
3058c609719bSwdenk
3059c609719bSwdenk		To store commands and special characters in a
3060c609719bSwdenk		variable, please use double quotation marks
3061c609719bSwdenk		surrounding the whole text of the variable, instead
3062c609719bSwdenk		of the backslashes before semicolons and special
3063c609719bSwdenk		symbols.
3064c609719bSwdenk
3065b445bbb4SJeremiah Mahler- Command Line Editing and History:
3066aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
3067aa0c71acSWolfgang Denk
306811ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
3069aa0c71acSWolfgang Denk		command line input operations
3070aa0c71acSWolfgang Denk
3071a8c7c708Swdenk- Default Environment:
3072c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
3073c609719bSwdenk
3074c609719bSwdenk		Define this to contain any number of null terminated
3075c609719bSwdenk		strings (variable = value pairs) that will be part of
30767152b1d0Swdenk		the default environment compiled into the boot image.
30772262cfeeSwdenk
3078c609719bSwdenk		For example, place something like this in your
3079c609719bSwdenk		board's config file:
3080c609719bSwdenk
3081c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
3082c609719bSwdenk			"myvar1=value1\0" \
3083c609719bSwdenk			"myvar2=value2\0"
3084c609719bSwdenk
3085c609719bSwdenk		Warning: This method is based on knowledge about the
3086c609719bSwdenk		internal format how the environment is stored by the
30872262cfeeSwdenk		U-Boot code. This is NOT an official, exported
3088c609719bSwdenk		interface! Although it is unlikely that this format
30897152b1d0Swdenk		will change soon, there is no guarantee either.
3090c609719bSwdenk		You better know what you are doing here.
3091c609719bSwdenk
3092c609719bSwdenk		Note: overly (ab)use of the default environment is
3093c609719bSwdenk		discouraged. Make sure to check other ways to preset
309474de7aefSWolfgang Denk		the environment like the "source" command or the
3095c609719bSwdenk		boot command first.
3096c609719bSwdenk
30975e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
30985e724ca2SStephen Warren
30995e724ca2SStephen Warren		Define this in order to add variables describing the
31005e724ca2SStephen Warren		U-Boot build configuration to the default environment.
31015e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
31025e724ca2SStephen Warren
31035e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
31045e724ca2SStephen Warren
31055e724ca2SStephen Warren		- CONFIG_SYS_ARCH
31065e724ca2SStephen Warren		- CONFIG_SYS_CPU
31075e724ca2SStephen Warren		- CONFIG_SYS_BOARD
31085e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
31095e724ca2SStephen Warren		- CONFIG_SYS_SOC
31105e724ca2SStephen Warren
31117e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
31127e27f89fSTom Rini
31137e27f89fSTom Rini		Define this in order to add variables describing certain
31147e27f89fSTom Rini		run-time determined information about the hardware to the
31157e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
31167e27f89fSTom Rini
311706fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
311806fd8538SSimon Glass
311906fd8538SSimon Glass		Normally the environment is loaded when the board is
3120b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
312106fd8538SSimon Glass		that so that the environment is not available until
312206fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
312306fd8538SSimon Glass		this is instead controlled by the value of
312406fd8538SSimon Glass		/config/load-environment.
312506fd8538SSimon Glass
3126a8c7c708Swdenk- DataFlash Support:
31272abbe075Swdenk		CONFIG_HAS_DATAFLASH
31282abbe075Swdenk
31292abbe075Swdenk		Defining this option enables DataFlash features and
31302abbe075Swdenk		allows to read/write in Dataflash via the standard
31312abbe075Swdenk		commands cp, md...
31322abbe075Swdenk
3133f61ec45eSEric Nelson- Serial Flash support
3134f61ec45eSEric Nelson		CONFIG_CMD_SF
3135f61ec45eSEric Nelson
3136f61ec45eSEric Nelson		Defining this option enables SPI flash commands
3137f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
3138f61ec45eSEric Nelson
3139f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
3140f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
3141f61ec45eSEric Nelson		commands.
3142f61ec45eSEric Nelson
3143f61ec45eSEric Nelson		The following defaults may be provided by the platform
3144f61ec45eSEric Nelson		to handle the common case when only a single serial
3145f61ec45eSEric Nelson		flash is present on the system.
3146f61ec45eSEric Nelson
3147f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
3148f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
3149f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
3150f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
3151f61ec45eSEric Nelson
315224007273SSimon Glass		CONFIG_CMD_SF_TEST
315324007273SSimon Glass
315424007273SSimon Glass		Define this option to include a destructive SPI flash
315524007273SSimon Glass		test ('sf test').
315624007273SSimon Glass
31571dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
31581dcd6d03SJagannadha Sutradharudu Teki
31591dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
31601dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
31611dcd6d03SJagannadha Sutradharudu Teki
3162b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
3163b902e07cSJagannadha Sutradharudu Teki
3164b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
3165b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
3166b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
3167b902e07cSJagannadha Sutradharudu Teki
3168562f8df1SHeiko Schocher		CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3169562f8df1SHeiko Schocher		enable the W#/Vpp signal to disable writing to the status
3170562f8df1SHeiko Schocher		register on ST MICRON flashes like the N25Q128.
3171562f8df1SHeiko Schocher		The status register write enable/disable bit, combined with
3172562f8df1SHeiko Schocher		the W#/VPP signal provides hardware data protection for the
3173562f8df1SHeiko Schocher		device as follows: When the enable/disable bit is set to 1,
3174562f8df1SHeiko Schocher		and the W#/VPP signal is driven LOW, the status register
3175562f8df1SHeiko Schocher		nonvolatile bits become read-only and the WRITE STATUS REGISTER
3176562f8df1SHeiko Schocher		operation will not execute. The only way to exit this
3177562f8df1SHeiko Schocher		hardware-protected mode is to drive W#/VPP HIGH.
3178562f8df1SHeiko Schocher
31793f85ce27Swdenk- SystemACE Support:
31803f85ce27Swdenk		CONFIG_SYSTEMACE
31813f85ce27Swdenk
31823f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
31833f85ce27Swdenk		chips attached via some sort of local bus. The address
318411ccc33fSMarcel Ziswiler		of the chip must also be defined in the
31856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
31863f85ce27Swdenk
31873f85ce27Swdenk		#define CONFIG_SYSTEMACE
31886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
31893f85ce27Swdenk
31903f85ce27Swdenk		When SystemACE support is added, the "ace" device type
31913f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
31923f85ce27Swdenk
3193ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
3194ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
3195ecb0ccd9SWolfgang Denk
319628cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
3197ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
319828cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
3199ecb0ccd9SWolfgang Denk		number generator is used.
3200ecb0ccd9SWolfgang Denk
320128cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
320228cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
320328cb9375SWolfgang Denk		defined, the normal port 69 is used.
320428cb9375SWolfgang Denk
320528cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
3206ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
3207ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
3208ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
3209ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
3210ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
3211ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
3212ecb0ccd9SWolfgang Denk
3213bf36c5d5SSimon Glass- Hashing support:
3214bf36c5d5SSimon Glass		CONFIG_CMD_HASH
3215bf36c5d5SSimon Glass
3216bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
3217bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3218bf36c5d5SSimon Glass
3219bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3220bf36c5d5SSimon Glass
3221bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3222bf36c5d5SSimon Glass		size a little.
3223bf36c5d5SSimon Glass
322494e3c8c4Sgaurav rana		CONFIG_SHA1 - This option enables support of hashing using SHA1
322594e3c8c4Sgaurav rana		algorithm. The hash is calculated in software.
322694e3c8c4Sgaurav rana		CONFIG_SHA256 - This option enables support of hashing using
322794e3c8c4Sgaurav rana		SHA256 algorithm. The hash is calculated in software.
322894e3c8c4Sgaurav rana		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
322994e3c8c4Sgaurav rana		for SHA1/SHA256 hashing.
323094e3c8c4Sgaurav rana		This affects the 'hash' command and also the
323194e3c8c4Sgaurav rana		hash_lookup_algo() function.
323294e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL - This option enables
323394e3c8c4Sgaurav rana		hardware-acceleration for SHA1/SHA256 progressive hashing.
323494e3c8c4Sgaurav rana		Data can be streamed in a block at a time and the hashing
323594e3c8c4Sgaurav rana		is performed in hardware.
3236bf36c5d5SSimon Glass
3237bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3238bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3239bf36c5d5SSimon Glass
3240a11f1873SRobert Winkler- Freescale i.MX specific commands:
3241a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3242a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3243a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3244a11f1873SRobert Winkler
3245a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3246a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3247a11f1873SRobert Winkler		a boot from specific media.
3248a11f1873SRobert Winkler
3249a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3250a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3251a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3252a11f1873SRobert Winkler		will set it back to normal.  This command currently
3253a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3254a11f1873SRobert Winkler
325519c402afSSimon Glass- Signing support:
325619c402afSSimon Glass		CONFIG_RSA
325719c402afSSimon Glass
325819c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
32598bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
326019c402afSSimon Glass
3261c937ff6dSRuchika Gupta		The Modular Exponentiation algorithm in RSA is implemented using
3262c937ff6dSRuchika Gupta		driver model. So CONFIG_DM needs to be enabled by default for this
3263c937ff6dSRuchika Gupta		library to function.
3264c937ff6dSRuchika Gupta
326519c402afSSimon Glass		The signing part is build into mkimage regardless of this
3266c937ff6dSRuchika Gupta		option. The software based modular exponentiation is built into
3267c937ff6dSRuchika Gupta		mkimage irrespective of this option.
326819c402afSSimon Glass
32699e50c406SHeiko Schocher- bootcount support:
32709e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
32719e50c406SHeiko Schocher
32729e50c406SHeiko Schocher		This enables the bootcounter support, see:
32739e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
32749e50c406SHeiko Schocher
32759e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
32769e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
32779e50c406SHeiko Schocher		CONFIG_BLACKFIN
32789e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
32799e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
32809e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
32819e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
32829e50c406SHeiko Schocher		enable support for the bootcounter in RAM
32839e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
32849e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
32859e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
32869e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
32879e50c406SHeiko Schocher						    the bootcounter.
32889e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
328919c402afSSimon Glass
3290a8c7c708Swdenk- Show boot progress:
3291c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3292c609719bSwdenk
3293c609719bSwdenk		Defining this option allows to add some board-
3294c609719bSwdenk		specific code (calling a user-provided function
3295c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3296c609719bSwdenk		the system's boot progress on some display (for
3297c609719bSwdenk		example, some LED's) on your board. At the moment,
3298c609719bSwdenk		the following checkpoints are implemented:
3299c609719bSwdenk
33003a608ca0SSimon Glass- Detailed boot stage timing
33013a608ca0SSimon Glass		CONFIG_BOOTSTAGE
33023a608ca0SSimon Glass		Define this option to get detailed timing of each stage
33033a608ca0SSimon Glass		of the boot process.
33043a608ca0SSimon Glass
33053a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
33063a608ca0SSimon Glass		This is the number of available user bootstage records.
33073a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
33083a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
33093a608ca0SSimon Glass		the limit, recording will stop.
33103a608ca0SSimon Glass
33113a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
33123a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
33133a608ca0SSimon Glass
33143a608ca0SSimon Glass		Timer summary in microseconds:
33153a608ca0SSimon Glass		       Mark    Elapsed  Stage
33163a608ca0SSimon Glass			  0          0  reset
33173a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
33183a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
33193a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
33203a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
33213a608ca0SSimon Glass		  3,910,375    250,777  main_loop
33223a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
33233a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
33243a608ca0SSimon Glass
33252eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
33262eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
33272eba38cfSSimon Glass		and un/stashing of bootstage data.
33282eba38cfSSimon Glass
332994fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
333094fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
333194fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
333294fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
333394fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
333494fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
333594fd1316SSimon Glass		For example:
333694fd1316SSimon Glass
333794fd1316SSimon Glass		bootstage {
333894fd1316SSimon Glass			154 {
333994fd1316SSimon Glass				name = "board_init_f";
334094fd1316SSimon Glass				mark = <3575678>;
334194fd1316SSimon Glass			};
334294fd1316SSimon Glass			170 {
334394fd1316SSimon Glass				name = "lcd";
334494fd1316SSimon Glass				accum = <33482>;
334594fd1316SSimon Glass			};
334694fd1316SSimon Glass		};
334794fd1316SSimon Glass
334894fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
334994fd1316SSimon Glass
33501372cce2SMarian BalakowiczLegacy uImage format:
33511372cce2SMarian Balakowicz
3352c609719bSwdenk  Arg	Where			When
3353c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3354c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3355c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3356c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3357c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3358c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3359c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3360c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3361c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
33621372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3363c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3364c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3365c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3366c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
33671372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3368c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
33691372cce2SMarian Balakowicz
33701372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
33711372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
33721372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
33731372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
33741372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
33751372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
33761372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
337711ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
33781372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
33791372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
33801372cce2SMarian Balakowicz
3381ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3382c609719bSwdenk
3383a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
338463e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
338563e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
338663e73c9aSwdenk
3387566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3388566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3389566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3390566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3391566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3392566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3393566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3394566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3395566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3396566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3397566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3398566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3399566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3400566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3401566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3402566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3403566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3404566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3405566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3406566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3407566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3408566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3409566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3410566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3411566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3412566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3413566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3414566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3415566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3416566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3417566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3418566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3419566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3420566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3421566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3422566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3423566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3424566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3425566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3426566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3427566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3428566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3429566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3430566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3431566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3432566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3433566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3434c609719bSwdenk
3435566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3436c609719bSwdenk
3437566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3438566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3439566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3440206c60cbSwdenk
3441566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3442566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
344311ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3444566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3445566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3446566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
344774de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
344874de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3449566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3450c609719bSwdenk
34511372cce2SMarian BalakowiczFIT uImage format:
34521372cce2SMarian Balakowicz
34531372cce2SMarian Balakowicz  Arg	Where			When
34541372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
34551372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
34561372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
34571372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
34581372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
34591372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3460f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
34611372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
34621372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
34631372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
34641372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
34651372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
346611ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
346711ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
34681372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
34691372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
34701372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
34711372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
34721372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
34731372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
34741372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
34751372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
34761372cce2SMarian Balakowicz
34771372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
34781372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
34791372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
348011ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
34811372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
34821372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
34831372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
34841372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
34851372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
34861372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
34871372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
34881372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
34891372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
34901372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
34911372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
34921372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
34931372cce2SMarian Balakowicz
349411ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
34951372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
34961372cce2SMarian Balakowicz
349711ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
34981372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
34991372cce2SMarian Balakowicz
350011ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
35011372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
35021372cce2SMarian Balakowicz
350321d29f7fSHeiko Schocher- legacy image format:
350421d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
350521d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
350621d29f7fSHeiko Schocher
350721d29f7fSHeiko Schocher		Default:
350821d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
350921d29f7fSHeiko Schocher
351021d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
351121d29f7fSHeiko Schocher		disable the legacy image format
351221d29f7fSHeiko Schocher
351321d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
351421d29f7fSHeiko Schocher		enabled per default for backward compatibility.
351521d29f7fSHeiko Schocher
3516d95f6ec7SGabe Black- FIT image support:
3517d95f6ec7SGabe Black		CONFIG_FIT
3518d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3519d95f6ec7SGabe Black
3520d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3521d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3522d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3523d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3524d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3525d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3526d95f6ec7SGabe Black
35273e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
35283e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
352994e3c8c4Sgaurav rana		using a hash signed and verified using RSA. If
353094e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
353194e3c8c4Sgaurav rana		hashing is available using hardware, RSA library will use it.
353294e3c8c4Sgaurav rana		See doc/uImage.FIT/signature.txt for more details.
35333e569a6bSSimon Glass
353421d29f7fSHeiko Schocher		WARNING: When relying on signed FIT images with required
353521d29f7fSHeiko Schocher		signature check the legacy image format is default
353621d29f7fSHeiko Schocher		disabled. If a board need legacy image format support
353721d29f7fSHeiko Schocher		enable this through CONFIG_IMAGE_FORMAT_LEGACY
353821d29f7fSHeiko Schocher
35399a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
35409a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
35419a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
35429a4f479bSDirk Eibach		with this option.
35439a4f479bSDirk Eibach
35444cf2609bSWolfgang Denk- Standalone program support:
35454cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
35464cf2609bSWolfgang Denk
35476feff899SWolfgang Denk		This option defines a board specific value for the
35486feff899SWolfgang Denk		address where standalone program gets loaded, thus
35496feff899SWolfgang Denk		overwriting the architecture dependent default
35504cf2609bSWolfgang Denk		settings.
35514cf2609bSWolfgang Denk
35524cf2609bSWolfgang Denk- Frame Buffer Address:
35534cf2609bSWolfgang Denk		CONFIG_FB_ADDR
35544cf2609bSWolfgang Denk
35554cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
355644a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
355744a53b57SWolfgang Denk		when using a graphics controller has separate video
355844a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
355944a53b57SWolfgang Denk		the given address instead of dynamically reserving it
356044a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
356144a53b57SWolfgang Denk		the memory for the frame buffer depending on the
356244a53b57SWolfgang Denk		configured panel size.
35634cf2609bSWolfgang Denk
35644cf2609bSWolfgang Denk		Please see board_init_f function.
35654cf2609bSWolfgang Denk
3566cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3567cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3568cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3569cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3570cccfc2abSDetlev Zundel
3571cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3572cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3573cccfc2abSDetlev Zundel
3574cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3575cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3576cccfc2abSDetlev Zundel
3577cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3578cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3579cccfc2abSDetlev Zundel
3580cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3581cccfc2abSDetlev Zundel
3582cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3583cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3584cccfc2abSDetlev Zundel
3585ff94bc40SHeiko Schocher		CONFIG_MTD_NAND_VERIFY_WRITE
3586ff94bc40SHeiko Schocher		verify if the written data is correct reread.
3587ff94bc40SHeiko Schocher
358870c219cdSJoe Hershberger- UBI support
358970c219cdSJoe Hershberger		CONFIG_CMD_UBI
359070c219cdSJoe Hershberger
359170c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
359270c219cdSJoe Hershberger		with the UBI flash translation layer
359370c219cdSJoe Hershberger
359470c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
359570c219cdSJoe Hershberger
3596147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3597147162daSJoe Hershberger
3598147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3599147162daSJoe Hershberger		warnings and errors enabled.
3600147162daSJoe Hershberger
3601ff94bc40SHeiko Schocher
3602ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3603ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3604ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3605ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3606ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3607ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3608ff94bc40SHeiko Schocher
3609ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3610ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3611ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3612ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3613ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3614ff94bc40SHeiko Schocher
3615ff94bc40SHeiko Schocher		default: 4096
3616ff94bc40SHeiko Schocher
3617ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3618ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3619ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3620ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3621ff94bc40SHeiko Schocher		flash), this value is ignored.
3622ff94bc40SHeiko Schocher
3623ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3624ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3625ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3626ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3627ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3628ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3629ff94bc40SHeiko Schocher
3630ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3631ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3632ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3633ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3634ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3635ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3636ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3637ff94bc40SHeiko Schocher		partition.
3638ff94bc40SHeiko Schocher
3639ff94bc40SHeiko Schocher		default: 20
3640ff94bc40SHeiko Schocher
3641ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3642ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3643ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3644ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3645ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3646ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3647ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3648ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3649ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3650ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3651ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3652ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3653ff94bc40SHeiko Schocher
3654ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3655ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3656ff94bc40SHeiko Schocher		without a fastmap.
3657ff94bc40SHeiko Schocher		default: 0
3658ff94bc40SHeiko Schocher
365970c219cdSJoe Hershberger- UBIFS support
366070c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
366170c219cdSJoe Hershberger
366270c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
366370c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
366470c219cdSJoe Hershberger
366570c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
366670c219cdSJoe Hershberger
3667147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3668147162daSJoe Hershberger
3669147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3670147162daSJoe Hershberger		warnings and errors enabled.
3671147162daSJoe Hershberger
36726a11cf48SDaniel Schwierzeck- SPL framework
36736a11cf48SDaniel Schwierzeck		CONFIG_SPL
36746a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
36756a11cf48SDaniel Schwierzeck
367695579793STom Rini		CONFIG_SPL_LDSCRIPT
367795579793STom Rini		LDSCRIPT for linking the SPL binary.
367895579793STom Rini
36796ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
36806ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
36816ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
36826ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
36838960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
36846ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
36856ebc3461SAlbert ARIBAUD
368695579793STom Rini		CONFIG_SPL_MAX_SIZE
36876ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
36886ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
36896ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
36906ebc3461SAlbert ARIBAUD		not exceed it.
369195579793STom Rini
36926a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
36936a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
36946a11cf48SDaniel Schwierzeck
369594a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
369694a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
369794a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
369894a45bb1SScott Wood
369995579793STom Rini		CONFIG_SPL_BSS_START_ADDR
370095579793STom Rini		Link address for the BSS within the SPL binary.
370195579793STom Rini
370295579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
37036ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
37046ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
37056ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
37068960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
37076ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
370895579793STom Rini
370995579793STom Rini		CONFIG_SPL_STACK
371095579793STom Rini		Adress of the start of the stack SPL will use
371195579793STom Rini
371294a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
371394a45bb1SScott Wood		Adress of the start of the stack SPL will use after
371494a45bb1SScott Wood		relocation.  If unspecified, this is equal to
371594a45bb1SScott Wood		CONFIG_SPL_STACK.
371694a45bb1SScott Wood
371795579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
371895579793STom Rini		Starting address of the malloc pool used in SPL.
371995579793STom Rini
372095579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
372195579793STom Rini		The size of the malloc pool used in SPL.
37226a11cf48SDaniel Schwierzeck
372347f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
372447f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
372547f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
372647f7bcaeSTom Rini		NAND loading of the Linux Kernel.
372747f7bcaeSTom Rini
37289607faf2STom Rini		CONFIG_SPL_OS_BOOT
37299607faf2STom Rini		Enable booting directly to an OS from SPL.
37309607faf2STom Rini		See also: doc/README.falcon
37319607faf2STom Rini
3732861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3733861a86f4STom Rini		For ARM, enable an optional function to print more information
3734861a86f4STom Rini		about the running system.
3735861a86f4STom Rini
37364b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
37374b919725SScott Wood		Arch init code should be built for a very small image
37384b919725SScott Wood
37396a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
37406a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
37416a11cf48SDaniel Schwierzeck
37426a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
37436a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
37446a11cf48SDaniel Schwierzeck
37456a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
37466a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
37476a11cf48SDaniel Schwierzeck
37486a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
37496a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
37506a11cf48SDaniel Schwierzeck
37516a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
37526a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
37536a11cf48SDaniel Schwierzeck
375495579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
375595579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3756e2ccdf89SPaul Kocialkowski		Address and partition on the MMC to load U-Boot from
375795579793STom Rini		when the MMC is being used in raw mode.
375895579793STom Rini
3759b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3760b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3761b97300b6SPaul Kocialkowski		used in raw mode
3762b97300b6SPaul Kocialkowski
37632b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
37642b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
37652b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
37662b75b0adSPeter Korsgaard
37672b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
37682b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
37692b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
37702b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
37712b75b0adSPeter Korsgaard		(for falcon mode)
37722b75b0adSPeter Korsgaard
3773e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3774e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3775e2ccdf89SPaul Kocialkowski		used in fs mode
3776e2ccdf89SPaul Kocialkowski
377795579793STom Rini		CONFIG_SPL_FAT_SUPPORT
377895579793STom Rini		Support for fs/fat/libfat.o in SPL binary
377995579793STom Rini
3780fae81c72SGuillaume GARDET		CONFIG_SPL_EXT_SUPPORT
3781fae81c72SGuillaume GARDET		Support for EXT filesystem in SPL binary
378295579793STom Rini
3783fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3784fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3785fae81c72SGuillaume GARDET
3786fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
37877ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3788fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
37897ad2cc79SPeter Korsgaard
3790fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
37917ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3792fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
37937ad2cc79SPeter Korsgaard
379406f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
379506f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
379606f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
379706f60ae3SScott Wood		continuing (the hardware starts execution after just
379806f60ae3SScott Wood		loading the first page rather than the full 4K).
379906f60ae3SScott Wood
3800651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3801651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3802651fcf60SPrabhakar Kushwaha
38036f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
38046f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
38056f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
38066f2f01b9SScott Wood
38076f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
38086f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
38096f2f01b9SScott Wood
38106f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
38116f2f01b9SScott Wood		Include standard software ECC in the SPL
38126f2f01b9SScott Wood
381395579793STom Rini		CONFIG_SPL_NAND_SIMPLE
38147d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
38157d4b7955SScott Wood		expose the cmd_ctrl() interface.
381695579793STom Rini
38176dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
38186dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
38196dd3b566STom Rini		environment on NAND support within SPL.
38206dd3b566STom Rini
38210c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
38220c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
38230c3117b1SHeiko Schocher		if you need to save space.
38240c3117b1SHeiko Schocher
3825bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3826bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
38275614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3828bb0dc108SYing Zhang
38297c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
38307c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
38317c8eea59SYing Zhang		SPL binary.
38327c8eea59SYing Zhang
383395579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
383495579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
383595579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
383695579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
383795579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
383895579793STom Rini		Defines the size and behavior of the NAND that SPL uses
38397d4b7955SScott Wood		to read U-Boot
384095579793STom Rini
3841fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3842fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3843fbe76ae4SPrabhakar Kushwaha
384495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
38457d4b7955SScott Wood		Location in NAND to read U-Boot from
38467d4b7955SScott Wood
38477d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
38487d4b7955SScott Wood		Location in memory to load U-Boot to
38497d4b7955SScott Wood
38507d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
38517d4b7955SScott Wood		Size of image to load
385295579793STom Rini
385395579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
38547d4b7955SScott Wood		Entry point in loaded image to jump to
385595579793STom Rini
385695579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
385795579793STom Rini		Define this if you need to first read the OOB and then the
3858b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
385995579793STom Rini
386095579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
386195579793STom Rini		Support for an OMAP3-specific set of functions to return the
386295579793STom Rini		ID and MFR of the first attached NAND chip, if present.
386395579793STom Rini
38646a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
38656a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
38666a11cf48SDaniel Schwierzeck
38676a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
38686a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
38696a11cf48SDaniel Schwierzeck
38706a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
38716a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
38726a11cf48SDaniel Schwierzeck
3873c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3874c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3875c57b953dSPavel Machek
38766a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
38776a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
38781372cce2SMarian Balakowicz
3879ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3880ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3881ba1bee43SYing Zhang
3882ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3883ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3884ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3885ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3886ba1bee43SYing Zhang
388774752baaSScott Wood		CONFIG_SPL_PAD_TO
38886113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
38896113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
38906113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
38916113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
38926113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
389374752baaSScott Wood
3894ca2fca22SScott Wood		CONFIG_SPL_TARGET
3895ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3896ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3897ca2fca22SScott Wood		example if more than one image needs to be produced.
3898ca2fca22SScott Wood
389987ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
390087ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
390187ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
390287ebee39SSimon Glass		option to re-enable it. This will affect the output of the
390387ebee39SSimon Glass		bootm command when booting a FIT image.
390487ebee39SSimon Glass
39053aa29de0SYing Zhang- TPL framework
39063aa29de0SYing Zhang		CONFIG_TPL
39073aa29de0SYing Zhang		Enable building of TPL globally.
39083aa29de0SYing Zhang
39093aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
39103aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
39113aa29de0SYing Zhang		the TPL payload. By default, this is defined as
39123aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
39133aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
39143aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
39153aa29de0SYing Zhang
3916c609719bSwdenkModem Support:
3917c609719bSwdenk--------------
3918c609719bSwdenk
3919566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3920c609719bSwdenk
392111ccc33fSMarcel Ziswiler- Modem support enable:
3922c609719bSwdenk		CONFIG_MODEM_SUPPORT
3923c609719bSwdenk
3924c609719bSwdenk- RTS/CTS Flow control enable:
3925c609719bSwdenk		CONFIG_HWFLOW
3926c609719bSwdenk
3927c609719bSwdenk- Modem debug support:
3928c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3929c609719bSwdenk
3930c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3931c609719bSwdenk		for modem support. Useful only with BDI2000.
3932c609719bSwdenk
3933a8c7c708Swdenk- Interrupt support (PPC):
3934a8c7c708Swdenk
3935a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3936a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
393711ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3938a8c7c708Swdenk		should set decrementer_count to appropriate value. If
393911ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3940a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
394111ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3942a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3943a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3944a8c7c708Swdenk		general timer_interrupt().
3945a8c7c708Swdenk
3946c609719bSwdenk- General:
3947c609719bSwdenk
3948c609719bSwdenk		In the target system modem support is enabled when a
3949c609719bSwdenk		specific key (key combination) is pressed during
3950c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
395111ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3952c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3953c609719bSwdenk		function, returning 1 and thus enabling modem
3954c609719bSwdenk		initialization.
3955c609719bSwdenk
3956c609719bSwdenk		If there are no modem init strings in the
3957c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3958c609719bSwdenk		previous output (banner, info printfs) will be
395911ccc33fSMarcel Ziswiler		suppressed, though.
3960c609719bSwdenk
3961c609719bSwdenk		See also: doc/README.Modem
3962c609719bSwdenk
39639660e442SHelmut RaigerBoard initialization settings:
39649660e442SHelmut Raiger------------------------------
39659660e442SHelmut Raiger
39669660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
39679660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
39689660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
39699660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
39709660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
39719660e442SHelmut Raigertypically in board_init_f() and board_init_r().
39729660e442SHelmut Raiger
39739660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
39749660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
39759660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
39769660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3977c609719bSwdenk
3978c609719bSwdenkConfiguration Settings:
3979c609719bSwdenk-----------------------
3980c609719bSwdenk
39814d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
39824d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
39834d1fd7f1SYork Sun
39846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3985c609719bSwdenk		undefine this when you're short of memory.
3986c609719bSwdenk
39872fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
39882fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
39892fb2604dSPeter Tyser
39906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3991c609719bSwdenk		prompt for user input.
3992c609719bSwdenk
39936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3994c609719bSwdenk
39956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3996c609719bSwdenk
39976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3998c609719bSwdenk
39996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
4000c609719bSwdenk		the application (usually a Linux kernel) when it is
4001c609719bSwdenk		booted
4002c609719bSwdenk
40036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
4004c609719bSwdenk		List of legal baudrate settings for this board.
4005c609719bSwdenk
40066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
4007c609719bSwdenk		Suppress display of console information at boot.
4008c609719bSwdenk
40096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
4010c609719bSwdenk		If the board specific function
4011c609719bSwdenk			extern int overwrite_console (void);
4012c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
4013c609719bSwdenk		serial port, else the settings in the environment are used.
4014c609719bSwdenk
40156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
4016c609719bSwdenk		Enable the call to overwrite_console().
4017c609719bSwdenk
40186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
4019c609719bSwdenk		Enable overwrite of previous console environment settings.
4020c609719bSwdenk
40216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
4022c609719bSwdenk		Begin and End addresses of the area used by the
4023c609719bSwdenk		simple memory test.
4024c609719bSwdenk
40256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
4026c609719bSwdenk		Enable an alternate, more extensive memory test.
4027c609719bSwdenk
40286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
40295f535fe1Swdenk		Scratch address used by the alternate memory test
40305f535fe1Swdenk		You only need to set this if address zero isn't writeable
40315f535fe1Swdenk
40326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
40336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
403414f73ca6SStefan Roese		this specified memory area will get subtracted from the top
403511ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
403614f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
403714f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
403814f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
40395e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
404014f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
40415e12e75dSStefan Roese		will have to get fixed in Linux additionally.
404214f73ca6SStefan Roese
404314f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
404414f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
404514f73ca6SStefan Roese		be touched.
404614f73ca6SStefan Roese
404714f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
404814f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
404914f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
405014f73ca6SStefan Roese		non page size aligned address and this could cause major
405114f73ca6SStefan Roese		problems.
405214f73ca6SStefan Roese
40536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
4054c609719bSwdenk		Enable temporary baudrate change while serial download
4055c609719bSwdenk
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
4057c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
4058c609719bSwdenk
40596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
4060c609719bSwdenk		Physical start address of Motherboard I/O (if using a
4061c609719bSwdenk		Cogent motherboard)
4062c609719bSwdenk
40636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
4064c609719bSwdenk		Physical start address of Flash memory.
4065c609719bSwdenk
40666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
4067c609719bSwdenk		Physical start address of boot monitor code (set by
4068c609719bSwdenk		make config files to be same as the text base address
406914d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
40706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
4071c609719bSwdenk
40726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
40733b57fe0aSwdenk		Size of memory reserved for monitor code, used to
40743b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
40753b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
40763b57fe0aSwdenk		flash sector.
4077c609719bSwdenk
40786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
4079c609719bSwdenk		Size of DRAM reserved for malloc() use.
4080c609719bSwdenk
4081d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
4082d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
4083d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
4084d59476b6SSimon Glass		will become available before relocation. The address is just
4085d59476b6SSimon Glass		below the global data, and the stack is moved down to make
4086d59476b6SSimon Glass		space.
4087d59476b6SSimon Glass
4088d59476b6SSimon Glass		This feature allocates regions with increasing addresses
4089d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
4090d59476b6SSimon Glass		is not available. free() is supported but does nothing.
4091b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
4092d59476b6SSimon Glass		U-Boot relocates itself.
4093d59476b6SSimon Glass
4094e7b14e9aSSimon Glass		Pre-relocation malloc() is only supported on ARM and sandbox
409529afe9e6SSimon Glass		at present but is fairly easy to enable for other archs.
409629afe9e6SSimon Glass
409738687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
409838687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
409938687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
410038687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
410138687ae6SSimon Glass
41021dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
41031dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
41041dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
41051dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
41061dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
41071dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
41081dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
41091dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
41101dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
41111dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
41121dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
41131dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
41141dfdd9baSThierry Reding		written to another region in the same cache-line. This can
41151dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
41161dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
41171dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
41181dfdd9baSThierry Reding
41191dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
41201dfdd9baSThierry Reding
41216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
412215940c9aSStefan Roese		Normally compressed uImages are limited to an
412315940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
41246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
412515940c9aSStefan Roese		to adjust this setting to your needs.
4126c609719bSwdenk
41276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
4128c609719bSwdenk		Maximum size of memory mapped by the startup code of
4129c609719bSwdenk		the Linux kernel; all data that must be processed by
41307d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
41317d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
41321bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
41337d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
4134c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
4135c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
4136c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
4137c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
4138c609719bSwdenk
4139fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4140fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
4141fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
4142fca43cc8SJohn Rigby		is enabled.
4143fca43cc8SJohn Rigby
4144fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
4145fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
4146fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
4147fca43cc8SJohn Rigby
4148fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
4149fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
4150fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4151fca43cc8SJohn Rigby
41526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
4153c609719bSwdenk		Max number of Flash memory banks
4154c609719bSwdenk
41556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
4156c609719bSwdenk		Max number of sectors on a Flash chip
4157c609719bSwdenk
41586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
4159c609719bSwdenk		Timeout for Flash erase operations (in ms)
4160c609719bSwdenk
41616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
4162c609719bSwdenk		Timeout for Flash write operations (in ms)
4163c609719bSwdenk
41646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
41658564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
41668564acf9Swdenk
41676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
41688564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
41698564acf9Swdenk
41706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
41718564acf9Swdenk		If defined, hardware flash sectors protection is used
41728564acf9Swdenk		instead of U-Boot software protection.
41738564acf9Swdenk
41746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
4175c609719bSwdenk
4176c609719bSwdenk		Enable TFTP transfers directly to flash memory;
4177c609719bSwdenk		without this option such a download has to be
4178c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
4179c609719bSwdenk		copy from RAM to flash.
4180c609719bSwdenk
4181c609719bSwdenk		The two-step approach is usually more reliable, since
4182c609719bSwdenk		you can check if the download worked before you erase
418311ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
418411ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
4185c609719bSwdenk		downloaded image) this option may be very useful.
4186c609719bSwdenk
41876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
4188c609719bSwdenk		Define if the flash driver uses extra elements in the
41895653fc33Swdenk		common flash structure for storing flash geometry.
41905653fc33Swdenk
419100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
41925653fc33Swdenk		This option also enables the building of the cfi_flash driver
41935653fc33Swdenk		in the drivers directory
419453cf9435Sstroese
419591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
419691809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
419791809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
419891809ed5SPiotr Ziecik		to the MTD layer.
419991809ed5SPiotr Ziecik
42006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
420196ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
420296ef831fSGuennadi Liakhovetski
420396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
420496ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
420596ef831fSGuennadi Liakhovetski		write commands.
420696ef831fSGuennadi Liakhovetski
42076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
42085568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
42095568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
42105568e613SStefan Roese		is useful, if some of the configured banks are only
42115568e613SStefan Roese		optionally available.
42125568e613SStefan Roese
42139a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
42149a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
42159a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
42169a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
42179a042e9cSJerry Van Baren
4218352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
4219352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
4220352ef3f1SStefan Roese		against the source after the write operation. An error message
4221352ef3f1SStefan Roese		will be printed when the contents are not identical.
4222352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
4223352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
4224352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
4225352ef3f1SStefan Roese		this option if you really know what you are doing.
4226352ef3f1SStefan Roese
42276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
422811ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
422911ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
423053cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
423153cf9435Sstroese		buffers can be full shortly after enabling the interface
423211ccc33fSMarcel Ziswiler		on high Ethernet traffic.
423353cf9435Sstroese		Defaults to 4 if not defined.
4234c609719bSwdenk
4235ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
4236ea882bafSWolfgang Denk
4237ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
4238ea882bafSWolfgang Denk	internally to store the environment settings. The default
4239ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
4240ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
4241ea882bafSWolfgang Denk	lib/hashtable.c for details.
4242ea882bafSWolfgang Denk
42432598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
42442598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
42451bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
42462598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
42472598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
42482598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
42492598090bSJoe Hershberger
42502598090bSJoe Hershberger	The format of the list is:
42512598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
4252b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
4253b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
42542598090bSJoe Hershberger		entry = variable_name[:attributes]
42552598090bSJoe Hershberger		list = entry[,list]
42562598090bSJoe Hershberger
42572598090bSJoe Hershberger	The type attributes are:
42582598090bSJoe Hershberger		s - String (default)
42592598090bSJoe Hershberger		d - Decimal
42602598090bSJoe Hershberger		x - Hexadecimal
42612598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
42622598090bSJoe Hershberger		i - IP address
42632598090bSJoe Hershberger		m - MAC address
42642598090bSJoe Hershberger
4265267541f7SJoe Hershberger	The access attributes are:
4266267541f7SJoe Hershberger		a - Any (default)
4267267541f7SJoe Hershberger		r - Read-only
4268267541f7SJoe Hershberger		o - Write-once
4269267541f7SJoe Hershberger		c - Change-default
4270267541f7SJoe Hershberger
42712598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
42722598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
4273b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
42742598090bSJoe Hershberger
42752598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
42762598090bSJoe Hershberger		Define this to a list (string) to define validation that
42772598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
42782598090bSJoe Hershberger		environment variable.  To override a setting in the static
42792598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
42802598090bSJoe Hershberger		".flags" variable.
42812598090bSJoe Hershberger
4282267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
4283267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
4284267541f7SJoe Hershberger	access flags.
4285267541f7SJoe Hershberger
42865c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
42875c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
42885c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
42895c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
42905c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
42915c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
42925c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
42935c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
42945c1a7ea6SSimon Glass	your board please report the problem and send patches!
42955c1a7ea6SSimon Glass
42960b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
42970b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
42980b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
4299b445bbb4SJeremiah Mahler	the value can be calculated on a given board.
4300632efa74SSimon Glass
43010d296cc2SGabe Black- CONFIG_USE_STDINT
43020d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
43030d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
43040d296cc2SGabe Black	building U-Boot to enable this.
43050d296cc2SGabe Black
4306c609719bSwdenkThe following definitions that deal with the placement and management
4307c609719bSwdenkof environment data (variable area); in general, we support the
4308c609719bSwdenkfollowing configurations:
4309c609719bSwdenk
4310c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
4311c3eb3fe4SMike Frysinger
4312c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
4313c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
4314c3eb3fe4SMike Frysinger
43155a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
4316c609719bSwdenk
4317c609719bSwdenk	Define this if the environment is in flash memory.
4318c609719bSwdenk
4319c609719bSwdenk	a) The environment occupies one whole flash sector, which is
4320c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
4321c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
4322c609719bSwdenk	   sector" type flash chips, which have several smaller
4323c609719bSwdenk	   sectors at the start or the end. For instance, such a
4324c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4325c609719bSwdenk	   such a case you would place the environment in one of the
4326c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
4327c609719bSwdenk	   "top boot sector" type flash chips, you would put the
4328c609719bSwdenk	   environment in one of the last sectors, leaving a gap
4329c609719bSwdenk	   between U-Boot and the environment.
4330c609719bSwdenk
43310e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4332c609719bSwdenk
4333c609719bSwdenk	   Offset of environment data (variable area) to the
4334c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
4335c609719bSwdenk	   type flash chips the second sector can be used: the offset
4336c609719bSwdenk	   for this sector is given here.
4337c609719bSwdenk
43386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4339c609719bSwdenk
43400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4341c609719bSwdenk
4342c609719bSwdenk	   This is just another way to specify the start address of
4343c609719bSwdenk	   the flash sector containing the environment (instead of
43440e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
4345c609719bSwdenk
43460e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
4347c609719bSwdenk
4348c609719bSwdenk	   Size of the sector containing the environment.
4349c609719bSwdenk
4350c609719bSwdenk
4351c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
4352c609719bSwdenk	   In such a case you don't want to spend a whole sector for
4353c609719bSwdenk	   the environment.
4354c609719bSwdenk
43550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4356c609719bSwdenk
43575a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
43580e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4359c609719bSwdenk	   of this flash sector for the environment. This saves
4360c609719bSwdenk	   memory for the RAM copy of the environment.
4361c609719bSwdenk
4362c609719bSwdenk	   It may also save flash memory if you decide to use this
4363c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
4364c609719bSwdenk	   since then the remainder of the flash sector could be used
4365c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4366c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4367c609719bSwdenk	   updating the environment in flash makes it always
4368c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4369c609719bSwdenk	   wrong before the contents has been restored from a copy in
4370c609719bSwdenk	   RAM, your target system will be dead.
4371c609719bSwdenk
43720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
43730e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4374c609719bSwdenk
4375c609719bSwdenk	   These settings describe a second storage area used to hold
437611ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
43773e38691eSwdenk	   a valid backup copy in case there is a power failure during
4378c609719bSwdenk	   a "saveenv" operation.
4379c609719bSwdenk
4380c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4381c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4382c609719bSwdenkaccordingly!
4383c609719bSwdenk
4384c609719bSwdenk
43859314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4386c609719bSwdenk
4387c609719bSwdenk	Define this if you have some non-volatile memory device
4388c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4389c609719bSwdenk	environment.
4390c609719bSwdenk
43910e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
43920e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4393c609719bSwdenk
439411ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4395c609719bSwdenk	  want to use for environment. It is assumed that this memory
4396c609719bSwdenk	  can just be read and written to, without any special
4397c609719bSwdenk	  provision.
4398c609719bSwdenk
4399c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4400b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
440111ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4402c609719bSwdenkU-Boot will hang.
4403c609719bSwdenk
4404c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4405c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4406c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4407c609719bSwdenkto save the current settings.
4408c609719bSwdenk
4409c609719bSwdenk
4410bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4411c609719bSwdenk
4412c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4413c609719bSwdenk	device and a driver for it.
4414c609719bSwdenk
44150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
44160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4417c609719bSwdenk
4418c609719bSwdenk	  These two #defines specify the offset and size of the
4419c609719bSwdenk	  environment area within the total memory of your EEPROM.
4420c609719bSwdenk
44216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4422c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4423c609719bSwdenk	  The default address is zero.
4424c609719bSwdenk
44256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4426c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4427c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4428c609719bSwdenk	  would require six bits.
4429c609719bSwdenk
44306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4431c609719bSwdenk	  If defined, the number of milliseconds to delay between
4432c609719bSwdenk	  page writes.	The default is zero milliseconds.
4433c609719bSwdenk
44346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4435c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4436c609719bSwdenk	  that this is NOT the chip address length!
4437c609719bSwdenk
44386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
44395cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
44405cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
44415cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
44425cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
44435cf91d6bSwdenk	  byte chips.
44445cf91d6bSwdenk
44455cf91d6bSwdenk	  Note that we consider the length of the address field to
44465cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
44475cf91d6bSwdenk	  in the chip address.
44485cf91d6bSwdenk
44496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4450c609719bSwdenk	  The size in bytes of the EEPROM device.
4451c609719bSwdenk
4452548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4453548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4454548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4455548738b4SHeiko Schocher
4456548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4457548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4458548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4459548738b4SHeiko Schocher	  EEPROM. For example:
4460548738b4SHeiko Schocher
4461ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4462548738b4SHeiko Schocher
4463548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4464548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4465c609719bSwdenk
4466057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
44675779d8d9Swdenk
44685779d8d9Swdenk	Define this if you have a DataFlash memory device which you
44695779d8d9Swdenk	want to use for the environment.
44705779d8d9Swdenk
44710e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
44720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
44730e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
44745779d8d9Swdenk
44755779d8d9Swdenk	  These three #defines specify the offset and size of the
44765779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
44775779d8d9Swdenk	  at the specified address.
44785779d8d9Swdenk
4479bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4480bd83b592SWu, Josh
4481bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4482bd83b592SWu, Josh	want to use for the environment.
4483bd83b592SWu, Josh
4484bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4485bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4486bd83b592SWu, Josh
4487bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4488bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4489bd83b592SWu, Josh	  aligned to an erase sector boundary.
4490bd83b592SWu, Josh
4491bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4492bd83b592SWu, Josh
4493bd83b592SWu, Josh	  Define the SPI flash's sector size.
4494bd83b592SWu, Josh
4495bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4496bd83b592SWu, Josh
4497bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4498bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4499bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
4500bd83b592SWu, Josh	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4501bd83b592SWu, Josh	  aligned to an erase sector boundary.
4502bd83b592SWu, Josh
4503bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4504bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4505bd83b592SWu, Josh
4506bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4507bd83b592SWu, Josh
4508bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4509bd83b592SWu, Josh
4510bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4511bd83b592SWu, Josh
4512bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4513bd83b592SWu, Josh
4514bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4515bd83b592SWu, Josh
45160a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
45170a85a9e7SLiu Gang
45180a85a9e7SLiu Gang	Define this if you have a remote memory space which you
45190a85a9e7SLiu Gang	want to use for the local device's environment.
45200a85a9e7SLiu Gang
45210a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
45220a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
45230a85a9e7SLiu Gang
45240a85a9e7SLiu Gang	  These two #defines specify the address and size of the
45250a85a9e7SLiu Gang	  environment area within the remote memory space. The
45260a85a9e7SLiu Gang	  local device can get the environment from remote memory
4527fc54c7faSLiu Gang	  space by SRIO or PCIE links.
45280a85a9e7SLiu Gang
45290a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
45300a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4531fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4532fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
45330a85a9e7SLiu Gang
453451bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
453513a5695bSwdenk
453613a5695bSwdenk	Define this if you have a NAND device which you want to use
453713a5695bSwdenk	for the environment.
453813a5695bSwdenk
45390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
45400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
454113a5695bSwdenk
454213a5695bSwdenk	  These two #defines specify the offset and size of the environment
4543fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4544fdd813deSScott Wood	  aligned to an erase block boundary.
45455779d8d9Swdenk
4546fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4547e443c944SMarkus Klotzbuecher
45480e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4549fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4550fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4551fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4552fdd813deSScott Wood	  aligned to an erase block boundary.
4553e443c944SMarkus Klotzbuecher
4554fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4555fdd813deSScott Wood
4556fdd813deSScott Wood	  Specifies the length of the region in which the environment
4557fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4558fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4559fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4560fdd813deSScott Wood	  the range to be avoided.
4561fdd813deSScott Wood
4562fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4563fdd813deSScott Wood
4564fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4565fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4566fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4567fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4568fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4569e443c944SMarkus Klotzbuecher
4570b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4571b74ab737SGuennadi Liakhovetski
4572b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4573b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4574b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4575b74ab737SGuennadi Liakhovetski
45762b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
45772b74433fSJoe Hershberger
45782b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
45792b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
45802b74433fSJoe Hershberger	accesses, which is important on NAND.
45812b74433fSJoe Hershberger
45822b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
45832b74433fSJoe Hershberger
45842b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
45852b74433fSJoe Hershberger
45862b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
45872b74433fSJoe Hershberger
45882b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
45892b74433fSJoe Hershberger	  environment in.
45902b74433fSJoe Hershberger
4591785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4592785881f7SJoe Hershberger
4593785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4594785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4595785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4596785881f7SJoe Hershberger
45972b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
45982b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
45992b74433fSJoe Hershberger
46002b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
46012b74433fSJoe Hershberger	  when storing the env in UBI.
46022b74433fSJoe Hershberger
4603d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4604d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4605d1db76f1SWu, Josh
4606d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4607d1db76f1SWu, Josh
4608d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4609d1db76f1SWu, Josh
4610d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4611d1db76f1SWu, Josh
4612d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4613d1db76f1SWu, Josh         be as following:
4614d1db76f1SWu, Josh
4615d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4616d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4617d1db76f1SWu, Josh                        partition table.
4618d1db76f1SWu, Josh               - "D:0": device D.
4619d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4620d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4621d1db76f1SWu, Josh                              table.
4622d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4623b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
4624d1db76f1SWu, Josh                           partition table then means device D.
4625d1db76f1SWu, Josh
4626d1db76f1SWu, Josh       - FAT_ENV_FILE:
4627d1db76f1SWu, Josh
4628d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4629b445bbb4SJeremiah Mahler         environment.
4630d1db76f1SWu, Josh
4631d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4632b445bbb4SJeremiah Mahler         This should be defined. Otherwise it cannot save the environment file.
4633d1db76f1SWu, Josh
463406e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
463506e4ae5fSStephen Warren
463606e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
463706e4ae5fSStephen Warren	environment.
463806e4ae5fSStephen Warren
463906e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
464006e4ae5fSStephen Warren
464106e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
464206e4ae5fSStephen Warren
464306e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
464406e4ae5fSStephen Warren
464506e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
464606e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
464706e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
464806e4ae5fSStephen Warren
464906e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
465006e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
465106e4ae5fSStephen Warren
465206e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
465306e4ae5fSStephen Warren	  area within the specified MMC device.
465406e4ae5fSStephen Warren
46555c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
46565c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
46575c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
46585c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
46595c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
46605c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
46615c088ee8SStephen Warren	  maximum possible space before it, to store other data.
46625c088ee8SStephen Warren
466306e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
466406e4ae5fSStephen Warren	  MMC sector boundary.
466506e4ae5fSStephen Warren
466606e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
466706e4ae5fSStephen Warren
466806e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
466906e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
467006e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
467106e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
467206e4ae5fSStephen Warren
46735c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
46745c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
46755c088ee8SStephen Warren
467606e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
467706e4ae5fSStephen Warren	  an MMC sector boundary.
467806e4ae5fSStephen Warren
467906e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
468006e4ae5fSStephen Warren
468106e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
468206e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
468306e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
468406e4ae5fSStephen Warren
46856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4686c609719bSwdenk
4687c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4688c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4689c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4690c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4691c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4692c609719bSwdenk	to be a good choice since it makes it far enough from the
4693c609719bSwdenk	start of the data area as well as from the stack pointer.
4694c609719bSwdenk
4695e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4696c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4697cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4698c609719bSwdenkuntil then to read environment variables.
4699c609719bSwdenk
470085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
470185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
470285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
470385ec0bccSwdenknecessary, because the first environment variable we need is the
470485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
470585ec0bccSwdenkhave any device yet where we could complain.]
4706c609719bSwdenk
4707c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4708c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
470985ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4710c609719bSwdenk
47116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4712fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4713fc3e2165Swdenk
47146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4715fc3e2165Swdenk		      also needs to be defined.
4716fc3e2165Swdenk
47176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4718fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4719c609719bSwdenk
4720f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4721f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4722f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4723f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4724f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4725f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4726f5675aa5SRon Madrid
4727b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4728b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4729b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4730b2b92f53SSimon Glass		to do this.
4731b2b92f53SSimon Glass
4732e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4733e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4734e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4735e2e3e2b1SSimon Glass		present.
4736e2e3e2b1SSimon Glass
4737feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4738feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4739feb85801SSascha Silbe		build system checks that the actual size does not
4740feb85801SSascha Silbe		exceed it.
4741feb85801SSascha Silbe
4742c609719bSwdenkLow Level (hardware related) configuration options:
4743dc7c9a1aSwdenk---------------------------------------------------
4744c609719bSwdenk
47456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4746c609719bSwdenk		Cache Line Size of the CPU.
4747c609719bSwdenk
47486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4749c609719bSwdenk		Default address of the IMMR after system reset.
47502535d602Swdenk
47512535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
47522535d602Swdenk		and RPXsuper) to be able to adjust the position of
47532535d602Swdenk		the IMMR register after a reset.
4754c609719bSwdenk
4755e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4756e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4757e46fedfeSTimur Tabi		PowerPC SOCs.
4758e46fedfeSTimur Tabi
4759e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4760e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4761e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4762e46fedfeSTimur Tabi
4763e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4764e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4765e46fedfeSTimur Tabi
4766e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4767e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4768e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4769e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4770e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4771e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4772e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4773e46fedfeSTimur Tabi
4774e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4775e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4776e46fedfeSTimur Tabi
4777e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4778e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4779e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4780e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4781e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4782e46fedfeSTimur Tabi
4783e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4784e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4785e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4786e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4787e46fedfeSTimur Tabi
4788e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4789e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4790e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4791e46fedfeSTimur Tabi
47927f6c2cbcSwdenk- Floppy Disk Support:
47936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
47947f6c2cbcSwdenk
47957f6c2cbcSwdenk		the default drive number (default value 0)
47967f6c2cbcSwdenk
47976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
47987f6c2cbcSwdenk
479911ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
48007f6c2cbcSwdenk		(default value 1)
48017f6c2cbcSwdenk
48026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
48037f6c2cbcSwdenk
48047f6c2cbcSwdenk		defines the offset of register from address. It
48057f6c2cbcSwdenk		depends on which part of the data bus is connected to
480611ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
48077f6c2cbcSwdenk
48086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
48096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
48107f6c2cbcSwdenk		default value.
48117f6c2cbcSwdenk
48126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
48137f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
48147f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
4815b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
48167f6c2cbcSwdenk		initializations.
48177f6c2cbcSwdenk
48180abddf82SMacpaul Lin- CONFIG_IDE_AHB:
48190abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
48200abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
48210abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
48220abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
48230abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4824b445bbb4SJeremiah Mahler		is required.
48250abddf82SMacpaul Lin
48266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
482725d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
482825d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4829c609719bSwdenk
48306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4831c609719bSwdenk
48327152b1d0Swdenk		Start address of memory area that can be used for
4833c609719bSwdenk		initial data and stack; please note that this must be
4834c609719bSwdenk		writable memory that is working WITHOUT special
4835c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4836c609719bSwdenk		will become available only after programming the
4837c609719bSwdenk		memory controller and running certain initialization
4838c609719bSwdenk		sequences.
4839c609719bSwdenk
4840c609719bSwdenk		U-Boot uses the following memory types:
4841c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4842c609719bSwdenk		- MPC824X: data cache
4843c609719bSwdenk		- PPC4xx:  data cache
4844c609719bSwdenk
48456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4846c609719bSwdenk
4847c609719bSwdenk		Offset of the initial data structure in the memory
48486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
48496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4850c609719bSwdenk		data is located at the end of the available space
4851553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
48526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
48536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
48546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4855c609719bSwdenk
4856c609719bSwdenk	Note:
4857c609719bSwdenk		On the MPC824X (or other systems that use the data
4858c609719bSwdenk		cache for initial memory) the address chosen for
48596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4860c609719bSwdenk		point to an otherwise UNUSED address space between
4861c609719bSwdenk		the top of RAM and the start of the PCI space.
4862c609719bSwdenk
48636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4864c609719bSwdenk
48656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4866c609719bSwdenk
48676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4868c609719bSwdenk
48696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4870c609719bSwdenk
48716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4872c609719bSwdenk
48736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4874c609719bSwdenk
48756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4876c609719bSwdenk		SDRAM timing
4877c609719bSwdenk
48786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4879c609719bSwdenk		periodic timer for refresh
4880c609719bSwdenk
48816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4882c609719bSwdenk
48836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
48846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
48856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
48866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4887c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4888c609719bSwdenk
4889c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
48906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
48916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4892c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4893c609719bSwdenk
48946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
48956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4896c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4897c609719bSwdenk		Prescaler definitions (SDRAM timing)
4898c609719bSwdenk
48996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4900c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4901c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4902c609719bSwdenk
49036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4904b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4905b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4906b423d055SHeiko Schocher
49076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4908c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4909c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4910c609719bSwdenk
49116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4912c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4913c609719bSwdenk		wrong setting might damage your board. Read
4914c609719bSwdenk		doc/README.MBX before setting this variable!
4915c609719bSwdenk
49166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4917ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4918ea909b76Swdenk		(Power On Self Tests). This definition overrides
4919ea909b76Swdenk		#define'd default value in commproc.h resp.
4920ea909b76Swdenk		cpm_8260.h.
4921ea909b76Swdenk
49226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
49236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
49246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
49256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
49266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
49276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
49286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
49296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4930a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
49315d232d0eSwdenk
49329cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
49339cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
49349cacf4fcSDirk Eibach		required.
49359cacf4fcSDirk Eibach
493669fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4937b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
493869fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
493969fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
494069fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
494169fd2d3bSAndrew Sharp		by coreboot or similar.
494269fd2d3bSAndrew Sharp
4943842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4944842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4945842033e6SGabor Juhos
4946a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4947a09b9b68SKumar Gala		Chip has SRIO or not
4948a09b9b68SKumar Gala
4949a09b9b68SKumar Gala- CONFIG_SRIO1:
4950a09b9b68SKumar Gala		Board has SRIO 1 port available
4951a09b9b68SKumar Gala
4952a09b9b68SKumar Gala- CONFIG_SRIO2:
4953a09b9b68SKumar Gala		Board has SRIO 2 port available
4954a09b9b68SKumar Gala
4955c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4956c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4957c8b28152SLiu Gang
4958a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4959a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4960a09b9b68SKumar Gala
4961a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4962a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4963a09b9b68SKumar Gala
4964a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4965a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4966a09b9b68SKumar Gala
496766bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
496866bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
496966bd1846SFabio Estevam		a 16 bit bus.
497066bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4971a430e916SFabio Estevam		Example of drivers that use it:
497266bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4973a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4974eced4626SAlex Waterman
4975eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4976eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4977eced4626SAlex Waterman		a default value will be used.
4978eced4626SAlex Waterman
4979bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4980218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4981218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4982218ca724SWolfgang Denk
4983bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4984bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4985bb99ad6dSBen Warren
49866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4987218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4988218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4989218ca724SWolfgang Denk		to something your driver can deal with.
4990bb99ad6dSBen Warren
49911b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
49921b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
49931b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
49941b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
49951b3e3c4fSYork Sun		header files or board specific files.
49961b3e3c4fSYork Sun
49976f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
49986f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
49996f5e1dc5SYork Sun
5000e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
5001e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
5002e32d59a2SYork Sun
50036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
5004218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
5005218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
50062ad6b513STimur Tabi
5007c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
5008c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
5009c26e454dSwdenk
5010c26e454dSwdenk- CONFIG_FEC[12]_PHY
5011c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
50126e592385Swdenk		to the given FEC; i. e.
5013c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
5014c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
5015c26e454dSwdenk
5016c26e454dSwdenk		When set to -1, means to probe for first available.
5017c26e454dSwdenk
5018c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
5019c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
5020c26e454dSwdenk		(so program the FEC to ignore it).
5021c26e454dSwdenk
5022c26e454dSwdenk- CONFIG_RMII
5023c26e454dSwdenk		Enable RMII mode for all FECs.
5024c26e454dSwdenk		Note that this is a global option, we can't
5025c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
5026c26e454dSwdenk
50275cf91d6bSwdenk- CONFIG_CRC32_VERIFY
50285cf91d6bSwdenk		Add a verify option to the crc32 command.
50295cf91d6bSwdenk		The syntax is:
50305cf91d6bSwdenk
50315cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
50325cf91d6bSwdenk
50335cf91d6bSwdenk		Where address/count indicate a memory area
50345cf91d6bSwdenk		and crc32 is the correct crc32 which the
50355cf91d6bSwdenk		area should have.
50365cf91d6bSwdenk
503756523f12Swdenk- CONFIG_LOOPW
503856523f12Swdenk		Add the "loopw" memory command. This only takes effect if
5039602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
504056523f12Swdenk
50417b466641Sstroese- CONFIG_MX_CYCLIC
50427b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
50437b466641Sstroese		"md/mw" commands.
50447b466641Sstroese		Examples:
50457b466641Sstroese
50467b466641Sstroese		=> mdc.b 10 4 500
50477b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
50487b466641Sstroese
50497b466641Sstroese		=> mwc.l 100 12345678 10
50507b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
50517b466641Sstroese
50527b466641Sstroese		This only takes effect if the memory commands are activated
5053602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
50547b466641Sstroese
50558aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
5056afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
5057e03f3169SWolfgang Denk		low level initializations (like setting up the memory
5058e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
5059e03f3169SWolfgang Denk		relocate itself into RAM.
50608aa1a2d1Swdenk
5061e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
5062e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
5063e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
5064e03f3169SWolfgang Denk		these initializations itself.
50658aa1a2d1Swdenk
5066401bb30bSAneesh V- CONFIG_SPL_BUILD
5067df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
5068df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
5069df81238bSMagnus Lilja		compiling a NAND SPL.
5070400558b5Swdenk
50713aa29de0SYing Zhang- CONFIG_TPL_BUILD
50723aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
50733aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
50743aa29de0SYing Zhang		It is loaded by the SPL.
50753aa29de0SYing Zhang
50765df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
50775df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
50785df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
50795df572f0SYing Zhang		previous 4k of the .text section.
50805df572f0SYing Zhang
50814213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
50824213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
50834213fc29SSimon Glass		effective address. It is therefore not necessary to regard
50844213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
50854213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
50864213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
50874213fc29SSimon Glass		addressable memory. This option causes some memory accesses
50884213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
50894213fc29SSimon Glass
5090d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
5091d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
5092d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
5093d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
5094d8834a13SMatthias Weisser		conditions but may increase the binary size.
5095d8834a13SMatthias Weisser
5096588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
5097588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
5098588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
5099b16f521aSGabe Black
5100fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
5101fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
5102fc33705eSMark Jackson
5103fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
51045b5ece9eSGabe Black
510516678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
510616678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
510716678eb4SHeiko Schocher
5108999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5109999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
5110999d7d32SKaricheri, Muralidharan		driver that uses this:
5111999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
5112999d7d32SKaricheri, Muralidharan
5113f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
5114f2717b47STimur Tabi-----------------------------------
5115f2717b47STimur Tabi
5116f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5117f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
5118f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
5119f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
5120f2717b47STimur Tabiwithin that device.
5121f2717b47STimur Tabi
5122dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
5123dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
5124dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5125dcf1d774SZhao Qiang	is also specified.
5126dcf1d774SZhao Qiang
5127dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
5128dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
5129f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5130f2717b47STimur Tabi	is also specified.
5131f2717b47STimur Tabi
5132f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
5133f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
5134f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
5135f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
5136f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
5137f2717b47STimur Tabi
5138f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5139f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5140f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
5141f2717b47STimur Tabi	virtual address in NOR flash.
5142f2717b47STimur Tabi
5143f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5144f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
5145f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5146f2717b47STimur Tabi
5147f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5148f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
5149f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5150f2717b47STimur Tabi
5151f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5152f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
5153f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5154f2717b47STimur Tabi
5155292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5156292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
5157292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
5158fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5159fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
5160fc54c7faSLiu Gang	master's memory space.
5161f2717b47STimur Tabi
5162b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
5163b940ca64SJ. German Rivera---------------------------------------------------------
5164b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
5165b940ca64SJ. German Rivera"firmware".
5166b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
5167b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
5168b940ca64SJ. German Riverawithin that device.
5169b940ca64SJ. German Rivera
5170b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
5171b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
5172b940ca64SJ. German Rivera
5173b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR
5174b940ca64SJ. German Rivera	The address in the storage device where the firmware is located.  The
5175b940ca64SJ. German Rivera	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5176b940ca64SJ. German Rivera	is also specified.
5177b940ca64SJ. German Rivera
5178b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH
5179b940ca64SJ. German Rivera	The maximum possible size of the firmware.  The firmware binary format
5180b940ca64SJ. German Rivera	has a field that specifies the actual size of the firmware, but it
5181b940ca64SJ. German Rivera	might not be possible to read any part of the firmware unless some
5182b940ca64SJ. German Rivera	local storage is allocated to hold the entire firmware first.
5183b940ca64SJ. German Rivera
5184b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR
5185b940ca64SJ. German Rivera	Specifies that MC firmware is located in NOR flash, mapped as
5186b940ca64SJ. German Rivera	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5187b940ca64SJ. German Rivera	virtual address in NOR flash.
5188b940ca64SJ. German Rivera
5189c609719bSwdenkBuilding the Software:
5190c609719bSwdenk======================
5191c609719bSwdenk
5192218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
5193218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
5194218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
5195218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
5196218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5197218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
5198c609719bSwdenk
5199218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
5200218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
5201218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
5202218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
5203218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
5204c609719bSwdenk
5205218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
5206218ca724SWolfgang Denk	$ export CROSS_COMPILE
5207c609719bSwdenk
52082f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
52092f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
52102f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
52112f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
52122f8d396bSPeter Tyser
52132f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
52142f8d396bSPeter Tyser
52152f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
52162f8d396bSPeter Tyser      be executed on computers running Windows.
52172f8d396bSPeter Tyser
5218c609719bSwdenkU-Boot is intended to be simple to build. After installing the
5219c609719bSwdenksources you must configure U-Boot for one specific board type. This
5220c609719bSwdenkis done by typing:
5221c609719bSwdenk
5222ab584d67SHolger Freyther	make NAME_defconfig
5223c609719bSwdenk
5224ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
52254d675ae6SMichael Jonesrations; see boards.cfg for supported names.
522654387ac9Swdenk
5227c609719bSwdenkNote: for some board special configuration names may exist; check if
5228c609719bSwdenk      additional information is available from the board vendor; for
52292729af9dSwdenk      instance, the TQM823L systems are available without (standard)
52302729af9dSwdenk      or with LCD support. You can select such additional "features"
523111ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
5232c609719bSwdenk
5233ab584d67SHolger Freyther      make TQM823L_defconfig
52342729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
5235c609719bSwdenk
5236ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
5237c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
5238c609719bSwdenk
5239c609719bSwdenk      etc.
5240c609719bSwdenk
5241c609719bSwdenk
5242c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
52437152b1d0Swdenkimages ready for download to / installation on your system:
5244c609719bSwdenk
5245c609719bSwdenk- "u-boot.bin" is a raw binary image
5246c609719bSwdenk- "u-boot" is an image in ELF binary format
5247c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
5248c609719bSwdenk
5249baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
5250baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
5251baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
5252baf31249SMarian Balakowicz
5253baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
5254baf31249SMarian Balakowicz
5255baf31249SMarian Balakowicz	make O=/tmp/build distclean
5256ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
5257baf31249SMarian Balakowicz	make O=/tmp/build all
5258baf31249SMarian Balakowicz
5259adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
5260baf31249SMarian Balakowicz
5261adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
5262baf31249SMarian Balakowicz	make distclean
5263ab584d67SHolger Freyther	make NAME_defconfig
5264baf31249SMarian Balakowicz	make all
5265baf31249SMarian Balakowicz
5266adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
5267baf31249SMarian Balakowiczvariable.
5268baf31249SMarian Balakowicz
5269c609719bSwdenk
5270c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
5271c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
5272c609719bSwdenknative "make".
5273c609719bSwdenk
5274c609719bSwdenk
5275c609719bSwdenkIf the system board that you have is not listed, then you will need
5276c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
5277c609719bSwdenksteps:
5278c609719bSwdenk
5279c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
52804d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
52814d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
5282c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
528385ec0bccSwdenk    files you need. In your board directory, you will need at least
528485ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
528585ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
528685ec0bccSwdenk    your board
5287c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
5288c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
5289ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
5290c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
5291c609719bSwdenk    to be installed on your target system.
529285ec0bccSwdenk6.  Debug and solve any problems that might arise.
5293c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
5294c609719bSwdenk
5295c609719bSwdenk
5296c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
5297c609719bSwdenk==============================================================
5298c609719bSwdenk
5299c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
5300c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
5301c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
5302c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
5303218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
5304c609719bSwdenk
5305c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
5306c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
5307c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
5308c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
5309c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
53107152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
5311218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
5312218ca724SWolfgang Denkyou can type
5313c609719bSwdenk
5314c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
5315c609719bSwdenk
5316c609719bSwdenkor to build on a native PowerPC system you can type
5317c609719bSwdenk
5318c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
5319c609719bSwdenk
5320218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
5321218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
5322218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
5323218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
5324218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
5325218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
5326218ca724SWolfgang Denkvariable. For example:
5327baf31249SMarian Balakowicz
5328baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
5329baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
5330baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
5331baf31249SMarian Balakowicz
5332218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
5333218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
5334218ca724SWolfgang Denkduring the whole build process.
5335baf31249SMarian Balakowicz
5336baf31249SMarian Balakowicz
5337c609719bSwdenkSee also "U-Boot Porting Guide" below.
5338c609719bSwdenk
5339c609719bSwdenk
5340c609719bSwdenkMonitor Commands - Overview:
5341c609719bSwdenk============================
5342c609719bSwdenk
5343c609719bSwdenkgo	- start application at address 'addr'
5344c609719bSwdenkrun	- run commands in an environment variable
5345c609719bSwdenkbootm	- boot application image from memory
5346c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
534744f074c7SMarek Vasutbootz   - boot zImage from memory
5348c609719bSwdenktftpboot- boot image via network using TFTP protocol
5349c609719bSwdenk	       and env variables "ipaddr" and "serverip"
5350c609719bSwdenk	       (and eventually "gatewayip")
53511fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
5352c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
5353c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5354c609719bSwdenkloads	- load S-Record file over serial line
5355c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
5356c609719bSwdenkmd	- memory display
5357c609719bSwdenkmm	- memory modify (auto-incrementing)
5358c609719bSwdenknm	- memory modify (constant address)
5359c609719bSwdenkmw	- memory write (fill)
5360c609719bSwdenkcp	- memory copy
5361c609719bSwdenkcmp	- memory compare
5362c609719bSwdenkcrc32	- checksum calculation
53630f89c54bSPeter Tyseri2c	- I2C sub-system
5364c609719bSwdenksspi	- SPI utility commands
5365c609719bSwdenkbase	- print or set address offset
5366c609719bSwdenkprintenv- print environment variables
5367c609719bSwdenksetenv	- set environment variables
5368c609719bSwdenksaveenv - save environment variables to persistent storage
5369c609719bSwdenkprotect - enable or disable FLASH write protection
5370c609719bSwdenkerase	- erase FLASH memory
5371c609719bSwdenkflinfo	- print FLASH memory information
537210635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
5373c609719bSwdenkbdinfo	- print Board Info structure
5374c609719bSwdenkiminfo	- print header information for application image
5375c609719bSwdenkconinfo - print console devices and informations
5376c609719bSwdenkide	- IDE sub-system
5377c609719bSwdenkloop	- infinite loop on address range
537856523f12Swdenkloopw	- infinite write loop on address range
5379c609719bSwdenkmtest	- simple RAM test
5380c609719bSwdenkicache	- enable or disable instruction cache
5381c609719bSwdenkdcache	- enable or disable data cache
5382c609719bSwdenkreset	- Perform RESET of the CPU
5383c609719bSwdenkecho	- echo args to console
5384c609719bSwdenkversion - print monitor version
5385c609719bSwdenkhelp	- print online help
5386c609719bSwdenk?	- alias for 'help'
5387c609719bSwdenk
5388c609719bSwdenk
5389c609719bSwdenkMonitor Commands - Detailed Description:
5390c609719bSwdenk========================================
5391c609719bSwdenk
5392c609719bSwdenkTODO.
5393c609719bSwdenk
5394c609719bSwdenkFor now: just type "help <command>".
5395c609719bSwdenk
5396c609719bSwdenk
5397c609719bSwdenkEnvironment Variables:
5398c609719bSwdenk======================
5399c609719bSwdenk
5400c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5401c609719bSwdenkcan be made persistent by saving to Flash memory.
5402c609719bSwdenk
5403c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5404c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5405c609719bSwdenkwithout a value can be used to delete a variable from the
5406c609719bSwdenkenvironment. As long as you don't save the environment you are
5407c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5408c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5409c609719bSwdenk
5410c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5411c96f86eeSWolfgang Denk
5412c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5413c609719bSwdenk
5414c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5415c609719bSwdenk
5416c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5417c609719bSwdenk
5418c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5419c609719bSwdenk
5420c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5421c609719bSwdenk
5422c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5423c609719bSwdenk
54247d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
54257d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
54267d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
54277d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
54287d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
54297d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5430c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5431c3624e6eSGrant Likely		  bootm_mapsize.
5432c3624e6eSGrant Likely
5433c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5434c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5435c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5436c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5437c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5438c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5439c3624e6eSGrant Likely		  used otherwise.
54407d721e34SBartlomiej Sieka
54417d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
54427d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
54437d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
54447d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
54457d721e34SBartlomiej Sieka		  environment variable.
54467d721e34SBartlomiej Sieka
54474bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
54484bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
54494bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
54504bae9090SBartlomiej Sieka
5451c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5452c609719bSwdenk		  "bootp" will just load perform a lookup of the
5453c609719bSwdenk		  configuration from the BOOTP server, but not try to
5454c609719bSwdenk		  load any image using TFTP
5455c609719bSwdenk
5456c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5457c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5458c609719bSwdenk		  be automatically started (by internally calling
5459c609719bSwdenk		  "bootm")
5460c609719bSwdenk
54614a6fd34bSwdenk		  If set to "no", a standalone image passed to the
54624a6fd34bSwdenk		  "bootm" command will be copied to the load address
54634a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
54644a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
54654a6fd34bSwdenk		  data.
54664a6fd34bSwdenk
5467a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5468a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5469fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5470fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5471fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5472fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5473fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5474fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5475fa34f6b2SShawn Guo		  access it during the boot procedure.
5476fa34f6b2SShawn Guo
5477a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5478a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5479a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5480a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5481a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5482a28afca5SDavid A. Long		  must be accessible by the kernel.
5483a28afca5SDavid A. Long
5484eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5485eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5486eea63e05SSimon Glass		  defined.
5487eea63e05SSimon Glass
548817ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
548917ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
549017ea1177Swdenk		  mode (400kHZ). This environment variable is used in
549117ea1177Swdenk		  initialization code. So, for changes to be effective
549217ea1177Swdenk		  it must be saved and board must be reset.
549317ea1177Swdenk
5494c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5495c609719bSwdenk		  If this variable is not set, initrd images will be
5496c609719bSwdenk		  copied to the highest possible address in RAM; this
5497c609719bSwdenk		  is usually what you want since it allows for
5498c609719bSwdenk		  maximum initrd size. If for some reason you want to
5499c609719bSwdenk		  make sure that the initrd image is loaded below the
55006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5501c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5502c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5503c609719bSwdenk		  address to use (U-Boot will still check that it
5504c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5505c609719bSwdenk
5506c609719bSwdenk		  For instance, when you have a system with 16 MB
55077152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5508c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5509c609719bSwdenk		  the "bootargs" variable. However, now you must make
55107152b1d0Swdenk		  sure that the initrd image is placed in the first
5511c609719bSwdenk		  12 MB as well - this can be done with
5512c609719bSwdenk
5513c609719bSwdenk		  setenv initrd_high 00c00000
5514c609719bSwdenk
551538b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
551638b99261Swdenk		  indication to U-Boot that all addresses are legal
551738b99261Swdenk		  for the Linux kernel, including addresses in flash
551838b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
551938b99261Swdenk		  ramdisk at all. This may be useful to reduce the
552038b99261Swdenk		  boot time on your system, but requires that this
552138b99261Swdenk		  feature is supported by your Linux kernel.
552238b99261Swdenk
5523c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5524c609719bSwdenk
5525c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5526dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5527c609719bSwdenk
5528c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5529c609719bSwdenk
5530c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5531c609719bSwdenk
5532c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5533c609719bSwdenk
5534c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5535c609719bSwdenk
5536c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5537c609719bSwdenk
5538e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5539a3d991bdSwdenk
5540e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5541e2a53458SMike Frysinger		  For example you can do the following
5542a3d991bdSwdenk
554348690d80SHeiko Schocher		  => setenv ethact FEC
554448690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
554548690d80SHeiko Schocher		  => setenv ethact SCC
554648690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5547a3d991bdSwdenk
5548e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5549e1692577SMatthias Fuchs		  available network interfaces.
5550e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5551e1692577SMatthias Fuchs
5552a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5553a3d991bdSwdenk		  either succeed or fail without retrying.
55546e592385Swdenk		  When set to "once" the network operation will
55556e592385Swdenk		  fail when all the available network interfaces
55566e592385Swdenk		  are tried once without success.
5557a3d991bdSwdenk		  Useful on scripts which control the retry operation
5558a3d991bdSwdenk		  themselves.
5559a3d991bdSwdenk
5560b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5561a1cf027aSJean-Christophe PLAGNIOL-VILLARD
5562b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
55638d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
55648d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
55658d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
55668d51aacdSSimon Glass		  is silent.
55678d51aacdSSimon Glass
556828cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
5569ecb0ccd9SWolfgang Denk		  UDP source port.
5570ecb0ccd9SWolfgang Denk
557128cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
557228cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
557328cb9375SWolfgang Denk
5574c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5575c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5576c96f86eeSWolfgang Denk
5577c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5578c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5579c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5580c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5581c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5582c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5583c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5584c96f86eeSWolfgang Denk
5585a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
558611ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5587a3d991bdSwdenk		  VLAN tagged frames.
5588c609719bSwdenk
5589dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5590dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5591dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5592dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5593dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5594dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5595dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5596dc0b7b0eSJason Hobbs
5597dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5598dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
5599dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5600dc0b7b0eSJason Hobbs
5601dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5602dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5603dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5604dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5605dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5606dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5607dc0b7b0eSJason Hobbs
5608c609719bSwdenkThe following environment variables may be used and automatically
5609c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5610c609719bSwdenkdepending the information provided by your boot server:
5611c609719bSwdenk
5612c609719bSwdenk  bootfile	- see above
5613c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5614fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5615c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5616c609719bSwdenk  hostname	- Target hostname
5617c609719bSwdenk  ipaddr	- see above
5618c609719bSwdenk  netmask	- Subnet Mask
5619c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5620c609719bSwdenk  serverip	- see above
5621c609719bSwdenk
5622c609719bSwdenk
5623c609719bSwdenkThere are two special Environment Variables:
5624c609719bSwdenk
5625c609719bSwdenk  serial#	- contains hardware identification information such
5626c609719bSwdenk		  as type string and/or serial number
5627c609719bSwdenk  ethaddr	- Ethernet address
5628c609719bSwdenk
5629c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5630c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5631c609719bSwdenkonce they have been set once.
5632c609719bSwdenk
5633c609719bSwdenk
5634c1551ea8SstroeseFurther special Environment Variables:
5635c1551ea8Sstroese
5636c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5637c1551ea8Sstroese		  with the "version" command. This variable is
5638c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5639c1551ea8Sstroese
5640c1551ea8Sstroese
5641c609719bSwdenkPlease note that changes to some configuration parameters may take
5642c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5643c609719bSwdenk
5644c609719bSwdenk
5645170ab110SJoe HershbergerCallback functions for environment variables:
5646170ab110SJoe Hershberger---------------------------------------------
5647170ab110SJoe Hershberger
5648170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5649b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
5650170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5651170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5652170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5653170ab110SJoe Hershberger
5654170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5655170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5656170ab110SJoe Hershberger
5657170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5658170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5659170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5660170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5661170ab110SJoe Hershberger
5662170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5663170ab110SJoe Hershberger	list = entry[,list]
5664170ab110SJoe Hershberger
5665170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5666170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5667170ab110SJoe Hershberger
5668170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5669170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5670170ab110SJoe Hershbergeroverride any association in the static list. You can define
5671170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5672b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
5673170ab110SJoe Hershberger
5674170ab110SJoe Hershberger
5675f07771ccSwdenkCommand Line Parsing:
5676f07771ccSwdenk=====================
5677f07771ccSwdenk
5678f07771ccSwdenkThere are two different command line parsers available with U-Boot:
56797152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5680f07771ccSwdenk
5681f07771ccSwdenkOld, simple command line parser:
5682f07771ccSwdenk--------------------------------
5683f07771ccSwdenk
5684f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5685f07771ccSwdenk- several commands on one line, separated by ';'
5686fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5687f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5688f07771ccSwdenk  for example:
5689fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5690f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5691f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5692f07771ccSwdenk
5693f07771ccSwdenkHush shell:
5694f07771ccSwdenk-----------
5695f07771ccSwdenk
5696f07771ccSwdenk- similar to Bourne shell, with control structures like
5697f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5698f07771ccSwdenk  until...do...done, ...
5699f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5700f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5701f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5702f07771ccSwdenk  command
5703f07771ccSwdenk
5704f07771ccSwdenkGeneral rules:
5705f07771ccSwdenk--------------
5706f07771ccSwdenk
5707f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5708f07771ccSwdenk    command) contains several commands separated by semicolon, and
5709f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5710f07771ccSwdenk    executed anyway.
5711f07771ccSwdenk
5712f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
571311ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5714f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5715f07771ccSwdenk    variables are not executed.
5716f07771ccSwdenk
5717c609719bSwdenkNote for Redundant Ethernet Interfaces:
5718c609719bSwdenk=======================================
5719c609719bSwdenk
572011ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5721c609719bSwdenksuch configurations and is capable of automatic selection of a
57227152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5723c609719bSwdenk
5724c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5725c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5726c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5727c609719bSwdenk
5728c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5729c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5730c609719bSwdenkding setting in the environment; if the corresponding environment
5731c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5732c609719bSwdenk
5733c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5734c609719bSwdenk  environment, the SROM's address is used.
5735c609719bSwdenk
5736c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5737c609719bSwdenk  environment exists, then the value from the environment variable is
5738c609719bSwdenk  used.
5739c609719bSwdenk
5740c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5741c609719bSwdenk  both addresses are the same, this MAC address is used.
5742c609719bSwdenk
5743c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5744c609719bSwdenk  addresses differ, the value from the environment is used and a
5745c609719bSwdenk  warning is printed.
5746c609719bSwdenk
5747c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5748c609719bSwdenk  is raised.
5749c609719bSwdenk
5750ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5751ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5752ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5753ecee9324SBen WarrenThe naming convention is as follows:
5754ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5755c609719bSwdenk
5756c609719bSwdenkImage Formats:
5757c609719bSwdenk==============
5758c609719bSwdenk
57593310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
57603310c549SMarian Balakowiczimages in two formats:
57613310c549SMarian Balakowicz
57623310c549SMarian BalakowiczNew uImage format (FIT)
57633310c549SMarian Balakowicz-----------------------
57643310c549SMarian Balakowicz
57653310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
57663310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
57673310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
57683310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
57693310c549SMarian Balakowicz
57703310c549SMarian Balakowicz
57713310c549SMarian BalakowiczOld uImage format
57723310c549SMarian Balakowicz-----------------
57733310c549SMarian Balakowicz
57743310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
57753310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
57763310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5777c609719bSwdenk
5778c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5779c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5780f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5781f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5782f5ed9e39SPeter Tyser  INTEGRITY).
57837b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5784afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5785afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5786c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5787c609719bSwdenk* Load Address
5788c609719bSwdenk* Entry Point
5789c609719bSwdenk* Image Name
5790c609719bSwdenk* Image Timestamp
5791c609719bSwdenk
5792c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5793c609719bSwdenkand the data portions of the image are secured against corruption by
5794c609719bSwdenkCRC32 checksums.
5795c609719bSwdenk
5796c609719bSwdenk
5797c609719bSwdenkLinux Support:
5798c609719bSwdenk==============
5799c609719bSwdenk
5800c609719bSwdenkAlthough U-Boot should support any OS or standalone application
58017152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5802c609719bSwdenkU-Boot.
5803c609719bSwdenk
5804c609719bSwdenkU-Boot includes many features that so far have been part of some
5805c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5806c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5807c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
58087152b1d0Swdenkserves several purposes:
5809c609719bSwdenk
5810c609719bSwdenk- the same features can be used for other OS or standalone
5811c609719bSwdenk  applications (for instance: using compressed images to reduce the
5812c609719bSwdenk  Flash memory footprint)
5813c609719bSwdenk
5814c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
58157152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5816c609719bSwdenk
5817c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5818c609719bSwdenk  images; of course this also means that different kernel images can
5819c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5820c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5821c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5822c609719bSwdenk  software is easier now.
5823c609719bSwdenk
5824c609719bSwdenk
5825c609719bSwdenkLinux HOWTO:
5826c609719bSwdenk============
5827c609719bSwdenk
5828c609719bSwdenkPorting Linux to U-Boot based systems:
5829c609719bSwdenk---------------------------------------
5830c609719bSwdenk
5831c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5832c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5833c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5834c609719bSwdenkLinux :-).
5835c609719bSwdenk
5836a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5837c609719bSwdenk
5838c609719bSwdenkJust make sure your machine specific header file (for instance
5839c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
58401dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
58411dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
58426d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5843c609719bSwdenk
58442eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
58452eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
58462eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
58472eb31b13SSimon Glassdoc/driver-model.
58482eb31b13SSimon Glass
5849c609719bSwdenk
5850c609719bSwdenkConfiguring the Linux kernel:
5851c609719bSwdenk-----------------------------
5852c609719bSwdenk
5853c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5854c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5855c609719bSwdenk
5856c609719bSwdenk
5857c609719bSwdenkBuilding a Linux Image:
5858c609719bSwdenk-----------------------
5859c609719bSwdenk
586024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
586124ee89b9Swdenknot used. If you use recent kernel source, a new build target
586224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
586324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
586424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
586524ee89b9Swdenk100% compatible format.
5866c609719bSwdenk
5867c609719bSwdenkExample:
5868c609719bSwdenk
5869ab584d67SHolger Freyther	make TQM850L_defconfig
5870c609719bSwdenk	make oldconfig
5871c609719bSwdenk	make dep
587224ee89b9Swdenk	make uImage
5873c609719bSwdenk
587424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
587524ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
587624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5877c609719bSwdenk
587824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
587924ee89b9Swdenk
588024ee89b9Swdenk* convert the kernel into a raw binary image:
588124ee89b9Swdenk
588224ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
588324ee89b9Swdenk				 -R .note -R .comment \
588424ee89b9Swdenk				 -S vmlinux linux.bin
588524ee89b9Swdenk
588624ee89b9Swdenk* compress the binary image:
588724ee89b9Swdenk
588824ee89b9Swdenk	gzip -9 linux.bin
588924ee89b9Swdenk
589024ee89b9Swdenk* package compressed binary image for U-Boot:
589124ee89b9Swdenk
589224ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
589324ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
589424ee89b9Swdenk		-d linux.bin.gz uImage
589524ee89b9Swdenk
589624ee89b9Swdenk
589724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
589824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
589924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
590024ee89b9Swdenkbyte header containing information about target architecture,
590124ee89b9Swdenkoperating system, image type, compression method, entry points, time
590224ee89b9Swdenkstamp, CRC32 checksums, etc.
590324ee89b9Swdenk
590424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
590524ee89b9Swdenkprint the header information, or to build new images.
5906c609719bSwdenk
5907c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5908c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5909c609719bSwdenkchecksum verification:
5910c609719bSwdenk
5911c609719bSwdenk	tools/mkimage -l image
5912c609719bSwdenk	  -l ==> list image header information
5913c609719bSwdenk
5914c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5915c609719bSwdenkfrom a "data file" which is used as image payload:
5916c609719bSwdenk
5917c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5918c609719bSwdenk		      -n name -d data_file image
5919c609719bSwdenk	  -A ==> set architecture to 'arch'
5920c609719bSwdenk	  -O ==> set operating system to 'os'
5921c609719bSwdenk	  -T ==> set image type to 'type'
5922c609719bSwdenk	  -C ==> set compression type 'comp'
5923c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5924c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5925c609719bSwdenk	  -n ==> set image name to 'name'
5926c609719bSwdenk	  -d ==> use image data from 'datafile'
5927c609719bSwdenk
592869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
592969459791Swdenkaddress (0x00000000), but the entry point address depends on the
593069459791Swdenkkernel version:
5931c609719bSwdenk
5932c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
593324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5934c609719bSwdenk
5935c609719bSwdenkSo a typical call to build a U-Boot image would read:
5936c609719bSwdenk
593724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
593824ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5939a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
594024ee89b9Swdenk	> examples/uImage.TQM850L
594124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5942c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5943c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5944c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5945c609719bSwdenk	Load Address: 0x00000000
594624ee89b9Swdenk	Entry Point:  0x00000000
5947c609719bSwdenk
5948c609719bSwdenkTo verify the contents of the image (or check for corruption):
5949c609719bSwdenk
595024ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
595124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5952c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5953c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5954c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5955c609719bSwdenk	Load Address: 0x00000000
595624ee89b9Swdenk	Entry Point:  0x00000000
5957c609719bSwdenk
5958c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5959c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5960c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5961c609719bSwdenkneed to be uncompressed:
5962c609719bSwdenk
5963a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
596424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
596524ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5966a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
596724ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
596824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5969c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5970c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5971c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5972c609719bSwdenk	Load Address: 0x00000000
597324ee89b9Swdenk	Entry Point:  0x00000000
5974c609719bSwdenk
5975c609719bSwdenk
5976c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5977c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5978c609719bSwdenk
5979c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5980c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5981c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5982c609719bSwdenk	Image Name:   Simple Ramdisk Image
5983c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5984c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5985c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5986c609719bSwdenk	Load Address: 0x00000000
5987c609719bSwdenk	Entry Point:  0x00000000
5988c609719bSwdenk
5989a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5990a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5991a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5992a804b5ceSGuilherme Maciel Ferreirafrom the image:
5993a804b5ceSGuilherme Maciel Ferreira
5994f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5995f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5996f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5997f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5998a804b5ceSGuilherme Maciel Ferreira
5999c609719bSwdenk
6000c609719bSwdenkInstalling a Linux Image:
6001c609719bSwdenk-------------------------
6002c609719bSwdenk
6003c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
6004c609719bSwdenkyou must convert the image to S-Record format:
6005c609719bSwdenk
6006c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
6007c609719bSwdenk
6008c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
6009c609719bSwdenkimage header, so the resulting S-Record file will be relative to
6010c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
6011c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
6012c609719bSwdenkcommand.
6013c609719bSwdenk
6014c609719bSwdenkExample: install the image to address 0x40100000 (which on the
6015c609719bSwdenkTQM8xxL is in the first Flash bank):
6016c609719bSwdenk
6017c609719bSwdenk	=> erase 40100000 401FFFFF
6018c609719bSwdenk
6019c609719bSwdenk	.......... done
6020c609719bSwdenk	Erased 8 sectors
6021c609719bSwdenk
6022c609719bSwdenk	=> loads 40100000
6023c609719bSwdenk	## Ready for S-Record download ...
6024c609719bSwdenk	~>examples/image.srec
6025c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
6026c609719bSwdenk	...
6027c609719bSwdenk	15989 15990 15991 15992
6028c609719bSwdenk	[file transfer complete]
6029c609719bSwdenk	[connected]
6030c609719bSwdenk	## Start Addr = 0x00000000
6031c609719bSwdenk
6032c609719bSwdenk
6033c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
6034c609719bSwdenkthis includes a checksum verification so you can be sure no data
6035c609719bSwdenkcorruption happened:
6036c609719bSwdenk
6037c609719bSwdenk	=> imi 40100000
6038c609719bSwdenk
6039c609719bSwdenk	## Checking Image at 40100000 ...
6040c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
6041c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6042c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
6043c609719bSwdenk	   Load Address: 00000000
6044c609719bSwdenk	   Entry Point:	 0000000c
6045c609719bSwdenk	   Verifying Checksum ... OK
6046c609719bSwdenk
6047c609719bSwdenk
6048c609719bSwdenkBoot Linux:
6049c609719bSwdenk-----------
6050c609719bSwdenk
6051c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
6052c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
6053c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
6054c609719bSwdenkparameters. You can check and modify this variable using the
6055c609719bSwdenk"printenv" and "setenv" commands:
6056c609719bSwdenk
6057c609719bSwdenk
6058c609719bSwdenk	=> printenv bootargs
6059c609719bSwdenk	bootargs=root=/dev/ram
6060c609719bSwdenk
6061c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6062c609719bSwdenk
6063c609719bSwdenk	=> printenv bootargs
6064c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6065c609719bSwdenk
6066c609719bSwdenk	=> bootm 40020000
6067c609719bSwdenk	## Booting Linux kernel at 40020000 ...
6068c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
6069c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6070c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
6071c609719bSwdenk	   Load Address: 00000000
6072c609719bSwdenk	   Entry Point:	 0000000c
6073c609719bSwdenk	   Verifying Checksum ... OK
6074c609719bSwdenk	   Uncompressing Kernel Image ... OK
6075c609719bSwdenk	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
6076c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6077c609719bSwdenk	time_init: decrementer frequency = 187500000/60
6078c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
6079c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
6080c609719bSwdenk	...
6081c609719bSwdenk
608211ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
60837152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
6084c609719bSwdenkformat!) to the "bootm" command:
6085c609719bSwdenk
6086c609719bSwdenk	=> imi 40100000 40200000
6087c609719bSwdenk
6088c609719bSwdenk	## Checking Image at 40100000 ...
6089c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
6090c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6091c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
6092c609719bSwdenk	   Load Address: 00000000
6093c609719bSwdenk	   Entry Point:	 0000000c
6094c609719bSwdenk	   Verifying Checksum ... OK
6095c609719bSwdenk
6096c609719bSwdenk	## Checking Image at 40200000 ...
6097c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
6098c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
6099c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
6100c609719bSwdenk	   Load Address: 00000000
6101c609719bSwdenk	   Entry Point:	 00000000
6102c609719bSwdenk	   Verifying Checksum ... OK
6103c609719bSwdenk
6104c609719bSwdenk	=> bootm 40100000 40200000
6105c609719bSwdenk	## Booting Linux kernel at 40100000 ...
6106c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
6107c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6108c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
6109c609719bSwdenk	   Load Address: 00000000
6110c609719bSwdenk	   Entry Point:	 0000000c
6111c609719bSwdenk	   Verifying Checksum ... OK
6112c609719bSwdenk	   Uncompressing Kernel Image ... OK
6113c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
6114c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
6115c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
6116c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
6117c609719bSwdenk	   Load Address: 00000000
6118c609719bSwdenk	   Entry Point:	 00000000
6119c609719bSwdenk	   Verifying Checksum ... OK
6120c609719bSwdenk	   Loading Ramdisk ... OK
6121c609719bSwdenk	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
6122c609719bSwdenk	Boot arguments: root=/dev/ram
6123c609719bSwdenk	time_init: decrementer frequency = 187500000/60
6124c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
6125c609719bSwdenk	...
6126c609719bSwdenk	RAMDISK: Compressed image found at block 0
6127c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
6128c609719bSwdenk
6129c609719bSwdenk	bash#
6130c609719bSwdenk
61310267768eSMatthew McClintockBoot Linux and pass a flat device tree:
61320267768eSMatthew McClintock-----------
61330267768eSMatthew McClintock
61340267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
61350267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
61360267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
61370267768eSMatthew McClintockflat device tree:
61380267768eSMatthew McClintock
61390267768eSMatthew McClintock=> print oftaddr
61400267768eSMatthew McClintockoftaddr=0x300000
61410267768eSMatthew McClintock=> print oft
61420267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
61430267768eSMatthew McClintock=> tftp $oftaddr $oft
61440267768eSMatthew McClintockSpeed: 1000, full duplex
61450267768eSMatthew McClintockUsing TSEC0 device
61460267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
61470267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
61480267768eSMatthew McClintockLoad address: 0x300000
61490267768eSMatthew McClintockLoading: #
61500267768eSMatthew McClintockdone
61510267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
61520267768eSMatthew McClintock=> tftp $loadaddr $bootfile
61530267768eSMatthew McClintockSpeed: 1000, full duplex
61540267768eSMatthew McClintockUsing TSEC0 device
61550267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
61560267768eSMatthew McClintockFilename 'uImage'.
61570267768eSMatthew McClintockLoad address: 0x200000
61580267768eSMatthew McClintockLoading:############
61590267768eSMatthew McClintockdone
61600267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
61610267768eSMatthew McClintock=> print loadaddr
61620267768eSMatthew McClintockloadaddr=200000
61630267768eSMatthew McClintock=> print oftaddr
61640267768eSMatthew McClintockoftaddr=0x300000
61650267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
61660267768eSMatthew McClintock## Booting image at 00200000 ...
61670267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
61680267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
61690267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
61700267768eSMatthew McClintock   Load Address: 00000000
61710267768eSMatthew McClintock   Entry Point:	 00000000
61720267768eSMatthew McClintock   Verifying Checksum ... OK
61730267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
61740267768eSMatthew McClintockBooting using flat device tree at 0x300000
61750267768eSMatthew McClintockUsing MPC85xx ADS machine description
61760267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
61770267768eSMatthew McClintock[snip]
61780267768eSMatthew McClintock
61790267768eSMatthew McClintock
61806069ff26SwdenkMore About U-Boot Image Types:
61816069ff26Swdenk------------------------------
61826069ff26Swdenk
61836069ff26SwdenkU-Boot supports the following image types:
61846069ff26Swdenk
61856069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
61866069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
61876069ff26Swdenk	well) you can continue to work in U-Boot after return from
61886069ff26Swdenk	the Standalone Program.
61896069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
61906069ff26Swdenk	will take over control completely. Usually these programs
61916069ff26Swdenk	will install their own set of exception handlers, device
61926069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
61936069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
61946069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
61956069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
61966069ff26Swdenk	being started.
61976069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
61986069ff26Swdenk	(Linux) kernel image and one or more data images like
61996069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
62006069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
62016069ff26Swdenk	server provides just a single image file, but you want to get
62026069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
62036069ff26Swdenk
62046069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
62056069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
62066069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
62076069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
62086069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
62096069ff26Swdenk	a multiple of 4 bytes).
62106069ff26Swdenk
62116069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
62126069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
62136069ff26Swdenk	flash memory.
62146069ff26Swdenk
62156069ff26Swdenk   "Script files" are command sequences that will be executed by
62166069ff26Swdenk	U-Boot's command interpreter; this feature is especially
62176069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
62186069ff26Swdenk	as command interpreter.
62196069ff26Swdenk
622044f074c7SMarek VasutBooting the Linux zImage:
622144f074c7SMarek Vasut-------------------------
622244f074c7SMarek Vasut
622344f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
622444f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
622544f074c7SMarek Vasutas the syntax of "bootm" command.
622644f074c7SMarek Vasut
62278ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
6228017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
6229017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
6230017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
6231017e1f3fSMarek Vasut
6232c609719bSwdenk
6233c609719bSwdenkStandalone HOWTO:
6234c609719bSwdenk=================
6235c609719bSwdenk
6236c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
6237c609719bSwdenkrun "standalone" applications, which can use some resources of
6238c609719bSwdenkU-Boot like console I/O functions or interrupt services.
6239c609719bSwdenk
6240c609719bSwdenkTwo simple examples are included with the sources:
6241c609719bSwdenk
6242c609719bSwdenk"Hello World" Demo:
6243c609719bSwdenk-------------------
6244c609719bSwdenk
6245c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
6246c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
6247c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
6248c609719bSwdenklike that:
6249c609719bSwdenk
6250c609719bSwdenk	=> loads
6251c609719bSwdenk	## Ready for S-Record download ...
6252c609719bSwdenk	~>examples/hello_world.srec
6253c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6254c609719bSwdenk	[file transfer complete]
6255c609719bSwdenk	[connected]
6256c609719bSwdenk	## Start Addr = 0x00040004
6257c609719bSwdenk
6258c609719bSwdenk	=> go 40004 Hello World! This is a test.
6259c609719bSwdenk	## Starting application at 0x00040004 ...
6260c609719bSwdenk	Hello World
6261c609719bSwdenk	argc = 7
6262c609719bSwdenk	argv[0] = "40004"
6263c609719bSwdenk	argv[1] = "Hello"
6264c609719bSwdenk	argv[2] = "World!"
6265c609719bSwdenk	argv[3] = "This"
6266c609719bSwdenk	argv[4] = "is"
6267c609719bSwdenk	argv[5] = "a"
6268c609719bSwdenk	argv[6] = "test."
6269c609719bSwdenk	argv[7] = "<NULL>"
6270c609719bSwdenk	Hit any key to exit ...
6271c609719bSwdenk
6272c609719bSwdenk	## Application terminated, rc = 0x0
6273c609719bSwdenk
6274c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
6275c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
6276c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
6277c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
6278c609719bSwdenkcharacter, but this is just a demo program. The application can be
6279c609719bSwdenkcontrolled by the following keys:
6280c609719bSwdenk
6281c609719bSwdenk	? - print current values og the CPM Timer registers
6282c609719bSwdenk	b - enable interrupts and start timer
6283c609719bSwdenk	e - stop timer and disable interrupts
6284c609719bSwdenk	q - quit application
6285c609719bSwdenk
6286c609719bSwdenk	=> loads
6287c609719bSwdenk	## Ready for S-Record download ...
6288c609719bSwdenk	~>examples/timer.srec
6289c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6290c609719bSwdenk	[file transfer complete]
6291c609719bSwdenk	[connected]
6292c609719bSwdenk	## Start Addr = 0x00040004
6293c609719bSwdenk
6294c609719bSwdenk	=> go 40004
6295c609719bSwdenk	## Starting application at 0x00040004 ...
6296c609719bSwdenk	TIMERS=0xfff00980
6297c609719bSwdenk	Using timer 1
6298c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6299c609719bSwdenk
6300c609719bSwdenkHit 'b':
6301c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
6302c609719bSwdenk	Enabling timer
6303c609719bSwdenkHit '?':
6304c609719bSwdenk	[q, b, e, ?] ........
6305c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6306c609719bSwdenkHit '?':
6307c609719bSwdenk	[q, b, e, ?] .
6308c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6309c609719bSwdenkHit '?':
6310c609719bSwdenk	[q, b, e, ?] .
6311c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6312c609719bSwdenkHit '?':
6313c609719bSwdenk	[q, b, e, ?] .
6314c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6315c609719bSwdenkHit 'e':
6316c609719bSwdenk	[q, b, e, ?] ...Stopping timer
6317c609719bSwdenkHit 'q':
6318c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
6319c609719bSwdenk
6320c609719bSwdenk
632185ec0bccSwdenkMinicom warning:
632285ec0bccSwdenk================
632385ec0bccSwdenk
63247152b1d0SwdenkOver time, many people have reported problems when trying to use the
632585ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
632685ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
6327f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
632885ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
6329e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
6330e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6331e53515a2SKarl O. Pincfor help with kermit.
6332e53515a2SKarl O. Pinc
633385ec0bccSwdenk
633452f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
633552f52c14Swdenkconfiguration to your "File transfer protocols" section:
633652f52c14Swdenk
633752f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
633852f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
633952f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
634052f52c14Swdenk
634152f52c14Swdenk
6342c609719bSwdenkNetBSD Notes:
6343c609719bSwdenk=============
6344c609719bSwdenk
6345c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
6346c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
6347c609719bSwdenk
6348c609719bSwdenkBuilding requires a cross environment; it is known to work on
6349c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6350c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
6351c609719bSwdenkNote that the cross-powerpc package does not install include files;
6352c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
6353c609719bSwdenkmissing.  This file has to be installed and patched manually:
6354c609719bSwdenk
6355c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
6356c609719bSwdenk	# mkdir powerpc
6357c609719bSwdenk	# ln -s powerpc machine
6358c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6359c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6360c609719bSwdenk
6361c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6362c609719bSwdenkand U-Boot include files.
6363c609719bSwdenk
6364c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6365c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6366c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6367c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
63682a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6369c609719bSwdenk
6370c609719bSwdenk
6371c609719bSwdenkImplementation Internals:
6372c609719bSwdenk=========================
6373c609719bSwdenk
6374c609719bSwdenkThe following is not intended to be a complete description of every
6375c609719bSwdenkimplementation detail. However, it should help to understand the
6376c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6377c609719bSwdenkhardware.
6378c609719bSwdenk
6379c609719bSwdenk
6380c609719bSwdenkInitial Stack, Global Data:
6381c609719bSwdenk---------------------------
6382c609719bSwdenk
6383c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6384c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6385c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6386c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6387c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6388c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6389c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6390c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6391c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6392c609719bSwdenklocked as (mis-) used as memory, etc.
6393c609719bSwdenk
63947152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
63950668236bSWolfgang Denk	U-Boot mailing list:
639643d9616cSwdenk
639743d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
639843d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
639943d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
640043d9616cSwdenk	...
640143d9616cSwdenk
640243d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
640343d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
640443d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
640543d9616cSwdenk	is that the cache is being used as a temporary supply of
640643d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
640711ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
640843d9616cSwdenk	can see how this works by studying the cache architecture and
640943d9616cSwdenk	operation in the architecture and processor-specific manuals.
641043d9616cSwdenk
641143d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
641243d9616cSwdenk	is another option for the system designer to use as an
641311ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
641443d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
641543d9616cSwdenk	board designers haven't used it for something that would
641643d9616cSwdenk	cause you grief during the initial boot! It is frequently not
641743d9616cSwdenk	used.
641843d9616cSwdenk
64196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
642043d9616cSwdenk	with your processor/board/system design. The default value
642143d9616cSwdenk	you will find in any recent u-boot distribution in
64228a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
642343d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
642443d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
642543d9616cSwdenk	that are supposed to respond to that address! That code in
642643d9616cSwdenk	start.S has been around a while and should work as is when
642743d9616cSwdenk	you get the config right.
642843d9616cSwdenk
642943d9616cSwdenk	-Chris Hallinan
643043d9616cSwdenk	DS4.COM, Inc.
643143d9616cSwdenk
6432c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6433c609719bSwdenkcode for the initialization procedures:
6434c609719bSwdenk
6435c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6436c609719bSwdenk  to write it.
6437c609719bSwdenk
6438b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
6439c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
64407152b1d0Swdenk  zation is performed later (when relocating to RAM).
6441c609719bSwdenk
6442c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6443c609719bSwdenk  that.
6444c609719bSwdenk
6445c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6446b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
6447c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6448c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6449c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6450c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6451c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6452c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6453c609719bSwdenkreserve for this purpose.
6454c609719bSwdenk
64557152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6456c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6457c609719bSwdenkGCC's implementation.
6458c609719bSwdenk
6459c609719bSwdenkFor PowerPC, the following registers have specific use:
6460c609719bSwdenk	R1:	stack pointer
6461e7670f6cSWolfgang Denk	R2:	reserved for system use
6462c609719bSwdenk	R3-R4:	parameter passing and return values
6463c609719bSwdenk	R5-R10: parameter passing
6464c609719bSwdenk	R13:	small data area pointer
6465c609719bSwdenk	R30:	GOT pointer
6466c609719bSwdenk	R31:	frame pointer
6467c609719bSwdenk
6468e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6469e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6470e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6471c609719bSwdenk
6472e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6473c609719bSwdenk
6474c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6475c609719bSwdenk    address of the global data structure is known at compile time),
6476c609719bSwdenk    but it turned out that reserving a register results in somewhat
6477c609719bSwdenk    smaller code - although the code savings are not that big (on
6478c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6479c609719bSwdenk    624 text + 127 data).
6480c609719bSwdenk
6481c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
64824c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
64834c58eb55SMike Frysinger
6484c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
64854c58eb55SMike Frysinger
6486c609719bSwdenkOn ARM, the following registers are used:
6487c609719bSwdenk
6488c609719bSwdenk	R0:	function argument word/integer result
6489c609719bSwdenk	R1-R3:	function argument word
649012eba1b4SJeroen Hofstee	R9:	platform specific
649112eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6492c609719bSwdenk	R11:	argument (frame) pointer
6493c609719bSwdenk	R12:	temporary workspace
6494c609719bSwdenk	R13:	stack pointer
6495c609719bSwdenk	R14:	link register
6496c609719bSwdenk	R15:	program counter
6497c609719bSwdenk
649812eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
649912eba1b4SJeroen Hofstee
650012eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6501c609719bSwdenk
65020df01fd3SThomas ChouOn Nios II, the ABI is documented here:
65030df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
65040df01fd3SThomas Chou
65050df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
65060df01fd3SThomas Chou
65070df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
65080df01fd3SThomas Chou    to access small data sections, so gp is free.
65090df01fd3SThomas Chou
6510afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6511afc1ce82SMacpaul Lin
6512afc1ce82SMacpaul Lin	R0-R1:	argument/return
6513afc1ce82SMacpaul Lin	R2-R5:	argument
6514afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6515afc1ce82SMacpaul Lin	R16:	trampoline register
6516afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6517afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6518afc1ce82SMacpaul Lin	R30:	link register (LP)
6519afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6520afc1ce82SMacpaul Lin	PC:	program counter (PC)
6521afc1ce82SMacpaul Lin
6522afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6523afc1ce82SMacpaul Lin
6524d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6525d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6526c609719bSwdenk
6527c609719bSwdenkMemory Management:
6528c609719bSwdenk------------------
6529c609719bSwdenk
6530c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6531c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6532c609719bSwdenk
6533c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6534c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6535c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6536c609719bSwdenkphysical memory banks.
6537c609719bSwdenk
6538c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6539c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6540c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6541c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
65426d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6543c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6544c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6545c609719bSwdenk
6546c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6547c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6548c609719bSwdenk
6549c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6550c609719bSwdenkthis:
6551c609719bSwdenk
6552c609719bSwdenk	0x0000 0000	Exception Vector code
6553c609719bSwdenk	      :
6554c609719bSwdenk	0x0000 1FFF
6555c609719bSwdenk	0x0000 2000	Free for Application Use
6556c609719bSwdenk	      :
6557c609719bSwdenk	      :
6558c609719bSwdenk
6559c609719bSwdenk	      :
6560c609719bSwdenk	      :
6561c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6562c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6563c609719bSwdenk	0x00FC 0000	Malloc Arena
6564c609719bSwdenk	      :
6565c609719bSwdenk	0x00FD FFFF
6566c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6567c609719bSwdenk	...		eventually: LCD or video framebuffer
6568c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6569c609719bSwdenk	0x00FF FFFF	[End of RAM]
6570c609719bSwdenk
6571c609719bSwdenk
6572c609719bSwdenkSystem Initialization:
6573c609719bSwdenk----------------------
6574c609719bSwdenk
6575c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
657611ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6577c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
65787152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6579c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6580c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6581c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6582c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6583c609719bSwdenkthe caches and the SIU.
6584c609719bSwdenk
6585c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6586c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6587c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6588c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6589c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6590c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6591c609719bSwdenkbanks.
6592c609719bSwdenk
6593c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
65947152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6595c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6596c609719bSwdenk0x00000000, with any additional banks following immediately to create
6597c609719bSwdenkcontiguous memory starting from 0.
6598c609719bSwdenk
6599c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6600c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6601c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6602c609719bSwdenkpages, and the final stack is set up.
6603c609719bSwdenk
6604c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6605c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6606c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6607c609719bSwdenknew address in RAM.
6608c609719bSwdenk
6609c609719bSwdenk
6610c609719bSwdenkU-Boot Porting Guide:
6611c609719bSwdenk----------------------
6612c609719bSwdenk
6613c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
66146aff3115Swdenklist, October 2002]
6615c609719bSwdenk
6616c609719bSwdenk
6617c609719bSwdenkint main(int argc, char *argv[])
6618c609719bSwdenk{
6619c609719bSwdenk	sighandler_t no_more_time;
6620c609719bSwdenk
6621c609719bSwdenk	signal(SIGALRM, no_more_time);
6622c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6623c609719bSwdenk
6624c609719bSwdenk	if (available_money > available_manpower) {
66256c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6626c609719bSwdenk		return 0;
6627c609719bSwdenk	}
6628c609719bSwdenk
6629c609719bSwdenk	Download latest U-Boot source;
6630c609719bSwdenk
66310668236bSWolfgang Denk	Subscribe to u-boot mailing list;
66326aff3115Swdenk
66336c3fef28SJerry Van Baren	if (clueless)
6634c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6635c609719bSwdenk
6636c609719bSwdenk	while (learning) {
6637c609719bSwdenk		Read the README file in the top level directory;
66387cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
66396c3fef28SJerry Van Baren		Read applicable doc/*.README;
6640c609719bSwdenk		Read the source, Luke;
66416c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6642c609719bSwdenk	}
6643c609719bSwdenk
66446c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
66456c3fef28SJerry Van Baren		Buy a BDI3000;
66466c3fef28SJerry Van Baren	else
6647c609719bSwdenk		Add a lot of aggravation and time;
6648c609719bSwdenk
66496c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
66506c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
66516c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
66526c3fef28SJerry Van Baren	} else {
6653c609719bSwdenk		Create your own board support subdirectory;
66546c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
66556c3fef28SJerry Van Baren	}
66566c3fef28SJerry Van Baren	Edit new board/<myboard> files
66576c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6658c609719bSwdenk
66596c3fef28SJerry Van Baren	while (!accepted) {
6660c609719bSwdenk		while (!running) {
6661c609719bSwdenk			do {
6662c609719bSwdenk				Add / modify source code;
6663c609719bSwdenk			} until (compiles);
6664c609719bSwdenk			Debug;
6665c609719bSwdenk			if (clueless)
6666c609719bSwdenk				email("Hi, I am having problems...");
6667c609719bSwdenk		}
66686c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
66696c3fef28SJerry Van Baren		if (reasonable critiques)
66706c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
66716c3fef28SJerry Van Baren		else
66726c3fef28SJerry Van Baren			Defend code as written;
66736c3fef28SJerry Van Baren	}
6674c609719bSwdenk
6675c609719bSwdenk	return 0;
6676c609719bSwdenk}
6677c609719bSwdenk
6678c609719bSwdenkvoid no_more_time (int sig)
6679c609719bSwdenk{
6680c609719bSwdenk      hire_a_guru();
6681c609719bSwdenk}
6682c609719bSwdenk
6683c609719bSwdenk
6684c609719bSwdenkCoding Standards:
6685c609719bSwdenk-----------------
6686c609719bSwdenk
6687c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
66882c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
66897ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6690c609719bSwdenk
66912c051651SDetlev ZundelSource files originating from a different project (for example the
66922c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
6693b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
66942c051651SDetlev Zundelsources.
66952c051651SDetlev Zundel
66962c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
66972c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
66982c051651SDetlev Zundelin your code.
6699c609719bSwdenk
6700c178d3daSwdenkPlease also stick to the following formatting rules:
6701180d3f74Swdenk- remove any trailing white space
67027ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6703180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
67047ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6705180d3f74Swdenk- do not add trailing empty lines to source files
6706180d3f74Swdenk
6707c609719bSwdenkSubmissions which do not conform to the standards may be returned
6708c609719bSwdenkwith a request to reformat the changes.
6709c609719bSwdenk
6710c609719bSwdenk
6711c609719bSwdenkSubmitting Patches:
6712c609719bSwdenk-------------------
6713c609719bSwdenk
6714c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6715c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6716c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6717c609719bSwdenk
67180d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6719218ca724SWolfgang Denk
67200668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
67210668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
67220668236bSWolfgang Denk
6723c609719bSwdenkWhen you send a patch, please include the following information with
6724c609719bSwdenkit:
6725c609719bSwdenk
6726c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6727c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6728c609719bSwdenk  patch actually fixes something.
6729c609719bSwdenk
6730c609719bSwdenk* For new features: a description of the feature and your
6731c609719bSwdenk  implementation.
6732c609719bSwdenk
6733c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6734c609719bSwdenk
6735c609719bSwdenk* For major contributions, your entry to the CREDITS file
6736c609719bSwdenk
673727af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
673827af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6739c609719bSwdenk
6740c609719bSwdenk* If your patch adds new configuration options, don't forget to
6741c609719bSwdenk  document these in the README file.
6742c609719bSwdenk
6743218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6744218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
67457ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6746218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6747218ca724SWolfgang Denk  with some other mail clients.
6748c609719bSwdenk
6749218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6750218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6751218ca724SWolfgang Denk  GNU diff.
67526dff5529Swdenk
6753218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6754218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6755218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6756218ca724SWolfgang Denk  affected files).
6757218ca724SWolfgang Denk
6758218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6759218ca724SWolfgang Denk  and compressed attachments must not be used.
6760c609719bSwdenk
676152f52c14Swdenk* If one logical set of modifications affects or creates several
676252f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
676352f52c14Swdenk
676452f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
676552f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
676652f52c14Swdenk
676752f52c14Swdenk
6768c609719bSwdenkNotes:
6769c609719bSwdenk
6770c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6771c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6772c609719bSwdenk  for any of the boards.
6773c609719bSwdenk
6774c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6775c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6776c609719bSwdenk  returned with a request to re-formatting / split it.
6777c609719bSwdenk
6778c609719bSwdenk* If you modify existing code, make sure that your new code does not
6779c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6780c609719bSwdenk  When adding new features, these should compile conditionally only
6781c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6782c609719bSwdenk  disabled must not need more memory than the old code without your
6783c609719bSwdenk  modification.
678490dc6704Swdenk
67850668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
67860668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
67870668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
67880668236bSWolfgang Denk  bigger than the size limit should be avoided.
6789