xref: /openbmc/u-boot/README (revision 9b4d65f918dd84a479552b86ef2cde389926738f)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1356eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1366eae68e4SMasahiro Yamada    /cpu		CPU specific files
1376eae68e4SMasahiro Yamada      /arc700		Files specific to ARC 700 CPUs
1386eae68e4SMasahiro Yamada    /lib		Architecture specific library files
1398d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1408d321b81SPeter Tyser    /cpu		CPU specific files
1418d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1428d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1436eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1448d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1458d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1468d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1478d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1488d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1498d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1508d321b81SPeter Tyser    /lib		Architecture specific library files
1518d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser    /lib		Architecture specific library files
1548d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1558d321b81SPeter Tyser    /cpu		CPU specific files
1568d321b81SPeter Tyser    /lib		Architecture specific library files
1578d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1588d321b81SPeter Tyser    /cpu		CPU specific files
1598d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1608d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1618d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1628d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1638d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1648d321b81SPeter Tyser    /lib		Architecture specific library files
1658d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1668d321b81SPeter Tyser    /cpu		CPU specific files
1678d321b81SPeter Tyser    /lib		Architecture specific library files
1688d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1698d321b81SPeter Tyser    /cpu		CPU specific files
17092bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
1716eae68e4SMasahiro Yamada      /mips64		Files specific to MIPS64 CPUs
1728d321b81SPeter Tyser    /lib		Architecture specific library files
173afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
174afc1ce82SMacpaul Lin    /cpu		CPU specific files
175afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
176afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1778d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1788d321b81SPeter Tyser    /cpu		CPU specific files
1798d321b81SPeter Tyser    /lib		Architecture specific library files
18033c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
18133c7731bSRobert P. J. Day    /cpu		CPU specific files
18233c7731bSRobert P. J. Day    /lib		Architecture specific library files
183a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1868d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1878d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1888d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1898d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1908d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1918d321b81SPeter Tyser    /lib		Architecture specific library files
1928d321b81SPeter Tyser  /sh			Files generic to SH architecture
1938d321b81SPeter Tyser    /cpu		CPU specific files
1948d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1958d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1968d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1978d321b81SPeter Tyser    /lib		Architecture specific library files
1988d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1998d321b81SPeter Tyser    /cpu		CPU specific files
2008d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2018d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2028d321b81SPeter Tyser    /lib		Architecture specific library files
20333c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20433c7731bSRobert P. J. Day    /cpu		CPU specific files
20533c7731bSRobert P. J. Day    /lib		Architecture specific library files
2068d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2078d321b81SPeter Tyser/board			Board dependent files
2088d321b81SPeter Tyser/common			Misc architecture independent functions
2098d321b81SPeter Tyser/disk			Code for disk drive partition handling
2108d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2118d321b81SPeter Tyser/drivers		Commonly used device drivers
21233c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2138d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2148d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2158d321b81SPeter Tyser/include		Header Files
2168d321b81SPeter Tyser/lib			Files generic to all architectures
2178d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2188d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2198d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2208d321b81SPeter Tyser/net			Networking code
2218d321b81SPeter Tyser/post			Power On Self Test
22233c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2238d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
224c609719bSwdenk
225c609719bSwdenkSoftware Configuration:
226c609719bSwdenk=======================
227c609719bSwdenk
228c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
229c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
230c609719bSwdenk
231c609719bSwdenkThere are two classes of configuration variables:
232c609719bSwdenk
233c609719bSwdenk* Configuration _OPTIONS_:
234c609719bSwdenk  These are selectable by the user and have names beginning with
235c609719bSwdenk  "CONFIG_".
236c609719bSwdenk
237c609719bSwdenk* Configuration _SETTINGS_:
238c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
239c609719bSwdenk  you don't know what you're doing; they have names beginning with
2406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
241c609719bSwdenk
242c609719bSwdenkLater we will add a configuration tool - probably similar to or even
243c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
244c609719bSwdenkdo the configuration by hand, which means creating some symbolic
245c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
246c609719bSwdenkas an example here.
247c609719bSwdenk
248c609719bSwdenk
249c609719bSwdenkSelection of Processor Architecture and Board Type:
250c609719bSwdenk---------------------------------------------------
251c609719bSwdenk
252c609719bSwdenkFor all supported boards there are ready-to-use default
253ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
254c609719bSwdenk
255c609719bSwdenkExample: For a TQM823L module type:
256c609719bSwdenk
257c609719bSwdenk	cd u-boot
258ab584d67SHolger Freyther	make TQM823L_defconfig
259c609719bSwdenk
26011ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
261ab584d67SHolger Freythere.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
262c609719bSwdenkdirectory according to the instructions in cogent/README.
263c609719bSwdenk
264c609719bSwdenk
26575b3c3aaSSimon GlassSandbox Environment:
26675b3c3aaSSimon Glass--------------------
26775b3c3aaSSimon Glass
26875b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
26975b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
27075b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
27175b3c3aaSSimon Glassrun some of U-Boot's tests.
27275b3c3aaSSimon Glass
2736b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
27475b3c3aaSSimon Glass
27575b3c3aaSSimon Glass
276db910353SSimon GlassBoard Initialisation Flow:
277db910353SSimon Glass--------------------------
278db910353SSimon Glass
279db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both
280db910353SSimon GlassSPL and U-Boot proper (i.e. they both follow the same rules). At present SPL
281db910353SSimon Glassmostly uses a separate code path, but the funtion names and roles of each
282db910353SSimon Glassfunction are the same. Some boards or architectures may not conform to this.
283db910353SSimon GlassAt least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this.
284db910353SSimon Glass
285db910353SSimon GlassExecution starts with start.S with three functions called during init after
286db910353SSimon Glassthat. The purpose and limitations of each is described below.
287db910353SSimon Glass
288db910353SSimon Glasslowlevel_init():
289db910353SSimon Glass	- purpose: essential init to permit execution to reach board_init_f()
290db910353SSimon Glass	- no global_data or BSS
291db910353SSimon Glass	- there is no stack (ARMv7 may have one but it will soon be removed)
292db910353SSimon Glass	- must not set up SDRAM or use console
293db910353SSimon Glass	- must only do the bare minimum to allow execution to continue to
294db910353SSimon Glass		board_init_f()
295db910353SSimon Glass	- this is almost never needed
296db910353SSimon Glass	- return normally from this function
297db910353SSimon Glass
298db910353SSimon Glassboard_init_f():
299db910353SSimon Glass	- purpose: set up the machine ready for running board_init_r():
300db910353SSimon Glass		i.e. SDRAM and serial UART
301db910353SSimon Glass	- global_data is available
302db910353SSimon Glass	- stack is in SRAM
303db910353SSimon Glass	- BSS is not available, so you cannot use global/static variables,
304db910353SSimon Glass		only stack variables and global_data
305db910353SSimon Glass
306db910353SSimon Glass	Non-SPL-specific notes:
307db910353SSimon Glass	- dram_init() is called to set up DRAM. If already done in SPL this
308db910353SSimon Glass		can do nothing
309db910353SSimon Glass
310db910353SSimon Glass	SPL-specific notes:
311db910353SSimon Glass	- you can override the entire board_init_f() function with your own
312db910353SSimon Glass		version as needed.
313db910353SSimon Glass	- preloader_console_init() can be called here in extremis
314db910353SSimon Glass	- should set up SDRAM, and anything needed to make the UART work
315db910353SSimon Glass	- these is no need to clear BSS, it will be done by crt0.S
316db910353SSimon Glass	- must return normally from this function (don't call board_init_r()
317db910353SSimon Glass		directly)
318db910353SSimon Glass
319db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
320db910353SSimon Glassthis point the stack and global_data are relocated to below
321db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
322db910353SSimon Glassmemory.
323db910353SSimon Glass
324db910353SSimon Glassboard_init_r():
325db910353SSimon Glass	- purpose: main execution, common code
326db910353SSimon Glass	- global_data is available
327db910353SSimon Glass	- SDRAM is available
328db910353SSimon Glass	- BSS is available, all static/global variables can be used
329db910353SSimon Glass	- execution eventually continues to main_loop()
330db910353SSimon Glass
331db910353SSimon Glass	Non-SPL-specific notes:
332db910353SSimon Glass	- U-Boot is relocated to the top of memory and is now running from
333db910353SSimon Glass		there.
334db910353SSimon Glass
335db910353SSimon Glass	SPL-specific notes:
336db910353SSimon Glass	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
337db910353SSimon Glass		CONFIG_SPL_STACK_R_ADDR points into SDRAM
338db910353SSimon Glass	- preloader_console_init() can be called here - typically this is
339db910353SSimon Glass		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
340db910353SSimon Glass		spl_board_init() function containing this call
341db910353SSimon Glass	- loads U-Boot or (in falcon mode) Linux
342db910353SSimon Glass
343db910353SSimon Glass
344db910353SSimon Glass
345c609719bSwdenkConfiguration Options:
346c609719bSwdenk----------------------
347c609719bSwdenk
348c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
349c609719bSwdenksuch information is kept in a configuration file
350c609719bSwdenk"include/configs/<board_name>.h".
351c609719bSwdenk
352c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
353c609719bSwdenk"include/configs/TQM823L.h".
354c609719bSwdenk
355c609719bSwdenk
3567f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
3577f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
3587f6c2cbcSwdenkbuild a config tool - later.
3597f6c2cbcSwdenk
3607f6c2cbcSwdenk
361c609719bSwdenkThe following options need to be configured:
362c609719bSwdenk
3632628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
364c609719bSwdenk
3652628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
3666ccec449SWolfgang Denk
3676ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
36809ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
369c609719bSwdenk
370c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
371c609719bSwdenk		Define exactly one of
372c609719bSwdenk		CONFIG_CMA286_60_OLD
373c609719bSwdenk--- FIXME --- not tested yet:
374c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
375c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
376c609719bSwdenk
377c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
378c609719bSwdenk		Define exactly one of
379c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
380c609719bSwdenk
381c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
382c609719bSwdenk		Define one or more of
383c609719bSwdenk		CONFIG_CMA302
384c609719bSwdenk
385c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
386c609719bSwdenk		Define one or more of
387c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
38811ccc33fSMarcel Ziswiler					  the LCD display every second with
389c609719bSwdenk					  a "rotator" |\-/|\-/
390c609719bSwdenk
391cf946c6dSLei Wen- Marvell Family Member
392cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
393cf946c6dSLei Wen					  multiple fs option at one time
394cf946c6dSLei Wen					  for marvell soc family
395cf946c6dSLei Wen
39611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
39766ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
39866ca92a5Swdenk					  get_gclk_freq() cannot work
3995da627a4Swdenk					  e.g. if there is no 32KHz
4005da627a4Swdenk					  reference PIT/RTC clock
40166ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
40266ca92a5Swdenk					  or XTAL/EXTAL)
403c609719bSwdenk
40466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
4056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
4066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
40766ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
40875d1ea7fSwdenk			See doc/README.MPC866
40975d1ea7fSwdenk
4106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
41175d1ea7fSwdenk
41275d1ea7fSwdenk		Define this to measure the actual CPU clock instead
41375d1ea7fSwdenk		of relying on the correctness of the configured
41475d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
41575d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
41675d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
4176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
41875d1ea7fSwdenk
419506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
420506f3918SHeiko Schocher
421506f3918SHeiko Schocher		Define this option if you want to enable the
422506f3918SHeiko Schocher		ICache only when Code runs from RAM.
423506f3918SHeiko Schocher
42466412c63SKumar Gala- 85xx CPU Options:
425ffd06e02SYork Sun		CONFIG_SYS_PPC64
426ffd06e02SYork Sun
427ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
428ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
429ffd06e02SYork Sun		compliance, among other possible reasons.
430ffd06e02SYork Sun
43166412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
43266412c63SKumar Gala
43366412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
43466412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
43566412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
43666412c63SKumar Gala
4378f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
4388f29084aSKumar Gala
4398f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
4408f29084aSKumar Gala		tree nodes for the given platform.
4418f29084aSKumar Gala
442afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
443afa6b551SPrabhakar Kushwaha
444afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
445afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
446afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
447afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
448afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
449afa6b551SPrabhakar Kushwaha		purpose.
450afa6b551SPrabhakar Kushwaha
45133eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
45233eee330SScott Wood
45333eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
45433eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
45533eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
45633eee330SScott Wood
45733eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
45833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
45933eee330SScott Wood
46033eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
46133eee330SScott Wood		for which the A004510 workaround should be applied.
46233eee330SScott Wood
46333eee330SScott Wood		The rest of SVR is either not relevant to the decision
46433eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
46533eee330SScott Wood		p2041) or is implied by the build target, which controls
46633eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
46733eee330SScott Wood
46833eee330SScott Wood		See Freescale App Note 4493 for more information about
46933eee330SScott Wood		this erratum.
47033eee330SScott Wood
47174fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
47274fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
473b445bbb4SJeremiah Mahler		required during NOR boot.
47474fa22edSPrabhakar Kushwaha
4759f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
4769f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
477b445bbb4SJeremiah Mahler		required during NAND boot and valid for Rev 1.0 SoC revision
4789f074e67SPrabhakar Kushwaha
47933eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
48033eee330SScott Wood
48133eee330SScott Wood		This is the value to write into CCSR offset 0x18600
48233eee330SScott Wood		according to the A004510 workaround.
48333eee330SScott Wood
48464501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
48564501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
48664501c66SPriyanka Jain		connected exclusively to the DSP cores.
48764501c66SPriyanka Jain
488765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
489765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
490765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
491765b0bdbSPriyanka Jain
49264501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
49364501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
49464501c66SPriyanka Jain		connected to the DSP core.
49564501c66SPriyanka Jain
496765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
497765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
498765b0bdbSPriyanka Jain
499b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
500b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
501b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
502b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
503b135991aSPriyanka Jain
504fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
505fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
506fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
507fb4a2409SAneesh Bansal
508aade2004STang Yuantian		CONFIG_DEEP_SLEEP
509b445bbb4SJeremiah Mahler		Indicates this SoC supports deep sleep feature. If deep sleep is
510aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
511aade2004STang Yuantian
5126cb461b4SDaniel Schwierzeck- Generic CPU options:
5132a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
5142a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
5152a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
5162a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
5172a1680e3SYork Sun		should initialize global data before calling board_init_f().
5182a1680e3SYork Sun
5196cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
5206cb461b4SDaniel Schwierzeck
5216cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
5226cb461b4SDaniel Schwierzeck		values is arch specific.
5236cb461b4SDaniel Schwierzeck
5245614e71bSYork Sun		CONFIG_SYS_FSL_DDR
5255614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
5265614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
5275614e71bSYork Sun		SoCs.
5285614e71bSYork Sun
5295614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
5305614e71bSYork Sun		Freescale DDR memory-mapped register base.
5315614e71bSYork Sun
5325614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
5335614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
5345614e71bSYork Sun		deskew training are not available.
5355614e71bSYork Sun
5365614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
5375614e71bSYork Sun		Freescale DDR1 controller.
5385614e71bSYork Sun
5395614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
5405614e71bSYork Sun		Freescale DDR2 controller.
5415614e71bSYork Sun
5425614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
5435614e71bSYork Sun		Freescale DDR3 controller.
5445614e71bSYork Sun
54534e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
54634e026f9SYork Sun		Freescale DDR4 controller.
54734e026f9SYork Sun
5489ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
5499ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
5509ac4ffbdSYork Sun
5515614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
5525614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
5535614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
5545614e71bSYork Sun		implemetation.
5555614e71bSYork Sun
5565614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
5575614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
5585614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
5595614e71bSYork Sun		implementation.
5605614e71bSYork Sun
5615614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
5625614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
56334e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
56434e026f9SYork Sun
56534e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
56634e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
56734e026f9SYork Sun		DDR3L controllers.
56834e026f9SYork Sun
56934e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
57034e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
57134e026f9SYork Sun		DDR4 controllers.
5725614e71bSYork Sun
5731b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5741b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5751b4175d6SPrabhakar Kushwaha
5761b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5771b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5781b4175d6SPrabhakar Kushwaha
579690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
580690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
581690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
582690e4258SPrabhakar Kushwaha
583690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
584690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
585690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
586690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
587690e4258SPrabhakar Kushwaha
58889ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
58989ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
59089ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
59189ad7be8SPrabhakar Kushwaha
5924e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5934e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5944e5b1bd0SYork Sun
5954e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5964e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5974e5b1bd0SYork Sun
5986b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5996b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
6006b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
6016b9e309aSYork Sun		it could be different for ARM SoCs.
6026b9e309aSYork Sun
6036b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
6046b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
6056b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
6066b1e1254SYork Sun		SoCs with ARM core.
6076b1e1254SYork Sun
6081d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
6091d71efbbSYork Sun		Number of controllers used as main memory.
6101d71efbbSYork Sun
6111d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
6121d71efbbSYork Sun		Number of controllers used for other than main memory.
6131d71efbbSYork Sun
614028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
615028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
616028dbb8dSRuchika Gupta
617028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
618028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
619028dbb8dSRuchika Gupta
6200b953ffcSMarkus Klotzbuecher- Intel Monahans options:
6216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
6220b953ffcSMarkus Klotzbuecher
6230b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
6240b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
6250b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
6260b953ffcSMarkus Klotzbuecher
6276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
6280b953ffcSMarkus Klotzbuecher
6290b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
6300b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
6310b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
6320b953ffcSMarkus Klotzbuecher		by this value.
6330b953ffcSMarkus Klotzbuecher
63492bbd64eSDaniel Schwierzeck- MIPS CPU options:
63592bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
63692bbd64eSDaniel Schwierzeck
63792bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
63892bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
63992bbd64eSDaniel Schwierzeck		relocation.
64092bbd64eSDaniel Schwierzeck
64192bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
64292bbd64eSDaniel Schwierzeck
64392bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
64492bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
64592bbd64eSDaniel Schwierzeck		Possible values are:
64692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
64792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
64892bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
64992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
65092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
65192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
65292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
65392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
65492bbd64eSDaniel Schwierzeck
65592bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
65692bbd64eSDaniel Schwierzeck
65792bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
65892bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
65992bbd64eSDaniel Schwierzeck
66092bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
66192bbd64eSDaniel Schwierzeck
66292bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
66392bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
66492bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
66592bbd64eSDaniel Schwierzeck
666b67d8816SChristian Riesch- ARM options:
667b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
668b67d8816SChristian Riesch
669b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
670b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
671b67d8816SChristian Riesch
6725356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
6735356f545SAneesh V
6745356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6755356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6765356f545SAneesh V		better code density. For ARM architectures that support
6775356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6785356f545SAneesh V		GCC.
6795356f545SAneesh V
680c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6810678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6820678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6830678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
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
693c616a0dfSNishanth Menon		NOTE: The following can be machine specific errata. These
694c616a0dfSNishanth Menon		do have ability to provide rudimentary version and machine
695c616a0dfSNishanth Menon		specific checks, but expect no product checks.
6965902f4ceSNishanth Menon		CONFIG_ARM_ERRATA_430973
697b45c48a7SNishanth Menon		CONFIG_ARM_ERRATA_454179
698*9b4d65f9SNishanth Menon		CONFIG_ARM_ERRATA_621766
699c616a0dfSNishanth Menon		CONFIG_ARM_ERRATA_798870
700c616a0dfSNishanth Menon
70173c38934SStephen Warren- Tegra SoC options:
70273c38934SStephen Warren		CONFIG_TEGRA_SUPPORT_NON_SECURE
70373c38934SStephen Warren
70473c38934SStephen Warren		Support executing U-Boot in non-secure (NS) mode. Certain
70573c38934SStephen Warren		impossible actions will be skipped if the CPU is in NS mode,
70673c38934SStephen Warren		such as ARM architectural timer initialization.
70773c38934SStephen Warren
70838687ae6SSimon Glass- Driver Model
70938687ae6SSimon Glass		Driver model is a new framework for devices in U-Boot
71038687ae6SSimon Glass		introduced in early 2014. U-Boot is being progressively
71138687ae6SSimon Glass		moved over to this. It offers a consistent device structure,
71238687ae6SSimon Glass		supports grouping devices into classes and has built-in
71338687ae6SSimon Glass		handling of platform data and device tree.
71438687ae6SSimon Glass
71538687ae6SSimon Glass		To enable transition to driver model in a relatively
71638687ae6SSimon Glass		painful fashion, each subsystem can be independently
71738687ae6SSimon Glass		switched between the legacy/ad-hoc approach and the new
71838687ae6SSimon Glass		driver model using the options below. Also, many uclass
71938687ae6SSimon Glass		interfaces include compatibility features which may be
72038687ae6SSimon Glass		removed once the conversion of that subsystem is complete.
72138687ae6SSimon Glass		As a result, the API provided by the subsystem may in fact
72238687ae6SSimon Glass		not change with driver model.
72338687ae6SSimon Glass
72438687ae6SSimon Glass		See doc/driver-model/README.txt for more information.
72538687ae6SSimon Glass
72638687ae6SSimon Glass		CONFIG_DM
72738687ae6SSimon Glass
72838687ae6SSimon Glass		Enable driver model. This brings in the core support,
72938687ae6SSimon Glass		including scanning of platform data on start-up. If
73038687ae6SSimon Glass		CONFIG_OF_CONTROL is enabled, the device tree will be
73138687ae6SSimon Glass		scanned also when available.
73238687ae6SSimon Glass
73338687ae6SSimon Glass		CONFIG_CMD_DM
73438687ae6SSimon Glass
73538687ae6SSimon Glass		Enable driver model test commands. These allow you to print
73638687ae6SSimon Glass		out the driver model tree and the uclasses.
73738687ae6SSimon Glass
73838687ae6SSimon Glass		CONFIG_DM_DEMO
73938687ae6SSimon Glass
74038687ae6SSimon Glass		Enable some demo devices and the 'demo' command. These are
74138687ae6SSimon Glass		really only useful for playing around while trying to
74238687ae6SSimon Glass		understand driver model in sandbox.
74338687ae6SSimon Glass
74438687ae6SSimon Glass		CONFIG_SPL_DM
74538687ae6SSimon Glass
74638687ae6SSimon Glass		Enable driver model in SPL. You will need to provide a
74738687ae6SSimon Glass		suitable malloc() implementation. If you are not using the
74838687ae6SSimon Glass		full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
74938687ae6SSimon Glass		consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
75038687ae6SSimon Glass		must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
75138687ae6SSimon Glass		In most cases driver model will only allocate a few uclasses
75238687ae6SSimon Glass		and devices in SPL, so 1KB should be enable. See
75338687ae6SSimon Glass		CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
75438687ae6SSimon Glass		it.
75538687ae6SSimon Glass
75638687ae6SSimon Glass		CONFIG_DM_SERIAL
75738687ae6SSimon Glass
75838687ae6SSimon Glass		Enable driver model for serial. This replaces
75938687ae6SSimon Glass		drivers/serial/serial.c with the serial uclass, which
76038687ae6SSimon Glass		implements serial_putc() etc. The uclass interface is
76138687ae6SSimon Glass		defined in include/serial.h.
76238687ae6SSimon Glass
76338687ae6SSimon Glass		CONFIG_DM_GPIO
76438687ae6SSimon Glass
76538687ae6SSimon Glass		Enable driver model for GPIO access. The standard GPIO
76638687ae6SSimon Glass		interface (gpio_get_value(), etc.) is then implemented by
76738687ae6SSimon Glass		the GPIO uclass. Drivers provide methods to query the
76838687ae6SSimon Glass		particular GPIOs that they provide. The uclass interface
76938687ae6SSimon Glass		is defined in include/asm-generic/gpio.h.
77038687ae6SSimon Glass
77138687ae6SSimon Glass		CONFIG_DM_SPI
77238687ae6SSimon Glass
77338687ae6SSimon Glass		Enable driver model for SPI. The SPI slave interface
77438687ae6SSimon Glass		(spi_setup_slave(), spi_xfer(), etc.) is then implemented by
77538687ae6SSimon Glass		the SPI uclass. Drivers provide methods to access the SPI
77638687ae6SSimon Glass		buses that they control. The uclass interface is defined in
77738687ae6SSimon Glass		include/spi.h. The existing spi_slave structure is attached
77838687ae6SSimon Glass		as 'parent data' to every slave on each bus. Slaves
77938687ae6SSimon Glass		typically use driver-private data instead of extending the
78038687ae6SSimon Glass		spi_slave structure.
78138687ae6SSimon Glass
78238687ae6SSimon Glass		CONFIG_DM_SPI_FLASH
78338687ae6SSimon Glass
78438687ae6SSimon Glass		Enable driver model for SPI flash. This SPI flash interface
78538687ae6SSimon Glass		(spi_flash_probe(), spi_flash_write(), etc.) is then
78638687ae6SSimon Glass		implemented by the SPI flash uclass. There is one standard
78738687ae6SSimon Glass		SPI flash driver which knows how to probe most chips
78838687ae6SSimon Glass		supported by U-Boot. The uclass interface is defined in
78938687ae6SSimon Glass		include/spi_flash.h, but is currently fully compatible
79038687ae6SSimon Glass		with the old interface to avoid confusion and duplication
79138687ae6SSimon Glass		during the transition parent. SPI and SPI flash must be
79238687ae6SSimon Glass		enabled together (it is not possible to use driver model
79338687ae6SSimon Glass		for one and not the other).
79438687ae6SSimon Glass
79538687ae6SSimon Glass		CONFIG_DM_CROS_EC
79638687ae6SSimon Glass
79738687ae6SSimon Glass		Enable driver model for the Chrome OS EC interface. This
79838687ae6SSimon Glass		allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
79938687ae6SSimon Glass		but otherwise makes few changes. Since cros_ec also supports
80038687ae6SSimon Glass		I2C and LPC (which don't support driver model yet), a full
80138687ae6SSimon Glass		conversion is not yet possible.
80238687ae6SSimon Glass
80338687ae6SSimon Glass
80438687ae6SSimon Glass		** Code size options: The following options are enabled by
80538687ae6SSimon Glass		default except in SPL. Enable them explicitly to get these
80638687ae6SSimon Glass		features in SPL.
80738687ae6SSimon Glass
80838687ae6SSimon Glass		CONFIG_DM_WARN
80938687ae6SSimon Glass
81038687ae6SSimon Glass		Enable the dm_warn() function. This can use up quite a bit
81138687ae6SSimon Glass		of space for its strings.
81238687ae6SSimon Glass
81338687ae6SSimon Glass		CONFIG_DM_STDIO
81438687ae6SSimon Glass
81538687ae6SSimon Glass		Enable registering a serial device with the stdio library.
81638687ae6SSimon Glass
81738687ae6SSimon Glass		CONFIG_DM_DEVICE_REMOVE
81838687ae6SSimon Glass
81938687ae6SSimon Glass		Enable removing of devices.
82038687ae6SSimon Glass
8215da627a4Swdenk- Linux Kernel Interface:
822c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
823c609719bSwdenk
824c609719bSwdenk		U-Boot stores all clock information in Hz
825c609719bSwdenk		internally. For binary compatibility with older Linux
826c609719bSwdenk		kernels (which expect the clocks passed in the
827c609719bSwdenk		bd_info data to be in MHz) the environment variable
828c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
829c609719bSwdenk		converts clock data to MHZ before passing it to the
830c609719bSwdenk		Linux kernel.
831c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
832c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
833c609719bSwdenk		default environment.
834c609719bSwdenk
8355da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
8365da627a4Swdenk
837b445bbb4SJeremiah Mahler		When transferring memsize parameter to Linux, some versions
8385da627a4Swdenk		expect it to be in bytes, others in MB.
8395da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
8405da627a4Swdenk
841fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
842f57f70aaSWolfgang Denk
843f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
844213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
845213bf8c8SGerald Van Baren		concepts).
846213bf8c8SGerald Van Baren
847213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
848213bf8c8SGerald Van Baren		 * New libfdt-based support
849213bf8c8SGerald Van Baren		 * Adds the "fdt" command
8503bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
851213bf8c8SGerald Van Baren
852b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
853b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
854b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
855b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
856f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
857c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
858f57f70aaSWolfgang Denk
85911ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
86011ccc33fSMarcel Ziswiler		addresses
8613bb342fcSKim Phillips
8624e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
8634e253137SKumar Gala
8644e253137SKumar Gala		Board code has addition modification that it wants to make
8654e253137SKumar Gala		to the flat device tree before handing it off to the kernel
8666705d81eSwdenk
867c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
868c654b517SSimon Glass
869c654b517SSimon Glass		Other code has addition modification that it wants to make
870c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
871c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
872c654b517SSimon Glass		the kernel.
873c654b517SSimon Glass
8740267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
8750267768eSMatthew McClintock
87611ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
8770267768eSMatthew McClintock		param header, the default value is zero if undefined.
8780267768eSMatthew McClintock
8793887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
8803887c3fbSHeiko Schocher
8813887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
8823887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
8833887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
8843887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
8853887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
8863887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
8873887c3fbSHeiko Schocher
8887eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
8897eb29398SIgor Grinberg
8907eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
8917eb29398SIgor Grinberg		machine type and must be used to specify the machine type
8927eb29398SIgor Grinberg		number as it appears in the ARM machine registry
8937eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
8947eb29398SIgor Grinberg		Only boards that have multiple machine types supported
8957eb29398SIgor Grinberg		in a single configuration file and the machine type is
8967eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
8977eb29398SIgor Grinberg
8980b2f4ecaSNiklaus Giger- vxWorks boot parameters:
8990b2f4ecaSNiklaus Giger
9000b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
9010b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
9020b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
9030b2f4ecaSNiklaus Giger
9040b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
9050b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
9060b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
9070b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
9080b2f4ecaSNiklaus Giger
9090b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
9100b2f4ecaSNiklaus Giger
9110b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
9120b2f4ecaSNiklaus Giger
9130b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
9140b2f4ecaSNiklaus Giger		the defaults discussed just above.
9150b2f4ecaSNiklaus Giger
9162c451f78SAneesh V- Cache Configuration:
9172c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
9182c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
9192c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
9202c451f78SAneesh V
92193bc2193SAneesh V- Cache Configuration for ARM:
92293bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
92393bc2193SAneesh V				      controller
92493bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
92593bc2193SAneesh V					controller register space
92693bc2193SAneesh V
9276705d81eSwdenk- Serial Ports:
92848d0192fSAndreas Engel		CONFIG_PL010_SERIAL
9296705d81eSwdenk
9306705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
9316705d81eSwdenk
93248d0192fSAndreas Engel		CONFIG_PL011_SERIAL
9336705d81eSwdenk
9346705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
9356705d81eSwdenk
9366705d81eSwdenk		CONFIG_PL011_CLOCK
9376705d81eSwdenk
9386705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
9396705d81eSwdenk		the clock speed of the UARTs.
9406705d81eSwdenk
9416705d81eSwdenk		CONFIG_PL01x_PORTS
9426705d81eSwdenk
9436705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
9446705d81eSwdenk		define this to a list of base addresses for each (supported)
9456705d81eSwdenk		port. See e.g. include/configs/versatile.h
9466705d81eSwdenk
947910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
948910f1ae3SJohn Rigby
949910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
950910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
951910f1ae3SJohn Rigby		this variable to initialize the extra register.
952910f1ae3SJohn Rigby
953910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
954910f1ae3SJohn Rigby
955910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
956910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
957910f1ae3SJohn Rigby		variable to flush the UART at init time.
958910f1ae3SJohn Rigby
959d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
960d57dee57SKaricheri, Muralidharan
961d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
962d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
9636705d81eSwdenk
964c609719bSwdenk- Console Interface:
965c609719bSwdenk		Depending on board, define exactly one serial port
966c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
967c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
968c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
969c609719bSwdenk
970c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
971c609719bSwdenk		port routines must be defined elsewhere
972c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
973c609719bSwdenk
974c609719bSwdenk		CONFIG_CFB_CONSOLE
975c609719bSwdenk		Enables console device for a color framebuffer. Needs following
976c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
977c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
978c609719bSwdenk						(default big endian)
979c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
980c609719bSwdenk						rectangle fill
981c609719bSwdenk						(cf. smiLynxEM)
982c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
983c609719bSwdenk						bit-blit (cf. smiLynxEM)
984c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
985c609719bSwdenk						(cols=pitch)
986c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
987c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
988c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
989c609719bSwdenk						(0-5, cf. cfb_console.c)
990c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
991c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
992c609719bSwdenk						(i.e. i8042_kbd_init())
993c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
994c609719bSwdenk						(i.e. i8042_tstc)
995c609719bSwdenk			VIDEO_GETC_FCT		get char fct
996c609719bSwdenk						(i.e. i8042_getc)
997c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
998c609719bSwdenk						(requires blink timer
999c609719bSwdenk						cf. i8042.c)
10006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
1001c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
1002c609719bSwdenk						upper right corner
1003602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
1004c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
1005c609719bSwdenk						upper left corner
1006a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
1007a6c7ad2fSwdenk						linux_logo.h for logo.
1008a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
1009c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
101011ccc33fSMarcel Ziswiler						additional board info beside
1011c609719bSwdenk						the logo
1012c609719bSwdenk
101333a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
101433a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
101533a35bbbSPali Rohár		erase functions and limited graphics rendition control).
101633a35bbbSPali Rohár
1017c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
1018c609719bSwdenk		default i/o. Serial console can be forced with
1019c609719bSwdenk		environment 'console=serial'.
1020c609719bSwdenk
1021a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
1022a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
1023a3ad8e26Swdenk		the "silent" environment variable. See
1024a3ad8e26Swdenk		doc/README.silent for more information.
1025a3ad8e26Swdenk
102645ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
102745ae2546SHeiko Schocher			is 0x00.
102845ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
102945ae2546SHeiko Schocher			is 0xa0.
103045ae2546SHeiko Schocher
1031c609719bSwdenk- Console Baudrate:
1032c609719bSwdenk		CONFIG_BAUDRATE - in bps
1033c609719bSwdenk		Select one of the baudrates listed in
10346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
10356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
1036c609719bSwdenk
1037c92fac91SHeiko Schocher- Console Rx buffer length
1038c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
1039c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
10402b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
1041c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
1042c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
1043c92fac91SHeiko Schocher		the SMC.
1044c92fac91SHeiko Schocher
10459558b48aSGraeme Russ- Pre-Console Buffer:
10469558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
10479558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
10489558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
10499558b48aSGraeme Russ		buffer any console messages prior to the console being
10509558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
10519558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
10529558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
10539558b48aSGraeme Russ		bytes are output before the console is initialised, the
10549558b48aSGraeme Russ		earlier bytes are discarded.
10559558b48aSGraeme Russ
10569558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
10579558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
10589558b48aSGraeme Russ
1059046a37bdSSonny Rao- Safe printf() functions
1060046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
1061046a37bdSSonny Rao		the printf() functions. These are defined in
1062046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
1063046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
1064046a37bdSSonny Rao		If this option is not given then these functions will
1065046a37bdSSonny Rao		silently discard their buffer size argument - this means
1066046a37bdSSonny Rao		you are not getting any overflow checking in this case.
1067046a37bdSSonny Rao
1068c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
1069c609719bSwdenk		Delay before automatically booting the default image;
1070c609719bSwdenk		set to -1 to disable autoboot.
107193d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
107293d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
1073c609719bSwdenk
1074c609719bSwdenk		See doc/README.autoboot for these options that
1075c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
1076c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
1077c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
1078c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
1079c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
1080c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
1081c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
1082c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
1083c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
1084c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
1085c609719bSwdenk		CONFIG_RESET_TO_RETRY
1086c609719bSwdenk
1087c609719bSwdenk- Autoboot Command:
1088c609719bSwdenk		CONFIG_BOOTCOMMAND
1089c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
1090c609719bSwdenk		define a command string that is automatically executed
1091c609719bSwdenk		when no character is read on the console interface
1092c609719bSwdenk		within "Boot Delay" after reset.
1093c609719bSwdenk
1094c609719bSwdenk		CONFIG_BOOTARGS
1095c609719bSwdenk		This can be used to pass arguments to the bootm
1096c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
1097c609719bSwdenk		environment value "bootargs".
1098c609719bSwdenk
1099c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
1100c609719bSwdenk		The value of these goes into the environment as
1101c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
1102c609719bSwdenk		as a convenience, when switching between booting from
110311ccc33fSMarcel Ziswiler		RAM and NFS.
1104c609719bSwdenk
1105eda0ba38SHeiko Schocher- Bootcount:
1106eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
1107eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
1108eda0ba38SHeiko Schocher		cycle, see:
1109eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1110eda0ba38SHeiko Schocher
1111eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
1112eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
1113eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
1114eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
1115eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
1116eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
1117eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
1118eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
1119eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
1120eda0ba38SHeiko Schocher
1121c609719bSwdenk- Pre-Boot Commands:
1122c609719bSwdenk		CONFIG_PREBOOT
1123c609719bSwdenk
1124c609719bSwdenk		When this option is #defined, the existence of the
1125c609719bSwdenk		environment variable "preboot" will be checked
1126c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
1127c609719bSwdenk		countdown and/or running the auto-boot command resp.
1128c609719bSwdenk		entering interactive mode.
1129c609719bSwdenk
1130c609719bSwdenk		This feature is especially useful when "preboot" is
1131c609719bSwdenk		automatically generated or modified. For an example
1132c609719bSwdenk		see the LWMON board specific code: here "preboot" is
1133c609719bSwdenk		modified when the user holds down a certain
1134c609719bSwdenk		combination of keys on the (special) keyboard when
1135c609719bSwdenk		booting the systems
1136c609719bSwdenk
1137c609719bSwdenk- Serial Download Echo Mode:
1138c609719bSwdenk		CONFIG_LOADS_ECHO
1139c609719bSwdenk		If defined to 1, all characters received during a
1140c609719bSwdenk		serial download (using the "loads" command) are
1141c609719bSwdenk		echoed back. This might be needed by some terminal
1142c609719bSwdenk		emulations (like "cu"), but may as well just take
1143c609719bSwdenk		time on others. This setting #define's the initial
1144c609719bSwdenk		value of the "loads_echo" environment variable.
1145c609719bSwdenk
1146602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
1147c609719bSwdenk		CONFIG_KGDB_BAUDRATE
1148c609719bSwdenk		Select one of the baudrates listed in
11496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
1150c609719bSwdenk
1151c609719bSwdenk- Monitor Functions:
1152602ad3b3SJon Loeliger		Monitor commands can be included or excluded
1153602ad3b3SJon Loeliger		from the build by using the #include files
1154c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
1155c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
1156602ad3b3SJon Loeliger		and augmenting with additional #define's
1157602ad3b3SJon Loeliger		for wanted commands.
1158c609719bSwdenk
1159602ad3b3SJon Loeliger		The default command configuration includes all commands
1160602ad3b3SJon Loeliger		except those marked below with a "*".
1161602ad3b3SJon Loeliger
1162b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
1163602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
1164602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
1165602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
1166602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
1167602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
1168602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
1169d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
1170602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
117108d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
1172602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
1173710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
1174602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
1175602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
1176602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
1177a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
1178a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
1179a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
1180a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
1181602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
1182602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
1183246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
1184602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
1185602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
11865e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
1187fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
118888733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
11890c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
119003e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
119103e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
119216f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
119316f4d933SStephen Warren					  that work for multiple fs types
119459e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
1195bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
1196602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
119703e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
1198602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
1199602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
12004d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
120153fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
1202a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
1203a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
1204bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
1205602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
1206602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
1207602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
1208602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
12098fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
12104d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1211602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
1212aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
12130c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
1214c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
1215602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
1216602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
1217602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
1218602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
12194d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1220d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
1221d22c338eSJoe Hershberger					  (169.254.*.*)
1222602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
1223602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
12244d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
122502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
122615a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1227602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1228a2681707SWolfgang Denk					  loop, loopw
12294d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1230602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1231602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1232602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
123368d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1234602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1235602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
12364d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1237e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1238e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1239602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1240602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1241602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1242602ad3b3SJon Loeliger					  host
1243602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1244ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1245602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1246602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1247d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1248602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1249602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1250602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1251602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1252602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1253602ad3b3SJon Loeliger					  (4xx only)
1254f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
12554d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
125602c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
12577d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
125874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1259602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
12607a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
12611fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1262da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1263da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1264602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1265602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1266c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
12674d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
126889c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1269c609719bSwdenk
1270c609719bSwdenk		EXAMPLE: If you want all functions except of network
1271c609719bSwdenk		support you can write:
1272c609719bSwdenk
1273602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1274602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1275c609719bSwdenk
1276213bf8c8SGerald Van Baren	Other Commands:
1277213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1278c609719bSwdenk
1279c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1280602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1281c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1282c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1283c609719bSwdenk		8260 (where accesses to the IMMR region must be
1284c609719bSwdenk		uncached), and it cannot be disabled on all other
1285c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1286c609719bSwdenk		initial stack and some data.
1287c609719bSwdenk
1288c609719bSwdenk
1289c609719bSwdenk		XXX - this list needs to get updated!
1290c609719bSwdenk
1291a5ecbe62SWolfgang Denk- Regular expression support:
1292a5ecbe62SWolfgang Denk		CONFIG_REGEX
1293a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1294a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1295a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1296a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1297a5ecbe62SWolfgang Denk
129845ba8077SSimon Glass- Device tree:
129945ba8077SSimon Glass		CONFIG_OF_CONTROL
130045ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
130145ba8077SSimon Glass		to configure its devices, instead of relying on statically
130245ba8077SSimon Glass		compiled #defines in the board file. This option is
130345ba8077SSimon Glass		experimental and only available on a few boards. The device
130445ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
130545ba8077SSimon Glass
13062c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
13072c0f79e4SSimon Glass		be done using one of the two options below:
1308bbb0b128SSimon Glass
1309bbb0b128SSimon Glass		CONFIG_OF_EMBED
1310bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1311bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1312bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1313bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1314bbb0b128SSimon Glass		the global data structure as gd->blob.
131545ba8077SSimon Glass
13162c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
13172c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
13182c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
13192c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
13202c0f79e4SSimon Glass
13212c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
13222c0f79e4SSimon Glass
13232c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
13242c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
13252c0f79e4SSimon Glass		still use the individual files if you need something more
13262c0f79e4SSimon Glass		exotic.
13272c0f79e4SSimon Glass
1328c609719bSwdenk- Watchdog:
1329c609719bSwdenk		CONFIG_WATCHDOG
1330c609719bSwdenk		If this variable is defined, it enables watchdog
13316abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
13326abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
13336abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
13346abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
13356abe6fb6SDetlev Zundel		available, then no further board specific code should
13366abe6fb6SDetlev Zundel		be needed to use it.
13376abe6fb6SDetlev Zundel
13386abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
13396abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
13406abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
13416abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1342c609719bSwdenk
13437bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
13447bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
13457bae0d6fSHeiko Schocher
1346c1551ea8Sstroese- U-Boot Version:
1347c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1348c1551ea8Sstroese		If this variable is defined, an environment variable
1349c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1350c1551ea8Sstroese		version as printed by the "version" command.
1351a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1352a1ea8e51SBenoît Thébaudeau		next reset.
1353c1551ea8Sstroese
1354c609719bSwdenk- Real-Time Clock:
1355c609719bSwdenk
1356602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1357c609719bSwdenk		has to be selected, too. Define exactly one of the
1358c609719bSwdenk		following options:
1359c609719bSwdenk
1360c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1361c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
13624e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1363c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
13641cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1365c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
13667f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1367412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
13683bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
13699536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
13704c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
13716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
137271d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
137371d19f30SHeiko Schocher					  RV3029 RTC.
1374c609719bSwdenk
1375b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1376b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1377b37c7e5eSwdenk
1378e92739d3SPeter Tyser- GPIO Support:
1379e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1380e92739d3SPeter Tyser
13815dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
13825dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
13835dec49caSChris Packham		pins supported by a particular chip.
13845dec49caSChris Packham
1385e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1386e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1387e92739d3SPeter Tyser
1388aa53233aSSimon Glass- I/O tracing:
1389aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1390aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1391aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1392aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1393aa53233aSSimon Glass		the driver behaves the same way before and after a code
1394aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1395aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1396aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1397aa53233aSSimon Glass
1398aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1399aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1400aa53233aSSimon Glass		still continue to operate.
1401aa53233aSSimon Glass
1402aa53233aSSimon Glass			iotrace is enabled
1403aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1404aa53233aSSimon Glass			Size:   00010000	(buffer size)
1405aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1406aa53233aSSimon Glass			Output: 10000120	(start + offset)
1407aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1408aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1409aa53233aSSimon Glass
1410c609719bSwdenk- Timestamp Support:
1411c609719bSwdenk
1412c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1413c609719bSwdenk		(date and time) of an image is printed by image
1414c609719bSwdenk		commands like bootm or iminfo. This option is
1415602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1416c609719bSwdenk
1417923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1418923c46f9SKarl O. Pinc		Zero or more of the following:
1419923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1420923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1421923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1422923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1423923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1424923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1425923c46f9SKarl O. Pinc				       disk/part_efi.c
1426923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1427c609719bSwdenk
1428602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1429218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1430923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1431c609719bSwdenk
1432c609719bSwdenk- IDE Reset method:
14334d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
14344d13cbadSwdenk		board configurations files but used nowhere!
1435c609719bSwdenk
14364d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
14374d13cbadSwdenk		be performed by calling the function
14384d13cbadSwdenk			ide_set_reset(int reset)
14394d13cbadSwdenk		which has to be defined in a board specific file
1440c609719bSwdenk
1441c609719bSwdenk- ATAPI Support:
1442c609719bSwdenk		CONFIG_ATAPI
1443c609719bSwdenk
1444c609719bSwdenk		Set this to enable ATAPI support.
1445c609719bSwdenk
1446c40b2956Swdenk- LBA48 Support
1447c40b2956Swdenk		CONFIG_LBA48
1448c40b2956Swdenk
1449c40b2956Swdenk		Set this to enable support for disks larger than 137GB
14504b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1451c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1452c40b2956Swdenk		support disks up to 2.1TB.
1453c40b2956Swdenk
14546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1455c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1456c40b2956Swdenk			Default is 32bit.
1457c40b2956Swdenk
1458c609719bSwdenk- SCSI Support:
1459c609719bSwdenk		At the moment only there is only support for the
1460c609719bSwdenk		SYM53C8XX SCSI controller; define
1461c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1462c609719bSwdenk
14636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
14646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
14656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1466c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1467c609719bSwdenk		devices.
14686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1469c609719bSwdenk
1470447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1471447c031bSStefan Reinauer		SCSI devices found during the last scan.
1472447c031bSStefan Reinauer
1473c609719bSwdenk- NETWORK Support (PCI):
1474682011ffSwdenk		CONFIG_E1000
1475ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1476ce5207e1SKyle Moffett
1477ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1478ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1479ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1480ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1481ce5207e1SKyle Moffett
1482ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1483ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1484ce5207e1SKyle Moffett		example with the "sspi" command.
1485ce5207e1SKyle Moffett
1486ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1487ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1488ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1489682011ffSwdenk
1490ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
149111ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1492ac3315c2SAndre Schwarz
1493c609719bSwdenk		CONFIG_EEPRO100
1494c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
149511ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1496c609719bSwdenk		write routine for first time initialisation.
1497c609719bSwdenk
1498c609719bSwdenk		CONFIG_TULIP
1499c609719bSwdenk		Support for Digital 2114x chips.
1500c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1501c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1502c609719bSwdenk
1503c609719bSwdenk		CONFIG_NATSEMI
1504c609719bSwdenk		Support for National dp83815 chips.
1505c609719bSwdenk
1506c609719bSwdenk		CONFIG_NS8382X
1507c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1508c609719bSwdenk
150945219c46Swdenk- NETWORK Support (other):
151045219c46Swdenk
1511c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1512c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1513c041e9d2SJens Scharsig
1514c041e9d2SJens Scharsig			CONFIG_RMII
1515c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1516c041e9d2SJens Scharsig
1517c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1518c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1519c041e9d2SJens Scharsig			The driver doen't show link status messages.
1520c041e9d2SJens Scharsig
1521efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1522efdd7319SRob Herring		Support for the Calxeda XGMAC device
1523efdd7319SRob Herring
15243bb46d23SAshok		CONFIG_LAN91C96
152545219c46Swdenk		Support for SMSC's LAN91C96 chips.
152645219c46Swdenk
152745219c46Swdenk			CONFIG_LAN91C96_BASE
152845219c46Swdenk			Define this to hold the physical address
152945219c46Swdenk			of the LAN91C96's I/O space
153045219c46Swdenk
153145219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
153245219c46Swdenk			Define this to enable 32 bit addressing
153345219c46Swdenk
15343bb46d23SAshok		CONFIG_SMC91111
1535f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1536f39748aeSwdenk
1537f39748aeSwdenk			CONFIG_SMC91111_BASE
1538f39748aeSwdenk			Define this to hold the physical address
1539f39748aeSwdenk			of the device (I/O space)
1540f39748aeSwdenk
1541f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1542f39748aeSwdenk			Define this if data bus is 32 bits
1543f39748aeSwdenk
1544f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1545f39748aeSwdenk			Define this to use i/o functions instead of macros
1546f39748aeSwdenk			(some hardware wont work with macros)
1547f39748aeSwdenk
1548dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1549dc02badaSHeiko Schocher		Support for davinci emac
1550dc02badaSHeiko Schocher
1551dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1552dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1553dc02badaSHeiko Schocher
1554b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1555b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1556b3dbf4a5SMacpaul Lin
1557b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1558b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1559b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1560b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1561b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1562b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1563b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1564b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1565b3dbf4a5SMacpaul Lin
1566c2fff331SMike Rapoport		CONFIG_SMC911X
1567557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1568557b377dSJens Gehrlein
1569c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1570557b377dSJens Gehrlein			Define this to hold the physical address
1571557b377dSJens Gehrlein			of the device (I/O space)
1572557b377dSJens Gehrlein
1573c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1574557b377dSJens Gehrlein			Define this if data bus is 32 bits
1575557b377dSJens Gehrlein
1576c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1577557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1578557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1579c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1580557b377dSJens Gehrlein
15813d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
15823d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
15833d0075faSYoshihiro Shimoda
15843d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
15853d0075faSYoshihiro Shimoda			Define the number of ports to be used
15863d0075faSYoshihiro Shimoda
15873d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
15883d0075faSYoshihiro Shimoda			Define the ETH PHY's address
15893d0075faSYoshihiro Shimoda
159068260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
159168260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
159268260aabSYoshihiro Shimoda
1593b2f97cf2SHeiko Schocher- PWM Support:
1594b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1595b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1596b2f97cf2SHeiko Schocher
15975e124724SVadim Bendebury- TPM Support:
159890899cc0SChe-liang Chiou		CONFIG_TPM
159990899cc0SChe-liang Chiou		Support TPM devices.
160090899cc0SChe-liang Chiou
16011b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
16021b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
16031b393db5STom Wai-Hong Tam		per system is supported at this time.
16041b393db5STom Wai-Hong Tam
16051b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
16061b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
16071b393db5STom Wai-Hong Tam
16081b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
16091b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
16101b393db5STom Wai-Hong Tam
16111b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
16121b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
16131b393db5STom Wai-Hong Tam
1614c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1615c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1616c01939c7SDirk Eibach
161790899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
16185e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
16195e124724SVadim Bendebury		per system is supported at this time.
16205e124724SVadim Bendebury
16215e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
16225e124724SVadim Bendebury			Base address where the generic TPM device is mapped
16235e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
16245e124724SVadim Bendebury			0xfed40000.
16255e124724SVadim Bendebury
1626be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1627be6c1529SReinhard Pfau		Add tpm monitor functions.
1628be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1629be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1630be6c1529SReinhard Pfau
1631be6c1529SReinhard Pfau		CONFIG_TPM
1632be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1633be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1634be6c1529SReinhard Pfau		Requires support for a TPM device.
1635be6c1529SReinhard Pfau
1636be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1637be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1638be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1639be6c1529SReinhard Pfau
1640c609719bSwdenk- USB Support:
1641c609719bSwdenk		At the moment only the UHCI host controller is
16424d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1643c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1644c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
164530d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1646c609719bSwdenk		storage devices.
1647c609719bSwdenk		Note:
1648c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1649c609719bSwdenk		(TEAC FD-05PUB).
16504d13cbadSwdenk		MPC5200 USB requires additional defines:
16514d13cbadSwdenk			CONFIG_USB_CLOCK
16524d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1653307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1654307ecb6dSEric Millbrandt				for USB on PSC3
16554d13cbadSwdenk			CONFIG_USB_CONFIG
16564d13cbadSwdenk				for differential drivers: 0x00001000
16574d13cbadSwdenk				for single ended drivers: 0x00005000
1658307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1659307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
16606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1661fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1662fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
16634d13cbadSwdenk
16649ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
16659ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
16669ab4ce22SSimon Glass
16676e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
16686e9e0626SOleksandr Tymoshenko		HW module registers.
16696e9e0626SOleksandr Tymoshenko
167016c8d5e7SWolfgang Denk- USB Device:
167116c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
167216c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
167316c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
167411ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
167516c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
167616c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
167716c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
167816c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
167916c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
168016c8d5e7SWolfgang Denk		a Linux host by
168116c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
168216c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
168316c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
168416c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
168516c8d5e7SWolfgang Denk
168616c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
168716c8d5e7SWolfgang Denk			Define this to build a UDC device
168816c8d5e7SWolfgang Denk
168916c8d5e7SWolfgang Denk			CONFIG_USB_TTY
169016c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
169116c8d5e7SWolfgang Denk			talk to the UDC device
169216c8d5e7SWolfgang Denk
1693f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1694f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1695f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1696f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1697f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1698f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1699f9da0f89SVipin KUMAR			speed.
1700f9da0f89SVipin KUMAR
17016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
170216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
170316c8d5e7SWolfgang Denk			be set to usbtty.
170416c8d5e7SWolfgang Denk
170516c8d5e7SWolfgang Denk			mpc8xx:
17066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
170716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
17086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
170916c8d5e7SWolfgang Denk
17106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
171116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
17126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
171316c8d5e7SWolfgang Denk
171416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
171516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
171616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
171716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
171816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
171916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
172016c8d5e7SWolfgang Denk
172116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
172216c8d5e7SWolfgang Denk			Define this string as the name of your company for
172316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
172416c8d5e7SWolfgang Denk
172516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
172616c8d5e7SWolfgang Denk			Define this string as the name of your product
172716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
172816c8d5e7SWolfgang Denk
172916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
173016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
173116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
173216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
173316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
173416c8d5e7SWolfgang Denk
173516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
173616c8d5e7SWolfgang Denk			Define this as the unique Product ID
173716c8d5e7SWolfgang Denk			for your device
173816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1739c609719bSwdenk
1740d70a560fSIgor Grinberg- ULPI Layer Support:
1741d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1742d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1743d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1744d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1745d70a560fSIgor Grinberg		viewport is supported.
1746d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1747d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
17486d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
17496d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
17506d365ea0SLucas Stach		the appropriate value in Hz.
1751c609719bSwdenk
1752c609719bSwdenk- MMC Support:
1753c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1754c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1755c609719bSwdenk		accessed from the boot prompt by mapping the device
1756c609719bSwdenk		to physical memory similar to flash. Command line is
1757602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1758602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1759c609719bSwdenk
1760afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1761afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1762afb35666SYoshihiro Shimoda
1763afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1764afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1765afb35666SYoshihiro Shimoda
1766afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1767afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1768afb35666SYoshihiro Shimoda
17691fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
17701fd93c6eSPierre Aubert		Enable the generic MMC driver
17711fd93c6eSPierre Aubert
17721fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
17731fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
17741fd93c6eSPierre Aubert
17751fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
17761fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
17771fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
17781fd93c6eSPierre Aubert
1779b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1780b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1781b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1782b3ba6e94STom Rini
1783b3ba6e94STom Rini		CONFIG_CMD_DFU
1784b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1785b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1786b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1787b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1788b3ba6e94STom Rini
1789b3ba6e94STom Rini		CONFIG_DFU_MMC
1790b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1791b3ba6e94STom Rini
1792c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1793c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1794c6631764SPantelis Antoniou
1795a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1796a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1797a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1798a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1799a9479f04SAfzal Mohammed		one that would help mostly the developer.
1800a9479f04SAfzal Mohammed
1801e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1802e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1803e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1804e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1805e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1806e7e75c70SHeiko Schocher
1807ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1808ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1809ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1810ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1811ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1812ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1813ea2453d5SPantelis Antoniou
1814001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1815001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1816001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1817001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1818001a8319SHeiko Schocher
1819001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1820001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1821001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1822001a8319SHeiko Schocher		sending again an USB request to the device.
1823001a8319SHeiko Schocher
18243aab70afSSebastian Siewior- USB Device Android Fastboot support:
18253aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
18263aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
18273aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
18283aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
18293aab70afSSebastian Siewior		used on Android devices.
18303aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
18313aab70afSSebastian Siewior
18323aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
18333aab70afSSebastian Siewior		This enables support for booting images which use the Android
18343aab70afSSebastian Siewior		image format header.
18353aab70afSSebastian Siewior
18363aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_ADDR
18373aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
18383aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
18393aab70afSSebastian Siewior		downloaded images.
18403aab70afSSebastian Siewior
18413aab70afSSebastian Siewior		CONFIG_USB_FASTBOOT_BUF_SIZE
18423aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
18433aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
18443aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
18453aab70afSSebastian Siewior
1846d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1847d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1848d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1849d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1850d1b5ed07SSteve Rae
1851d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1852d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1853d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1854d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1855d1b5ed07SSteve Rae
18560ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
18570ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
18580ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
18590ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
18600ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
18610ff7e585SSteve Rae		This occurs when the specified "partition name" on the
18620ff7e585SSteve Rae		"fastboot flash" command line matches this value.
18630ff7e585SSteve Rae		Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
18640ff7e585SSteve Rae
18656705d81eSwdenk- Journaling Flash filesystem support:
18666705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
18676705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
18686705d81eSwdenk		Define these for a default partition on a NAND device
18696705d81eSwdenk
18706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
18716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
18726705d81eSwdenk		Define these for a default partition on a NOR device
18736705d81eSwdenk
18746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
18756705d81eSwdenk		Define this to create an own partition. You have to provide a
18766705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
18776705d81eSwdenk
18786705d81eSwdenk		If you define only one JFFS2 partition you may also want to
18796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
18806705d81eSwdenk		to disable the command chpart. This is the default when you
18816705d81eSwdenk		have not defined a custom partition
18826705d81eSwdenk
1883c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1884c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1885656f4c65SDonggeun Kim
1886656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1887656f4c65SDonggeun Kim		file in FAT formatted partition.
1888656f4c65SDonggeun Kim
1889656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1890656f4c65SDonggeun Kim		user to write files to FAT.
1891c30a15e5SDonggeun Kim
189284cd9327SGabe BlackCBFS (Coreboot Filesystem) support
189384cd9327SGabe Black		CONFIG_CMD_CBFS
189484cd9327SGabe Black
189584cd9327SGabe Black		Define this to enable support for reading from a Coreboot
189684cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
189784cd9327SGabe Black		and cbfsload.
189884cd9327SGabe Black
18994f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
19004f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
19014f0d1a2aSSiva Durga Prasad Paladugu
19024f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
19034f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
19044f0d1a2aSSiva Durga Prasad Paladugu
1905c609719bSwdenk- Keyboard Support:
1906c609719bSwdenk		CONFIG_ISA_KEYBOARD
1907c609719bSwdenk
1908c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1909c609719bSwdenk		support
1910c609719bSwdenk
1911c609719bSwdenk		CONFIG_I8042_KBD
1912c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1913c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1914c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1915c609719bSwdenk		for cfb_console. Supports cursor blinking.
1916c609719bSwdenk
1917713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1918713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1919713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1920713cb680SHung-ying Tyan		which provides key scans on request.
1921713cb680SHung-ying Tyan
1922c609719bSwdenk- Video support:
1923c609719bSwdenk		CONFIG_VIDEO
1924c609719bSwdenk
1925c609719bSwdenk		Define this to enable video support (for output to
1926c609719bSwdenk		video).
1927c609719bSwdenk
1928c609719bSwdenk		CONFIG_VIDEO_CT69000
1929c609719bSwdenk
1930c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1931c609719bSwdenk
1932c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1933eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1934eeb1b77bSwdenk		video output is selected via environment 'videoout'
1935eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1936eeb1b77bSwdenk		assumed.
1937c609719bSwdenk
1938eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
193911ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1940eeb1b77bSwdenk		are possible:
1941eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1942eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1943eeb1b77bSwdenk
1944eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1945eeb1b77bSwdenk		-------------+---------------------------------------------
1946eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1947eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1948eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1949eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1950eeb1b77bSwdenk		-------------+---------------------------------------------
1951c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1952c609719bSwdenk
1953eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
19547817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1955eeb1b77bSwdenk
1956eeb1b77bSwdenk
1957a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1958a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1959a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1960a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1961a6c7ad2fSwdenk
19627d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
19637d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
19647d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
19657d3053fbSTimur Tabi		support, and should also define these other macros:
19667d3053fbSTimur Tabi
19677d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
19687d3053fbSTimur Tabi			CONFIG_VIDEO
19697d3053fbSTimur Tabi			CONFIG_CMD_BMP
19707d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
19717d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
19727d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
19737d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
19747d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
19757d3053fbSTimur Tabi
1976ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1977ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1978ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1979ba8e76bdSTimur Tabi		description of this variable.
19807d3053fbSTimur Tabi
1981058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1982058d59b0SSimon Glass
1983058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1984058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1985058d59b0SSimon Glass		driver.
1986058d59b0SSimon Glass
1987058d59b0SSimon Glass
1988682011ffSwdenk- Keyboard Support:
1989682011ffSwdenk		CONFIG_KEYBOARD
1990682011ffSwdenk
1991682011ffSwdenk		Define this to enable a custom keyboard support.
1992682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1993682011ffSwdenk		defined in your board-specific files.
1994682011ffSwdenk		The only board using this so far is RBC823.
1995a6c7ad2fSwdenk
1996c609719bSwdenk- LCD Support:	CONFIG_LCD
1997c609719bSwdenk
1998c609719bSwdenk		Define this to enable LCD support (for output to LCD
1999c609719bSwdenk		display); also select one of the supported displays
2000c609719bSwdenk		by defining one of these:
2001c609719bSwdenk
200239cf4804SStelian Pop		CONFIG_ATMEL_LCD:
200339cf4804SStelian Pop
200439cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
200539cf4804SStelian Pop
2006fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
2007c609719bSwdenk
2008fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
2009c609719bSwdenk
2010fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
2011c609719bSwdenk
2012fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
2013fd3103bbSwdenk			Active, color, single scan.
2014fd3103bbSwdenk
2015fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
2016fd3103bbSwdenk
2017fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
2018c609719bSwdenk			Active, color, single scan.
2019c609719bSwdenk
2020c609719bSwdenk		CONFIG_SHARP_16x9
2021c609719bSwdenk
2022c609719bSwdenk			Sharp 320x240. Active, color, single scan.
2023c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
2024c609719bSwdenk
2025c609719bSwdenk		CONFIG_SHARP_LQ64D341
2026c609719bSwdenk
2027c609719bSwdenk			Sharp LQ64D341 display, 640x480.
2028c609719bSwdenk			Active, color, single scan.
2029c609719bSwdenk
2030c609719bSwdenk		CONFIG_HLD1045
2031c609719bSwdenk
2032c609719bSwdenk			HLD1045 display, 640x480.
2033c609719bSwdenk			Active, color, single scan.
2034c609719bSwdenk
2035c609719bSwdenk		CONFIG_OPTREX_BW
2036c609719bSwdenk
2037c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
2038c609719bSwdenk			or
2039c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
2040c609719bSwdenk			or
2041c609719bSwdenk			Hitachi	 SP14Q002
2042c609719bSwdenk
2043c609719bSwdenk			320x240. Black & white.
2044c609719bSwdenk
2045c609719bSwdenk		Normally display is black on white background; define
20466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
2047c609719bSwdenk
2048676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
2049676d319eSSimon Glass
2050b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
2051676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
2052676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
2053676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
2054676d319eSSimon Glass		a per-section basis.
2055676d319eSSimon Glass
20560d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
20570d89efefSSimon Glass
20580d89efefSSimon Glass		When the console need to be scrolled, this is the number of
20590d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
20600d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
20610d89efefSSimon Glass		is slow.
2062676d319eSSimon Glass
206345d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
206445d7f525STom Wai-Hong Tam
206545d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
206645d7f525STom Wai-Hong Tam
2067735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
2068735987c5STom Wai-Hong Tam
2069735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
2070735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
2071735987c5STom Wai-Hong Tam
20727152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
2073d791b1dcSwdenk
2074d791b1dcSwdenk		If this option is set, the environment is checked for
2075d791b1dcSwdenk		a variable "splashimage". If found, the usual display
2076d791b1dcSwdenk		of logo, copyright and system information on the LCD
2077e94d2cd9Swdenk		is suppressed and the BMP image at the address
2078d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
2079d791b1dcSwdenk		console is redirected to the "nulldev", too. This
2080d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
2081d791b1dcSwdenk		loaded very quickly after power-on.
2082d791b1dcSwdenk
2083c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
2084c0880485SNikita Kiryanov
2085c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
2086c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
20871551df35STom Rini		(see README.displaying-bmps).
2088c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
2089c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
2090c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
2091c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
2092c0880485SNikita Kiryanov		there is no need to set this option.
2093c0880485SNikita Kiryanov
20941ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
20951ca298ceSMatthias Weisser
20961ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
20971ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
20981ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
20991ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
21001ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
21011ca298ceSMatthias Weisser		specify 'm' for centering the image.
21021ca298ceSMatthias Weisser
21031ca298ceSMatthias Weisser		Example:
21041ca298ceSMatthias Weisser		setenv splashpos m,m
21051ca298ceSMatthias Weisser			=> image at center of screen
21061ca298ceSMatthias Weisser
21071ca298ceSMatthias Weisser		setenv splashpos 30,20
21081ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
21091ca298ceSMatthias Weisser
21101ca298ceSMatthias Weisser		setenv splashpos -10,m
21111ca298ceSMatthias Weisser			=> vertically centered image
21121ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
21131ca298ceSMatthias Weisser
211498f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
211598f4a3dfSStefan Roese
211698f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
211798f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
211898f4a3dfSStefan Roese		splashscreen support or the bmp command.
211998f4a3dfSStefan Roese
2120d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2121d5011762SAnatolij Gustschin
2122d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
2123d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
2124d5011762SAnatolij Gustschin		bmp command.
2125d5011762SAnatolij Gustschin
2126b445bbb4SJeremiah Mahler- Do compressing for memory range:
2127f2b96dfbSLei Wen		CONFIG_CMD_ZIP
2128f2b96dfbSLei Wen
2129f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
2130f2b96dfbSLei Wen		to compress the specified memory at its best effort.
2131f2b96dfbSLei Wen
2132c29fdfc1Swdenk- Compression support:
21338ef70478SKees Cook		CONFIG_GZIP
21348ef70478SKees Cook
21358ef70478SKees Cook		Enabled by default to support gzip compressed images.
21368ef70478SKees Cook
2137c29fdfc1Swdenk		CONFIG_BZIP2
2138c29fdfc1Swdenk
2139c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
2140c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
2141c29fdfc1Swdenk		compressed images are supported.
2142c29fdfc1Swdenk
2143c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
21446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
2145c29fdfc1Swdenk		be at least 4MB.
2146d791b1dcSwdenk
2147fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
2148fc9c1727SLuigi 'Comio' Mantellini
2149fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
2150fc9c1727SLuigi 'Comio' Mantellini		images is included.
2151fc9c1727SLuigi 'Comio' Mantellini
2152fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
2153fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
2154fc9c1727SLuigi 'Comio' Mantellini		formula:
2155fc9c1727SLuigi 'Comio' Mantellini
2156fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
2157fc9c1727SLuigi 'Comio' Mantellini
2158fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
2159fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
2160fc9c1727SLuigi 'Comio' Mantellini
2161fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
2162fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2163fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2164fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
2165fc9c1727SLuigi 'Comio' Mantellini
2166fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
2167fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
21686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
2169fc9c1727SLuigi 'Comio' Mantellini
21708ef70478SKees Cook		CONFIG_LZO
21718ef70478SKees Cook
21728ef70478SKees Cook		If this option is set, support for LZO compressed images
21738ef70478SKees Cook		is included.
21748ef70478SKees Cook
217517ea1177Swdenk- MII/PHY support:
217617ea1177Swdenk		CONFIG_PHY_ADDR
217717ea1177Swdenk
217817ea1177Swdenk		The address of PHY on MII bus.
217917ea1177Swdenk
218017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
218117ea1177Swdenk
218217ea1177Swdenk		The clock frequency of the MII bus
218317ea1177Swdenk
218417ea1177Swdenk		CONFIG_PHY_GIGE
218517ea1177Swdenk
218617ea1177Swdenk		If this option is set, support for speed/duplex
218711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
218817ea1177Swdenk
218917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
219017ea1177Swdenk
219117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
219217ea1177Swdenk		reset before any MII register access is possible.
219317ea1177Swdenk		For such PHY, set this option to the usec delay
219417ea1177Swdenk		required. (minimum 300usec for LXT971A)
219517ea1177Swdenk
219617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
219717ea1177Swdenk
219817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
219917ea1177Swdenk		command issued before MII status register can be read
220017ea1177Swdenk
2201c609719bSwdenk- Ethernet address:
2202c609719bSwdenk		CONFIG_ETHADDR
2203c68a05feSrichardretanubun		CONFIG_ETH1ADDR
2204c609719bSwdenk		CONFIG_ETH2ADDR
2205c609719bSwdenk		CONFIG_ETH3ADDR
2206c68a05feSrichardretanubun		CONFIG_ETH4ADDR
2207c68a05feSrichardretanubun		CONFIG_ETH5ADDR
2208c609719bSwdenk
220911ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
221011ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
2211c609719bSwdenk		is not determined automatically.
2212c609719bSwdenk
2213c609719bSwdenk- IP address:
2214c609719bSwdenk		CONFIG_IPADDR
2215c609719bSwdenk
2216c609719bSwdenk		Define a default value for the IP address to use for
221711ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
2218c609719bSwdenk		determined through e.g. bootp.
22191ebcd654SWolfgang Denk		(Environment variable "ipaddr")
2220c609719bSwdenk
2221c609719bSwdenk- Server IP address:
2222c609719bSwdenk		CONFIG_SERVERIP
2223c609719bSwdenk
2224c609719bSwdenk		Defines a default value for the IP address of a TFTP
2225c609719bSwdenk		server to contact when using the "tftboot" command.
22261ebcd654SWolfgang Denk		(Environment variable "serverip")
2227c609719bSwdenk
222897cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
222997cfe861SRobin Getz
223097cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
223197cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
223297cfe861SRobin Getz
22331ebcd654SWolfgang Denk- Gateway IP address:
22341ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
22351ebcd654SWolfgang Denk
22361ebcd654SWolfgang Denk		Defines a default value for the IP address of the
22371ebcd654SWolfgang Denk		default router where packets to other networks are
22381ebcd654SWolfgang Denk		sent to.
22391ebcd654SWolfgang Denk		(Environment variable "gatewayip")
22401ebcd654SWolfgang Denk
22411ebcd654SWolfgang Denk- Subnet mask:
22421ebcd654SWolfgang Denk		CONFIG_NETMASK
22431ebcd654SWolfgang Denk
22441ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
22451ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
22461ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
22471ebcd654SWolfgang Denk		forwarded through a router.
22481ebcd654SWolfgang Denk		(Environment variable "netmask")
22491ebcd654SWolfgang Denk
225053a5c424SDavid Updegraff- Multicast TFTP Mode:
225153a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
225253a5c424SDavid Updegraff
225353a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
225453a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
225511ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
225653a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
225753a5c424SDavid Updegraff		multicast group.
225853a5c424SDavid Updegraff
2259c609719bSwdenk- BOOTP Recovery Mode:
2260c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2261c609719bSwdenk
2262c609719bSwdenk		If you have many targets in a network that try to
2263c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2264c609719bSwdenk		systems send out BOOTP requests at precisely the same
2265c609719bSwdenk		moment (which would happen for instance at recovery
2266c609719bSwdenk		from a power failure, when all systems will try to
2267c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2268c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2269c609719bSwdenk		inserted before sending out BOOTP requests. The
22706c33c785SWolfgang Denk		following delays are inserted then:
2271c609719bSwdenk
2272c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2273c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2274c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2275c609719bSwdenk		4th and following
2276c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2277c609719bSwdenk
227892ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
227992ac8accSThierry Reding
228092ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
228192ac8accSThierry Reding		server will copy the ID from client requests to responses and
228292ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
228392ac8accSThierry Reding		an incoming response. Some servers will check that addresses
228492ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
228592ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
228692ac8accSThierry Reding		respond. Network congestion may also influence the time it
228792ac8accSThierry Reding		takes for a response to make it back to the client. If that
228892ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
228992ac8accSThierry Reding		to allow earlier responses to still be accepted after these
229092ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
229192ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
229292ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
229392ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
229492ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
229592ac8accSThierry Reding
2296fe389a82Sstroese- DHCP Advanced Options:
22971fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
22981fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2299fe389a82Sstroese
23001fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
23011fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
23021fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
23031fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
23041fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
23051fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
23061fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
23071fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
23081fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
23091fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
23101fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
23111fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
23122c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2313fe389a82Sstroese
23145d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
23155d110f0aSWilson Callan		environment variable, not the BOOTP server.
2316fe389a82Sstroese
23172c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
23182c00e099SJoe Hershberger		after the configured retry count, the call will fail
23192c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
23202c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
23212c00e099SJoe Hershberger		is not available.
23222c00e099SJoe Hershberger
2323fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2324fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2325fe389a82Sstroese		than one DNS serverip is offered to the client.
2326fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2327fe389a82Sstroese		serverip will be stored in the additional environment
2328fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2329fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
23301fe80d79SJon Loeliger		is defined.
2331fe389a82Sstroese
2332fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2333fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2334fe389a82Sstroese		need the hostname of the DHCP requester.
23355d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
23361fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
23371fe80d79SJon Loeliger		option 12 to the DHCP server.
2338fe389a82Sstroese
2339d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2340d9a2f416SAras Vaichas
2341d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2342d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2343d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2344d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2345d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2346d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2347d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2348d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2349d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2350d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2351d9a2f416SAras Vaichas		this delay.
2352d9a2f416SAras Vaichas
2353d22c338eSJoe Hershberger - Link-local IP address negotiation:
2354d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2355d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2356d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2357d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2358d22c338eSJoe Hershberger
2359d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2360d22c338eSJoe Hershberger
2361a3d991bdSwdenk - CDP Options:
2362a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2363a3d991bdSwdenk
2364a3d991bdSwdenk		The device id used in CDP trigger frames.
2365a3d991bdSwdenk
2366a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2367a3d991bdSwdenk
2368a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2369a3d991bdSwdenk		of the device.
2370a3d991bdSwdenk
2371a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2372a3d991bdSwdenk
2373a3d991bdSwdenk		A printf format string which contains the ascii name of
2374a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
237511ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2376a3d991bdSwdenk
2377a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2378a3d991bdSwdenk
2379a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2380a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2381a3d991bdSwdenk
2382a3d991bdSwdenk		CONFIG_CDP_VERSION
2383a3d991bdSwdenk
2384a3d991bdSwdenk		An ascii string containing the version of the software.
2385a3d991bdSwdenk
2386a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2387a3d991bdSwdenk
2388a3d991bdSwdenk		An ascii string containing the name of the platform.
2389a3d991bdSwdenk
2390a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2391a3d991bdSwdenk
2392a3d991bdSwdenk		A 32bit integer sent on the trigger.
2393a3d991bdSwdenk
2394a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2395a3d991bdSwdenk
2396a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2397a3d991bdSwdenk		device in .1 of milliwatts.
2398a3d991bdSwdenk
2399a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2400a3d991bdSwdenk
2401a3d991bdSwdenk		A byte containing the id of the VLAN.
2402a3d991bdSwdenk
2403c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2404c609719bSwdenk
2405c609719bSwdenk		Several configurations allow to display the current
2406c609719bSwdenk		status using a LED. For instance, the LED will blink
2407c609719bSwdenk		fast while running U-Boot code, stop blinking as
2408c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2409c609719bSwdenk		start blinking slow once the Linux kernel is running
2410c609719bSwdenk		(supported by a status LED driver in the Linux
2411c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2412c609719bSwdenk		feature in U-Boot.
2413c609719bSwdenk
24141df7bbbaSIgor Grinberg		Additional options:
24151df7bbbaSIgor Grinberg
24161df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
24171df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
24181df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
24191df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
24201df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
24211df7bbbaSIgor Grinberg
24229dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
24239dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
24249dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
24259dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
24269dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
24279dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
24289dfdcdfeSIgor Grinberg
2429c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2430c609719bSwdenk
2431c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2432c609719bSwdenk		on those systems that support this (optional)
2433c609719bSwdenk		feature, like the TQM8xxL modules.
2434c609719bSwdenk
24353f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2436c609719bSwdenk
24373f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
24383f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
24393f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
24403f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
24413f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
24423f4978c7SHeiko Schocher		interface.
24433f4978c7SHeiko Schocher
24443f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2445ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2446ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2447ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2448ea818dbbSHeiko Schocher		    for defining speed and slave address
2449ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2450ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2451ea818dbbSHeiko Schocher		    for defining speed and slave address
2452ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2453ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2454ea818dbbSHeiko Schocher		    for defining speed and slave address
2455ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2456ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2457ea818dbbSHeiko Schocher		    for defining speed and slave address
24583f4978c7SHeiko Schocher
245900f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
246000f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
246100f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
246200f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
246300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
246400f792e0SHeiko Schocher		    bus.
246500f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
246600f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
246700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
246800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
246900f792e0SHeiko Schocher		    second bus.
247000f792e0SHeiko Schocher
24711f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
24721f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
24731f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
24741f2ba722SSimon Glass		    100000 and the slave addr 0!
24751f2ba722SSimon Glass
2476880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2477880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2478880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2479880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2480880540deSDirk Eibach
2481fac96408Strem		- drivers/i2c/i2c_mxc.c
2482fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2483fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2484fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2485fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2486fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2487fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2488fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2489b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
2490fac96408Strem		for speed, and 0 for slave.
2491fac96408Strem
24921086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
24931086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
24941086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
24951086bfa9SNobuhiro Iwamatsu
24961086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
24971086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
24981086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
24991086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
25001086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
25011086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
25021086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
25031086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
25041086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
25051086bfa9SNobuhiro Iwamatsu
25062035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
25072035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
25082035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
25092035d77dSNobuhiro Iwamatsu
25102035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
25112035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
25122035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
25132035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
25142035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
25152035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
25162035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
25172035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
25182035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
25192035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
25202035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
25212035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2522b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
25232035d77dSNobuhiro Iwamatsu
25246789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
25256789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
25266789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
25276789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
25286789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
25296789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
25306789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
25316789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
25326789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
25336789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
25346789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
25356789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
25366789e84eSHeiko Schocher
25370bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
25380bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
25390bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
25400bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
25410bdffe71SHeiko Schocher
2542e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2543e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2544e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2545e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2546e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2547e717fc6dSNaveen Krishna Ch
2548b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2549b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2550b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2551b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2552b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2553b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2554b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2555b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2556b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2557b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2558b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2559b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2560b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2561b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2562b46226bdSDirk Eibach
25633f4978c7SHeiko Schocher		additional defines:
25643f4978c7SHeiko Schocher
25653f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2566b445bbb4SJeremiah Mahler		Hold the number of i2c buses you want to use. If you
25673f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
25683f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
25693f4978c7SHeiko Schocher		omit this define.
25703f4978c7SHeiko Schocher
25713f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
25723f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
25733f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
25743f4978c7SHeiko Schocher		omit this define.
25753f4978c7SHeiko Schocher
25763f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
25773f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
25783f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
25793f4978c7SHeiko Schocher		define.
25803f4978c7SHeiko Schocher
25813f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2582b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
25833f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
25843f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
25853f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
25863f4978c7SHeiko Schocher
25873f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
25883f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
25893f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
25903f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
25913f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
25923f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
25933f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
25943f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
25953f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
25963f4978c7SHeiko Schocher					}
25973f4978c7SHeiko Schocher
25983f4978c7SHeiko Schocher		which defines
25993f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2600ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2601ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2602ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2603ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2604ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
26053f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2606ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2607ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
26083f4978c7SHeiko Schocher
26093f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
26103f4978c7SHeiko Schocher
2611ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
26123f4978c7SHeiko Schocher
26133f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
26143f4978c7SHeiko Schocher		provides the following compelling advantages:
26153f4978c7SHeiko Schocher
26163f4978c7SHeiko Schocher		- more than one i2c adapter is usable
26173f4978c7SHeiko Schocher		- approved multibus support
26183f4978c7SHeiko Schocher		- better i2c mux support
26193f4978c7SHeiko Schocher
26203f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
26213f4978c7SHeiko Schocher
2622ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2623ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2624ea818dbbSHeiko Schocher		for the selected CPU.
2625c609719bSwdenk
2626b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2627602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2628b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2629b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2630c609719bSwdenk		command line interface.
2631c609719bSwdenk
2632bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2633c609719bSwdenk
2634b37c7e5eSwdenk		There are several other quantities that must also be
2635ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2636c609719bSwdenk
26376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2638b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
26396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
264011ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2641c609719bSwdenk
26428d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2643a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
26448d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
26458d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
26468d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2647b37c7e5eSwdenk
26485da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
26495da71efaSEric Millbrandt
26505da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
26515da71efaSEric Millbrandt		chips might think that the current transfer is still
26525da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
26535da71efaSEric Millbrandt		commands until the slave device responds.
26545da71efaSEric Millbrandt
2655b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2656b37c7e5eSwdenk
2657ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2658b37c7e5eSwdenk		then the following macros need to be defined (examples are
2659b37c7e5eSwdenk		from include/configs/lwmon.h):
2660c609719bSwdenk
2661c609719bSwdenk		I2C_INIT
2662c609719bSwdenk
2663b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2664c609719bSwdenk		controller or configure ports.
2665c609719bSwdenk
2666b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2667b37c7e5eSwdenk
2668c609719bSwdenk		I2C_PORT
2669c609719bSwdenk
2670c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2671c609719bSwdenk		assumes both bits are on the same port). Valid values
2672c609719bSwdenk		are 0..3 for ports A..D.
2673c609719bSwdenk
2674c609719bSwdenk		I2C_ACTIVE
2675c609719bSwdenk
2676c609719bSwdenk		The code necessary to make the I2C data line active
2677c609719bSwdenk		(driven).  If the data line is open collector, this
2678c609719bSwdenk		define can be null.
2679c609719bSwdenk
2680b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2681b37c7e5eSwdenk
2682c609719bSwdenk		I2C_TRISTATE
2683c609719bSwdenk
2684c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2685c609719bSwdenk		(inactive).  If the data line is open collector, this
2686c609719bSwdenk		define can be null.
2687c609719bSwdenk
2688b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2689b37c7e5eSwdenk
2690c609719bSwdenk		I2C_READ
2691c609719bSwdenk
2692472d5460SYork Sun		Code that returns true if the I2C data line is high,
2693472d5460SYork Sun		false if it is low.
2694c609719bSwdenk
2695b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2696b37c7e5eSwdenk
2697c609719bSwdenk		I2C_SDA(bit)
2698c609719bSwdenk
2699472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2700472d5460SYork Sun		is false, it clears it (low).
2701c609719bSwdenk
2702b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2703b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2704b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2705b37c7e5eSwdenk
2706c609719bSwdenk		I2C_SCL(bit)
2707c609719bSwdenk
2708472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2709472d5460SYork Sun		is false, it clears it (low).
2710c609719bSwdenk
2711b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2712b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2713b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2714b37c7e5eSwdenk
2715c609719bSwdenk		I2C_DELAY
2716c609719bSwdenk
2717c609719bSwdenk		This delay is invoked four times per clock cycle so this
2718c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2719b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2720b37c7e5eSwdenk		like:
2721b37c7e5eSwdenk
2722b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2723c609719bSwdenk
2724793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2725793b5726SMike Frysinger
2726793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2727793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2728793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2729793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2730793b5726SMike Frysinger
2731793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2732793b5726SMike Frysinger		the generic GPIO functions.
2733793b5726SMike Frysinger
27346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
273547cd00faSwdenk
273647cd00faSwdenk		When a board is reset during an i2c bus transfer
273747cd00faSwdenk		chips might think that the current transfer is still
273847cd00faSwdenk		in progress. On some boards it is possible to access
273947cd00faSwdenk		the i2c SCLK line directly, either by using the
274047cd00faSwdenk		processor pin as a GPIO or by having a second pin
274147cd00faSwdenk		connected to the bus. If this option is defined a
274247cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
274347cd00faSwdenk		is run early in the boot sequence.
274447cd00faSwdenk
274526a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
274626a33504SRichard Retanubun
274726a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
274826a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
274926a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
275026a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
275126a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
275226a33504SRichard Retanubun		controller provide such a method. It is called at the end of
275326a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
275426a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
275526a33504SRichard Retanubun
275617ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
275717ea1177Swdenk
275817ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
275917ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
276017ea1177Swdenk		variable "i2cfast". (see also i2cfast)
276117ea1177Swdenk
2762bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2763bb99ad6dSBen Warren
2764bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2765bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2766bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2767bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2768bb99ad6dSBen Warren
27696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2770bb99ad6dSBen Warren
2771bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
27720f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
27730f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
27740f89c54bSPeter Tyser		a 1D array of device addresses
2775bb99ad6dSBen Warren
2776bb99ad6dSBen Warren		e.g.
2777bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
27786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2779bb99ad6dSBen Warren
2780bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2781bb99ad6dSBen Warren
2782bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
27836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2784bb99ad6dSBen Warren
2785bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2786bb99ad6dSBen Warren
27876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2788be5e6181STimur Tabi
2789be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2790be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2791be5e6181STimur Tabi
27926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
27930dc018ecSStefan Roese
27940dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
27950dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
27960dc018ecSStefan Roese
27976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
27980dc018ecSStefan Roese
27990dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
28000dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
28010dc018ecSStefan Roese
28026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
28039ebbb54fSVictor Gallardo
28049ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
28059ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
28069ebbb54fSVictor Gallardo		specified DTT device.
28079ebbb54fSVictor Gallardo
28082ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
28092ac6985aSAndrew Dyer
28102ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
28112ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
28122ac6985aSAndrew Dyer		between writing the address pointer and reading the
28132ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
28142ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
28152ac6985aSAndrew Dyer		devices can use either method, but some require one or
28162ac6985aSAndrew Dyer		the other.
2817be5e6181STimur Tabi
2818c609719bSwdenk- SPI Support:	CONFIG_SPI
2819c609719bSwdenk
2820c609719bSwdenk		Enables SPI driver (so far only tested with
2821c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2822c609719bSwdenk		D/As on the SACSng board)
2823c609719bSwdenk
28246639562eSYoshihiro Shimoda		CONFIG_SH_SPI
28256639562eSYoshihiro Shimoda
28266639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
28276639562eSYoshihiro Shimoda		only SH7757 is supported.
28286639562eSYoshihiro Shimoda
2829c609719bSwdenk		CONFIG_SPI_X
2830c609719bSwdenk
2831c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2832c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2833c609719bSwdenk
2834c609719bSwdenk		CONFIG_SOFT_SPI
2835c609719bSwdenk
2836c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2837c609719bSwdenk		using hardware support. This is a general purpose
2838c609719bSwdenk		driver that only requires three general I/O port pins
2839c609719bSwdenk		(two outputs, one input) to function. If this is
2840c609719bSwdenk		defined, the board configuration must define several
2841c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2842c609719bSwdenk		an example, see include/configs/sacsng.h.
2843c609719bSwdenk
284404a9e118SBen Warren		CONFIG_HARD_SPI
284504a9e118SBen Warren
284604a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
284704a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
284804a9e118SBen Warren		must define a list of chip-select function pointers.
284904a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
285004a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
285104a9e118SBen Warren
285238254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
285338254f45SGuennadi Liakhovetski
285438254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
28552e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
285638254f45SGuennadi Liakhovetski
2857f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2858f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2859f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2860f659b573SHeiko Schocher
28610133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
28620133502eSMatthias Fuchs
28630133502eSMatthias Fuchs		Enables FPGA subsystem.
28640133502eSMatthias Fuchs
28650133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
28660133502eSMatthias Fuchs
28670133502eSMatthias Fuchs		Enables support for specific chip vendors.
28680133502eSMatthias Fuchs		(ALTERA, XILINX)
28690133502eSMatthias Fuchs
28700133502eSMatthias Fuchs		CONFIG_FPGA_<family>
28710133502eSMatthias Fuchs
28720133502eSMatthias Fuchs		Enables support for FPGA family.
28730133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
28740133502eSMatthias Fuchs
28750133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2876c609719bSwdenk
2877c609719bSwdenk		Specify the number of FPGA devices to support.
2878c609719bSwdenk
287964e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
288064e809afSSiva Durga Prasad Paladugu
288164e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
288264e809afSSiva Durga Prasad Paladugu
288367193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
288467193864SMichal Simek
288567193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
288667193864SMichal Simek
288767193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
288867193864SMichal Simek
288967193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
289067193864SMichal Simek		(Xilinx only)
289167193864SMichal Simek
28926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2893c609719bSwdenk
2894c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2895c609719bSwdenk
28966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2897c609719bSwdenk
2898c609719bSwdenk		Enable checks on FPGA configuration interface busy
2899c609719bSwdenk		status by the configuration function. This option
2900c609719bSwdenk		will require a board or device specific function to
2901c609719bSwdenk		be written.
2902c609719bSwdenk
2903c609719bSwdenk		CONFIG_FPGA_DELAY
2904c609719bSwdenk
2905c609719bSwdenk		If defined, a function that provides delays in the FPGA
2906c609719bSwdenk		configuration driver.
2907c609719bSwdenk
29086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2909c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2910c609719bSwdenk
29116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2912c609719bSwdenk
2913c609719bSwdenk		Check for configuration errors during FPGA bitfile
2914c609719bSwdenk		loading. For example, abort during Virtex II
2915c609719bSwdenk		configuration if the INIT_B line goes low (which
2916c609719bSwdenk		indicated a CRC error).
2917c609719bSwdenk
29186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2919c609719bSwdenk
2920b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2921b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2922c609719bSwdenk		FPGA configuration sequence. The default time is 500
292311ccc33fSMarcel Ziswiler		ms.
2924c609719bSwdenk
29256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2926c609719bSwdenk
2927b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
292811ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2929c609719bSwdenk
29306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2931c609719bSwdenk
2932c609719bSwdenk		Time to wait after FPGA configuration. The default is
293311ccc33fSMarcel Ziswiler		200 ms.
2934c609719bSwdenk
2935c609719bSwdenk- Configuration Management:
2936b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2937b2b8a696SStefan Roese
2938b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2939b2b8a696SStefan Roese		with a special header) as build targets. By defining
2940b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2941b2b8a696SStefan Roese		special image will be automatically built upon calling
2942b2b8a696SStefan Roese		make / MAKEALL.
2943b2b8a696SStefan Roese
2944c609719bSwdenk		CONFIG_IDENT_STRING
2945c609719bSwdenk
2946c609719bSwdenk		If defined, this string will be added to the U-Boot
2947c609719bSwdenk		version information (U_BOOT_VERSION)
2948c609719bSwdenk
2949c609719bSwdenk- Vendor Parameter Protection:
2950c609719bSwdenk
2951c609719bSwdenk		U-Boot considers the values of the environment
2952c609719bSwdenk		variables "serial#" (Board Serial Number) and
29537152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2954c609719bSwdenk		are set once by the board vendor / manufacturer, and
2955c609719bSwdenk		protects these variables from casual modification by
2956c609719bSwdenk		the user. Once set, these variables are read-only,
2957c609719bSwdenk		and write or delete attempts are rejected. You can
295811ccc33fSMarcel Ziswiler		change this behaviour:
2959c609719bSwdenk
2960c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2961c609719bSwdenk		file, the write protection for vendor parameters is
296247cd00faSwdenk		completely disabled. Anybody can change or delete
2963c609719bSwdenk		these parameters.
2964c609719bSwdenk
2965c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2966c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
296711ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2968c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2969c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2970c609719bSwdenk		read-only.]
2971c609719bSwdenk
29722598090bSJoe Hershberger		The same can be accomplished in a more flexible way
29732598090bSJoe Hershberger		for any variable by configuring the type of access
29742598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
29752598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
29762598090bSJoe Hershberger
2977c609719bSwdenk- Protected RAM:
2978c609719bSwdenk		CONFIG_PRAM
2979c609719bSwdenk
2980c609719bSwdenk		Define this variable to enable the reservation of
2981c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2982c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2983c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2984c609719bSwdenk		this default value by defining an environment
2985c609719bSwdenk		variable "pram" to the number of kB you want to
2986c609719bSwdenk		reserve. Note that the board info structure will
2987c609719bSwdenk		still show the full amount of RAM. If pRAM is
2988c609719bSwdenk		reserved, a new environment variable "mem" will
2989c609719bSwdenk		automatically be defined to hold the amount of
2990c609719bSwdenk		remaining RAM in a form that can be passed as boot
2991c609719bSwdenk		argument to Linux, for instance like that:
2992c609719bSwdenk
2993fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2994c609719bSwdenk			saveenv
2995c609719bSwdenk
2996c609719bSwdenk		This way you can tell Linux not to use this memory,
2997c609719bSwdenk		either, which results in a memory region that will
2998c609719bSwdenk		not be affected by reboots.
2999c609719bSwdenk
3000c609719bSwdenk		*WARNING* If your board configuration uses automatic
3001c609719bSwdenk		detection of the RAM size, you must make sure that
3002c609719bSwdenk		this memory test is non-destructive. So far, the
3003c609719bSwdenk		following board configurations are known to be
3004c609719bSwdenk		"pRAM-clean":
3005c609719bSwdenk
30061b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
30071b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
3008544d97e9SWolfgang Denk			FLAGADM, TQM8260
3009c609719bSwdenk
301040fef049SGabe Black- Access to physical memory region (> 4GB)
301140fef049SGabe Black		Some basic support is provided for operations on memory not
301240fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
301340fef049SGabe Black		support access to more than 4GB of memory on 32-bit
301440fef049SGabe Black		machines using physical address extension or similar.
301540fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
301640fef049SGabe Black		currently only supports clearing the memory.
301740fef049SGabe Black
3018c609719bSwdenk- Error Recovery:
3019c609719bSwdenk		CONFIG_PANIC_HANG
3020c609719bSwdenk
3021c609719bSwdenk		Define this variable to stop the system in case of a
3022c609719bSwdenk		fatal error, so that you have to reset it manually.
3023c609719bSwdenk		This is probably NOT a good idea for an embedded
302411ccc33fSMarcel Ziswiler		system where you want the system to reboot
3025c609719bSwdenk		automatically as fast as possible, but it may be
3026c609719bSwdenk		useful during development since you can try to debug
3027c609719bSwdenk		the conditions that lead to the situation.
3028c609719bSwdenk
3029c609719bSwdenk		CONFIG_NET_RETRY_COUNT
3030c609719bSwdenk
3031c609719bSwdenk		This variable defines the number of retries for
3032c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
3033c609719bSwdenk		before giving up the operation. If not defined, a
3034c609719bSwdenk		default value of 5 is used.
3035c609719bSwdenk
303640cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
303740cb90eeSGuennadi Liakhovetski
303840cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
303940cb90eeSGuennadi Liakhovetski
304048a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
304148a3e999STetsuyuki Kobayashi
304248a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
304348a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
304448a3e999STetsuyuki Kobayashi		try longer timeout such as
304548a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
304648a3e999STetsuyuki Kobayashi
3047c609719bSwdenk- Command Interpreter:
30488078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
304904a85b3bSwdenk
305004a85b3bSwdenk		Enable auto completion of commands using TAB.
305104a85b3bSwdenk
30526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
3053c609719bSwdenk
3054c609719bSwdenk		This defines the secondary prompt string, which is
3055c609719bSwdenk		printed when the command interpreter needs more input
3056c609719bSwdenk		to complete a command. Usually "> ".
3057c609719bSwdenk
3058c609719bSwdenk	Note:
3059c609719bSwdenk
3060c609719bSwdenk		In the current implementation, the local variables
3061c609719bSwdenk		space and global environment variables space are
3062c609719bSwdenk		separated. Local variables are those you define by
30633b57fe0aSwdenk		simply typing `name=value'. To access a local
3064c609719bSwdenk		variable later on, you have write `$name' or
30653b57fe0aSwdenk		`${name}'; to execute the contents of a variable
30663b57fe0aSwdenk		directly type `$name' at the command prompt.
3067c609719bSwdenk
3068c609719bSwdenk		Global environment variables are those you use
3069c609719bSwdenk		setenv/printenv to work with. To run a command stored
3070c609719bSwdenk		in such a variable, you need to use the run command,
3071c609719bSwdenk		and you must not use the '$' sign to access them.
3072c609719bSwdenk
3073c609719bSwdenk		To store commands and special characters in a
3074c609719bSwdenk		variable, please use double quotation marks
3075c609719bSwdenk		surrounding the whole text of the variable, instead
3076c609719bSwdenk		of the backslashes before semicolons and special
3077c609719bSwdenk		symbols.
3078c609719bSwdenk
3079b445bbb4SJeremiah Mahler- Command Line Editing and History:
3080aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
3081aa0c71acSWolfgang Denk
308211ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
3083aa0c71acSWolfgang Denk		command line input operations
3084aa0c71acSWolfgang Denk
3085a8c7c708Swdenk- Default Environment:
3086c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
3087c609719bSwdenk
3088c609719bSwdenk		Define this to contain any number of null terminated
3089c609719bSwdenk		strings (variable = value pairs) that will be part of
30907152b1d0Swdenk		the default environment compiled into the boot image.
30912262cfeeSwdenk
3092c609719bSwdenk		For example, place something like this in your
3093c609719bSwdenk		board's config file:
3094c609719bSwdenk
3095c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
3096c609719bSwdenk			"myvar1=value1\0" \
3097c609719bSwdenk			"myvar2=value2\0"
3098c609719bSwdenk
3099c609719bSwdenk		Warning: This method is based on knowledge about the
3100c609719bSwdenk		internal format how the environment is stored by the
31012262cfeeSwdenk		U-Boot code. This is NOT an official, exported
3102c609719bSwdenk		interface! Although it is unlikely that this format
31037152b1d0Swdenk		will change soon, there is no guarantee either.
3104c609719bSwdenk		You better know what you are doing here.
3105c609719bSwdenk
3106c609719bSwdenk		Note: overly (ab)use of the default environment is
3107c609719bSwdenk		discouraged. Make sure to check other ways to preset
310874de7aefSWolfgang Denk		the environment like the "source" command or the
3109c609719bSwdenk		boot command first.
3110c609719bSwdenk
31115e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
31125e724ca2SStephen Warren
31135e724ca2SStephen Warren		Define this in order to add variables describing the
31145e724ca2SStephen Warren		U-Boot build configuration to the default environment.
31155e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
31165e724ca2SStephen Warren
31175e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
31185e724ca2SStephen Warren
31195e724ca2SStephen Warren		- CONFIG_SYS_ARCH
31205e724ca2SStephen Warren		- CONFIG_SYS_CPU
31215e724ca2SStephen Warren		- CONFIG_SYS_BOARD
31225e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
31235e724ca2SStephen Warren		- CONFIG_SYS_SOC
31245e724ca2SStephen Warren
31257e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
31267e27f89fSTom Rini
31277e27f89fSTom Rini		Define this in order to add variables describing certain
31287e27f89fSTom Rini		run-time determined information about the hardware to the
31297e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
31307e27f89fSTom Rini
313106fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
313206fd8538SSimon Glass
313306fd8538SSimon Glass		Normally the environment is loaded when the board is
3134b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
313506fd8538SSimon Glass		that so that the environment is not available until
313606fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
313706fd8538SSimon Glass		this is instead controlled by the value of
313806fd8538SSimon Glass		/config/load-environment.
313906fd8538SSimon Glass
3140a8c7c708Swdenk- DataFlash Support:
31412abbe075Swdenk		CONFIG_HAS_DATAFLASH
31422abbe075Swdenk
31432abbe075Swdenk		Defining this option enables DataFlash features and
31442abbe075Swdenk		allows to read/write in Dataflash via the standard
31452abbe075Swdenk		commands cp, md...
31462abbe075Swdenk
3147f61ec45eSEric Nelson- Serial Flash support
3148f61ec45eSEric Nelson		CONFIG_CMD_SF
3149f61ec45eSEric Nelson
3150f61ec45eSEric Nelson		Defining this option enables SPI flash commands
3151f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
3152f61ec45eSEric Nelson
3153f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
3154f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
3155f61ec45eSEric Nelson		commands.
3156f61ec45eSEric Nelson
3157f61ec45eSEric Nelson		The following defaults may be provided by the platform
3158f61ec45eSEric Nelson		to handle the common case when only a single serial
3159f61ec45eSEric Nelson		flash is present on the system.
3160f61ec45eSEric Nelson
3161f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
3162f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
3163f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
3164f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
3165f61ec45eSEric Nelson
316624007273SSimon Glass		CONFIG_CMD_SF_TEST
316724007273SSimon Glass
316824007273SSimon Glass		Define this option to include a destructive SPI flash
316924007273SSimon Glass		test ('sf test').
317024007273SSimon Glass
31711dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
31721dcd6d03SJagannadha Sutradharudu Teki
31731dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
31741dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
31751dcd6d03SJagannadha Sutradharudu Teki
3176b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
3177b902e07cSJagannadha Sutradharudu Teki
3178b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
3179b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
3180b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
3181b902e07cSJagannadha Sutradharudu Teki
3182562f8df1SHeiko Schocher		CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3183562f8df1SHeiko Schocher		enable the W#/Vpp signal to disable writing to the status
3184562f8df1SHeiko Schocher		register on ST MICRON flashes like the N25Q128.
3185562f8df1SHeiko Schocher		The status register write enable/disable bit, combined with
3186562f8df1SHeiko Schocher		the W#/VPP signal provides hardware data protection for the
3187562f8df1SHeiko Schocher		device as follows: When the enable/disable bit is set to 1,
3188562f8df1SHeiko Schocher		and the W#/VPP signal is driven LOW, the status register
3189562f8df1SHeiko Schocher		nonvolatile bits become read-only and the WRITE STATUS REGISTER
3190562f8df1SHeiko Schocher		operation will not execute. The only way to exit this
3191562f8df1SHeiko Schocher		hardware-protected mode is to drive W#/VPP HIGH.
3192562f8df1SHeiko Schocher
31933f85ce27Swdenk- SystemACE Support:
31943f85ce27Swdenk		CONFIG_SYSTEMACE
31953f85ce27Swdenk
31963f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
31973f85ce27Swdenk		chips attached via some sort of local bus. The address
319811ccc33fSMarcel Ziswiler		of the chip must also be defined in the
31996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
32003f85ce27Swdenk
32013f85ce27Swdenk		#define CONFIG_SYSTEMACE
32026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
32033f85ce27Swdenk
32043f85ce27Swdenk		When SystemACE support is added, the "ace" device type
32053f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
32063f85ce27Swdenk
3207ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
3208ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
3209ecb0ccd9SWolfgang Denk
321028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
3211ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
321228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
3213ecb0ccd9SWolfgang Denk		number generator is used.
3214ecb0ccd9SWolfgang Denk
321528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
321628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
321728cb9375SWolfgang Denk		defined, the normal port 69 is used.
321828cb9375SWolfgang Denk
321928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
3220ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
3221ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
3222ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
3223ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
3224ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
3225ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
3226ecb0ccd9SWolfgang Denk
3227bf36c5d5SSimon Glass- Hashing support:
3228bf36c5d5SSimon Glass		CONFIG_CMD_HASH
3229bf36c5d5SSimon Glass
3230bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
3231bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3232bf36c5d5SSimon Glass
3233bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3234bf36c5d5SSimon Glass
3235bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3236bf36c5d5SSimon Glass		size a little.
3237bf36c5d5SSimon Glass
323894e3c8c4Sgaurav rana		CONFIG_SHA1 - This option enables support of hashing using SHA1
323994e3c8c4Sgaurav rana		algorithm. The hash is calculated in software.
324094e3c8c4Sgaurav rana		CONFIG_SHA256 - This option enables support of hashing using
324194e3c8c4Sgaurav rana		SHA256 algorithm. The hash is calculated in software.
324294e3c8c4Sgaurav rana		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
324394e3c8c4Sgaurav rana		for SHA1/SHA256 hashing.
324494e3c8c4Sgaurav rana		This affects the 'hash' command and also the
324594e3c8c4Sgaurav rana		hash_lookup_algo() function.
324694e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL - This option enables
324794e3c8c4Sgaurav rana		hardware-acceleration for SHA1/SHA256 progressive hashing.
324894e3c8c4Sgaurav rana		Data can be streamed in a block at a time and the hashing
324994e3c8c4Sgaurav rana		is performed in hardware.
3250bf36c5d5SSimon Glass
3251bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3252bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3253bf36c5d5SSimon Glass
3254a11f1873SRobert Winkler- Freescale i.MX specific commands:
3255a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3256a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3257a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3258a11f1873SRobert Winkler
3259a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3260a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3261a11f1873SRobert Winkler		a boot from specific media.
3262a11f1873SRobert Winkler
3263a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3264a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3265a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3266a11f1873SRobert Winkler		will set it back to normal.  This command currently
3267a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3268a11f1873SRobert Winkler
326919c402afSSimon Glass- Signing support:
327019c402afSSimon Glass		CONFIG_RSA
327119c402afSSimon Glass
327219c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
32738bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
327419c402afSSimon Glass
3275c937ff6dSRuchika Gupta		The Modular Exponentiation algorithm in RSA is implemented using
3276c937ff6dSRuchika Gupta		driver model. So CONFIG_DM needs to be enabled by default for this
3277c937ff6dSRuchika Gupta		library to function.
3278c937ff6dSRuchika Gupta
327919c402afSSimon Glass		The signing part is build into mkimage regardless of this
3280c937ff6dSRuchika Gupta		option. The software based modular exponentiation is built into
3281c937ff6dSRuchika Gupta		mkimage irrespective of this option.
328219c402afSSimon Glass
32839e50c406SHeiko Schocher- bootcount support:
32849e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
32859e50c406SHeiko Schocher
32869e50c406SHeiko Schocher		This enables the bootcounter support, see:
32879e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
32889e50c406SHeiko Schocher
32899e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
32909e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
32919e50c406SHeiko Schocher		CONFIG_BLACKFIN
32929e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
32939e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
32949e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
32959e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
32969e50c406SHeiko Schocher		enable support for the bootcounter in RAM
32979e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
32989e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
32999e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
33009e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
33019e50c406SHeiko Schocher						    the bootcounter.
33029e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
330319c402afSSimon Glass
3304a8c7c708Swdenk- Show boot progress:
3305c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3306c609719bSwdenk
3307c609719bSwdenk		Defining this option allows to add some board-
3308c609719bSwdenk		specific code (calling a user-provided function
3309c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3310c609719bSwdenk		the system's boot progress on some display (for
3311c609719bSwdenk		example, some LED's) on your board. At the moment,
3312c609719bSwdenk		the following checkpoints are implemented:
3313c609719bSwdenk
33143a608ca0SSimon Glass- Detailed boot stage timing
33153a608ca0SSimon Glass		CONFIG_BOOTSTAGE
33163a608ca0SSimon Glass		Define this option to get detailed timing of each stage
33173a608ca0SSimon Glass		of the boot process.
33183a608ca0SSimon Glass
33193a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
33203a608ca0SSimon Glass		This is the number of available user bootstage records.
33213a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
33223a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
33233a608ca0SSimon Glass		the limit, recording will stop.
33243a608ca0SSimon Glass
33253a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
33263a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
33273a608ca0SSimon Glass
33283a608ca0SSimon Glass		Timer summary in microseconds:
33293a608ca0SSimon Glass		       Mark    Elapsed  Stage
33303a608ca0SSimon Glass			  0          0  reset
33313a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
33323a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
33333a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
33343a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
33353a608ca0SSimon Glass		  3,910,375    250,777  main_loop
33363a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
33373a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
33383a608ca0SSimon Glass
33392eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
33402eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
33412eba38cfSSimon Glass		and un/stashing of bootstage data.
33422eba38cfSSimon Glass
334394fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
334494fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
334594fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
334694fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
334794fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
334894fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
334994fd1316SSimon Glass		For example:
335094fd1316SSimon Glass
335194fd1316SSimon Glass		bootstage {
335294fd1316SSimon Glass			154 {
335394fd1316SSimon Glass				name = "board_init_f";
335494fd1316SSimon Glass				mark = <3575678>;
335594fd1316SSimon Glass			};
335694fd1316SSimon Glass			170 {
335794fd1316SSimon Glass				name = "lcd";
335894fd1316SSimon Glass				accum = <33482>;
335994fd1316SSimon Glass			};
336094fd1316SSimon Glass		};
336194fd1316SSimon Glass
336294fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
336394fd1316SSimon Glass
33641372cce2SMarian BalakowiczLegacy uImage format:
33651372cce2SMarian Balakowicz
3366c609719bSwdenk  Arg	Where			When
3367c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3368c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3369c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3370c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3371c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3372c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3373c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3374c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3375c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
33761372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3377c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3378c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3379c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3380c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
33811372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3382c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
33831372cce2SMarian Balakowicz
33841372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
33851372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
33861372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
33871372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
33881372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
33891372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
33901372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
339111ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
33921372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
33931372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
33941372cce2SMarian Balakowicz
3395ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3396c609719bSwdenk
3397a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
339863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
339963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
340063e73c9aSwdenk
3401566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3402566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3403566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3404566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3405566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3406566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3407566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3408566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3409566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3410566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3411566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3412566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3413566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3414566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3415566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3416566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3417566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3418566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3419566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3420566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3421566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3422566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3423566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3424566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3425566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3426566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3427566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3428566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3429566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3430566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3431566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3432566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3433566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3434566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3435566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3436566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3437566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3438566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3439566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3440566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3441566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3442566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3443566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3444566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3445566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3446566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3447566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3448c609719bSwdenk
3449566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3450c609719bSwdenk
3451566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3452566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3453566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3454206c60cbSwdenk
3455566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3456566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
345711ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3458566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3459566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3460566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
346174de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
346274de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3463566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3464c609719bSwdenk
34651372cce2SMarian BalakowiczFIT uImage format:
34661372cce2SMarian Balakowicz
34671372cce2SMarian Balakowicz  Arg	Where			When
34681372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
34691372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
34701372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
34711372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
34721372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
34731372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3474f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
34751372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
34761372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
34771372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
34781372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
34791372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
348011ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
348111ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
34821372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
34831372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
34841372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
34851372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
34861372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
34871372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
34881372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
34891372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
34901372cce2SMarian Balakowicz
34911372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
34921372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
34931372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
349411ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
34951372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
34961372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
34971372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
34981372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
34991372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
35001372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
35011372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
35021372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
35031372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
35041372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
35051372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
35061372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
35071372cce2SMarian Balakowicz
350811ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
35091372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
35101372cce2SMarian Balakowicz
351111ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
35121372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
35131372cce2SMarian Balakowicz
351411ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
35151372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
35161372cce2SMarian Balakowicz
351721d29f7fSHeiko Schocher- legacy image format:
351821d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
351921d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
352021d29f7fSHeiko Schocher
352121d29f7fSHeiko Schocher		Default:
352221d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
352321d29f7fSHeiko Schocher
352421d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
352521d29f7fSHeiko Schocher		disable the legacy image format
352621d29f7fSHeiko Schocher
352721d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
352821d29f7fSHeiko Schocher		enabled per default for backward compatibility.
352921d29f7fSHeiko Schocher
3530d95f6ec7SGabe Black- FIT image support:
3531d95f6ec7SGabe Black		CONFIG_FIT
3532d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3533d95f6ec7SGabe Black
3534d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3535d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3536d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3537d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3538d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3539d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3540d95f6ec7SGabe Black
35413e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
35423e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
354394e3c8c4Sgaurav rana		using a hash signed and verified using RSA. If
354494e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
354594e3c8c4Sgaurav rana		hashing is available using hardware, RSA library will use it.
354694e3c8c4Sgaurav rana		See doc/uImage.FIT/signature.txt for more details.
35473e569a6bSSimon Glass
354821d29f7fSHeiko Schocher		WARNING: When relying on signed FIT images with required
354921d29f7fSHeiko Schocher		signature check the legacy image format is default
355021d29f7fSHeiko Schocher		disabled. If a board need legacy image format support
355121d29f7fSHeiko Schocher		enable this through CONFIG_IMAGE_FORMAT_LEGACY
355221d29f7fSHeiko Schocher
35539a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
35549a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
35559a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
35569a4f479bSDirk Eibach		with this option.
35579a4f479bSDirk Eibach
35584cf2609bSWolfgang Denk- Standalone program support:
35594cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
35604cf2609bSWolfgang Denk
35616feff899SWolfgang Denk		This option defines a board specific value for the
35626feff899SWolfgang Denk		address where standalone program gets loaded, thus
35636feff899SWolfgang Denk		overwriting the architecture dependent default
35644cf2609bSWolfgang Denk		settings.
35654cf2609bSWolfgang Denk
35664cf2609bSWolfgang Denk- Frame Buffer Address:
35674cf2609bSWolfgang Denk		CONFIG_FB_ADDR
35684cf2609bSWolfgang Denk
35694cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
357044a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
357144a53b57SWolfgang Denk		when using a graphics controller has separate video
357244a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
357344a53b57SWolfgang Denk		the given address instead of dynamically reserving it
357444a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
357544a53b57SWolfgang Denk		the memory for the frame buffer depending on the
357644a53b57SWolfgang Denk		configured panel size.
35774cf2609bSWolfgang Denk
35784cf2609bSWolfgang Denk		Please see board_init_f function.
35794cf2609bSWolfgang Denk
3580cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3581cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3582cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3583cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3584cccfc2abSDetlev Zundel
3585cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3586cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3587cccfc2abSDetlev Zundel
3588cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3589cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3590cccfc2abSDetlev Zundel
3591cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3592cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3593cccfc2abSDetlev Zundel
3594cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3595cccfc2abSDetlev Zundel
3596cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3597cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3598cccfc2abSDetlev Zundel
3599ff94bc40SHeiko Schocher		CONFIG_MTD_NAND_VERIFY_WRITE
3600ff94bc40SHeiko Schocher		verify if the written data is correct reread.
3601ff94bc40SHeiko Schocher
360270c219cdSJoe Hershberger- UBI support
360370c219cdSJoe Hershberger		CONFIG_CMD_UBI
360470c219cdSJoe Hershberger
360570c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
360670c219cdSJoe Hershberger		with the UBI flash translation layer
360770c219cdSJoe Hershberger
360870c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
360970c219cdSJoe Hershberger
3610147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3611147162daSJoe Hershberger
3612147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3613147162daSJoe Hershberger		warnings and errors enabled.
3614147162daSJoe Hershberger
3615ff94bc40SHeiko Schocher
3616ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3617ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3618ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3619ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3620ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3621ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3622ff94bc40SHeiko Schocher
3623ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3624ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3625ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3626ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3627ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3628ff94bc40SHeiko Schocher
3629ff94bc40SHeiko Schocher		default: 4096
3630ff94bc40SHeiko Schocher
3631ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3632ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3633ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3634ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3635ff94bc40SHeiko Schocher		flash), this value is ignored.
3636ff94bc40SHeiko Schocher
3637ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3638ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3639ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3640ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3641ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3642ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3643ff94bc40SHeiko Schocher
3644ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3645ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3646ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3647ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3648ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3649ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3650ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3651ff94bc40SHeiko Schocher		partition.
3652ff94bc40SHeiko Schocher
3653ff94bc40SHeiko Schocher		default: 20
3654ff94bc40SHeiko Schocher
3655ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3656ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3657ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3658ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3659ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3660ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3661ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3662ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3663ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3664ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3665ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3666ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3667ff94bc40SHeiko Schocher
3668ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3669ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3670ff94bc40SHeiko Schocher		without a fastmap.
3671ff94bc40SHeiko Schocher		default: 0
3672ff94bc40SHeiko Schocher
367370c219cdSJoe Hershberger- UBIFS support
367470c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
367570c219cdSJoe Hershberger
367670c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
367770c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
367870c219cdSJoe Hershberger
367970c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
368070c219cdSJoe Hershberger
3681147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3682147162daSJoe Hershberger
3683147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3684147162daSJoe Hershberger		warnings and errors enabled.
3685147162daSJoe Hershberger
36866a11cf48SDaniel Schwierzeck- SPL framework
36876a11cf48SDaniel Schwierzeck		CONFIG_SPL
36886a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
36896a11cf48SDaniel Schwierzeck
369095579793STom Rini		CONFIG_SPL_LDSCRIPT
369195579793STom Rini		LDSCRIPT for linking the SPL binary.
369295579793STom Rini
36936ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
36946ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
36956ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
36966ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
36978960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
36986ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
36996ebc3461SAlbert ARIBAUD
370095579793STom Rini		CONFIG_SPL_MAX_SIZE
37016ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
37026ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
37036ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
37046ebc3461SAlbert ARIBAUD		not exceed it.
370595579793STom Rini
37066a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
37076a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
37086a11cf48SDaniel Schwierzeck
370994a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
371094a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
371194a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
371294a45bb1SScott Wood
371395579793STom Rini		CONFIG_SPL_BSS_START_ADDR
371495579793STom Rini		Link address for the BSS within the SPL binary.
371595579793STom Rini
371695579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
37176ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
37186ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
37196ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
37208960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
37216ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
372295579793STom Rini
372395579793STom Rini		CONFIG_SPL_STACK
372495579793STom Rini		Adress of the start of the stack SPL will use
372595579793STom Rini
372694a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
372794a45bb1SScott Wood		Adress of the start of the stack SPL will use after
372894a45bb1SScott Wood		relocation.  If unspecified, this is equal to
372994a45bb1SScott Wood		CONFIG_SPL_STACK.
373094a45bb1SScott Wood
373195579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
373295579793STom Rini		Starting address of the malloc pool used in SPL.
373395579793STom Rini
373495579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
373595579793STom Rini		The size of the malloc pool used in SPL.
37366a11cf48SDaniel Schwierzeck
373747f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
373847f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
373947f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
374047f7bcaeSTom Rini		NAND loading of the Linux Kernel.
374147f7bcaeSTom Rini
37429607faf2STom Rini		CONFIG_SPL_OS_BOOT
37439607faf2STom Rini		Enable booting directly to an OS from SPL.
37449607faf2STom Rini		See also: doc/README.falcon
37459607faf2STom Rini
3746861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3747861a86f4STom Rini		For ARM, enable an optional function to print more information
3748861a86f4STom Rini		about the running system.
3749861a86f4STom Rini
37504b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
37514b919725SScott Wood		Arch init code should be built for a very small image
37524b919725SScott Wood
37536a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
37546a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
37556a11cf48SDaniel Schwierzeck
37566a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
37576a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
37586a11cf48SDaniel Schwierzeck
37596a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
37606a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
37616a11cf48SDaniel Schwierzeck
37626a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
37636a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
37646a11cf48SDaniel Schwierzeck
37656a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
37666a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
37676a11cf48SDaniel Schwierzeck
376895579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
376995579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3770e2ccdf89SPaul Kocialkowski		Address and partition on the MMC to load U-Boot from
377195579793STom Rini		when the MMC is being used in raw mode.
377295579793STom Rini
3773b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3774b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3775b97300b6SPaul Kocialkowski		used in raw mode
3776b97300b6SPaul Kocialkowski
37772b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
37782b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
37792b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
37802b75b0adSPeter Korsgaard
37812b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
37822b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
37832b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
37842b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
37852b75b0adSPeter Korsgaard		(for falcon mode)
37862b75b0adSPeter Korsgaard
3787e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3788e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3789e2ccdf89SPaul Kocialkowski		used in fs mode
3790e2ccdf89SPaul Kocialkowski
379195579793STom Rini		CONFIG_SPL_FAT_SUPPORT
379295579793STom Rini		Support for fs/fat/libfat.o in SPL binary
379395579793STom Rini
3794fae81c72SGuillaume GARDET		CONFIG_SPL_EXT_SUPPORT
3795fae81c72SGuillaume GARDET		Support for EXT filesystem in SPL binary
379695579793STom Rini
3797fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3798fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3799fae81c72SGuillaume GARDET
3800fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
38017ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3802fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
38037ad2cc79SPeter Korsgaard
3804fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
38057ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3806fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
38077ad2cc79SPeter Korsgaard
380806f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
380906f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
381006f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
381106f60ae3SScott Wood		continuing (the hardware starts execution after just
381206f60ae3SScott Wood		loading the first page rather than the full 4K).
381306f60ae3SScott Wood
3814651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3815651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3816651fcf60SPrabhakar Kushwaha
38176f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
38186f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
38196f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
38206f2f01b9SScott Wood
38216f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
38226f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
38236f2f01b9SScott Wood
38246f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
38256f2f01b9SScott Wood		Include standard software ECC in the SPL
38266f2f01b9SScott Wood
382795579793STom Rini		CONFIG_SPL_NAND_SIMPLE
38287d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
38297d4b7955SScott Wood		expose the cmd_ctrl() interface.
383095579793STom Rini
38316dd3b566STom Rini		CONFIG_SPL_MTD_SUPPORT
38326dd3b566STom Rini		Support for the MTD subsystem within SPL.  Useful for
38336dd3b566STom Rini		environment on NAND support within SPL.
38346dd3b566STom Rini
38350c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
38360c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
38370c3117b1SHeiko Schocher		if you need to save space.
38380c3117b1SHeiko Schocher
3839bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3840bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
38415614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3842bb0dc108SYing Zhang
38437c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
38447c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
38457c8eea59SYing Zhang		SPL binary.
38467c8eea59SYing Zhang
384795579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
384895579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
384995579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
385095579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
385195579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
385295579793STom Rini		Defines the size and behavior of the NAND that SPL uses
38537d4b7955SScott Wood		to read U-Boot
385495579793STom Rini
3855fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3856fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3857fbe76ae4SPrabhakar Kushwaha
385895579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
38597d4b7955SScott Wood		Location in NAND to read U-Boot from
38607d4b7955SScott Wood
38617d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
38627d4b7955SScott Wood		Location in memory to load U-Boot to
38637d4b7955SScott Wood
38647d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
38657d4b7955SScott Wood		Size of image to load
386695579793STom Rini
386795579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
38687d4b7955SScott Wood		Entry point in loaded image to jump to
386995579793STom Rini
387095579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
387195579793STom Rini		Define this if you need to first read the OOB and then the
3872b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
387395579793STom Rini
387495579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
387595579793STom Rini		Support for an OMAP3-specific set of functions to return the
387695579793STom Rini		ID and MFR of the first attached NAND chip, if present.
387795579793STom Rini
38786a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
38796a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
38806a11cf48SDaniel Schwierzeck
38816a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
38826a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
38836a11cf48SDaniel Schwierzeck
38846a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
38856a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
38866a11cf48SDaniel Schwierzeck
3887c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3888c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3889c57b953dSPavel Machek
38906a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
38916a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
38921372cce2SMarian Balakowicz
3893ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3894ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3895ba1bee43SYing Zhang
3896ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3897ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3898ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3899ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3900ba1bee43SYing Zhang
390174752baaSScott Wood		CONFIG_SPL_PAD_TO
39026113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
39036113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
39046113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
39056113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
39066113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
390774752baaSScott Wood
3908ca2fca22SScott Wood		CONFIG_SPL_TARGET
3909ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3910ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3911ca2fca22SScott Wood		example if more than one image needs to be produced.
3912ca2fca22SScott Wood
391387ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
391487ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
391587ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
391687ebee39SSimon Glass		option to re-enable it. This will affect the output of the
391787ebee39SSimon Glass		bootm command when booting a FIT image.
391887ebee39SSimon Glass
39193aa29de0SYing Zhang- TPL framework
39203aa29de0SYing Zhang		CONFIG_TPL
39213aa29de0SYing Zhang		Enable building of TPL globally.
39223aa29de0SYing Zhang
39233aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
39243aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
39253aa29de0SYing Zhang		the TPL payload. By default, this is defined as
39263aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
39273aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
39283aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
39293aa29de0SYing Zhang
3930c609719bSwdenkModem Support:
3931c609719bSwdenk--------------
3932c609719bSwdenk
3933566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3934c609719bSwdenk
393511ccc33fSMarcel Ziswiler- Modem support enable:
3936c609719bSwdenk		CONFIG_MODEM_SUPPORT
3937c609719bSwdenk
3938c609719bSwdenk- RTS/CTS Flow control enable:
3939c609719bSwdenk		CONFIG_HWFLOW
3940c609719bSwdenk
3941c609719bSwdenk- Modem debug support:
3942c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3943c609719bSwdenk
3944c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3945c609719bSwdenk		for modem support. Useful only with BDI2000.
3946c609719bSwdenk
3947a8c7c708Swdenk- Interrupt support (PPC):
3948a8c7c708Swdenk
3949a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3950a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
395111ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3952a8c7c708Swdenk		should set decrementer_count to appropriate value. If
395311ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3954a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
395511ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3956a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3957a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3958a8c7c708Swdenk		general timer_interrupt().
3959a8c7c708Swdenk
3960c609719bSwdenk- General:
3961c609719bSwdenk
3962c609719bSwdenk		In the target system modem support is enabled when a
3963c609719bSwdenk		specific key (key combination) is pressed during
3964c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
396511ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3966c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3967c609719bSwdenk		function, returning 1 and thus enabling modem
3968c609719bSwdenk		initialization.
3969c609719bSwdenk
3970c609719bSwdenk		If there are no modem init strings in the
3971c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3972c609719bSwdenk		previous output (banner, info printfs) will be
397311ccc33fSMarcel Ziswiler		suppressed, though.
3974c609719bSwdenk
3975c609719bSwdenk		See also: doc/README.Modem
3976c609719bSwdenk
39779660e442SHelmut RaigerBoard initialization settings:
39789660e442SHelmut Raiger------------------------------
39799660e442SHelmut Raiger
39809660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
39819660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
39829660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
39839660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
39849660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
39859660e442SHelmut Raigertypically in board_init_f() and board_init_r().
39869660e442SHelmut Raiger
39879660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
39889660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
39899660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
39909660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3991c609719bSwdenk
3992c609719bSwdenkConfiguration Settings:
3993c609719bSwdenk-----------------------
3994c609719bSwdenk
39954d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
39964d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
39974d1fd7f1SYork Sun
39986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3999c609719bSwdenk		undefine this when you're short of memory.
4000c609719bSwdenk
40012fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
40022fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
40032fb2604dSPeter Tyser
40046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
4005c609719bSwdenk		prompt for user input.
4006c609719bSwdenk
40076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
4008c609719bSwdenk
40096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
4010c609719bSwdenk
40116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
4012c609719bSwdenk
40136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
4014c609719bSwdenk		the application (usually a Linux kernel) when it is
4015c609719bSwdenk		booted
4016c609719bSwdenk
40176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
4018c609719bSwdenk		List of legal baudrate settings for this board.
4019c609719bSwdenk
40206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
4021c609719bSwdenk		Suppress display of console information at boot.
4022c609719bSwdenk
40236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
4024c609719bSwdenk		If the board specific function
4025c609719bSwdenk			extern int overwrite_console (void);
4026c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
4027c609719bSwdenk		serial port, else the settings in the environment are used.
4028c609719bSwdenk
40296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
4030c609719bSwdenk		Enable the call to overwrite_console().
4031c609719bSwdenk
40326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
4033c609719bSwdenk		Enable overwrite of previous console environment settings.
4034c609719bSwdenk
40356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
4036c609719bSwdenk		Begin and End addresses of the area used by the
4037c609719bSwdenk		simple memory test.
4038c609719bSwdenk
40396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
4040c609719bSwdenk		Enable an alternate, more extensive memory test.
4041c609719bSwdenk
40426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
40435f535fe1Swdenk		Scratch address used by the alternate memory test
40445f535fe1Swdenk		You only need to set this if address zero isn't writeable
40455f535fe1Swdenk
40466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
40476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
404814f73ca6SStefan Roese		this specified memory area will get subtracted from the top
404911ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
405014f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
405114f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
405214f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
40535e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
405414f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
40555e12e75dSStefan Roese		will have to get fixed in Linux additionally.
405614f73ca6SStefan Roese
405714f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
405814f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
405914f73ca6SStefan Roese		be touched.
406014f73ca6SStefan Roese
406114f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
406214f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
406314f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
406414f73ca6SStefan Roese		non page size aligned address and this could cause major
406514f73ca6SStefan Roese		problems.
406614f73ca6SStefan Roese
40676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
4068c609719bSwdenk		Enable temporary baudrate change while serial download
4069c609719bSwdenk
40706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
4071c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
4072c609719bSwdenk
40736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
4074c609719bSwdenk		Physical start address of Motherboard I/O (if using a
4075c609719bSwdenk		Cogent motherboard)
4076c609719bSwdenk
40776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
4078c609719bSwdenk		Physical start address of Flash memory.
4079c609719bSwdenk
40806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
4081c609719bSwdenk		Physical start address of boot monitor code (set by
4082c609719bSwdenk		make config files to be same as the text base address
408314d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
40846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
4085c609719bSwdenk
40866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
40873b57fe0aSwdenk		Size of memory reserved for monitor code, used to
40883b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
40893b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
40903b57fe0aSwdenk		flash sector.
4091c609719bSwdenk
40926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
4093c609719bSwdenk		Size of DRAM reserved for malloc() use.
4094c609719bSwdenk
4095d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
4096d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
4097d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
4098d59476b6SSimon Glass		will become available before relocation. The address is just
4099d59476b6SSimon Glass		below the global data, and the stack is moved down to make
4100d59476b6SSimon Glass		space.
4101d59476b6SSimon Glass
4102d59476b6SSimon Glass		This feature allocates regions with increasing addresses
4103d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
4104d59476b6SSimon Glass		is not available. free() is supported but does nothing.
4105b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
4106d59476b6SSimon Glass		U-Boot relocates itself.
4107d59476b6SSimon Glass
4108e7b14e9aSSimon Glass		Pre-relocation malloc() is only supported on ARM and sandbox
410929afe9e6SSimon Glass		at present but is fairly easy to enable for other archs.
411029afe9e6SSimon Glass
411138687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
411238687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
411338687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
411438687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
411538687ae6SSimon Glass
41161dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
41171dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
41181dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
41191dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
41201dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
41211dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
41221dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
41231dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
41241dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
41251dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
41261dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
41271dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
41281dfdd9baSThierry Reding		written to another region in the same cache-line. This can
41291dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
41301dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
41311dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
41321dfdd9baSThierry Reding
41331dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
41341dfdd9baSThierry Reding
41356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
413615940c9aSStefan Roese		Normally compressed uImages are limited to an
413715940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
41386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
413915940c9aSStefan Roese		to adjust this setting to your needs.
4140c609719bSwdenk
41416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
4142c609719bSwdenk		Maximum size of memory mapped by the startup code of
4143c609719bSwdenk		the Linux kernel; all data that must be processed by
41447d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
41457d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
41461bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
41477d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
4148c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
4149c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
4150c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
4151c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
4152c609719bSwdenk
4153fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4154fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
4155fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
4156fca43cc8SJohn Rigby		is enabled.
4157fca43cc8SJohn Rigby
4158fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
4159fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
4160fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
4161fca43cc8SJohn Rigby
4162fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
4163fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
4164fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4165fca43cc8SJohn Rigby
41666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
4167c609719bSwdenk		Max number of Flash memory banks
4168c609719bSwdenk
41696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
4170c609719bSwdenk		Max number of sectors on a Flash chip
4171c609719bSwdenk
41726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
4173c609719bSwdenk		Timeout for Flash erase operations (in ms)
4174c609719bSwdenk
41756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
4176c609719bSwdenk		Timeout for Flash write operations (in ms)
4177c609719bSwdenk
41786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
41798564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
41808564acf9Swdenk
41816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
41828564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
41838564acf9Swdenk
41846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
41858564acf9Swdenk		If defined, hardware flash sectors protection is used
41868564acf9Swdenk		instead of U-Boot software protection.
41878564acf9Swdenk
41886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
4189c609719bSwdenk
4190c609719bSwdenk		Enable TFTP transfers directly to flash memory;
4191c609719bSwdenk		without this option such a download has to be
4192c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
4193c609719bSwdenk		copy from RAM to flash.
4194c609719bSwdenk
4195c609719bSwdenk		The two-step approach is usually more reliable, since
4196c609719bSwdenk		you can check if the download worked before you erase
419711ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
419811ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
4199c609719bSwdenk		downloaded image) this option may be very useful.
4200c609719bSwdenk
42016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
4202c609719bSwdenk		Define if the flash driver uses extra elements in the
42035653fc33Swdenk		common flash structure for storing flash geometry.
42045653fc33Swdenk
420500b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
42065653fc33Swdenk		This option also enables the building of the cfi_flash driver
42075653fc33Swdenk		in the drivers directory
420853cf9435Sstroese
420991809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
421091809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
421191809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
421291809ed5SPiotr Ziecik		to the MTD layer.
421391809ed5SPiotr Ziecik
42146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
421596ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
421696ef831fSGuennadi Liakhovetski
421796ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
421896ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
421996ef831fSGuennadi Liakhovetski		write commands.
422096ef831fSGuennadi Liakhovetski
42216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
42225568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
42235568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
42245568e613SStefan Roese		is useful, if some of the configured banks are only
42255568e613SStefan Roese		optionally available.
42265568e613SStefan Roese
42279a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
42289a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
42299a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
42309a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
42319a042e9cSJerry Van Baren
4232352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
4233352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
4234352ef3f1SStefan Roese		against the source after the write operation. An error message
4235352ef3f1SStefan Roese		will be printed when the contents are not identical.
4236352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
4237352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
4238352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
4239352ef3f1SStefan Roese		this option if you really know what you are doing.
4240352ef3f1SStefan Roese
42416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
424211ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
424311ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
424453cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
424553cf9435Sstroese		buffers can be full shortly after enabling the interface
424611ccc33fSMarcel Ziswiler		on high Ethernet traffic.
424753cf9435Sstroese		Defaults to 4 if not defined.
4248c609719bSwdenk
4249ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
4250ea882bafSWolfgang Denk
4251ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
4252ea882bafSWolfgang Denk	internally to store the environment settings. The default
4253ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
4254ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
4255ea882bafSWolfgang Denk	lib/hashtable.c for details.
4256ea882bafSWolfgang Denk
42572598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
42582598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
42591bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
42602598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
42612598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
42622598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
42632598090bSJoe Hershberger
42642598090bSJoe Hershberger	The format of the list is:
42652598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
4266b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
4267b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
42682598090bSJoe Hershberger		entry = variable_name[:attributes]
42692598090bSJoe Hershberger		list = entry[,list]
42702598090bSJoe Hershberger
42712598090bSJoe Hershberger	The type attributes are:
42722598090bSJoe Hershberger		s - String (default)
42732598090bSJoe Hershberger		d - Decimal
42742598090bSJoe Hershberger		x - Hexadecimal
42752598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
42762598090bSJoe Hershberger		i - IP address
42772598090bSJoe Hershberger		m - MAC address
42782598090bSJoe Hershberger
4279267541f7SJoe Hershberger	The access attributes are:
4280267541f7SJoe Hershberger		a - Any (default)
4281267541f7SJoe Hershberger		r - Read-only
4282267541f7SJoe Hershberger		o - Write-once
4283267541f7SJoe Hershberger		c - Change-default
4284267541f7SJoe Hershberger
42852598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
42862598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
4287b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
42882598090bSJoe Hershberger
42892598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
42902598090bSJoe Hershberger		Define this to a list (string) to define validation that
42912598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
42922598090bSJoe Hershberger		environment variable.  To override a setting in the static
42932598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
42942598090bSJoe Hershberger		".flags" variable.
42952598090bSJoe Hershberger
4296267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
4297267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
4298267541f7SJoe Hershberger	access flags.
4299267541f7SJoe Hershberger
43005c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
43015c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
43025c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
43035c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
43045c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
43055c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
43065c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
43075c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
43085c1a7ea6SSimon Glass	your board please report the problem and send patches!
43095c1a7ea6SSimon Glass
43100b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
43110b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
43120b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
4313b445bbb4SJeremiah Mahler	the value can be calculated on a given board.
4314632efa74SSimon Glass
43150d296cc2SGabe Black- CONFIG_USE_STDINT
43160d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
43170d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
43180d296cc2SGabe Black	building U-Boot to enable this.
43190d296cc2SGabe Black
4320c609719bSwdenkThe following definitions that deal with the placement and management
4321c609719bSwdenkof environment data (variable area); in general, we support the
4322c609719bSwdenkfollowing configurations:
4323c609719bSwdenk
4324c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
4325c3eb3fe4SMike Frysinger
4326c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
4327c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
4328c3eb3fe4SMike Frysinger
43295a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
4330c609719bSwdenk
4331c609719bSwdenk	Define this if the environment is in flash memory.
4332c609719bSwdenk
4333c609719bSwdenk	a) The environment occupies one whole flash sector, which is
4334c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
4335c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
4336c609719bSwdenk	   sector" type flash chips, which have several smaller
4337c609719bSwdenk	   sectors at the start or the end. For instance, such a
4338c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4339c609719bSwdenk	   such a case you would place the environment in one of the
4340c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
4341c609719bSwdenk	   "top boot sector" type flash chips, you would put the
4342c609719bSwdenk	   environment in one of the last sectors, leaving a gap
4343c609719bSwdenk	   between U-Boot and the environment.
4344c609719bSwdenk
43450e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
4346c609719bSwdenk
4347c609719bSwdenk	   Offset of environment data (variable area) to the
4348c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
4349c609719bSwdenk	   type flash chips the second sector can be used: the offset
4350c609719bSwdenk	   for this sector is given here.
4351c609719bSwdenk
43526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
4353c609719bSwdenk
43540e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
4355c609719bSwdenk
4356c609719bSwdenk	   This is just another way to specify the start address of
4357c609719bSwdenk	   the flash sector containing the environment (instead of
43580e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
4359c609719bSwdenk
43600e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
4361c609719bSwdenk
4362c609719bSwdenk	   Size of the sector containing the environment.
4363c609719bSwdenk
4364c609719bSwdenk
4365c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
4366c609719bSwdenk	   In such a case you don't want to spend a whole sector for
4367c609719bSwdenk	   the environment.
4368c609719bSwdenk
43690e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4370c609719bSwdenk
43715a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
43720e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4373c609719bSwdenk	   of this flash sector for the environment. This saves
4374c609719bSwdenk	   memory for the RAM copy of the environment.
4375c609719bSwdenk
4376c609719bSwdenk	   It may also save flash memory if you decide to use this
4377c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
4378c609719bSwdenk	   since then the remainder of the flash sector could be used
4379c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4380c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4381c609719bSwdenk	   updating the environment in flash makes it always
4382c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4383c609719bSwdenk	   wrong before the contents has been restored from a copy in
4384c609719bSwdenk	   RAM, your target system will be dead.
4385c609719bSwdenk
43860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
43870e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4388c609719bSwdenk
4389c609719bSwdenk	   These settings describe a second storage area used to hold
439011ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
43913e38691eSwdenk	   a valid backup copy in case there is a power failure during
4392c609719bSwdenk	   a "saveenv" operation.
4393c609719bSwdenk
4394c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4395c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4396c609719bSwdenkaccordingly!
4397c609719bSwdenk
4398c609719bSwdenk
43999314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4400c609719bSwdenk
4401c609719bSwdenk	Define this if you have some non-volatile memory device
4402c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4403c609719bSwdenk	environment.
4404c609719bSwdenk
44050e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
44060e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4407c609719bSwdenk
440811ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4409c609719bSwdenk	  want to use for environment. It is assumed that this memory
4410c609719bSwdenk	  can just be read and written to, without any special
4411c609719bSwdenk	  provision.
4412c609719bSwdenk
4413c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4414b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
441511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4416c609719bSwdenkU-Boot will hang.
4417c609719bSwdenk
4418c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4419c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4420c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4421c609719bSwdenkto save the current settings.
4422c609719bSwdenk
4423c609719bSwdenk
4424bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4425c609719bSwdenk
4426c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4427c609719bSwdenk	device and a driver for it.
4428c609719bSwdenk
44290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
44300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4431c609719bSwdenk
4432c609719bSwdenk	  These two #defines specify the offset and size of the
4433c609719bSwdenk	  environment area within the total memory of your EEPROM.
4434c609719bSwdenk
44356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4436c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4437c609719bSwdenk	  The default address is zero.
4438c609719bSwdenk
4439189d257bSChristian Gmeiner	- CONFIG_SYS_I2C_EEPROM_BUS:
4440189d257bSChristian Gmeiner	  If defined, specified the i2c bus of the EEPROM device.
4441189d257bSChristian Gmeiner
44426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4443c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4444c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4445c609719bSwdenk	  would require six bits.
4446c609719bSwdenk
44476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4448c609719bSwdenk	  If defined, the number of milliseconds to delay between
4449c609719bSwdenk	  page writes.	The default is zero milliseconds.
4450c609719bSwdenk
44516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4452c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4453c609719bSwdenk	  that this is NOT the chip address length!
4454c609719bSwdenk
44556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
44565cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
44575cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
44585cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
44595cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
44605cf91d6bSwdenk	  byte chips.
44615cf91d6bSwdenk
44625cf91d6bSwdenk	  Note that we consider the length of the address field to
44635cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
44645cf91d6bSwdenk	  in the chip address.
44655cf91d6bSwdenk
44666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4467c609719bSwdenk	  The size in bytes of the EEPROM device.
4468c609719bSwdenk
4469548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4470548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4471548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4472548738b4SHeiko Schocher
4473548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4474548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4475548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4476548738b4SHeiko Schocher	  EEPROM. For example:
4477548738b4SHeiko Schocher
4478ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4479548738b4SHeiko Schocher
4480548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4481548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4482c609719bSwdenk
4483057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
44845779d8d9Swdenk
44855779d8d9Swdenk	Define this if you have a DataFlash memory device which you
44865779d8d9Swdenk	want to use for the environment.
44875779d8d9Swdenk
44880e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
44890e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
44900e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
44915779d8d9Swdenk
44925779d8d9Swdenk	  These three #defines specify the offset and size of the
44935779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
44945779d8d9Swdenk	  at the specified address.
44955779d8d9Swdenk
4496bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4497bd83b592SWu, Josh
4498bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4499bd83b592SWu, Josh	want to use for the environment.
4500bd83b592SWu, Josh
4501bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4502bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4503bd83b592SWu, Josh
4504bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4505bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4506bd83b592SWu, Josh	  aligned to an erase sector boundary.
4507bd83b592SWu, Josh
4508bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4509bd83b592SWu, Josh
4510bd83b592SWu, Josh	  Define the SPI flash's sector size.
4511bd83b592SWu, Josh
4512bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4513bd83b592SWu, Josh
4514bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4515bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4516bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
4517bd83b592SWu, Josh	  during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4518bd83b592SWu, Josh	  aligned to an erase sector boundary.
4519bd83b592SWu, Josh
4520bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4521bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4522bd83b592SWu, Josh
4523bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4524bd83b592SWu, Josh
4525bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4526bd83b592SWu, Josh
4527bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4528bd83b592SWu, Josh
4529bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4530bd83b592SWu, Josh
4531bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4532bd83b592SWu, Josh
45330a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
45340a85a9e7SLiu Gang
45350a85a9e7SLiu Gang	Define this if you have a remote memory space which you
45360a85a9e7SLiu Gang	want to use for the local device's environment.
45370a85a9e7SLiu Gang
45380a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
45390a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
45400a85a9e7SLiu Gang
45410a85a9e7SLiu Gang	  These two #defines specify the address and size of the
45420a85a9e7SLiu Gang	  environment area within the remote memory space. The
45430a85a9e7SLiu Gang	  local device can get the environment from remote memory
4544fc54c7faSLiu Gang	  space by SRIO or PCIE links.
45450a85a9e7SLiu Gang
45460a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
45470a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4548fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4549fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
45500a85a9e7SLiu Gang
455151bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
455213a5695bSwdenk
455313a5695bSwdenk	Define this if you have a NAND device which you want to use
455413a5695bSwdenk	for the environment.
455513a5695bSwdenk
45560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
45570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
455813a5695bSwdenk
455913a5695bSwdenk	  These two #defines specify the offset and size of the environment
4560fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4561fdd813deSScott Wood	  aligned to an erase block boundary.
45625779d8d9Swdenk
4563fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4564e443c944SMarkus Klotzbuecher
45650e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4566fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4567fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4568fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4569fdd813deSScott Wood	  aligned to an erase block boundary.
4570e443c944SMarkus Klotzbuecher
4571fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4572fdd813deSScott Wood
4573fdd813deSScott Wood	  Specifies the length of the region in which the environment
4574fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4575fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4576fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4577fdd813deSScott Wood	  the range to be avoided.
4578fdd813deSScott Wood
4579fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4580fdd813deSScott Wood
4581fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4582fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4583fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4584fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4585fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4586e443c944SMarkus Klotzbuecher
4587b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4588b74ab737SGuennadi Liakhovetski
4589b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4590b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4591b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4592b74ab737SGuennadi Liakhovetski
45932b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
45942b74433fSJoe Hershberger
45952b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
45962b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
45972b74433fSJoe Hershberger	accesses, which is important on NAND.
45982b74433fSJoe Hershberger
45992b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
46002b74433fSJoe Hershberger
46012b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
46022b74433fSJoe Hershberger
46032b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
46042b74433fSJoe Hershberger
46052b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
46062b74433fSJoe Hershberger	  environment in.
46072b74433fSJoe Hershberger
4608785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4609785881f7SJoe Hershberger
4610785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4611785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4612785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4613785881f7SJoe Hershberger
46142b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
46152b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
46162b74433fSJoe Hershberger
46172b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
46182b74433fSJoe Hershberger	  when storing the env in UBI.
46192b74433fSJoe Hershberger
4620d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4621d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4622d1db76f1SWu, Josh
4623d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4624d1db76f1SWu, Josh
4625d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4626d1db76f1SWu, Josh
4627d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4628d1db76f1SWu, Josh
4629d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4630d1db76f1SWu, Josh         be as following:
4631d1db76f1SWu, Josh
4632d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4633d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4634d1db76f1SWu, Josh                        partition table.
4635d1db76f1SWu, Josh               - "D:0": device D.
4636d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4637d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4638d1db76f1SWu, Josh                              table.
4639d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4640b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
4641d1db76f1SWu, Josh                           partition table then means device D.
4642d1db76f1SWu, Josh
4643d1db76f1SWu, Josh       - FAT_ENV_FILE:
4644d1db76f1SWu, Josh
4645d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4646b445bbb4SJeremiah Mahler         environment.
4647d1db76f1SWu, Josh
4648d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4649b445bbb4SJeremiah Mahler         This should be defined. Otherwise it cannot save the environment file.
4650d1db76f1SWu, Josh
465106e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
465206e4ae5fSStephen Warren
465306e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
465406e4ae5fSStephen Warren	environment.
465506e4ae5fSStephen Warren
465606e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
465706e4ae5fSStephen Warren
465806e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
465906e4ae5fSStephen Warren
466006e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
466106e4ae5fSStephen Warren
466206e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
466306e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
466406e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
466506e4ae5fSStephen Warren
466606e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
466706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
466806e4ae5fSStephen Warren
466906e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
467006e4ae5fSStephen Warren	  area within the specified MMC device.
467106e4ae5fSStephen Warren
46725c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
46735c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
46745c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
46755c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
46765c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
46775c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
46785c088ee8SStephen Warren	  maximum possible space before it, to store other data.
46795c088ee8SStephen Warren
468006e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
468106e4ae5fSStephen Warren	  MMC sector boundary.
468206e4ae5fSStephen Warren
468306e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
468406e4ae5fSStephen Warren
468506e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
468606e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
468706e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
468806e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
468906e4ae5fSStephen Warren
46905c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
46915c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
46925c088ee8SStephen Warren
469306e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
469406e4ae5fSStephen Warren	  an MMC sector boundary.
469506e4ae5fSStephen Warren
469606e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
469706e4ae5fSStephen Warren
469806e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
469906e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
470006e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
470106e4ae5fSStephen Warren
47026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4703c609719bSwdenk
4704c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4705c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4706c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4707c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4708c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4709c609719bSwdenk	to be a good choice since it makes it far enough from the
4710c609719bSwdenk	start of the data area as well as from the stack pointer.
4711c609719bSwdenk
4712e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4713c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4714cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4715c609719bSwdenkuntil then to read environment variables.
4716c609719bSwdenk
471785ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
471885ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
471985ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
472085ec0bccSwdenknecessary, because the first environment variable we need is the
472185ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
472285ec0bccSwdenkhave any device yet where we could complain.]
4723c609719bSwdenk
4724c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4725c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
472685ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4727c609719bSwdenk
47286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4729fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4730fc3e2165Swdenk
47316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4732fc3e2165Swdenk		      also needs to be defined.
4733fc3e2165Swdenk
47346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4735fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4736c609719bSwdenk
4737f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4738f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4739f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4740f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4741f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4742f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4743f5675aa5SRon Madrid
4744b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4745b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4746b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4747b2b92f53SSimon Glass		to do this.
4748b2b92f53SSimon Glass
4749e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4750e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4751e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4752e2e3e2b1SSimon Glass		present.
4753e2e3e2b1SSimon Glass
4754feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4755feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4756feb85801SSascha Silbe		build system checks that the actual size does not
4757feb85801SSascha Silbe		exceed it.
4758feb85801SSascha Silbe
4759c609719bSwdenkLow Level (hardware related) configuration options:
4760dc7c9a1aSwdenk---------------------------------------------------
4761c609719bSwdenk
47626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4763c609719bSwdenk		Cache Line Size of the CPU.
4764c609719bSwdenk
47656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4766c609719bSwdenk		Default address of the IMMR after system reset.
47672535d602Swdenk
47682535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
47692535d602Swdenk		and RPXsuper) to be able to adjust the position of
47702535d602Swdenk		the IMMR register after a reset.
4771c609719bSwdenk
4772e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4773e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4774e46fedfeSTimur Tabi		PowerPC SOCs.
4775e46fedfeSTimur Tabi
4776e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4777e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4778e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4779e46fedfeSTimur Tabi
4780e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4781e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4782e46fedfeSTimur Tabi
4783e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4784e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4785e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4786e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4787e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4788e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4789e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4790e46fedfeSTimur Tabi
4791e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4792e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4793e46fedfeSTimur Tabi
4794e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4795e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4796e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4797e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4798e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4799e46fedfeSTimur Tabi
4800e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4801e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4802e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4803e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4804e46fedfeSTimur Tabi
4805e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4806e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4807e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4808e46fedfeSTimur Tabi
48097f6c2cbcSwdenk- Floppy Disk Support:
48106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
48117f6c2cbcSwdenk
48127f6c2cbcSwdenk		the default drive number (default value 0)
48137f6c2cbcSwdenk
48146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
48157f6c2cbcSwdenk
481611ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
48177f6c2cbcSwdenk		(default value 1)
48187f6c2cbcSwdenk
48196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
48207f6c2cbcSwdenk
48217f6c2cbcSwdenk		defines the offset of register from address. It
48227f6c2cbcSwdenk		depends on which part of the data bus is connected to
482311ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
48247f6c2cbcSwdenk
48256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
48266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
48277f6c2cbcSwdenk		default value.
48287f6c2cbcSwdenk
48296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
48307f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
48317f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
4832b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
48337f6c2cbcSwdenk		initializations.
48347f6c2cbcSwdenk
48350abddf82SMacpaul Lin- CONFIG_IDE_AHB:
48360abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
48370abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
48380abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
48390abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
48400abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4841b445bbb4SJeremiah Mahler		is required.
48420abddf82SMacpaul Lin
48436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
484425d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
484525d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4846c609719bSwdenk
48476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4848c609719bSwdenk
48497152b1d0Swdenk		Start address of memory area that can be used for
4850c609719bSwdenk		initial data and stack; please note that this must be
4851c609719bSwdenk		writable memory that is working WITHOUT special
4852c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4853c609719bSwdenk		will become available only after programming the
4854c609719bSwdenk		memory controller and running certain initialization
4855c609719bSwdenk		sequences.
4856c609719bSwdenk
4857c609719bSwdenk		U-Boot uses the following memory types:
4858c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4859c609719bSwdenk		- MPC824X: data cache
4860c609719bSwdenk		- PPC4xx:  data cache
4861c609719bSwdenk
48626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4863c609719bSwdenk
4864c609719bSwdenk		Offset of the initial data structure in the memory
48656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
48666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4867c609719bSwdenk		data is located at the end of the available space
4868553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
48696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
48706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
48716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4872c609719bSwdenk
4873c609719bSwdenk	Note:
4874c609719bSwdenk		On the MPC824X (or other systems that use the data
4875c609719bSwdenk		cache for initial memory) the address chosen for
48766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4877c609719bSwdenk		point to an otherwise UNUSED address space between
4878c609719bSwdenk		the top of RAM and the start of the PCI space.
4879c609719bSwdenk
48806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4881c609719bSwdenk
48826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4883c609719bSwdenk
48846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4885c609719bSwdenk
48866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4887c609719bSwdenk
48886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4889c609719bSwdenk
48906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4891c609719bSwdenk
48926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4893c609719bSwdenk		SDRAM timing
4894c609719bSwdenk
48956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4896c609719bSwdenk		periodic timer for refresh
4897c609719bSwdenk
48986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4899c609719bSwdenk
49006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
49016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
49026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
49036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4904c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4905c609719bSwdenk
4906c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
49076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
49086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4909c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4910c609719bSwdenk
49116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
49126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4913c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4914c609719bSwdenk		Prescaler definitions (SDRAM timing)
4915c609719bSwdenk
49166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4917c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4918c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4919c609719bSwdenk
49206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4921b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4922b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4923b423d055SHeiko Schocher
49246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4925c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4926c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4927c609719bSwdenk
49286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4929c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4930c609719bSwdenk		wrong setting might damage your board. Read
4931c609719bSwdenk		doc/README.MBX before setting this variable!
4932c609719bSwdenk
49336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4934ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4935ea909b76Swdenk		(Power On Self Tests). This definition overrides
4936ea909b76Swdenk		#define'd default value in commproc.h resp.
4937ea909b76Swdenk		cpm_8260.h.
4938ea909b76Swdenk
49396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
49406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
49416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
49426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
49436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
49446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
49456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
49466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4947a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
49485d232d0eSwdenk
49499cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
49509cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
49519cacf4fcSDirk Eibach		required.
49529cacf4fcSDirk Eibach
495369fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4954b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
495569fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
495669fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
495769fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
495869fd2d3bSAndrew Sharp		by coreboot or similar.
495969fd2d3bSAndrew Sharp
4960842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4961842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4962842033e6SGabor Juhos
4963a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4964a09b9b68SKumar Gala		Chip has SRIO or not
4965a09b9b68SKumar Gala
4966a09b9b68SKumar Gala- CONFIG_SRIO1:
4967a09b9b68SKumar Gala		Board has SRIO 1 port available
4968a09b9b68SKumar Gala
4969a09b9b68SKumar Gala- CONFIG_SRIO2:
4970a09b9b68SKumar Gala		Board has SRIO 2 port available
4971a09b9b68SKumar Gala
4972c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4973c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4974c8b28152SLiu Gang
4975a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4976a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4977a09b9b68SKumar Gala
4978a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4979a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4980a09b9b68SKumar Gala
4981a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4982a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4983a09b9b68SKumar Gala
498466bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
498566bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
498666bd1846SFabio Estevam		a 16 bit bus.
498766bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4988a430e916SFabio Estevam		Example of drivers that use it:
498966bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4990a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4991eced4626SAlex Waterman
4992eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4993eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4994eced4626SAlex Waterman		a default value will be used.
4995eced4626SAlex Waterman
4996bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4997218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4998218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4999218ca724SWolfgang Denk
5000bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
5001bb99ad6dSBen Warren		I2C address of the SPD EEPROM
5002bb99ad6dSBen Warren
50036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
5004218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
5005218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
5006218ca724SWolfgang Denk		to something your driver can deal with.
5007bb99ad6dSBen Warren
50081b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
50091b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
50101b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
50111b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
50121b3e3c4fSYork Sun		header files or board specific files.
50131b3e3c4fSYork Sun
50146f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
50156f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
50166f5e1dc5SYork Sun
5017e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
5018e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
5019e32d59a2SYork Sun
50206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
5021218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
5022218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
50232ad6b513STimur Tabi
5024c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
5025c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
5026c26e454dSwdenk
5027c26e454dSwdenk- CONFIG_FEC[12]_PHY
5028c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
50296e592385Swdenk		to the given FEC; i. e.
5030c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
5031c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
5032c26e454dSwdenk
5033c26e454dSwdenk		When set to -1, means to probe for first available.
5034c26e454dSwdenk
5035c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
5036c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
5037c26e454dSwdenk		(so program the FEC to ignore it).
5038c26e454dSwdenk
5039c26e454dSwdenk- CONFIG_RMII
5040c26e454dSwdenk		Enable RMII mode for all FECs.
5041c26e454dSwdenk		Note that this is a global option, we can't
5042c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
5043c26e454dSwdenk
50445cf91d6bSwdenk- CONFIG_CRC32_VERIFY
50455cf91d6bSwdenk		Add a verify option to the crc32 command.
50465cf91d6bSwdenk		The syntax is:
50475cf91d6bSwdenk
50485cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
50495cf91d6bSwdenk
50505cf91d6bSwdenk		Where address/count indicate a memory area
50515cf91d6bSwdenk		and crc32 is the correct crc32 which the
50525cf91d6bSwdenk		area should have.
50535cf91d6bSwdenk
505456523f12Swdenk- CONFIG_LOOPW
505556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
5056602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
505756523f12Swdenk
50587b466641Sstroese- CONFIG_MX_CYCLIC
50597b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
50607b466641Sstroese		"md/mw" commands.
50617b466641Sstroese		Examples:
50627b466641Sstroese
50637b466641Sstroese		=> mdc.b 10 4 500
50647b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
50657b466641Sstroese
50667b466641Sstroese		=> mwc.l 100 12345678 10
50677b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
50687b466641Sstroese
50697b466641Sstroese		This only takes effect if the memory commands are activated
5070602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
50717b466641Sstroese
50728aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
5073afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
5074e03f3169SWolfgang Denk		low level initializations (like setting up the memory
5075e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
5076e03f3169SWolfgang Denk		relocate itself into RAM.
50778aa1a2d1Swdenk
5078e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
5079e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
5080e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
5081e03f3169SWolfgang Denk		these initializations itself.
50828aa1a2d1Swdenk
5083401bb30bSAneesh V- CONFIG_SPL_BUILD
5084df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
5085df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
5086df81238bSMagnus Lilja		compiling a NAND SPL.
5087400558b5Swdenk
50883aa29de0SYing Zhang- CONFIG_TPL_BUILD
50893aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
50903aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
50913aa29de0SYing Zhang		It is loaded by the SPL.
50923aa29de0SYing Zhang
50935df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
50945df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
50955df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
50965df572f0SYing Zhang		previous 4k of the .text section.
50975df572f0SYing Zhang
50984213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
50994213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
51004213fc29SSimon Glass		effective address. It is therefore not necessary to regard
51014213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
51024213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
51034213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
51044213fc29SSimon Glass		addressable memory. This option causes some memory accesses
51054213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
51064213fc29SSimon Glass
5107d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
5108d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
5109d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
5110d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
5111d8834a13SMatthias Weisser		conditions but may increase the binary size.
5112d8834a13SMatthias Weisser
5113588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
5114588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
5115588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
5116b16f521aSGabe Black
5117fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
5118fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
5119fc33705eSMark Jackson
5120fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
51215b5ece9eSGabe Black
512216678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
512316678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
512416678eb4SHeiko Schocher
5125999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5126999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
5127999d7d32SKaricheri, Muralidharan		driver that uses this:
5128999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
5129999d7d32SKaricheri, Muralidharan
5130f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
5131f2717b47STimur Tabi-----------------------------------
5132f2717b47STimur Tabi
5133f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5134f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
5135f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
5136f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
5137f2717b47STimur Tabiwithin that device.
5138f2717b47STimur Tabi
5139dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
5140dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
5141dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5142dcf1d774SZhao Qiang	is also specified.
5143dcf1d774SZhao Qiang
5144dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
5145dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
5146f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5147f2717b47STimur Tabi	is also specified.
5148f2717b47STimur Tabi
5149f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
5150f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
5151f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
5152f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
5153f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
5154f2717b47STimur Tabi
5155f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5156f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5157f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
5158f2717b47STimur Tabi	virtual address in NOR flash.
5159f2717b47STimur Tabi
5160f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5161f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
5162f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5163f2717b47STimur Tabi
5164f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5165f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
5166f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5167f2717b47STimur Tabi
5168f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5169f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
5170f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5171f2717b47STimur Tabi
5172292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5173292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
5174292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
5175fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5176fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
5177fc54c7faSLiu Gang	master's memory space.
5178f2717b47STimur Tabi
5179b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
5180b940ca64SJ. German Rivera---------------------------------------------------------
5181b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
5182b940ca64SJ. German Rivera"firmware".
5183b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
5184b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
5185b940ca64SJ. German Riverawithin that device.
5186b940ca64SJ. German Rivera
5187b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
5188b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
5189b940ca64SJ. German Rivera
5190b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR
5191b940ca64SJ. German Rivera	The address in the storage device where the firmware is located.  The
5192b940ca64SJ. German Rivera	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5193b940ca64SJ. German Rivera	is also specified.
5194b940ca64SJ. German Rivera
5195b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH
5196b940ca64SJ. German Rivera	The maximum possible size of the firmware.  The firmware binary format
5197b940ca64SJ. German Rivera	has a field that specifies the actual size of the firmware, but it
5198b940ca64SJ. German Rivera	might not be possible to read any part of the firmware unless some
5199b940ca64SJ. German Rivera	local storage is allocated to hold the entire firmware first.
5200b940ca64SJ. German Rivera
5201b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR
5202b940ca64SJ. German Rivera	Specifies that MC firmware is located in NOR flash, mapped as
5203b940ca64SJ. German Rivera	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5204b940ca64SJ. German Rivera	virtual address in NOR flash.
5205b940ca64SJ. German Rivera
5206c609719bSwdenkBuilding the Software:
5207c609719bSwdenk======================
5208c609719bSwdenk
5209218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
5210218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
5211218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
5212218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
5213218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5214218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
5215c609719bSwdenk
5216218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
5217218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
5218218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
5219218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
5220218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
5221c609719bSwdenk
5222218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
5223218ca724SWolfgang Denk	$ export CROSS_COMPILE
5224c609719bSwdenk
52252f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
52262f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
52272f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
52282f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
52292f8d396bSPeter Tyser
52302f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
52312f8d396bSPeter Tyser
52322f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
52332f8d396bSPeter Tyser      be executed on computers running Windows.
52342f8d396bSPeter Tyser
5235c609719bSwdenkU-Boot is intended to be simple to build. After installing the
5236c609719bSwdenksources you must configure U-Boot for one specific board type. This
5237c609719bSwdenkis done by typing:
5238c609719bSwdenk
5239ab584d67SHolger Freyther	make NAME_defconfig
5240c609719bSwdenk
5241ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
52424d675ae6SMichael Jonesrations; see boards.cfg for supported names.
524354387ac9Swdenk
5244c609719bSwdenkNote: for some board special configuration names may exist; check if
5245c609719bSwdenk      additional information is available from the board vendor; for
52462729af9dSwdenk      instance, the TQM823L systems are available without (standard)
52472729af9dSwdenk      or with LCD support. You can select such additional "features"
524811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
5249c609719bSwdenk
5250ab584d67SHolger Freyther      make TQM823L_defconfig
52512729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
5252c609719bSwdenk
5253ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
5254c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
5255c609719bSwdenk
5256c609719bSwdenk      etc.
5257c609719bSwdenk
5258c609719bSwdenk
5259c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
52607152b1d0Swdenkimages ready for download to / installation on your system:
5261c609719bSwdenk
5262c609719bSwdenk- "u-boot.bin" is a raw binary image
5263c609719bSwdenk- "u-boot" is an image in ELF binary format
5264c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
5265c609719bSwdenk
5266baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
5267baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
5268baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
5269baf31249SMarian Balakowicz
5270baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
5271baf31249SMarian Balakowicz
5272baf31249SMarian Balakowicz	make O=/tmp/build distclean
5273ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
5274baf31249SMarian Balakowicz	make O=/tmp/build all
5275baf31249SMarian Balakowicz
5276adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
5277baf31249SMarian Balakowicz
5278adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
5279baf31249SMarian Balakowicz	make distclean
5280ab584d67SHolger Freyther	make NAME_defconfig
5281baf31249SMarian Balakowicz	make all
5282baf31249SMarian Balakowicz
5283adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
5284baf31249SMarian Balakowiczvariable.
5285baf31249SMarian Balakowicz
5286c609719bSwdenk
5287c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
5288c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
5289c609719bSwdenknative "make".
5290c609719bSwdenk
5291c609719bSwdenk
5292c609719bSwdenkIf the system board that you have is not listed, then you will need
5293c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
5294c609719bSwdenksteps:
5295c609719bSwdenk
5296c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
52974d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
52984d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
5299c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
530085ec0bccSwdenk    files you need. In your board directory, you will need at least
530185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
530285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
530385ec0bccSwdenk    your board
5304c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
5305c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
5306ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
5307c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
5308c609719bSwdenk    to be installed on your target system.
530985ec0bccSwdenk6.  Debug and solve any problems that might arise.
5310c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
5311c609719bSwdenk
5312c609719bSwdenk
5313c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
5314c609719bSwdenk==============================================================
5315c609719bSwdenk
5316c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
5317c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
5318c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
5319c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
5320218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
5321c609719bSwdenk
5322c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
5323c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
5324c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
5325c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
5326c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
53277152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
5328218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
5329218ca724SWolfgang Denkyou can type
5330c609719bSwdenk
5331c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
5332c609719bSwdenk
5333c609719bSwdenkor to build on a native PowerPC system you can type
5334c609719bSwdenk
5335c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
5336c609719bSwdenk
5337218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
5338218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
5339218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
5340218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
5341218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
5342218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
5343218ca724SWolfgang Denkvariable. For example:
5344baf31249SMarian Balakowicz
5345baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
5346baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
5347baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
5348baf31249SMarian Balakowicz
5349218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
5350218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
5351218ca724SWolfgang Denkduring the whole build process.
5352baf31249SMarian Balakowicz
5353baf31249SMarian Balakowicz
5354c609719bSwdenkSee also "U-Boot Porting Guide" below.
5355c609719bSwdenk
5356c609719bSwdenk
5357c609719bSwdenkMonitor Commands - Overview:
5358c609719bSwdenk============================
5359c609719bSwdenk
5360c609719bSwdenkgo	- start application at address 'addr'
5361c609719bSwdenkrun	- run commands in an environment variable
5362c609719bSwdenkbootm	- boot application image from memory
5363c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
536444f074c7SMarek Vasutbootz   - boot zImage from memory
5365c609719bSwdenktftpboot- boot image via network using TFTP protocol
5366c609719bSwdenk	       and env variables "ipaddr" and "serverip"
5367c609719bSwdenk	       (and eventually "gatewayip")
53681fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
5369c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
5370c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
5371c609719bSwdenkloads	- load S-Record file over serial line
5372c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
5373c609719bSwdenkmd	- memory display
5374c609719bSwdenkmm	- memory modify (auto-incrementing)
5375c609719bSwdenknm	- memory modify (constant address)
5376c609719bSwdenkmw	- memory write (fill)
5377c609719bSwdenkcp	- memory copy
5378c609719bSwdenkcmp	- memory compare
5379c609719bSwdenkcrc32	- checksum calculation
53800f89c54bSPeter Tyseri2c	- I2C sub-system
5381c609719bSwdenksspi	- SPI utility commands
5382c609719bSwdenkbase	- print or set address offset
5383c609719bSwdenkprintenv- print environment variables
5384c609719bSwdenksetenv	- set environment variables
5385c609719bSwdenksaveenv - save environment variables to persistent storage
5386c609719bSwdenkprotect - enable or disable FLASH write protection
5387c609719bSwdenkerase	- erase FLASH memory
5388c609719bSwdenkflinfo	- print FLASH memory information
538910635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
5390c609719bSwdenkbdinfo	- print Board Info structure
5391c609719bSwdenkiminfo	- print header information for application image
5392c609719bSwdenkconinfo - print console devices and informations
5393c609719bSwdenkide	- IDE sub-system
5394c609719bSwdenkloop	- infinite loop on address range
539556523f12Swdenkloopw	- infinite write loop on address range
5396c609719bSwdenkmtest	- simple RAM test
5397c609719bSwdenkicache	- enable or disable instruction cache
5398c609719bSwdenkdcache	- enable or disable data cache
5399c609719bSwdenkreset	- Perform RESET of the CPU
5400c609719bSwdenkecho	- echo args to console
5401c609719bSwdenkversion - print monitor version
5402c609719bSwdenkhelp	- print online help
5403c609719bSwdenk?	- alias for 'help'
5404c609719bSwdenk
5405c609719bSwdenk
5406c609719bSwdenkMonitor Commands - Detailed Description:
5407c609719bSwdenk========================================
5408c609719bSwdenk
5409c609719bSwdenkTODO.
5410c609719bSwdenk
5411c609719bSwdenkFor now: just type "help <command>".
5412c609719bSwdenk
5413c609719bSwdenk
5414c609719bSwdenkEnvironment Variables:
5415c609719bSwdenk======================
5416c609719bSwdenk
5417c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5418c609719bSwdenkcan be made persistent by saving to Flash memory.
5419c609719bSwdenk
5420c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5421c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5422c609719bSwdenkwithout a value can be used to delete a variable from the
5423c609719bSwdenkenvironment. As long as you don't save the environment you are
5424c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5425c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5426c609719bSwdenk
5427c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5428c96f86eeSWolfgang Denk
5429c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5430c609719bSwdenk
5431c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5432c609719bSwdenk
5433c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5434c609719bSwdenk
5435c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5436c609719bSwdenk
5437c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5438c609719bSwdenk
5439c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5440c609719bSwdenk
54417d721e34SBartlomiej Sieka  bootm_low	- 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 lowest address allowed
54447d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
54457d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
54467d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5447c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5448c3624e6eSGrant Likely		  bootm_mapsize.
5449c3624e6eSGrant Likely
5450c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5451c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5452c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5453c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5454c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5455c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5456c3624e6eSGrant Likely		  used otherwise.
54577d721e34SBartlomiej Sieka
54587d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
54597d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
54607d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
54617d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
54627d721e34SBartlomiej Sieka		  environment variable.
54637d721e34SBartlomiej Sieka
54644bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
54654bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
54664bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
54674bae9090SBartlomiej Sieka
5468c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5469c609719bSwdenk		  "bootp" will just load perform a lookup of the
5470c609719bSwdenk		  configuration from the BOOTP server, but not try to
5471c609719bSwdenk		  load any image using TFTP
5472c609719bSwdenk
5473c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5474c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5475c609719bSwdenk		  be automatically started (by internally calling
5476c609719bSwdenk		  "bootm")
5477c609719bSwdenk
54784a6fd34bSwdenk		  If set to "no", a standalone image passed to the
54794a6fd34bSwdenk		  "bootm" command will be copied to the load address
54804a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
54814a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
54824a6fd34bSwdenk		  data.
54834a6fd34bSwdenk
5484a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5485a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5486fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5487fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5488fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5489fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5490fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5491fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5492fa34f6b2SShawn Guo		  access it during the boot procedure.
5493fa34f6b2SShawn Guo
5494a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5495a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5496a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5497a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5498a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5499a28afca5SDavid A. Long		  must be accessible by the kernel.
5500a28afca5SDavid A. Long
5501eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5502eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5503eea63e05SSimon Glass		  defined.
5504eea63e05SSimon Glass
550517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
550617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
550717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
550817ea1177Swdenk		  initialization code. So, for changes to be effective
550917ea1177Swdenk		  it must be saved and board must be reset.
551017ea1177Swdenk
5511c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5512c609719bSwdenk		  If this variable is not set, initrd images will be
5513c609719bSwdenk		  copied to the highest possible address in RAM; this
5514c609719bSwdenk		  is usually what you want since it allows for
5515c609719bSwdenk		  maximum initrd size. If for some reason you want to
5516c609719bSwdenk		  make sure that the initrd image is loaded below the
55176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5518c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5519c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5520c609719bSwdenk		  address to use (U-Boot will still check that it
5521c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5522c609719bSwdenk
5523c609719bSwdenk		  For instance, when you have a system with 16 MB
55247152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5525c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5526c609719bSwdenk		  the "bootargs" variable. However, now you must make
55277152b1d0Swdenk		  sure that the initrd image is placed in the first
5528c609719bSwdenk		  12 MB as well - this can be done with
5529c609719bSwdenk
5530c609719bSwdenk		  setenv initrd_high 00c00000
5531c609719bSwdenk
553238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
553338b99261Swdenk		  indication to U-Boot that all addresses are legal
553438b99261Swdenk		  for the Linux kernel, including addresses in flash
553538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
553638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
553738b99261Swdenk		  boot time on your system, but requires that this
553838b99261Swdenk		  feature is supported by your Linux kernel.
553938b99261Swdenk
5540c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5541c609719bSwdenk
5542c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5543dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5544c609719bSwdenk
5545c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5546c609719bSwdenk
5547c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5548c609719bSwdenk
5549c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5550c609719bSwdenk
5551c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5552c609719bSwdenk
5553c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5554c609719bSwdenk
5555e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5556a3d991bdSwdenk
5557e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5558e2a53458SMike Frysinger		  For example you can do the following
5559a3d991bdSwdenk
556048690d80SHeiko Schocher		  => setenv ethact FEC
556148690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
556248690d80SHeiko Schocher		  => setenv ethact SCC
556348690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5564a3d991bdSwdenk
5565e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5566e1692577SMatthias Fuchs		  available network interfaces.
5567e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5568e1692577SMatthias Fuchs
5569a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5570a3d991bdSwdenk		  either succeed or fail without retrying.
55716e592385Swdenk		  When set to "once" the network operation will
55726e592385Swdenk		  fail when all the available network interfaces
55736e592385Swdenk		  are tried once without success.
5574a3d991bdSwdenk		  Useful on scripts which control the retry operation
5575a3d991bdSwdenk		  themselves.
5576a3d991bdSwdenk
5577b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5578a1cf027aSJean-Christophe PLAGNIOL-VILLARD
5579b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
55808d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
55818d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
55828d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
55838d51aacdSSimon Glass		  is silent.
55848d51aacdSSimon Glass
558528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
5586ecb0ccd9SWolfgang Denk		  UDP source port.
5587ecb0ccd9SWolfgang Denk
558828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
558928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
559028cb9375SWolfgang Denk
5591c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5592c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5593c96f86eeSWolfgang Denk
5594c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5595c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5596c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5597c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5598c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5599c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5600c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5601c96f86eeSWolfgang Denk
5602a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
560311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5604a3d991bdSwdenk		  VLAN tagged frames.
5605c609719bSwdenk
5606dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5607dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5608dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5609dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5610dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5611dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5612dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5613dc0b7b0eSJason Hobbs
5614dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5615dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
5616dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5617dc0b7b0eSJason Hobbs
5618dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5619dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5620dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5621dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5622dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5623dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5624dc0b7b0eSJason Hobbs
5625c609719bSwdenkThe following environment variables may be used and automatically
5626c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5627c609719bSwdenkdepending the information provided by your boot server:
5628c609719bSwdenk
5629c609719bSwdenk  bootfile	- see above
5630c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5631fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5632c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5633c609719bSwdenk  hostname	- Target hostname
5634c609719bSwdenk  ipaddr	- see above
5635c609719bSwdenk  netmask	- Subnet Mask
5636c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5637c609719bSwdenk  serverip	- see above
5638c609719bSwdenk
5639c609719bSwdenk
5640c609719bSwdenkThere are two special Environment Variables:
5641c609719bSwdenk
5642c609719bSwdenk  serial#	- contains hardware identification information such
5643c609719bSwdenk		  as type string and/or serial number
5644c609719bSwdenk  ethaddr	- Ethernet address
5645c609719bSwdenk
5646c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5647c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5648c609719bSwdenkonce they have been set once.
5649c609719bSwdenk
5650c609719bSwdenk
5651c1551ea8SstroeseFurther special Environment Variables:
5652c1551ea8Sstroese
5653c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5654c1551ea8Sstroese		  with the "version" command. This variable is
5655c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5656c1551ea8Sstroese
5657c1551ea8Sstroese
5658c609719bSwdenkPlease note that changes to some configuration parameters may take
5659c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5660c609719bSwdenk
5661c609719bSwdenk
5662170ab110SJoe HershbergerCallback functions for environment variables:
5663170ab110SJoe Hershberger---------------------------------------------
5664170ab110SJoe Hershberger
5665170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5666b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
5667170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5668170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5669170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5670170ab110SJoe Hershberger
5671170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5672170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5673170ab110SJoe Hershberger
5674170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5675170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5676170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5677170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5678170ab110SJoe Hershberger
5679170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5680170ab110SJoe Hershberger	list = entry[,list]
5681170ab110SJoe Hershberger
5682170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5683170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5684170ab110SJoe Hershberger
5685170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5686170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5687170ab110SJoe Hershbergeroverride any association in the static list. You can define
5688170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5689b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
5690170ab110SJoe Hershberger
5691170ab110SJoe Hershberger
5692f07771ccSwdenkCommand Line Parsing:
5693f07771ccSwdenk=====================
5694f07771ccSwdenk
5695f07771ccSwdenkThere are two different command line parsers available with U-Boot:
56967152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5697f07771ccSwdenk
5698f07771ccSwdenkOld, simple command line parser:
5699f07771ccSwdenk--------------------------------
5700f07771ccSwdenk
5701f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5702f07771ccSwdenk- several commands on one line, separated by ';'
5703fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5704f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5705f07771ccSwdenk  for example:
5706fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5707f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5708f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5709f07771ccSwdenk
5710f07771ccSwdenkHush shell:
5711f07771ccSwdenk-----------
5712f07771ccSwdenk
5713f07771ccSwdenk- similar to Bourne shell, with control structures like
5714f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5715f07771ccSwdenk  until...do...done, ...
5716f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5717f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5718f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5719f07771ccSwdenk  command
5720f07771ccSwdenk
5721f07771ccSwdenkGeneral rules:
5722f07771ccSwdenk--------------
5723f07771ccSwdenk
5724f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5725f07771ccSwdenk    command) contains several commands separated by semicolon, and
5726f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5727f07771ccSwdenk    executed anyway.
5728f07771ccSwdenk
5729f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
573011ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5731f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5732f07771ccSwdenk    variables are not executed.
5733f07771ccSwdenk
5734c609719bSwdenkNote for Redundant Ethernet Interfaces:
5735c609719bSwdenk=======================================
5736c609719bSwdenk
573711ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5738c609719bSwdenksuch configurations and is capable of automatic selection of a
57397152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5740c609719bSwdenk
5741c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5742c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5743c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5744c609719bSwdenk
5745c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5746c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5747c609719bSwdenkding setting in the environment; if the corresponding environment
5748c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5749c609719bSwdenk
5750c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5751c609719bSwdenk  environment, the SROM's address is used.
5752c609719bSwdenk
5753c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5754c609719bSwdenk  environment exists, then the value from the environment variable is
5755c609719bSwdenk  used.
5756c609719bSwdenk
5757c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5758c609719bSwdenk  both addresses are the same, this MAC address is used.
5759c609719bSwdenk
5760c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5761c609719bSwdenk  addresses differ, the value from the environment is used and a
5762c609719bSwdenk  warning is printed.
5763c609719bSwdenk
5764c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5765c609719bSwdenk  is raised.
5766c609719bSwdenk
5767ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5768ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5769ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5770ecee9324SBen WarrenThe naming convention is as follows:
5771ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5772c609719bSwdenk
5773c609719bSwdenkImage Formats:
5774c609719bSwdenk==============
5775c609719bSwdenk
57763310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
57773310c549SMarian Balakowiczimages in two formats:
57783310c549SMarian Balakowicz
57793310c549SMarian BalakowiczNew uImage format (FIT)
57803310c549SMarian Balakowicz-----------------------
57813310c549SMarian Balakowicz
57823310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
57833310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
57843310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
57853310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
57863310c549SMarian Balakowicz
57873310c549SMarian Balakowicz
57883310c549SMarian BalakowiczOld uImage format
57893310c549SMarian Balakowicz-----------------
57903310c549SMarian Balakowicz
57913310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
57923310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
57933310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5794c609719bSwdenk
5795c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5796c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5797f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5798f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5799f5ed9e39SPeter Tyser  INTEGRITY).
58007b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5801afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5802afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5803c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5804c609719bSwdenk* Load Address
5805c609719bSwdenk* Entry Point
5806c609719bSwdenk* Image Name
5807c609719bSwdenk* Image Timestamp
5808c609719bSwdenk
5809c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5810c609719bSwdenkand the data portions of the image are secured against corruption by
5811c609719bSwdenkCRC32 checksums.
5812c609719bSwdenk
5813c609719bSwdenk
5814c609719bSwdenkLinux Support:
5815c609719bSwdenk==============
5816c609719bSwdenk
5817c609719bSwdenkAlthough U-Boot should support any OS or standalone application
58187152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5819c609719bSwdenkU-Boot.
5820c609719bSwdenk
5821c609719bSwdenkU-Boot includes many features that so far have been part of some
5822c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5823c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5824c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
58257152b1d0Swdenkserves several purposes:
5826c609719bSwdenk
5827c609719bSwdenk- the same features can be used for other OS or standalone
5828c609719bSwdenk  applications (for instance: using compressed images to reduce the
5829c609719bSwdenk  Flash memory footprint)
5830c609719bSwdenk
5831c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
58327152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5833c609719bSwdenk
5834c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5835c609719bSwdenk  images; of course this also means that different kernel images can
5836c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5837c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5838c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5839c609719bSwdenk  software is easier now.
5840c609719bSwdenk
5841c609719bSwdenk
5842c609719bSwdenkLinux HOWTO:
5843c609719bSwdenk============
5844c609719bSwdenk
5845c609719bSwdenkPorting Linux to U-Boot based systems:
5846c609719bSwdenk---------------------------------------
5847c609719bSwdenk
5848c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5849c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5850c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5851c609719bSwdenkLinux :-).
5852c609719bSwdenk
5853a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5854c609719bSwdenk
5855c609719bSwdenkJust make sure your machine specific header file (for instance
5856c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
58571dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
58581dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
58596d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5860c609719bSwdenk
58612eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
58622eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
58632eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
58642eb31b13SSimon Glassdoc/driver-model.
58652eb31b13SSimon Glass
5866c609719bSwdenk
5867c609719bSwdenkConfiguring the Linux kernel:
5868c609719bSwdenk-----------------------------
5869c609719bSwdenk
5870c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5871c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5872c609719bSwdenk
5873c609719bSwdenk
5874c609719bSwdenkBuilding a Linux Image:
5875c609719bSwdenk-----------------------
5876c609719bSwdenk
587724ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
587824ee89b9Swdenknot used. If you use recent kernel source, a new build target
587924ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
588024ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
588124ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
588224ee89b9Swdenk100% compatible format.
5883c609719bSwdenk
5884c609719bSwdenkExample:
5885c609719bSwdenk
5886ab584d67SHolger Freyther	make TQM850L_defconfig
5887c609719bSwdenk	make oldconfig
5888c609719bSwdenk	make dep
588924ee89b9Swdenk	make uImage
5890c609719bSwdenk
589124ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
589224ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
589324ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5894c609719bSwdenk
589524ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
589624ee89b9Swdenk
589724ee89b9Swdenk* convert the kernel into a raw binary image:
589824ee89b9Swdenk
589924ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
590024ee89b9Swdenk				 -R .note -R .comment \
590124ee89b9Swdenk				 -S vmlinux linux.bin
590224ee89b9Swdenk
590324ee89b9Swdenk* compress the binary image:
590424ee89b9Swdenk
590524ee89b9Swdenk	gzip -9 linux.bin
590624ee89b9Swdenk
590724ee89b9Swdenk* package compressed binary image for U-Boot:
590824ee89b9Swdenk
590924ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
591024ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
591124ee89b9Swdenk		-d linux.bin.gz uImage
591224ee89b9Swdenk
591324ee89b9Swdenk
591424ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
591524ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
591624ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
591724ee89b9Swdenkbyte header containing information about target architecture,
591824ee89b9Swdenkoperating system, image type, compression method, entry points, time
591924ee89b9Swdenkstamp, CRC32 checksums, etc.
592024ee89b9Swdenk
592124ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
592224ee89b9Swdenkprint the header information, or to build new images.
5923c609719bSwdenk
5924c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5925c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5926c609719bSwdenkchecksum verification:
5927c609719bSwdenk
5928c609719bSwdenk	tools/mkimage -l image
5929c609719bSwdenk	  -l ==> list image header information
5930c609719bSwdenk
5931c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5932c609719bSwdenkfrom a "data file" which is used as image payload:
5933c609719bSwdenk
5934c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5935c609719bSwdenk		      -n name -d data_file image
5936c609719bSwdenk	  -A ==> set architecture to 'arch'
5937c609719bSwdenk	  -O ==> set operating system to 'os'
5938c609719bSwdenk	  -T ==> set image type to 'type'
5939c609719bSwdenk	  -C ==> set compression type 'comp'
5940c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5941c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5942c609719bSwdenk	  -n ==> set image name to 'name'
5943c609719bSwdenk	  -d ==> use image data from 'datafile'
5944c609719bSwdenk
594569459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
594669459791Swdenkaddress (0x00000000), but the entry point address depends on the
594769459791Swdenkkernel version:
5948c609719bSwdenk
5949c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
595024ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5951c609719bSwdenk
5952c609719bSwdenkSo a typical call to build a U-Boot image would read:
5953c609719bSwdenk
595424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
595524ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5956a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
595724ee89b9Swdenk	> examples/uImage.TQM850L
595824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5959c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5960c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5961c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5962c609719bSwdenk	Load Address: 0x00000000
596324ee89b9Swdenk	Entry Point:  0x00000000
5964c609719bSwdenk
5965c609719bSwdenkTo verify the contents of the image (or check for corruption):
5966c609719bSwdenk
596724ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
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 (gzip compressed)
5971c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5972c609719bSwdenk	Load Address: 0x00000000
597324ee89b9Swdenk	Entry Point:  0x00000000
5974c609719bSwdenk
5975c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5976c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5977c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5978c609719bSwdenkneed to be uncompressed:
5979c609719bSwdenk
5980a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
598124ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
598224ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5983a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
598424ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
598524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5986c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5987c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5988c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5989c609719bSwdenk	Load Address: 0x00000000
599024ee89b9Swdenk	Entry Point:  0x00000000
5991c609719bSwdenk
5992c609719bSwdenk
5993c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5994c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5995c609719bSwdenk
5996c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5997c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5998c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5999c609719bSwdenk	Image Name:   Simple Ramdisk Image
6000c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
6001c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
6002c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
6003c609719bSwdenk	Load Address: 0x00000000
6004c609719bSwdenk	Entry Point:  0x00000000
6005c609719bSwdenk
6006a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
6007a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
6008a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
6009a804b5ceSGuilherme Maciel Ferreirafrom the image:
6010a804b5ceSGuilherme Maciel Ferreira
6011f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
6012f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
6013f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
6014f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
6015a804b5ceSGuilherme Maciel Ferreira
6016c609719bSwdenk
6017c609719bSwdenkInstalling a Linux Image:
6018c609719bSwdenk-------------------------
6019c609719bSwdenk
6020c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
6021c609719bSwdenkyou must convert the image to S-Record format:
6022c609719bSwdenk
6023c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
6024c609719bSwdenk
6025c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
6026c609719bSwdenkimage header, so the resulting S-Record file will be relative to
6027c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
6028c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
6029c609719bSwdenkcommand.
6030c609719bSwdenk
6031c609719bSwdenkExample: install the image to address 0x40100000 (which on the
6032c609719bSwdenkTQM8xxL is in the first Flash bank):
6033c609719bSwdenk
6034c609719bSwdenk	=> erase 40100000 401FFFFF
6035c609719bSwdenk
6036c609719bSwdenk	.......... done
6037c609719bSwdenk	Erased 8 sectors
6038c609719bSwdenk
6039c609719bSwdenk	=> loads 40100000
6040c609719bSwdenk	## Ready for S-Record download ...
6041c609719bSwdenk	~>examples/image.srec
6042c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
6043c609719bSwdenk	...
6044c609719bSwdenk	15989 15990 15991 15992
6045c609719bSwdenk	[file transfer complete]
6046c609719bSwdenk	[connected]
6047c609719bSwdenk	## Start Addr = 0x00000000
6048c609719bSwdenk
6049c609719bSwdenk
6050c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
6051c609719bSwdenkthis includes a checksum verification so you can be sure no data
6052c609719bSwdenkcorruption happened:
6053c609719bSwdenk
6054c609719bSwdenk	=> imi 40100000
6055c609719bSwdenk
6056c609719bSwdenk	## Checking Image at 40100000 ...
6057c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
6058c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6059c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
6060c609719bSwdenk	   Load Address: 00000000
6061c609719bSwdenk	   Entry Point:	 0000000c
6062c609719bSwdenk	   Verifying Checksum ... OK
6063c609719bSwdenk
6064c609719bSwdenk
6065c609719bSwdenkBoot Linux:
6066c609719bSwdenk-----------
6067c609719bSwdenk
6068c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
6069c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
6070c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
6071c609719bSwdenkparameters. You can check and modify this variable using the
6072c609719bSwdenk"printenv" and "setenv" commands:
6073c609719bSwdenk
6074c609719bSwdenk
6075c609719bSwdenk	=> printenv bootargs
6076c609719bSwdenk	bootargs=root=/dev/ram
6077c609719bSwdenk
6078c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6079c609719bSwdenk
6080c609719bSwdenk	=> printenv bootargs
6081c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6082c609719bSwdenk
6083c609719bSwdenk	=> bootm 40020000
6084c609719bSwdenk	## Booting Linux kernel at 40020000 ...
6085c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
6086c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6087c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
6088c609719bSwdenk	   Load Address: 00000000
6089c609719bSwdenk	   Entry Point:	 0000000c
6090c609719bSwdenk	   Verifying Checksum ... OK
6091c609719bSwdenk	   Uncompressing Kernel Image ... OK
6092c609719bSwdenk	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
6093c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
6094c609719bSwdenk	time_init: decrementer frequency = 187500000/60
6095c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
6096c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
6097c609719bSwdenk	...
6098c609719bSwdenk
609911ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
61007152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
6101c609719bSwdenkformat!) to the "bootm" command:
6102c609719bSwdenk
6103c609719bSwdenk	=> imi 40100000 40200000
6104c609719bSwdenk
6105c609719bSwdenk	## Checking Image 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
6113c609719bSwdenk	## Checking 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
6121c609719bSwdenk	=> bootm 40100000 40200000
6122c609719bSwdenk	## Booting Linux kernel at 40100000 ...
6123c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
6124c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
6125c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
6126c609719bSwdenk	   Load Address: 00000000
6127c609719bSwdenk	   Entry Point:	 0000000c
6128c609719bSwdenk	   Verifying Checksum ... OK
6129c609719bSwdenk	   Uncompressing Kernel Image ... OK
6130c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
6131c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
6132c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
6133c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
6134c609719bSwdenk	   Load Address: 00000000
6135c609719bSwdenk	   Entry Point:	 00000000
6136c609719bSwdenk	   Verifying Checksum ... OK
6137c609719bSwdenk	   Loading Ramdisk ... OK
6138c609719bSwdenk	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
6139c609719bSwdenk	Boot arguments: root=/dev/ram
6140c609719bSwdenk	time_init: decrementer frequency = 187500000/60
6141c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
6142c609719bSwdenk	...
6143c609719bSwdenk	RAMDISK: Compressed image found at block 0
6144c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
6145c609719bSwdenk
6146c609719bSwdenk	bash#
6147c609719bSwdenk
61480267768eSMatthew McClintockBoot Linux and pass a flat device tree:
61490267768eSMatthew McClintock-----------
61500267768eSMatthew McClintock
61510267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
61520267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
61530267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
61540267768eSMatthew McClintockflat device tree:
61550267768eSMatthew McClintock
61560267768eSMatthew McClintock=> print oftaddr
61570267768eSMatthew McClintockoftaddr=0x300000
61580267768eSMatthew McClintock=> print oft
61590267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
61600267768eSMatthew McClintock=> tftp $oftaddr $oft
61610267768eSMatthew McClintockSpeed: 1000, full duplex
61620267768eSMatthew McClintockUsing TSEC0 device
61630267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
61640267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
61650267768eSMatthew McClintockLoad address: 0x300000
61660267768eSMatthew McClintockLoading: #
61670267768eSMatthew McClintockdone
61680267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
61690267768eSMatthew McClintock=> tftp $loadaddr $bootfile
61700267768eSMatthew McClintockSpeed: 1000, full duplex
61710267768eSMatthew McClintockUsing TSEC0 device
61720267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
61730267768eSMatthew McClintockFilename 'uImage'.
61740267768eSMatthew McClintockLoad address: 0x200000
61750267768eSMatthew McClintockLoading:############
61760267768eSMatthew McClintockdone
61770267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
61780267768eSMatthew McClintock=> print loadaddr
61790267768eSMatthew McClintockloadaddr=200000
61800267768eSMatthew McClintock=> print oftaddr
61810267768eSMatthew McClintockoftaddr=0x300000
61820267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
61830267768eSMatthew McClintock## Booting image at 00200000 ...
61840267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
61850267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
61860267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
61870267768eSMatthew McClintock   Load Address: 00000000
61880267768eSMatthew McClintock   Entry Point:	 00000000
61890267768eSMatthew McClintock   Verifying Checksum ... OK
61900267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
61910267768eSMatthew McClintockBooting using flat device tree at 0x300000
61920267768eSMatthew McClintockUsing MPC85xx ADS machine description
61930267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
61940267768eSMatthew McClintock[snip]
61950267768eSMatthew McClintock
61960267768eSMatthew McClintock
61976069ff26SwdenkMore About U-Boot Image Types:
61986069ff26Swdenk------------------------------
61996069ff26Swdenk
62006069ff26SwdenkU-Boot supports the following image types:
62016069ff26Swdenk
62026069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
62036069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
62046069ff26Swdenk	well) you can continue to work in U-Boot after return from
62056069ff26Swdenk	the Standalone Program.
62066069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
62076069ff26Swdenk	will take over control completely. Usually these programs
62086069ff26Swdenk	will install their own set of exception handlers, device
62096069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
62106069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
62116069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
62126069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
62136069ff26Swdenk	being started.
62146069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
62156069ff26Swdenk	(Linux) kernel image and one or more data images like
62166069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
62176069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
62186069ff26Swdenk	server provides just a single image file, but you want to get
62196069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
62206069ff26Swdenk
62216069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
62226069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
62236069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
62246069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
62256069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
62266069ff26Swdenk	a multiple of 4 bytes).
62276069ff26Swdenk
62286069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
62296069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
62306069ff26Swdenk	flash memory.
62316069ff26Swdenk
62326069ff26Swdenk   "Script files" are command sequences that will be executed by
62336069ff26Swdenk	U-Boot's command interpreter; this feature is especially
62346069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
62356069ff26Swdenk	as command interpreter.
62366069ff26Swdenk
623744f074c7SMarek VasutBooting the Linux zImage:
623844f074c7SMarek Vasut-------------------------
623944f074c7SMarek Vasut
624044f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
624144f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
624244f074c7SMarek Vasutas the syntax of "bootm" command.
624344f074c7SMarek Vasut
62448ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
6245017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
6246017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
6247017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
6248017e1f3fSMarek Vasut
6249c609719bSwdenk
6250c609719bSwdenkStandalone HOWTO:
6251c609719bSwdenk=================
6252c609719bSwdenk
6253c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
6254c609719bSwdenkrun "standalone" applications, which can use some resources of
6255c609719bSwdenkU-Boot like console I/O functions or interrupt services.
6256c609719bSwdenk
6257c609719bSwdenkTwo simple examples are included with the sources:
6258c609719bSwdenk
6259c609719bSwdenk"Hello World" Demo:
6260c609719bSwdenk-------------------
6261c609719bSwdenk
6262c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
6263c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
6264c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
6265c609719bSwdenklike that:
6266c609719bSwdenk
6267c609719bSwdenk	=> loads
6268c609719bSwdenk	## Ready for S-Record download ...
6269c609719bSwdenk	~>examples/hello_world.srec
6270c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6271c609719bSwdenk	[file transfer complete]
6272c609719bSwdenk	[connected]
6273c609719bSwdenk	## Start Addr = 0x00040004
6274c609719bSwdenk
6275c609719bSwdenk	=> go 40004 Hello World! This is a test.
6276c609719bSwdenk	## Starting application at 0x00040004 ...
6277c609719bSwdenk	Hello World
6278c609719bSwdenk	argc = 7
6279c609719bSwdenk	argv[0] = "40004"
6280c609719bSwdenk	argv[1] = "Hello"
6281c609719bSwdenk	argv[2] = "World!"
6282c609719bSwdenk	argv[3] = "This"
6283c609719bSwdenk	argv[4] = "is"
6284c609719bSwdenk	argv[5] = "a"
6285c609719bSwdenk	argv[6] = "test."
6286c609719bSwdenk	argv[7] = "<NULL>"
6287c609719bSwdenk	Hit any key to exit ...
6288c609719bSwdenk
6289c609719bSwdenk	## Application terminated, rc = 0x0
6290c609719bSwdenk
6291c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
6292c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
6293c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
6294c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
6295c609719bSwdenkcharacter, but this is just a demo program. The application can be
6296c609719bSwdenkcontrolled by the following keys:
6297c609719bSwdenk
6298c609719bSwdenk	? - print current values og the CPM Timer registers
6299c609719bSwdenk	b - enable interrupts and start timer
6300c609719bSwdenk	e - stop timer and disable interrupts
6301c609719bSwdenk	q - quit application
6302c609719bSwdenk
6303c609719bSwdenk	=> loads
6304c609719bSwdenk	## Ready for S-Record download ...
6305c609719bSwdenk	~>examples/timer.srec
6306c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
6307c609719bSwdenk	[file transfer complete]
6308c609719bSwdenk	[connected]
6309c609719bSwdenk	## Start Addr = 0x00040004
6310c609719bSwdenk
6311c609719bSwdenk	=> go 40004
6312c609719bSwdenk	## Starting application at 0x00040004 ...
6313c609719bSwdenk	TIMERS=0xfff00980
6314c609719bSwdenk	Using timer 1
6315c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6316c609719bSwdenk
6317c609719bSwdenkHit 'b':
6318c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
6319c609719bSwdenk	Enabling timer
6320c609719bSwdenkHit '?':
6321c609719bSwdenk	[q, b, e, ?] ........
6322c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6323c609719bSwdenkHit '?':
6324c609719bSwdenk	[q, b, e, ?] .
6325c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6326c609719bSwdenkHit '?':
6327c609719bSwdenk	[q, b, e, ?] .
6328c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6329c609719bSwdenkHit '?':
6330c609719bSwdenk	[q, b, e, ?] .
6331c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6332c609719bSwdenkHit 'e':
6333c609719bSwdenk	[q, b, e, ?] ...Stopping timer
6334c609719bSwdenkHit 'q':
6335c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
6336c609719bSwdenk
6337c609719bSwdenk
633885ec0bccSwdenkMinicom warning:
633985ec0bccSwdenk================
634085ec0bccSwdenk
63417152b1d0SwdenkOver time, many people have reported problems when trying to use the
634285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
634385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
6344f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
634585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
6346e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
6347e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6348e53515a2SKarl O. Pincfor help with kermit.
6349e53515a2SKarl O. Pinc
635085ec0bccSwdenk
635152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
635252f52c14Swdenkconfiguration to your "File transfer protocols" section:
635352f52c14Swdenk
635452f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
635552f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
635652f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
635752f52c14Swdenk
635852f52c14Swdenk
6359c609719bSwdenkNetBSD Notes:
6360c609719bSwdenk=============
6361c609719bSwdenk
6362c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
6363c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
6364c609719bSwdenk
6365c609719bSwdenkBuilding requires a cross environment; it is known to work on
6366c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6367c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
6368c609719bSwdenkNote that the cross-powerpc package does not install include files;
6369c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
6370c609719bSwdenkmissing.  This file has to be installed and patched manually:
6371c609719bSwdenk
6372c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
6373c609719bSwdenk	# mkdir powerpc
6374c609719bSwdenk	# ln -s powerpc machine
6375c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6376c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6377c609719bSwdenk
6378c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6379c609719bSwdenkand U-Boot include files.
6380c609719bSwdenk
6381c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6382c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6383c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6384c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
63852a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6386c609719bSwdenk
6387c609719bSwdenk
6388c609719bSwdenkImplementation Internals:
6389c609719bSwdenk=========================
6390c609719bSwdenk
6391c609719bSwdenkThe following is not intended to be a complete description of every
6392c609719bSwdenkimplementation detail. However, it should help to understand the
6393c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6394c609719bSwdenkhardware.
6395c609719bSwdenk
6396c609719bSwdenk
6397c609719bSwdenkInitial Stack, Global Data:
6398c609719bSwdenk---------------------------
6399c609719bSwdenk
6400c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6401c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6402c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6403c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6404c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6405c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6406c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6407c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6408c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6409c609719bSwdenklocked as (mis-) used as memory, etc.
6410c609719bSwdenk
64117152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
64120668236bSWolfgang Denk	U-Boot mailing list:
641343d9616cSwdenk
641443d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
641543d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
641643d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
641743d9616cSwdenk	...
641843d9616cSwdenk
641943d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
642043d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
642143d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
642243d9616cSwdenk	is that the cache is being used as a temporary supply of
642343d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
642411ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
642543d9616cSwdenk	can see how this works by studying the cache architecture and
642643d9616cSwdenk	operation in the architecture and processor-specific manuals.
642743d9616cSwdenk
642843d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
642943d9616cSwdenk	is another option for the system designer to use as an
643011ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
643143d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
643243d9616cSwdenk	board designers haven't used it for something that would
643343d9616cSwdenk	cause you grief during the initial boot! It is frequently not
643443d9616cSwdenk	used.
643543d9616cSwdenk
64366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
643743d9616cSwdenk	with your processor/board/system design. The default value
643843d9616cSwdenk	you will find in any recent u-boot distribution in
64398a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
644043d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
644143d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
644243d9616cSwdenk	that are supposed to respond to that address! That code in
644343d9616cSwdenk	start.S has been around a while and should work as is when
644443d9616cSwdenk	you get the config right.
644543d9616cSwdenk
644643d9616cSwdenk	-Chris Hallinan
644743d9616cSwdenk	DS4.COM, Inc.
644843d9616cSwdenk
6449c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6450c609719bSwdenkcode for the initialization procedures:
6451c609719bSwdenk
6452c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6453c609719bSwdenk  to write it.
6454c609719bSwdenk
6455b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
6456c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
64577152b1d0Swdenk  zation is performed later (when relocating to RAM).
6458c609719bSwdenk
6459c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6460c609719bSwdenk  that.
6461c609719bSwdenk
6462c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6463b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
6464c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6465c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6466c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6467c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6468c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6469c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6470c609719bSwdenkreserve for this purpose.
6471c609719bSwdenk
64727152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6473c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6474c609719bSwdenkGCC's implementation.
6475c609719bSwdenk
6476c609719bSwdenkFor PowerPC, the following registers have specific use:
6477c609719bSwdenk	R1:	stack pointer
6478e7670f6cSWolfgang Denk	R2:	reserved for system use
6479c609719bSwdenk	R3-R4:	parameter passing and return values
6480c609719bSwdenk	R5-R10: parameter passing
6481c609719bSwdenk	R13:	small data area pointer
6482c609719bSwdenk	R30:	GOT pointer
6483c609719bSwdenk	R31:	frame pointer
6484c609719bSwdenk
6485e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6486e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6487e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6488c609719bSwdenk
6489e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6490c609719bSwdenk
6491c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6492c609719bSwdenk    address of the global data structure is known at compile time),
6493c609719bSwdenk    but it turned out that reserving a register results in somewhat
6494c609719bSwdenk    smaller code - although the code savings are not that big (on
6495c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6496c609719bSwdenk    624 text + 127 data).
6497c609719bSwdenk
6498c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
64994c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
65004c58eb55SMike Frysinger
6501c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
65024c58eb55SMike Frysinger
6503c609719bSwdenkOn ARM, the following registers are used:
6504c609719bSwdenk
6505c609719bSwdenk	R0:	function argument word/integer result
6506c609719bSwdenk	R1-R3:	function argument word
650712eba1b4SJeroen Hofstee	R9:	platform specific
650812eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6509c609719bSwdenk	R11:	argument (frame) pointer
6510c609719bSwdenk	R12:	temporary workspace
6511c609719bSwdenk	R13:	stack pointer
6512c609719bSwdenk	R14:	link register
6513c609719bSwdenk	R15:	program counter
6514c609719bSwdenk
651512eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
651612eba1b4SJeroen Hofstee
651712eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6518c609719bSwdenk
65190df01fd3SThomas ChouOn Nios II, the ABI is documented here:
65200df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
65210df01fd3SThomas Chou
65220df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
65230df01fd3SThomas Chou
65240df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
65250df01fd3SThomas Chou    to access small data sections, so gp is free.
65260df01fd3SThomas Chou
6527afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6528afc1ce82SMacpaul Lin
6529afc1ce82SMacpaul Lin	R0-R1:	argument/return
6530afc1ce82SMacpaul Lin	R2-R5:	argument
6531afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6532afc1ce82SMacpaul Lin	R16:	trampoline register
6533afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6534afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6535afc1ce82SMacpaul Lin	R30:	link register (LP)
6536afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6537afc1ce82SMacpaul Lin	PC:	program counter (PC)
6538afc1ce82SMacpaul Lin
6539afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6540afc1ce82SMacpaul Lin
6541d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6542d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6543c609719bSwdenk
6544c609719bSwdenkMemory Management:
6545c609719bSwdenk------------------
6546c609719bSwdenk
6547c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6548c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6549c609719bSwdenk
6550c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6551c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6552c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6553c609719bSwdenkphysical memory banks.
6554c609719bSwdenk
6555c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6556c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6557c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6558c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
65596d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6560c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6561c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6562c609719bSwdenk
6563c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6564c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6565c609719bSwdenk
6566c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6567c609719bSwdenkthis:
6568c609719bSwdenk
6569c609719bSwdenk	0x0000 0000	Exception Vector code
6570c609719bSwdenk	      :
6571c609719bSwdenk	0x0000 1FFF
6572c609719bSwdenk	0x0000 2000	Free for Application Use
6573c609719bSwdenk	      :
6574c609719bSwdenk	      :
6575c609719bSwdenk
6576c609719bSwdenk	      :
6577c609719bSwdenk	      :
6578c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6579c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6580c609719bSwdenk	0x00FC 0000	Malloc Arena
6581c609719bSwdenk	      :
6582c609719bSwdenk	0x00FD FFFF
6583c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6584c609719bSwdenk	...		eventually: LCD or video framebuffer
6585c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6586c609719bSwdenk	0x00FF FFFF	[End of RAM]
6587c609719bSwdenk
6588c609719bSwdenk
6589c609719bSwdenkSystem Initialization:
6590c609719bSwdenk----------------------
6591c609719bSwdenk
6592c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
659311ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6594c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
65957152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6596c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6597c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6598c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6599c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6600c609719bSwdenkthe caches and the SIU.
6601c609719bSwdenk
6602c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6603c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6604c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6605c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6606c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6607c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6608c609719bSwdenkbanks.
6609c609719bSwdenk
6610c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
66117152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6612c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6613c609719bSwdenk0x00000000, with any additional banks following immediately to create
6614c609719bSwdenkcontiguous memory starting from 0.
6615c609719bSwdenk
6616c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6617c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6618c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6619c609719bSwdenkpages, and the final stack is set up.
6620c609719bSwdenk
6621c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6622c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6623c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6624c609719bSwdenknew address in RAM.
6625c609719bSwdenk
6626c609719bSwdenk
6627c609719bSwdenkU-Boot Porting Guide:
6628c609719bSwdenk----------------------
6629c609719bSwdenk
6630c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
66316aff3115Swdenklist, October 2002]
6632c609719bSwdenk
6633c609719bSwdenk
6634c609719bSwdenkint main(int argc, char *argv[])
6635c609719bSwdenk{
6636c609719bSwdenk	sighandler_t no_more_time;
6637c609719bSwdenk
6638c609719bSwdenk	signal(SIGALRM, no_more_time);
6639c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6640c609719bSwdenk
6641c609719bSwdenk	if (available_money > available_manpower) {
66426c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6643c609719bSwdenk		return 0;
6644c609719bSwdenk	}
6645c609719bSwdenk
6646c609719bSwdenk	Download latest U-Boot source;
6647c609719bSwdenk
66480668236bSWolfgang Denk	Subscribe to u-boot mailing list;
66496aff3115Swdenk
66506c3fef28SJerry Van Baren	if (clueless)
6651c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6652c609719bSwdenk
6653c609719bSwdenk	while (learning) {
6654c609719bSwdenk		Read the README file in the top level directory;
66557cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
66566c3fef28SJerry Van Baren		Read applicable doc/*.README;
6657c609719bSwdenk		Read the source, Luke;
66586c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6659c609719bSwdenk	}
6660c609719bSwdenk
66616c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
66626c3fef28SJerry Van Baren		Buy a BDI3000;
66636c3fef28SJerry Van Baren	else
6664c609719bSwdenk		Add a lot of aggravation and time;
6665c609719bSwdenk
66666c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
66676c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
66686c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
66696c3fef28SJerry Van Baren	} else {
6670c609719bSwdenk		Create your own board support subdirectory;
66716c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
66726c3fef28SJerry Van Baren	}
66736c3fef28SJerry Van Baren	Edit new board/<myboard> files
66746c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6675c609719bSwdenk
66766c3fef28SJerry Van Baren	while (!accepted) {
6677c609719bSwdenk		while (!running) {
6678c609719bSwdenk			do {
6679c609719bSwdenk				Add / modify source code;
6680c609719bSwdenk			} until (compiles);
6681c609719bSwdenk			Debug;
6682c609719bSwdenk			if (clueless)
6683c609719bSwdenk				email("Hi, I am having problems...");
6684c609719bSwdenk		}
66856c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
66866c3fef28SJerry Van Baren		if (reasonable critiques)
66876c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
66886c3fef28SJerry Van Baren		else
66896c3fef28SJerry Van Baren			Defend code as written;
66906c3fef28SJerry Van Baren	}
6691c609719bSwdenk
6692c609719bSwdenk	return 0;
6693c609719bSwdenk}
6694c609719bSwdenk
6695c609719bSwdenkvoid no_more_time (int sig)
6696c609719bSwdenk{
6697c609719bSwdenk      hire_a_guru();
6698c609719bSwdenk}
6699c609719bSwdenk
6700c609719bSwdenk
6701c609719bSwdenkCoding Standards:
6702c609719bSwdenk-----------------
6703c609719bSwdenk
6704c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
67052c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
67067ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6707c609719bSwdenk
67082c051651SDetlev ZundelSource files originating from a different project (for example the
67092c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
6710b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
67112c051651SDetlev Zundelsources.
67122c051651SDetlev Zundel
67132c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
67142c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
67152c051651SDetlev Zundelin your code.
6716c609719bSwdenk
6717c178d3daSwdenkPlease also stick to the following formatting rules:
6718180d3f74Swdenk- remove any trailing white space
67197ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6720180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
67217ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6722180d3f74Swdenk- do not add trailing empty lines to source files
6723180d3f74Swdenk
6724c609719bSwdenkSubmissions which do not conform to the standards may be returned
6725c609719bSwdenkwith a request to reformat the changes.
6726c609719bSwdenk
6727c609719bSwdenk
6728c609719bSwdenkSubmitting Patches:
6729c609719bSwdenk-------------------
6730c609719bSwdenk
6731c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6732c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6733c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6734c609719bSwdenk
67350d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6736218ca724SWolfgang Denk
67370668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
67380668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
67390668236bSWolfgang Denk
6740c609719bSwdenkWhen you send a patch, please include the following information with
6741c609719bSwdenkit:
6742c609719bSwdenk
6743c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6744c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6745c609719bSwdenk  patch actually fixes something.
6746c609719bSwdenk
6747c609719bSwdenk* For new features: a description of the feature and your
6748c609719bSwdenk  implementation.
6749c609719bSwdenk
6750c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6751c609719bSwdenk
6752c609719bSwdenk* For major contributions, your entry to the CREDITS file
6753c609719bSwdenk
675427af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
675527af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6756c609719bSwdenk
6757c609719bSwdenk* If your patch adds new configuration options, don't forget to
6758c609719bSwdenk  document these in the README file.
6759c609719bSwdenk
6760218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6761218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
67627ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6763218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6764218ca724SWolfgang Denk  with some other mail clients.
6765c609719bSwdenk
6766218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6767218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6768218ca724SWolfgang Denk  GNU diff.
67696dff5529Swdenk
6770218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6771218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6772218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6773218ca724SWolfgang Denk  affected files).
6774218ca724SWolfgang Denk
6775218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6776218ca724SWolfgang Denk  and compressed attachments must not be used.
6777c609719bSwdenk
677852f52c14Swdenk* If one logical set of modifications affects or creates several
677952f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
678052f52c14Swdenk
678152f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
678252f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
678352f52c14Swdenk
678452f52c14Swdenk
6785c609719bSwdenkNotes:
6786c609719bSwdenk
6787c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6788c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6789c609719bSwdenk  for any of the boards.
6790c609719bSwdenk
6791c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6792c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6793c609719bSwdenk  returned with a request to re-formatting / split it.
6794c609719bSwdenk
6795c609719bSwdenk* If you modify existing code, make sure that your new code does not
6796c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6797c609719bSwdenk  When adding new features, these should compile conditionally only
6798c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6799c609719bSwdenk  disabled must not need more memory than the old code without your
6800c609719bSwdenk  modification.
680190dc6704Swdenk
68020668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
68030668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
68040668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
68050668236bSWolfgang Denk  bigger than the size limit should be avoided.
6806