• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

.github/H06-Jul-2020-43

Licenses/H03-May-2022-170126

api/H06-Jul-2020-1,497865

arch/H06-Jul-2020-988,075795,779

board/H06-Jul-2020-429,754288,503

cmd/H06-Jul-2020-53,17139,510

common/H06-Jul-2020-48,81134,515

configs/H06-Jul-2020-88,90987,500

disk/H06-Jul-2020-3,6992,688

doc/H03-May-2022-36,63927,344

drivers/H06-Jul-2020-905,890662,541

dts/H06-Jul-2020-450374

env/H06-Jul-2020-5,1583,774

examples/H06-Jul-2020-3,3832,378

fs/H06-Jul-2020-67,81845,649

include/H06-Jul-2020-293,967181,048

lib/H06-Jul-2020-95,96568,348

net/H06-Jul-2020-8,8386,208

post/H06-Jul-2020-6,3404,670

scripts/H03-May-2022-52,61638,485

test/H06-Jul-2020-30,13821,502

tools/H03-May-2022-79,42758,853

.azure-pipelines.ymlH A D06-Jul-202015.6 KiB446432

.checkpatch.confH A D06-Jul-2020720 3411

.gitattributesH A D06-Jul-2020169 65

.gitignoreH A D06-Jul-2020911 9582

.gitlab-ci.ymlH A D06-Jul-20209.5 KiB351309

.mailmapH A D06-Jul-20202.1 KiB5149

.readthedocs.ymlH A D06-Jul-2020502 2015

.travis.ymlH A D06-Jul-202022.8 KiB641626

KbuildH A D06-Jul-2020737 3020

KconfigH A D06-Jul-202022.2 KiB650560

MAINTAINERSH A D06-Jul-202026.9 KiB1,032928

MakefileH A D03-May-202275.3 KiB2,2701,636

READMEH A D06-Jul-2020164.1 KiB4,7353,646

config.mkH A D06-Jul-20202.1 KiB7949

README

1# SPDX-License-Identifier: GPL-2.0+
2#
3# (C) Copyright 2000 - 2013
4# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5
6Summary:
7========
8
9This directory contains the source code for U-Boot, a boot loader for
10Embedded boards based on PowerPC, ARM, MIPS and several other
11processors, which can be installed in a boot ROM and used to
12initialize and test the hardware or to download and run application
13code.
14
15The development of U-Boot is closely related to Linux: some parts of
16the source code originate in the Linux source tree, we have some
17header files in common, and special provision has been made to
18support booting of Linux images.
19
20Some attention has been paid to make this software easily
21configurable and extendable. For instance, all monitor commands are
22implemented with the same call interface, so that it's very easy to
23add new commands. Also, instead of permanently adding rarely used
24code (for instance hardware test utilities) to the monitor, you can
25load and run it dynamically.
26
27
28Status:
29=======
30
31In general, all boards for which a configuration option exists in the
32Makefile have been tested to some extent and can be considered
33"working". In fact, many of them are used in production systems.
34
35In case of problems see the CHANGELOG file to find out who contributed
36the specific port. In addition, there are various MAINTAINERS files
37scattered throughout the U-Boot source identifying the people or
38companies responsible for various boards and subsystems.
39
40Note: As of August, 2010, there is no longer a CHANGELOG file in the
41actual U-Boot source tree; however, it can be created dynamically
42from the Git log using:
43
44	make CHANGELOG
45
46
47Where to get help:
48==================
49
50In case you have questions about, problems with or contributions for
51U-Boot, you should send a message to the U-Boot mailing list at
52<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56
57
58Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the Git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
66any version you might be interested in. Official releases are also
67available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
70Pre-built (and tested) images are available from
71ftp://ftp.denx.de/pub/u-boot/images/
72
73
74Where we come from:
75===================
76
77- start from 8xxrom sources
78- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83  * Provide extended interface to Linux boot loader
84  * S-Record download
85  * network boot
86  * ATA disk / SCSI ... boot
87- create ARMBoot project (http://sourceforge.net/projects/armboot)
88- add other CPU families (starting with ARM)
89- create U-Boot project (http://sourceforge.net/projects/u-boot)
90- current project page: see http://www.denx.de/wiki/U-Boot
91
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100	This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104	include/asm-ppc/u-boot.h
105
106	#include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111	U_BOOT_VERSION		u_boot_logo
112	IH_OS_U_BOOT		u_boot_hush_start
113
114
115Versioning:
116===========
117
118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
124
125Examples:
126	U-Boot v2009.11	    - Release November 2009
127	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128	U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
129
130
131Directory Hierarchy:
132====================
133
134/arch			Architecture specific files
135  /arc			Files generic to ARC architecture
136  /arm			Files generic to ARM architecture
137  /m68k			Files generic to m68k architecture
138  /microblaze		Files generic to microblaze architecture
139  /mips			Files generic to MIPS architecture
140  /nds32		Files generic to NDS32 architecture
141  /nios2		Files generic to Altera NIOS2 architecture
142  /openrisc		Files generic to OpenRISC architecture
143  /powerpc		Files generic to PowerPC architecture
144  /riscv		Files generic to RISC-V architecture
145  /sandbox		Files generic to HW-independent "sandbox"
146  /sh			Files generic to SH architecture
147  /x86			Files generic to x86 architecture
148/api			Machine/arch independent API for external apps
149/board			Board dependent files
150/cmd			U-Boot commands functions
151/common			Misc architecture independent functions
152/configs		Board default configuration files
153/disk			Code for disk drive partition handling
154/doc			Documentation (don't expect too much)
155/drivers		Commonly used device drivers
156/dts			Contains Makefile for building internal U-Boot fdt.
157/examples		Example code for standalone applications, etc.
158/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
159/include		Header Files
160/lib			Library routines generic to all architectures
161/Licenses		Various license files
162/net			Networking code
163/post			Power On Self Test
164/scripts		Various build scripts and Makefiles
165/test			Various unit test files
166/tools			Tools to build S-Record or U-Boot images, etc.
167
168Software Configuration:
169=======================
170
171Configuration is usually done using C preprocessor defines; the
172rationale behind that is to avoid dead code whenever possible.
173
174There are two classes of configuration variables:
175
176* Configuration _OPTIONS_:
177  These are selectable by the user and have names beginning with
178  "CONFIG_".
179
180* Configuration _SETTINGS_:
181  These depend on the hardware etc. and should not be meddled with if
182  you don't know what you're doing; they have names beginning with
183  "CONFIG_SYS_".
184
185Previously, all configuration was done by hand, which involved creating
186symbolic links and editing configuration files manually. More recently,
187U-Boot has added the Kbuild infrastructure used by the Linux kernel,
188allowing you to use the "make menuconfig" command to configure your
189build.
190
191
192Selection of Processor Architecture and Board Type:
193---------------------------------------------------
194
195For all supported boards there are ready-to-use default
196configurations available; just type "make <board_name>_defconfig".
197
198Example: For a TQM823L module type:
199
200	cd u-boot
201	make TQM823L_defconfig
202
203Note: If you're looking for the default configuration file for a board
204you're sure used to be there but is now missing, check the file
205doc/README.scrapyard for a list of no longer supported boards.
206
207Sandbox Environment:
208--------------------
209
210U-Boot can be built natively to run on a Linux host using the 'sandbox'
211board. This allows feature development which is not board- or architecture-
212specific to be undertaken on a native platform. The sandbox is also used to
213run some of U-Boot's tests.
214
215See doc/arch/index.rst for more details.
216
217
218Board Initialisation Flow:
219--------------------------
220
221This is the intended start-up flow for boards. This should apply for both
222SPL and U-Boot proper (i.e. they both follow the same rules).
223
224Note: "SPL" stands for "Secondary Program Loader," which is explained in
225more detail later in this file.
226
227At present, SPL mostly uses a separate code path, but the function names
228and roles of each function are the same. Some boards or architectures
229may not conform to this.  At least most ARM boards which use
230CONFIG_SPL_FRAMEWORK conform to this.
231
232Execution typically starts with an architecture-specific (and possibly
233CPU-specific) start.S file, such as:
234
235	- arch/arm/cpu/armv7/start.S
236	- arch/powerpc/cpu/mpc83xx/start.S
237	- arch/mips/cpu/start.S
238
239and so on. From there, three functions are called; the purpose and
240limitations of each of these functions are described below.
241
242lowlevel_init():
243	- purpose: essential init to permit execution to reach board_init_f()
244	- no global_data or BSS
245	- there is no stack (ARMv7 may have one but it will soon be removed)
246	- must not set up SDRAM or use console
247	- must only do the bare minimum to allow execution to continue to
248		board_init_f()
249	- this is almost never needed
250	- return normally from this function
251
252board_init_f():
253	- purpose: set up the machine ready for running board_init_r():
254		i.e. SDRAM and serial UART
255	- global_data is available
256	- stack is in SRAM
257	- BSS is not available, so you cannot use global/static variables,
258		only stack variables and global_data
259
260	Non-SPL-specific notes:
261	- dram_init() is called to set up DRAM. If already done in SPL this
262		can do nothing
263
264	SPL-specific notes:
265	- you can override the entire board_init_f() function with your own
266		version as needed.
267	- preloader_console_init() can be called here in extremis
268	- should set up SDRAM, and anything needed to make the UART work
269	- these is no need to clear BSS, it will be done by crt0.S
270	- for specific scenarios on certain architectures an early BSS *can*
271	  be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
272	  of BSS prior to entering board_init_f()) but doing so is discouraged.
273	  Instead it is strongly recommended to architect any code changes
274	  or additions such to not depend on the availability of BSS during
275	  board_init_f() as indicated in other sections of this README to
276	  maintain compatibility and consistency across the entire code base.
277	- must return normally from this function (don't call board_init_r()
278		directly)
279
280Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
281this point the stack and global_data are relocated to below
282CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
283memory.
284
285board_init_r():
286	- purpose: main execution, common code
287	- global_data is available
288	- SDRAM is available
289	- BSS is available, all static/global variables can be used
290	- execution eventually continues to main_loop()
291
292	Non-SPL-specific notes:
293	- U-Boot is relocated to the top of memory and is now running from
294		there.
295
296	SPL-specific notes:
297	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
298		CONFIG_SPL_STACK_R_ADDR points into SDRAM
299	- preloader_console_init() can be called here - typically this is
300		done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
301		spl_board_init() function containing this call
302	- loads U-Boot or (in falcon mode) Linux
303
304
305
306Configuration Options:
307----------------------
308
309Configuration depends on the combination of board and CPU type; all
310such information is kept in a configuration file
311"include/configs/<board_name>.h".
312
313Example: For a TQM823L module, all configuration settings are in
314"include/configs/TQM823L.h".
315
316
317Many of the options are named exactly as the corresponding Linux
318kernel configuration options. The intention is to make it easier to
319build a config tool - later.
320
321- ARM Platform Bus Type(CCI):
322		CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
323		provides full cache coherency between two clusters of multi-core
324		CPUs and I/O coherency for devices and I/O masters
325
326		CONFIG_SYS_FSL_HAS_CCI400
327
328		Defined For SoC that has cache coherent interconnect
329		CCN-400
330
331		CONFIG_SYS_FSL_HAS_CCN504
332
333		Defined for SoC that has cache coherent interconnect CCN-504
334
335The following options need to be configured:
336
337- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
338
339- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
340
341- 85xx CPU Options:
342		CONFIG_SYS_PPC64
343
344		Specifies that the core is a 64-bit PowerPC implementation (implements
345		the "64" category of the Power ISA). This is necessary for ePAPR
346		compliance, among other possible reasons.
347
348		CONFIG_SYS_FSL_TBCLK_DIV
349
350		Defines the core time base clock divider ratio compared to the
351		system clock.  On most PQ3 devices this is 8, on newer QorIQ
352		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
353
354		CONFIG_SYS_FSL_PCIE_COMPAT
355
356		Defines the string to utilize when trying to match PCIe device
357		tree nodes for the given platform.
358
359		CONFIG_SYS_FSL_ERRATUM_A004510
360
361		Enables a workaround for erratum A004510.  If set,
362		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
363		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
364
365		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
366		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
367
368		Defines one or two SoC revisions (low 8 bits of SVR)
369		for which the A004510 workaround should be applied.
370
371		The rest of SVR is either not relevant to the decision
372		of whether the erratum is present (e.g. p2040 versus
373		p2041) or is implied by the build target, which controls
374		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
375
376		See Freescale App Note 4493 for more information about
377		this erratum.
378
379		CONFIG_A003399_NOR_WORKAROUND
380		Enables a workaround for IFC erratum A003399. It is only
381		required during NOR boot.
382
383		CONFIG_A008044_WORKAROUND
384		Enables a workaround for T1040/T1042 erratum A008044. It is only
385		required during NAND boot and valid for Rev 1.0 SoC revision
386
387		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
388
389		This is the value to write into CCSR offset 0x18600
390		according to the A004510 workaround.
391
392		CONFIG_SYS_FSL_DSP_DDR_ADDR
393		This value denotes start offset of DDR memory which is
394		connected exclusively to the DSP cores.
395
396		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
397		This value denotes start offset of M2 memory
398		which is directly connected to the DSP core.
399
400		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
401		This value denotes start offset of M3 memory which is directly
402		connected to the DSP core.
403
404		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
405		This value denotes start offset of DSP CCSR space.
406
407		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
408		Single Source Clock is clocking mode present in some of FSL SoC's.
409		In this mode, a single differential clock is used to supply
410		clocks to the sysclock, ddrclock and usbclock.
411
412		CONFIG_SYS_CPC_REINIT_F
413		This CONFIG is defined when the CPC is configured as SRAM at the
414		time of U-Boot entry and is required to be re-initialized.
415
416		CONFIG_DEEP_SLEEP
417		Indicates this SoC supports deep sleep feature. If deep sleep is
418		supported, core will start to execute uboot when wakes up.
419
420- Generic CPU options:
421		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
422
423		Defines the endianess of the CPU. Implementation of those
424		values is arch specific.
425
426		CONFIG_SYS_FSL_DDR
427		Freescale DDR driver in use. This type of DDR controller is
428		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
429		SoCs.
430
431		CONFIG_SYS_FSL_DDR_ADDR
432		Freescale DDR memory-mapped register base.
433
434		CONFIG_SYS_FSL_DDR_EMU
435		Specify emulator support for DDR. Some DDR features such as
436		deskew training are not available.
437
438		CONFIG_SYS_FSL_DDRC_GEN1
439		Freescale DDR1 controller.
440
441		CONFIG_SYS_FSL_DDRC_GEN2
442		Freescale DDR2 controller.
443
444		CONFIG_SYS_FSL_DDRC_GEN3
445		Freescale DDR3 controller.
446
447		CONFIG_SYS_FSL_DDRC_GEN4
448		Freescale DDR4 controller.
449
450		CONFIG_SYS_FSL_DDRC_ARM_GEN3
451		Freescale DDR3 controller for ARM-based SoCs.
452
453		CONFIG_SYS_FSL_DDR1
454		Board config to use DDR1. It can be enabled for SoCs with
455		Freescale DDR1 or DDR2 controllers, depending on the board
456		implemetation.
457
458		CONFIG_SYS_FSL_DDR2
459		Board config to use DDR2. It can be enabled for SoCs with
460		Freescale DDR2 or DDR3 controllers, depending on the board
461		implementation.
462
463		CONFIG_SYS_FSL_DDR3
464		Board config to use DDR3. It can be enabled for SoCs with
465		Freescale DDR3 or DDR3L controllers.
466
467		CONFIG_SYS_FSL_DDR3L
468		Board config to use DDR3L. It can be enabled for SoCs with
469		DDR3L controllers.
470
471		CONFIG_SYS_FSL_DDR4
472		Board config to use DDR4. It can be enabled for SoCs with
473		DDR4 controllers.
474
475		CONFIG_SYS_FSL_IFC_BE
476		Defines the IFC controller register space as Big Endian
477
478		CONFIG_SYS_FSL_IFC_LE
479		Defines the IFC controller register space as Little Endian
480
481		CONFIG_SYS_FSL_IFC_CLK_DIV
482		Defines divider of platform clock(clock input to IFC controller).
483
484		CONFIG_SYS_FSL_LBC_CLK_DIV
485		Defines divider of platform clock(clock input to eLBC controller).
486
487		CONFIG_SYS_FSL_PBL_PBI
488		It enables addition of RCW (Power on reset configuration) in built image.
489		Please refer doc/README.pblimage for more details
490
491		CONFIG_SYS_FSL_PBL_RCW
492		It adds PBI(pre-boot instructions) commands in u-boot build image.
493		PBI commands can be used to configure SoC before it starts the execution.
494		Please refer doc/README.pblimage for more details
495
496		CONFIG_SYS_FSL_DDR_BE
497		Defines the DDR controller register space as Big Endian
498
499		CONFIG_SYS_FSL_DDR_LE
500		Defines the DDR controller register space as Little Endian
501
502		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
503		Physical address from the view of DDR controllers. It is the
504		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
505		it could be different for ARM SoCs.
506
507		CONFIG_SYS_FSL_DDR_INTLV_256B
508		DDR controller interleaving on 256-byte. This is a special
509		interleaving mode, handled by Dickens for Freescale layerscape
510		SoCs with ARM core.
511
512		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
513		Number of controllers used as main memory.
514
515		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
516		Number of controllers used for other than main memory.
517
518		CONFIG_SYS_FSL_HAS_DP_DDR
519		Defines the SoC has DP-DDR used for DPAA.
520
521		CONFIG_SYS_FSL_SEC_BE
522		Defines the SEC controller register space as Big Endian
523
524		CONFIG_SYS_FSL_SEC_LE
525		Defines the SEC controller register space as Little Endian
526
527- MIPS CPU options:
528		CONFIG_SYS_INIT_SP_OFFSET
529
530		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
531		pointer. This is needed for the temporary stack before
532		relocation.
533
534		CONFIG_XWAY_SWAP_BYTES
535
536		Enable compilation of tools/xway-swap-bytes needed for Lantiq
537		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
538		be swapped if a flash programmer is used.
539
540- ARM options:
541		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
542
543		Select high exception vectors of the ARM core, e.g., do not
544		clear the V bit of the c1 register of CP15.
545
546		COUNTER_FREQUENCY
547		Generic timer clock source frequency.
548
549		COUNTER_FREQUENCY_REAL
550		Generic timer clock source frequency if the real clock is
551		different from COUNTER_FREQUENCY, and can only be determined
552		at run time.
553
554- Tegra SoC options:
555		CONFIG_TEGRA_SUPPORT_NON_SECURE
556
557		Support executing U-Boot in non-secure (NS) mode. Certain
558		impossible actions will be skipped if the CPU is in NS mode,
559		such as ARM architectural timer initialization.
560
561- Linux Kernel Interface:
562		CONFIG_CLOCKS_IN_MHZ
563
564		U-Boot stores all clock information in Hz
565		internally. For binary compatibility with older Linux
566		kernels (which expect the clocks passed in the
567		bd_info data to be in MHz) the environment variable
568		"clocks_in_mhz" can be defined so that U-Boot
569		converts clock data to MHZ before passing it to the
570		Linux kernel.
571		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
572		"clocks_in_mhz=1" is automatically included in the
573		default environment.
574
575		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
576
577		When transferring memsize parameter to Linux, some versions
578		expect it to be in bytes, others in MB.
579		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
580
581		CONFIG_OF_LIBFDT
582
583		New kernel versions are expecting firmware settings to be
584		passed using flattened device trees (based on open firmware
585		concepts).
586
587		CONFIG_OF_LIBFDT
588		 * New libfdt-based support
589		 * Adds the "fdt" command
590		 * The bootm command automatically updates the fdt
591
592		OF_TBCLK - The timebase frequency.
593		OF_STDOUT_PATH - The path to the console device
594
595		boards with QUICC Engines require OF_QE to set UCC MAC
596		addresses
597
598		CONFIG_OF_BOARD_SETUP
599
600		Board code has addition modification that it wants to make
601		to the flat device tree before handing it off to the kernel
602
603		CONFIG_OF_SYSTEM_SETUP
604
605		Other code has addition modification that it wants to make
606		to the flat device tree before handing it off to the kernel.
607		This causes ft_system_setup() to be called before booting
608		the kernel.
609
610		CONFIG_OF_IDE_FIXUP
611
612		U-Boot can detect if an IDE device is present or not.
613		If not, and this new config option is activated, U-Boot
614		removes the ATA node from the DTS before booting Linux,
615		so the Linux IDE driver does not probe the device and
616		crash. This is needed for buggy hardware (uc101) where
617		no pull down resistor is connected to the signal IDE5V_DD7.
618
619		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
620
621		This setting is mandatory for all boards that have only one
622		machine type and must be used to specify the machine type
623		number as it appears in the ARM machine registry
624		(see http://www.arm.linux.org.uk/developer/machines/).
625		Only boards that have multiple machine types supported
626		in a single configuration file and the machine type is
627		runtime discoverable, do not have to use this setting.
628
629- vxWorks boot parameters:
630
631		bootvx constructs a valid bootline using the following
632		environments variables: bootdev, bootfile, ipaddr, netmask,
633		serverip, gatewayip, hostname, othbootargs.
634		It loads the vxWorks image pointed bootfile.
635
636		Note: If a "bootargs" environment is defined, it will overwride
637		the defaults discussed just above.
638
639- Cache Configuration:
640		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
641
642- Cache Configuration for ARM:
643		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
644				      controller
645		CONFIG_SYS_PL310_BASE - Physical base address of PL310
646					controller register space
647
648- Serial Ports:
649		CONFIG_PL010_SERIAL
650
651		Define this if you want support for Amba PrimeCell PL010 UARTs.
652
653		CONFIG_PL011_SERIAL
654
655		Define this if you want support for Amba PrimeCell PL011 UARTs.
656
657		CONFIG_PL011_CLOCK
658
659		If you have Amba PrimeCell PL011 UARTs, set this variable to
660		the clock speed of the UARTs.
661
662		CONFIG_PL01x_PORTS
663
664		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
665		define this to a list of base addresses for each (supported)
666		port. See e.g. include/configs/versatile.h
667
668		CONFIG_SERIAL_HW_FLOW_CONTROL
669
670		Define this variable to enable hw flow control in serial driver.
671		Current user of this option is drivers/serial/nsl16550.c driver
672
673- Console Baudrate:
674		CONFIG_BAUDRATE - in bps
675		Select one of the baudrates listed in
676		CONFIG_SYS_BAUDRATE_TABLE, see below.
677
678- Autoboot Command:
679		CONFIG_BOOTCOMMAND
680		Only needed when CONFIG_BOOTDELAY is enabled;
681		define a command string that is automatically executed
682		when no character is read on the console interface
683		within "Boot Delay" after reset.
684
685		CONFIG_RAMBOOT and CONFIG_NFSBOOT
686		The value of these goes into the environment as
687		"ramboot" and "nfsboot" respectively, and can be used
688		as a convenience, when switching between booting from
689		RAM and NFS.
690
691- Serial Download Echo Mode:
692		CONFIG_LOADS_ECHO
693		If defined to 1, all characters received during a
694		serial download (using the "loads" command) are
695		echoed back. This might be needed by some terminal
696		emulations (like "cu"), but may as well just take
697		time on others. This setting #define's the initial
698		value of the "loads_echo" environment variable.
699
700- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
701		CONFIG_KGDB_BAUDRATE
702		Select one of the baudrates listed in
703		CONFIG_SYS_BAUDRATE_TABLE, see below.
704
705- Removal of commands
706		If no commands are needed to boot, you can disable
707		CONFIG_CMDLINE to remove them. In this case, the command line
708		will not be available, and when U-Boot wants to execute the
709		boot command (on start-up) it will call board_run_command()
710		instead. This can reduce image size significantly for very
711		simple boot procedures.
712
713- Regular expression support:
714		CONFIG_REGEX
715		If this variable is defined, U-Boot is linked against
716		the SLRE (Super Light Regular Expression) library,
717		which adds regex support to some commands, as for
718		example "env grep" and "setexpr".
719
720- Device tree:
721		CONFIG_OF_CONTROL
722		If this variable is defined, U-Boot will use a device tree
723		to configure its devices, instead of relying on statically
724		compiled #defines in the board file. This option is
725		experimental and only available on a few boards. The device
726		tree is available in the global data as gd->fdt_blob.
727
728		U-Boot needs to get its device tree from somewhere. This can
729		be done using one of the three options below:
730
731		CONFIG_OF_EMBED
732		If this variable is defined, U-Boot will embed a device tree
733		binary in its image. This device tree file should be in the
734		board directory and called <soc>-<board>.dts. The binary file
735		is then picked up in board_init_f() and made available through
736		the global data structure as gd->fdt_blob.
737
738		CONFIG_OF_SEPARATE
739		If this variable is defined, U-Boot will build a device tree
740		binary. It will be called u-boot.dtb. Architecture-specific
741		code will locate it at run-time. Generally this works by:
742
743			cat u-boot.bin u-boot.dtb >image.bin
744
745		and in fact, U-Boot does this for you, creating a file called
746		u-boot-dtb.bin which is useful in the common case. You can
747		still use the individual files if you need something more
748		exotic.
749
750		CONFIG_OF_BOARD
751		If this variable is defined, U-Boot will use the device tree
752		provided by the board at runtime instead of embedding one with
753		the image. Only boards defining board_fdt_blob_setup() support
754		this option (see include/fdtdec.h file).
755
756- Watchdog:
757		CONFIG_WATCHDOG
758		If this variable is defined, it enables watchdog
759		support for the SoC. There must be support in the SoC
760		specific code for a watchdog. For the 8xx
761		CPUs, the SIU Watchdog feature is enabled in the SYPCR
762		register.  When supported for a specific SoC is
763		available, then no further board specific code should
764		be needed to use it.
765
766		CONFIG_HW_WATCHDOG
767		When using a watchdog circuitry external to the used
768		SoC, then define this variable and provide board
769		specific code for the "hw_watchdog_reset" function.
770
771- Real-Time Clock:
772
773		When CONFIG_CMD_DATE is selected, the type of the RTC
774		has to be selected, too. Define exactly one of the
775		following options:
776
777		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
778		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
779		CONFIG_RTC_MC146818	- use MC146818 RTC
780		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
781		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
782		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
783		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
784		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
785		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
786		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
787		CONFIG_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
788		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
789					  RV3029 RTC.
790
791		Note that if the RTC uses I2C, then the I2C interface
792		must also be configured. See I2C Support, below.
793
794- GPIO Support:
795		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
796
797		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
798		chip-ngpio pairs that tell the PCA953X driver the number of
799		pins supported by a particular chip.
800
801		Note that if the GPIO device uses I2C, then the I2C interface
802		must also be configured. See I2C Support, below.
803
804- I/O tracing:
805		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
806		accesses and can checksum them or write a list of them out
807		to memory. See the 'iotrace' command for details. This is
808		useful for testing device drivers since it can confirm that
809		the driver behaves the same way before and after a code
810		change. Currently this is supported on sandbox and arm. To
811		add support for your architecture, add '#include <iotrace.h>'
812		to the bottom of arch/<arch>/include/asm/io.h and test.
813
814		Example output from the 'iotrace stats' command is below.
815		Note that if the trace buffer is exhausted, the checksum will
816		still continue to operate.
817
818			iotrace is enabled
819			Start:  10000000	(buffer start address)
820			Size:   00010000	(buffer size)
821			Offset: 00000120	(current buffer offset)
822			Output: 10000120	(start + offset)
823			Count:  00000018	(number of trace records)
824			CRC32:  9526fb66	(CRC32 of all trace records)
825
826- Timestamp Support:
827
828		When CONFIG_TIMESTAMP is selected, the timestamp
829		(date and time) of an image is printed by image
830		commands like bootm or iminfo. This option is
831		automatically enabled when you select CONFIG_CMD_DATE .
832
833- Partition Labels (disklabels) Supported:
834		Zero or more of the following:
835		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
836		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
837		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
838				       bootloader.  Note 2TB partition limit; see
839				       disk/part_efi.c
840		CONFIG_SCSI) you must configure support for at
841		least one non-MTD partition type as well.
842
843- IDE Reset method:
844		CONFIG_IDE_RESET_ROUTINE - this is defined in several
845		board configurations files but used nowhere!
846
847		CONFIG_IDE_RESET - is this is defined, IDE Reset will
848		be performed by calling the function
849			ide_set_reset(int reset)
850		which has to be defined in a board specific file
851
852- ATAPI Support:
853		CONFIG_ATAPI
854
855		Set this to enable ATAPI support.
856
857- LBA48 Support
858		CONFIG_LBA48
859
860		Set this to enable support for disks larger than 137GB
861		Also look at CONFIG_SYS_64BIT_LBA.
862		Whithout these , LBA48 support uses 32bit variables and will 'only'
863		support disks up to 2.1TB.
864
865		CONFIG_SYS_64BIT_LBA:
866			When enabled, makes the IDE subsystem use 64bit sector addresses.
867			Default is 32bit.
868
869- SCSI Support:
870		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
871		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
872		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
873		maximum numbers of LUNs, SCSI ID's and target
874		devices.
875
876		The environment variable 'scsidevs' is set to the number of
877		SCSI devices found during the last scan.
878
879- NETWORK Support (PCI):
880		CONFIG_E1000
881		Support for Intel 8254x/8257x gigabit chips.
882
883		CONFIG_E1000_SPI
884		Utility code for direct access to the SPI bus on Intel 8257x.
885		This does not do anything useful unless you set at least one
886		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
887
888		CONFIG_E1000_SPI_GENERIC
889		Allow generic access to the SPI bus on the Intel 8257x, for
890		example with the "sspi" command.
891
892		CONFIG_EEPRO100
893		Support for Intel 82557/82559/82559ER chips.
894		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
895		write routine for first time initialisation.
896
897		CONFIG_TULIP
898		Support for Digital 2114x chips.
899
900		CONFIG_NATSEMI
901		Support for National dp83815 chips.
902
903		CONFIG_NS8382X
904		Support for National dp8382[01] gigabit chips.
905
906- NETWORK Support (other):
907
908		CONFIG_DRIVER_AT91EMAC
909		Support for AT91RM9200 EMAC.
910
911			CONFIG_RMII
912			Define this to use reduced MII inteface
913
914			CONFIG_DRIVER_AT91EMAC_QUIET
915			If this defined, the driver is quiet.
916			The driver doen't show link status messages.
917
918		CONFIG_CALXEDA_XGMAC
919		Support for the Calxeda XGMAC device
920
921		CONFIG_LAN91C96
922		Support for SMSC's LAN91C96 chips.
923
924			CONFIG_LAN91C96_USE_32_BIT
925			Define this to enable 32 bit addressing
926
927		CONFIG_SMC91111
928		Support for SMSC's LAN91C111 chip
929
930			CONFIG_SMC91111_BASE
931			Define this to hold the physical address
932			of the device (I/O space)
933
934			CONFIG_SMC_USE_32_BIT
935			Define this if data bus is 32 bits
936
937			CONFIG_SMC_USE_IOFUNCS
938			Define this to use i/o functions instead of macros
939			(some hardware wont work with macros)
940
941			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
942			Define this if you have more then 3 PHYs.
943
944		CONFIG_FTGMAC100
945		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
946
947			CONFIG_FTGMAC100_EGIGA
948			Define this to use GE link update with gigabit PHY.
949			Define this if FTGMAC100 is connected to gigabit PHY.
950			If your system has 10/100 PHY only, it might not occur
951			wrong behavior. Because PHY usually return timeout or
952			useless data when polling gigabit status and gigabit
953			control registers. This behavior won't affect the
954			correctnessof 10/100 link speed update.
955
956		CONFIG_SH_ETHER
957		Support for Renesas on-chip Ethernet controller
958
959			CONFIG_SH_ETHER_USE_PORT
960			Define the number of ports to be used
961
962			CONFIG_SH_ETHER_PHY_ADDR
963			Define the ETH PHY's address
964
965			CONFIG_SH_ETHER_CACHE_WRITEBACK
966			If this option is set, the driver enables cache flush.
967
968- TPM Support:
969		CONFIG_TPM
970		Support TPM devices.
971
972		CONFIG_TPM_TIS_INFINEON
973		Support for Infineon i2c bus TPM devices. Only one device
974		per system is supported at this time.
975
976			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
977			Define the burst count bytes upper limit
978
979		CONFIG_TPM_ST33ZP24
980		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
981
982			CONFIG_TPM_ST33ZP24_I2C
983			Support for STMicroelectronics ST33ZP24 I2C devices.
984			Requires TPM_ST33ZP24 and I2C.
985
986			CONFIG_TPM_ST33ZP24_SPI
987			Support for STMicroelectronics ST33ZP24 SPI devices.
988			Requires TPM_ST33ZP24 and SPI.
989
990		CONFIG_TPM_ATMEL_TWI
991		Support for Atmel TWI TPM device. Requires I2C support.
992
993		CONFIG_TPM_TIS_LPC
994		Support for generic parallel port TPM devices. Only one device
995		per system is supported at this time.
996
997			CONFIG_TPM_TIS_BASE_ADDRESS
998			Base address where the generic TPM device is mapped
999			to. Contemporary x86 systems usually map it at
1000			0xfed40000.
1001
1002		CONFIG_TPM
1003		Define this to enable the TPM support library which provides
1004		functional interfaces to some TPM commands.
1005		Requires support for a TPM device.
1006
1007		CONFIG_TPM_AUTH_SESSIONS
1008		Define this to enable authorized functions in the TPM library.
1009		Requires CONFIG_TPM and CONFIG_SHA1.
1010
1011- USB Support:
1012		At the moment only the UHCI host controller is
1013		supported (PIP405, MIP405); define
1014		CONFIG_USB_UHCI to enable it.
1015		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1016		and define CONFIG_USB_STORAGE to enable the USB
1017		storage devices.
1018		Note:
1019		Supported are USB Keyboards and USB Floppy drives
1020		(TEAC FD-05PUB).
1021
1022		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1023		txfilltuning field in the EHCI controller on reset.
1024
1025		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1026		HW module registers.
1027
1028- USB Device:
1029		Define the below if you wish to use the USB console.
1030		Once firmware is rebuilt from a serial console issue the
1031		command "setenv stdin usbtty; setenv stdout usbtty" and
1032		attach your USB cable. The Unix command "dmesg" should print
1033		it has found a new device. The environment variable usbtty
1034		can be set to gserial or cdc_acm to enable your device to
1035		appear to a USB host as a Linux gserial device or a
1036		Common Device Class Abstract Control Model serial device.
1037		If you select usbtty = gserial you should be able to enumerate
1038		a Linux host by
1039		# modprobe usbserial vendor=0xVendorID product=0xProductID
1040		else if using cdc_acm, simply setting the environment
1041		variable usbtty to be cdc_acm should suffice. The following
1042		might be defined in YourBoardName.h
1043
1044			CONFIG_USB_DEVICE
1045			Define this to build a UDC device
1046
1047			CONFIG_USB_TTY
1048			Define this to have a tty type of device available to
1049			talk to the UDC device
1050
1051			CONFIG_USBD_HS
1052			Define this to enable the high speed support for usb
1053			device and usbtty. If this feature is enabled, a routine
1054			int is_usbd_high_speed(void)
1055			also needs to be defined by the driver to dynamically poll
1056			whether the enumeration has succeded at high speed or full
1057			speed.
1058
1059			CONFIG_SYS_CONSOLE_IS_IN_ENV
1060			Define this if you want stdin, stdout &/or stderr to
1061			be set to usbtty.
1062
1063		If you have a USB-IF assigned VendorID then you may wish to
1064		define your own vendor specific values either in BoardName.h
1065		or directly in usbd_vendor_info.h. If you don't define
1066		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1067		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1068		should pretend to be a Linux device to it's target host.
1069
1070			CONFIG_USBD_MANUFACTURER
1071			Define this string as the name of your company for
1072			- CONFIG_USBD_MANUFACTURER "my company"
1073
1074			CONFIG_USBD_PRODUCT_NAME
1075			Define this string as the name of your product
1076			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
1077
1078			CONFIG_USBD_VENDORID
1079			Define this as your assigned Vendor ID from the USB
1080			Implementors Forum. This *must* be a genuine Vendor ID
1081			to avoid polluting the USB namespace.
1082			- CONFIG_USBD_VENDORID 0xFFFF
1083
1084			CONFIG_USBD_PRODUCTID
1085			Define this as the unique Product ID
1086			for your device
1087			- CONFIG_USBD_PRODUCTID 0xFFFF
1088
1089- ULPI Layer Support:
1090		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1091		the generic ULPI layer. The generic layer accesses the ULPI PHY
1092		via the platform viewport, so you need both the genric layer and
1093		the viewport enabled. Currently only Chipidea/ARC based
1094		viewport is supported.
1095		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1096		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1097		If your ULPI phy needs a different reference clock than the
1098		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1099		the appropriate value in Hz.
1100
1101- MMC Support:
1102		The MMC controller on the Intel PXA is supported. To
1103		enable this define CONFIG_MMC. The MMC can be
1104		accessed from the boot prompt by mapping the device
1105		to physical memory similar to flash. Command line is
1106		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1107		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1108
1109		CONFIG_SH_MMCIF
1110		Support for Renesas on-chip MMCIF controller
1111
1112			CONFIG_SH_MMCIF_ADDR
1113			Define the base address of MMCIF registers
1114
1115			CONFIG_SH_MMCIF_CLK
1116			Define the clock frequency for MMCIF
1117
1118- USB Device Firmware Update (DFU) class support:
1119		CONFIG_DFU_OVER_USB
1120		This enables the USB portion of the DFU USB class
1121
1122		CONFIG_DFU_NAND
1123		This enables support for exposing NAND devices via DFU.
1124
1125		CONFIG_DFU_RAM
1126		This enables support for exposing RAM via DFU.
1127		Note: DFU spec refer to non-volatile memory usage, but
1128		allow usages beyond the scope of spec - here RAM usage,
1129		one that would help mostly the developer.
1130
1131		CONFIG_SYS_DFU_DATA_BUF_SIZE
1132		Dfu transfer uses a buffer before writing data to the
1133		raw storage device. Make the size (in bytes) of this buffer
1134		configurable. The size of this buffer is also configurable
1135		through the "dfu_bufsiz" environment variable.
1136
1137		CONFIG_SYS_DFU_MAX_FILE_SIZE
1138		When updating files rather than the raw storage device,
1139		we use a static buffer to copy the file into and then write
1140		the buffer once we've been given the whole file.  Define
1141		this to the maximum filesize (in bytes) for the buffer.
1142		Default is 4 MiB if undefined.
1143
1144		DFU_DEFAULT_POLL_TIMEOUT
1145		Poll timeout [ms], is the timeout a device can send to the
1146		host. The host must wait for this timeout before sending
1147		a subsequent DFU_GET_STATUS request to the device.
1148
1149		DFU_MANIFEST_POLL_TIMEOUT
1150		Poll timeout [ms], which the device sends to the host when
1151		entering dfuMANIFEST state. Host waits this timeout, before
1152		sending again an USB request to the device.
1153
1154- Journaling Flash filesystem support:
1155		CONFIG_JFFS2_NAND
1156		Define these for a default partition on a NAND device
1157
1158		CONFIG_SYS_JFFS2_FIRST_SECTOR,
1159		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1160		Define these for a default partition on a NOR device
1161
1162- Keyboard Support:
1163		See Kconfig help for available keyboard drivers.
1164
1165		CONFIG_KEYBOARD
1166
1167		Define this to enable a custom keyboard support.
1168		This simply calls drv_keyboard_init() which must be
1169		defined in your board-specific files. This option is deprecated
1170		and is only used by novena. For new boards, use driver model
1171		instead.
1172
1173- Video support:
1174		CONFIG_FSL_DIU_FB
1175		Enable the Freescale DIU video driver.	Reference boards for
1176		SOCs that have a DIU should define this macro to enable DIU
1177		support, and should also define these other macros:
1178
1179			CONFIG_SYS_DIU_ADDR
1180			CONFIG_VIDEO
1181			CONFIG_CFB_CONSOLE
1182			CONFIG_VIDEO_SW_CURSOR
1183			CONFIG_VGA_AS_SINGLE_DEVICE
1184			CONFIG_VIDEO_LOGO
1185			CONFIG_VIDEO_BMP_LOGO
1186
1187		The DIU driver will look for the 'video-mode' environment
1188		variable, and if defined, enable the DIU as a console during
1189		boot.  See the documentation file doc/README.video for a
1190		description of this variable.
1191
1192- LCD Support:	CONFIG_LCD
1193
1194		Define this to enable LCD support (for output to LCD
1195		display); also select one of the supported displays
1196		by defining one of these:
1197
1198		CONFIG_ATMEL_LCD:
1199
1200			HITACHI TX09D70VM1CCA, 3.5", 240x320.
1201
1202		CONFIG_NEC_NL6448AC33:
1203
1204			NEC NL6448AC33-18. Active, color, single scan.
1205
1206		CONFIG_NEC_NL6448BC20
1207
1208			NEC NL6448BC20-08. 6.5", 640x480.
1209			Active, color, single scan.
1210
1211		CONFIG_NEC_NL6448BC33_54
1212
1213			NEC NL6448BC33-54. 10.4", 640x480.
1214			Active, color, single scan.
1215
1216		CONFIG_SHARP_16x9
1217
1218			Sharp 320x240. Active, color, single scan.
1219			It isn't 16x9, and I am not sure what it is.
1220
1221		CONFIG_SHARP_LQ64D341
1222
1223			Sharp LQ64D341 display, 640x480.
1224			Active, color, single scan.
1225
1226		CONFIG_HLD1045
1227
1228			HLD1045 display, 640x480.
1229			Active, color, single scan.
1230
1231		CONFIG_OPTREX_BW
1232
1233			Optrex	 CBL50840-2 NF-FW 99 22 M5
1234			or
1235			Hitachi	 LMG6912RPFC-00T
1236			or
1237			Hitachi	 SP14Q002
1238
1239			320x240. Black & white.
1240
1241		CONFIG_LCD_ALIGNMENT
1242
1243		Normally the LCD is page-aligned (typically 4KB). If this is
1244		defined then the LCD will be aligned to this value instead.
1245		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1246		here, since it is cheaper to change data cache settings on
1247		a per-section basis.
1248
1249
1250		CONFIG_LCD_ROTATION
1251
1252		Sometimes, for example if the display is mounted in portrait
1253		mode or even if it's mounted landscape but rotated by 180degree,
1254		we need to rotate our content of the display relative to the
1255		framebuffer, so that user can read the messages which are
1256		printed out.
1257		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1258		initialized with a given rotation from "vl_rot" out of
1259		"vidinfo_t" which is provided by the board specific code.
1260		The value for vl_rot is coded as following (matching to
1261		fbcon=rotate:<n> linux-kernel commandline):
1262		0 = no rotation respectively 0 degree
1263		1 = 90 degree rotation
1264		2 = 180 degree rotation
1265		3 = 270 degree rotation
1266
1267		If CONFIG_LCD_ROTATION is not defined, the console will be
1268		initialized with 0degree rotation.
1269
1270		CONFIG_LCD_BMP_RLE8
1271
1272		Support drawing of RLE8-compressed bitmaps on the LCD.
1273
1274		CONFIG_I2C_EDID
1275
1276		Enables an 'i2c edid' command which can read EDID
1277		information over I2C from an attached LCD display.
1278
1279- Splash Screen Support: CONFIG_SPLASH_SCREEN
1280
1281		If this option is set, the environment is checked for
1282		a variable "splashimage". If found, the usual display
1283		of logo, copyright and system information on the LCD
1284		is suppressed and the BMP image at the address
1285		specified in "splashimage" is loaded instead. The
1286		console is redirected to the "nulldev", too. This
1287		allows for a "silent" boot where a splash screen is
1288		loaded very quickly after power-on.
1289
1290		CONFIG_SPLASHIMAGE_GUARD
1291
1292		If this option is set, then U-Boot will prevent the environment
1293		variable "splashimage" from being set to a problematic address
1294		(see doc/README.displaying-bmps).
1295		This option is useful for targets where, due to alignment
1296		restrictions, an improperly aligned BMP image will cause a data
1297		abort. If you think you will not have problems with unaligned
1298		accesses (for example because your toolchain prevents them)
1299		there is no need to set this option.
1300
1301		CONFIG_SPLASH_SCREEN_ALIGN
1302
1303		If this option is set the splash image can be freely positioned
1304		on the screen. Environment variable "splashpos" specifies the
1305		position as "x,y". If a positive number is given it is used as
1306		number of pixel from left/top. If a negative number is given it
1307		is used as number of pixel from right/bottom. You can also
1308		specify 'm' for centering the image.
1309
1310		Example:
1311		setenv splashpos m,m
1312			=> image at center of screen
1313
1314		setenv splashpos 30,20
1315			=> image at x = 30 and y = 20
1316
1317		setenv splashpos -10,m
1318			=> vertically centered image
1319			   at x = dspWidth - bmpWidth - 9
1320
1321- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1322
1323		If this option is set, additionally to standard BMP
1324		images, gzipped BMP images can be displayed via the
1325		splashscreen support or the bmp command.
1326
1327- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1328
1329		If this option is set, 8-bit RLE compressed BMP images
1330		can be displayed via the splashscreen support or the
1331		bmp command.
1332
1333- MII/PHY support:
1334		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1335
1336		The clock frequency of the MII bus
1337
1338		CONFIG_PHY_RESET_DELAY
1339
1340		Some PHY like Intel LXT971A need extra delay after
1341		reset before any MII register access is possible.
1342		For such PHY, set this option to the usec delay
1343		required. (minimum 300usec for LXT971A)
1344
1345		CONFIG_PHY_CMD_DELAY (ppc4xx)
1346
1347		Some PHY like Intel LXT971A need extra delay after
1348		command issued before MII status register can be read
1349
1350- IP address:
1351		CONFIG_IPADDR
1352
1353		Define a default value for the IP address to use for
1354		the default Ethernet interface, in case this is not
1355		determined through e.g. bootp.
1356		(Environment variable "ipaddr")
1357
1358- Server IP address:
1359		CONFIG_SERVERIP
1360
1361		Defines a default value for the IP address of a TFTP
1362		server to contact when using the "tftboot" command.
1363		(Environment variable "serverip")
1364
1365		CONFIG_KEEP_SERVERADDR
1366
1367		Keeps the server's MAC address, in the env 'serveraddr'
1368		for passing to bootargs (like Linux's netconsole option)
1369
1370- Gateway IP address:
1371		CONFIG_GATEWAYIP
1372
1373		Defines a default value for the IP address of the
1374		default router where packets to other networks are
1375		sent to.
1376		(Environment variable "gatewayip")
1377
1378- Subnet mask:
1379		CONFIG_NETMASK
1380
1381		Defines a default value for the subnet mask (or
1382		routing prefix) which is used to determine if an IP
1383		address belongs to the local subnet or needs to be
1384		forwarded through a router.
1385		(Environment variable "netmask")
1386
1387- BOOTP Recovery Mode:
1388		CONFIG_BOOTP_RANDOM_DELAY
1389
1390		If you have many targets in a network that try to
1391		boot using BOOTP, you may want to avoid that all
1392		systems send out BOOTP requests at precisely the same
1393		moment (which would happen for instance at recovery
1394		from a power failure, when all systems will try to
1395		boot, thus flooding the BOOTP server. Defining
1396		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1397		inserted before sending out BOOTP requests. The
1398		following delays are inserted then:
1399
1400		1st BOOTP request:	delay 0 ... 1 sec
1401		2nd BOOTP request:	delay 0 ... 2 sec
1402		3rd BOOTP request:	delay 0 ... 4 sec
1403		4th and following
1404		BOOTP requests:		delay 0 ... 8 sec
1405
1406		CONFIG_BOOTP_ID_CACHE_SIZE
1407
1408		BOOTP packets are uniquely identified using a 32-bit ID. The
1409		server will copy the ID from client requests to responses and
1410		U-Boot will use this to determine if it is the destination of
1411		an incoming response. Some servers will check that addresses
1412		aren't in use before handing them out (usually using an ARP
1413		ping) and therefore take up to a few hundred milliseconds to
1414		respond. Network congestion may also influence the time it
1415		takes for a response to make it back to the client. If that
1416		time is too long, U-Boot will retransmit requests. In order
1417		to allow earlier responses to still be accepted after these
1418		retransmissions, U-Boot's BOOTP client keeps a small cache of
1419		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1420		cache. The default is to keep IDs for up to four outstanding
1421		requests. Increasing this will allow U-Boot to accept offers
1422		from a BOOTP client in networks with unusually high latency.
1423
1424- DHCP Advanced Options:
1425		You can fine tune the DHCP functionality by defining
1426		CONFIG_BOOTP_* symbols:
1427
1428		CONFIG_BOOTP_NISDOMAIN
1429		CONFIG_BOOTP_BOOTFILESIZE
1430		CONFIG_BOOTP_SEND_HOSTNAME
1431		CONFIG_BOOTP_NTPSERVER
1432		CONFIG_BOOTP_TIMEOFFSET
1433		CONFIG_BOOTP_VENDOREX
1434		CONFIG_BOOTP_MAY_FAIL
1435
1436		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1437		environment variable, not the BOOTP server.
1438
1439		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1440		after the configured retry count, the call will fail
1441		instead of starting over.  This can be used to fail over
1442		to Link-local IP address configuration if the DHCP server
1443		is not available.
1444
1445		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1446		to do a dynamic update of a DNS server. To do this, they
1447		need the hostname of the DHCP requester.
1448		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1449		of the "hostname" environment variable is passed as
1450		option 12 to the DHCP server.
1451
1452		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1453
1454		A 32bit value in microseconds for a delay between
1455		receiving a "DHCP Offer" and sending the "DHCP Request".
1456		This fixes a problem with certain DHCP servers that don't
1457		respond 100% of the time to a "DHCP request". E.g. On an
1458		AT91RM9200 processor running at 180MHz, this delay needed
1459		to be *at least* 15,000 usec before a Windows Server 2003
1460		DHCP server would reply 100% of the time. I recommend at
1461		least 50,000 usec to be safe. The alternative is to hope
1462		that one of the retries will be successful but note that
1463		the DHCP timeout and retry process takes a longer than
1464		this delay.
1465
1466 - Link-local IP address negotiation:
1467		Negotiate with other link-local clients on the local network
1468		for an address that doesn't require explicit configuration.
1469		This is especially useful if a DHCP server cannot be guaranteed
1470		to exist in all environments that the device must operate.
1471
1472		See doc/README.link-local for more information.
1473
1474 - MAC address from environment variables
1475
1476		FDT_SEQ_MACADDR_FROM_ENV
1477
1478		Fix-up device tree with MAC addresses fetched sequentially from
1479		environment variables. This config work on assumption that
1480		non-usable ethernet node of device-tree are either not present
1481		or their status has been marked as "disabled".
1482
1483 - CDP Options:
1484		CONFIG_CDP_DEVICE_ID
1485
1486		The device id used in CDP trigger frames.
1487
1488		CONFIG_CDP_DEVICE_ID_PREFIX
1489
1490		A two character string which is prefixed to the MAC address
1491		of the device.
1492
1493		CONFIG_CDP_PORT_ID
1494
1495		A printf format string which contains the ascii name of
1496		the port. Normally is set to "eth%d" which sets
1497		eth0 for the first Ethernet, eth1 for the second etc.
1498
1499		CONFIG_CDP_CAPABILITIES
1500
1501		A 32bit integer which indicates the device capabilities;
1502		0x00000010 for a normal host which does not forwards.
1503
1504		CONFIG_CDP_VERSION
1505
1506		An ascii string containing the version of the software.
1507
1508		CONFIG_CDP_PLATFORM
1509
1510		An ascii string containing the name of the platform.
1511
1512		CONFIG_CDP_TRIGGER
1513
1514		A 32bit integer sent on the trigger.
1515
1516		CONFIG_CDP_POWER_CONSUMPTION
1517
1518		A 16bit integer containing the power consumption of the
1519		device in .1 of milliwatts.
1520
1521		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1522
1523		A byte containing the id of the VLAN.
1524
1525- Status LED:	CONFIG_LED_STATUS
1526
1527		Several configurations allow to display the current
1528		status using a LED. For instance, the LED will blink
1529		fast while running U-Boot code, stop blinking as
1530		soon as a reply to a BOOTP request was received, and
1531		start blinking slow once the Linux kernel is running
1532		(supported by a status LED driver in the Linux
1533		kernel). Defining CONFIG_LED_STATUS enables this
1534		feature in U-Boot.
1535
1536		Additional options:
1537
1538		CONFIG_LED_STATUS_GPIO
1539		The status LED can be connected to a GPIO pin.
1540		In such cases, the gpio_led driver can be used as a
1541		status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1542		to include the gpio_led driver in the U-Boot binary.
1543
1544		CONFIG_GPIO_LED_INVERTED_TABLE
1545		Some GPIO connected LEDs may have inverted polarity in which
1546		case the GPIO high value corresponds to LED off state and
1547		GPIO low value corresponds to LED on state.
1548		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1549		with a list of GPIO LEDs that have inverted polarity.
1550
1551- I2C Support:	CONFIG_SYS_I2C
1552
1553		This enable the NEW i2c subsystem, and will allow you to use
1554		i2c commands at the u-boot command line (as long as you set
1555		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1556		    for defining speed and slave address
1557		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1558		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1559		    for defining speed and slave address
1560		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1561		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1562		    for defining speed and slave address
1563		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1564		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1565		    for defining speed and slave address
1566
1567		- drivers/i2c/fsl_i2c.c:
1568		  - activate i2c driver with CONFIG_SYS_I2C_FSL
1569		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1570		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1571		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1572		    bus.
1573		  - If your board supports a second fsl i2c bus, define
1574		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1575		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1576		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1577		    second bus.
1578
1579		- drivers/i2c/tegra_i2c.c:
1580		  - activate this driver with CONFIG_SYS_I2C_TEGRA
1581		  - This driver adds 4 i2c buses with a fix speed from
1582		    100000 and the slave addr 0!
1583
1584		- drivers/i2c/ppc4xx_i2c.c
1585		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
1586		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1587		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1588
1589		- drivers/i2c/i2c_mxc.c
1590		  - activate this driver with CONFIG_SYS_I2C_MXC
1591		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1592		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1593		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1594		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
1595		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1596		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1597		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1598		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1599		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1600		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
1601		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1602		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
1603		If those defines are not set, default value is 100000
1604		for speed, and 0 for slave.
1605
1606		- drivers/i2c/rcar_i2c.c:
1607		  - activate this driver with CONFIG_SYS_I2C_RCAR
1608		  - This driver adds 4 i2c buses
1609
1610		- drivers/i2c/sh_i2c.c:
1611		  - activate this driver with CONFIG_SYS_I2C_SH
1612		  - This driver adds from 2 to 5 i2c buses
1613
1614		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1615		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1616		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1617		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1618		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1619		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1620		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1621		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1622		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1623		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
1624		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
1625
1626		- drivers/i2c/omap24xx_i2c.c
1627		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1628		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1629		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1630		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1631		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1632		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1633		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1634		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1635		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1636		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1637		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1638
1639		- drivers/i2c/s3c24x0_i2c.c:
1640		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
1641		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1642		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1643		    with a fix speed from 100000 and the slave addr 0!
1644
1645		- drivers/i2c/ihs_i2c.c
1646		  - activate this driver with CONFIG_SYS_I2C_IHS
1647		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1648		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1649		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1650		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1651		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1652		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1653		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1654		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1655		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1656		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1657		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1658		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
1659		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1660		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1661		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1662		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1663		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1664		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1665		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1666		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1667		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
1668
1669		additional defines:
1670
1671		CONFIG_SYS_NUM_I2C_BUSES
1672		Hold the number of i2c buses you want to use.
1673
1674		CONFIG_SYS_I2C_DIRECT_BUS
1675		define this, if you don't use i2c muxes on your hardware.
1676		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1677		omit this define.
1678
1679		CONFIG_SYS_I2C_MAX_HOPS
1680		define how many muxes are maximal consecutively connected
1681		on one i2c bus. If you not use i2c muxes, omit this
1682		define.
1683
1684		CONFIG_SYS_I2C_BUSES
1685		hold a list of buses you want to use, only used if
1686		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1687		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1688		CONFIG_SYS_NUM_I2C_BUSES = 9:
1689
1690		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
1691					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1692					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1693					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1694					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1695					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1696					{1, {I2C_NULL_HOP}}, \
1697					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1698					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1699					}
1700
1701		which defines
1702			bus 0 on adapter 0 without a mux
1703			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1704			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1705			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1706			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1707			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
1708			bus 6 on adapter 1 without a mux
1709			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1710			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
1711
1712		If you do not have i2c muxes on your board, omit this define.
1713
1714- Legacy I2C Support:
1715		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
1716		then the following macros need to be defined (examples are
1717		from include/configs/lwmon.h):
1718
1719		I2C_INIT
1720
1721		(Optional). Any commands necessary to enable the I2C
1722		controller or configure ports.
1723
1724		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1725
1726		I2C_ACTIVE
1727
1728		The code necessary to make the I2C data line active
1729		(driven).  If the data line is open collector, this
1730		define can be null.
1731
1732		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1733
1734		I2C_TRISTATE
1735
1736		The code necessary to make the I2C data line tri-stated
1737		(inactive).  If the data line is open collector, this
1738		define can be null.
1739
1740		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1741
1742		I2C_READ
1743
1744		Code that returns true if the I2C data line is high,
1745		false if it is low.
1746
1747		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1748
1749		I2C_SDA(bit)
1750
1751		If <bit> is true, sets the I2C data line high. If it
1752		is false, it clears it (low).
1753
1754		eg: #define I2C_SDA(bit) \
1755			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1756			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1757
1758		I2C_SCL(bit)
1759
1760		If <bit> is true, sets the I2C clock line high. If it
1761		is false, it clears it (low).
1762
1763		eg: #define I2C_SCL(bit) \
1764			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1765			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1766
1767		I2C_DELAY
1768
1769		This delay is invoked four times per clock cycle so this
1770		controls the rate of data transfer.  The data rate thus
1771		is 1 / (I2C_DELAY * 4). Often defined to be something
1772		like:
1773
1774		#define I2C_DELAY  udelay(2)
1775
1776		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1777
1778		If your arch supports the generic GPIO framework (asm/gpio.h),
1779		then you may alternatively define the two GPIOs that are to be
1780		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1781		have GPIO-based defaults assigned to them as appropriate.
1782
1783		You should define these to the GPIO value as given directly to
1784		the generic GPIO functions.
1785
1786		CONFIG_SYS_I2C_INIT_BOARD
1787
1788		When a board is reset during an i2c bus transfer
1789		chips might think that the current transfer is still
1790		in progress. On some boards it is possible to access
1791		the i2c SCLK line directly, either by using the
1792		processor pin as a GPIO or by having a second pin
1793		connected to the bus. If this option is defined a
1794		custom i2c_init_board() routine in boards/xxx/board.c
1795		is run early in the boot sequence.
1796
1797		CONFIG_I2C_MULTI_BUS
1798
1799		This option allows the use of multiple I2C buses, each of which
1800		must have a controller.	 At any point in time, only one bus is
1801		active.	 To switch to a different bus, use the 'i2c dev' command.
1802		Note that bus numbering is zero-based.
1803
1804		CONFIG_SYS_I2C_NOPROBES
1805
1806		This option specifies a list of I2C devices that will be skipped
1807		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
1808		is set, specify a list of bus-device pairs.  Otherwise, specify
1809		a 1D array of device addresses
1810
1811		e.g.
1812			#undef	CONFIG_I2C_MULTI_BUS
1813			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1814
1815		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1816
1817			#define CONFIG_I2C_MULTI_BUS
1818			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1819
1820		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1821
1822		CONFIG_SYS_SPD_BUS_NUM
1823
1824		If defined, then this indicates the I2C bus number for DDR SPD.
1825		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1826
1827		CONFIG_SYS_RTC_BUS_NUM
1828
1829		If defined, then this indicates the I2C bus number for the RTC.
1830		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1831
1832		CONFIG_SOFT_I2C_READ_REPEATED_START
1833
1834		defining this will force the i2c_read() function in
1835		the soft_i2c driver to perform an I2C repeated start
1836		between writing the address pointer and reading the
1837		data.  If this define is omitted the default behaviour
1838		of doing a stop-start sequence will be used.  Most I2C
1839		devices can use either method, but some require one or
1840		the other.
1841
1842- SPI Support:	CONFIG_SPI
1843
1844		Enables SPI driver (so far only tested with
1845		SPI EEPROM, also an instance works with Crystal A/D and
1846		D/As on the SACSng board)
1847
1848		CONFIG_SOFT_SPI
1849
1850		Enables a software (bit-bang) SPI driver rather than
1851		using hardware support. This is a general purpose
1852		driver that only requires three general I/O port pins
1853		(two outputs, one input) to function. If this is
1854		defined, the board configuration must define several
1855		SPI configuration items (port pins to use, etc). For
1856		an example, see include/configs/sacsng.h.
1857
1858		CONFIG_SYS_SPI_MXC_WAIT
1859		Timeout for waiting until spi transfer completed.
1860		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
1861
1862- FPGA Support: CONFIG_FPGA
1863
1864		Enables FPGA subsystem.
1865
1866		CONFIG_FPGA_<vendor>
1867
1868		Enables support for specific chip vendors.
1869		(ALTERA, XILINX)
1870
1871		CONFIG_FPGA_<family>
1872
1873		Enables support for FPGA family.
1874		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1875
1876		CONFIG_FPGA_COUNT
1877
1878		Specify the number of FPGA devices to support.
1879
1880		CONFIG_SYS_FPGA_PROG_FEEDBACK
1881
1882		Enable printing of hash marks during FPGA configuration.
1883
1884		CONFIG_SYS_FPGA_CHECK_BUSY
1885
1886		Enable checks on FPGA configuration interface busy
1887		status by the configuration function. This option
1888		will require a board or device specific function to
1889		be written.
1890
1891		CONFIG_FPGA_DELAY
1892
1893		If defined, a function that provides delays in the FPGA
1894		configuration driver.
1895
1896		CONFIG_SYS_FPGA_CHECK_CTRLC
1897		Allow Control-C to interrupt FPGA configuration
1898
1899		CONFIG_SYS_FPGA_CHECK_ERROR
1900
1901		Check for configuration errors during FPGA bitfile
1902		loading. For example, abort during Virtex II
1903		configuration if the INIT_B line goes low (which
1904		indicated a CRC error).
1905
1906		CONFIG_SYS_FPGA_WAIT_INIT
1907
1908		Maximum time to wait for the INIT_B line to de-assert
1909		after PROB_B has been de-asserted during a Virtex II
1910		FPGA configuration sequence. The default time is 500
1911		ms.
1912
1913		CONFIG_SYS_FPGA_WAIT_BUSY
1914
1915		Maximum time to wait for BUSY to de-assert during
1916		Virtex II FPGA configuration. The default is 5 ms.
1917
1918		CONFIG_SYS_FPGA_WAIT_CONFIG
1919
1920		Time to wait after FPGA configuration. The default is
1921		200 ms.
1922
1923- Configuration Management:
1924
1925		CONFIG_IDENT_STRING
1926
1927		If defined, this string will be added to the U-Boot
1928		version information (U_BOOT_VERSION)
1929
1930- Vendor Parameter Protection:
1931
1932		U-Boot considers the values of the environment
1933		variables "serial#" (Board Serial Number) and
1934		"ethaddr" (Ethernet Address) to be parameters that
1935		are set once by the board vendor / manufacturer, and
1936		protects these variables from casual modification by
1937		the user. Once set, these variables are read-only,
1938		and write or delete attempts are rejected. You can
1939		change this behaviour:
1940
1941		If CONFIG_ENV_OVERWRITE is #defined in your config
1942		file, the write protection for vendor parameters is
1943		completely disabled. Anybody can change or delete
1944		these parameters.
1945
1946		Alternatively, if you define _both_ an ethaddr in the
1947		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1948		Ethernet address is installed in the environment,
1949		which can be changed exactly ONCE by the user. [The
1950		serial# is unaffected by this, i. e. it remains
1951		read-only.]
1952
1953		The same can be accomplished in a more flexible way
1954		for any variable by configuring the type of access
1955		to allow for those variables in the ".flags" variable
1956		or define CONFIG_ENV_FLAGS_LIST_STATIC.
1957
1958- Protected RAM:
1959		CONFIG_PRAM
1960
1961		Define this variable to enable the reservation of
1962		"protected RAM", i. e. RAM which is not overwritten
1963		by U-Boot. Define CONFIG_PRAM to hold the number of
1964		kB you want to reserve for pRAM. You can overwrite
1965		this default value by defining an environment
1966		variable "pram" to the number of kB you want to
1967		reserve. Note that the board info structure will
1968		still show the full amount of RAM. If pRAM is
1969		reserved, a new environment variable "mem" will
1970		automatically be defined to hold the amount of
1971		remaining RAM in a form that can be passed as boot
1972		argument to Linux, for instance like that:
1973
1974			setenv bootargs ... mem=\${mem}
1975			saveenv
1976
1977		This way you can tell Linux not to use this memory,
1978		either, which results in a memory region that will
1979		not be affected by reboots.
1980
1981		*WARNING* If your board configuration uses automatic
1982		detection of the RAM size, you must make sure that
1983		this memory test is non-destructive. So far, the
1984		following board configurations are known to be
1985		"pRAM-clean":
1986
1987			IVMS8, IVML24, SPD8xx,
1988			HERMES, IP860, RPXlite, LWMON,
1989			FLAGADM
1990
1991- Access to physical memory region (> 4GB)
1992		Some basic support is provided for operations on memory not
1993		normally accessible to U-Boot - e.g. some architectures
1994		support access to more than 4GB of memory on 32-bit
1995		machines using physical address extension or similar.
1996		Define CONFIG_PHYSMEM to access this basic support, which
1997		currently only supports clearing the memory.
1998
1999- Error Recovery:
2000		CONFIG_NET_RETRY_COUNT
2001
2002		This variable defines the number of retries for
2003		network operations like ARP, RARP, TFTP, or BOOTP
2004		before giving up the operation. If not defined, a
2005		default value of 5 is used.
2006
2007		CONFIG_ARP_TIMEOUT
2008
2009		Timeout waiting for an ARP reply in milliseconds.
2010
2011		CONFIG_NFS_TIMEOUT
2012
2013		Timeout in milliseconds used in NFS protocol.
2014		If you encounter "ERROR: Cannot umount" in nfs command,
2015		try longer timeout such as
2016		#define CONFIG_NFS_TIMEOUT 10000UL
2017
2018- Command Interpreter:
2019		CONFIG_SYS_PROMPT_HUSH_PS2
2020
2021		This defines the secondary prompt string, which is
2022		printed when the command interpreter needs more input
2023		to complete a command. Usually "> ".
2024
2025	Note:
2026
2027		In the current implementation, the local variables
2028		space and global environment variables space are
2029		separated. Local variables are those you define by
2030		simply typing `name=value'. To access a local
2031		variable later on, you have write `$name' or
2032		`${name}'; to execute the contents of a variable
2033		directly type `$name' at the command prompt.
2034
2035		Global environment variables are those you use
2036		setenv/printenv to work with. To run a command stored
2037		in such a variable, you need to use the run command,
2038		and you must not use the '$' sign to access them.
2039
2040		To store commands and special characters in a
2041		variable, please use double quotation marks
2042		surrounding the whole text of the variable, instead
2043		of the backslashes before semicolons and special
2044		symbols.
2045
2046- Command Line Editing and History:
2047		CONFIG_CMDLINE_PS_SUPPORT
2048
2049		Enable support for changing the command prompt string
2050		at run-time. Only static string is supported so far.
2051		The string is obtained from environment variables PS1
2052		and PS2.
2053
2054- Default Environment:
2055		CONFIG_EXTRA_ENV_SETTINGS
2056
2057		Define this to contain any number of null terminated
2058		strings (variable = value pairs) that will be part of
2059		the default environment compiled into the boot image.
2060
2061		For example, place something like this in your
2062		board's config file:
2063
2064		#define CONFIG_EXTRA_ENV_SETTINGS \
2065			"myvar1=value1\0" \
2066			"myvar2=value2\0"
2067
2068		Warning: This method is based on knowledge about the
2069		internal format how the environment is stored by the
2070		U-Boot code. This is NOT an official, exported
2071		interface! Although it is unlikely that this format
2072		will change soon, there is no guarantee either.
2073		You better know what you are doing here.
2074
2075		Note: overly (ab)use of the default environment is
2076		discouraged. Make sure to check other ways to preset
2077		the environment like the "source" command or the
2078		boot command first.
2079
2080		CONFIG_DELAY_ENVIRONMENT
2081
2082		Normally the environment is loaded when the board is
2083		initialised so that it is available to U-Boot. This inhibits
2084		that so that the environment is not available until
2085		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2086		this is instead controlled by the value of
2087		/config/load-environment.
2088
2089- TFTP Fixed UDP Port:
2090		CONFIG_TFTP_PORT
2091
2092		If this is defined, the environment variable tftpsrcp
2093		is used to supply the TFTP UDP source port value.
2094		If tftpsrcp isn't defined, the normal pseudo-random port
2095		number generator is used.
2096
2097		Also, the environment variable tftpdstp is used to supply
2098		the TFTP UDP destination port value.  If tftpdstp isn't
2099		defined, the normal port 69 is used.
2100
2101		The purpose for tftpsrcp is to allow a TFTP server to
2102		blindly start the TFTP transfer using the pre-configured
2103		target IP address and UDP port. This has the effect of
2104		"punching through" the (Windows XP) firewall, allowing
2105		the remainder of the TFTP transfer to proceed normally.
2106		A better solution is to properly configure the firewall,
2107		but sometimes that is not allowed.
2108
2109		CONFIG_STANDALONE_LOAD_ADDR
2110
2111		This option defines a board specific value for the
2112		address where standalone program gets loaded, thus
2113		overwriting the architecture dependent default
2114		settings.
2115
2116- Frame Buffer Address:
2117		CONFIG_FB_ADDR
2118
2119		Define CONFIG_FB_ADDR if you want to use specific
2120		address for frame buffer.  This is typically the case
2121		when using a graphics controller has separate video
2122		memory.  U-Boot will then place the frame buffer at
2123		the given address instead of dynamically reserving it
2124		in system RAM by calling lcd_setmem(), which grabs
2125		the memory for the frame buffer depending on the
2126		configured panel size.
2127
2128		Please see board_init_f function.
2129
2130- Automatic software updates via TFTP server
2131		CONFIG_UPDATE_TFTP
2132		CONFIG_UPDATE_TFTP_CNT_MAX
2133		CONFIG_UPDATE_TFTP_MSEC_MAX
2134
2135		These options enable and control the auto-update feature;
2136		for a more detailed description refer to doc/README.update.
2137
2138- MTD Support (mtdparts command, UBI support)
2139		CONFIG_MTD_UBI_WL_THRESHOLD
2140		This parameter defines the maximum difference between the highest
2141		erase counter value and the lowest erase counter value of eraseblocks
2142		of UBI devices. When this threshold is exceeded, UBI starts performing
2143		wear leveling by means of moving data from eraseblock with low erase
2144		counter to eraseblocks with high erase counter.
2145
2146		The default value should be OK for SLC NAND flashes, NOR flashes and
2147		other flashes which have eraseblock life-cycle 100000 or more.
2148		However, in case of MLC NAND flashes which typically have eraseblock
2149		life-cycle less than 10000, the threshold should be lessened (e.g.,
2150		to 128 or 256, although it does not have to be power of 2).
2151
2152		default: 4096
2153
2154		CONFIG_MTD_UBI_BEB_LIMIT
2155		This option specifies the maximum bad physical eraseblocks UBI
2156		expects on the MTD device (per 1024 eraseblocks). If the
2157		underlying flash does not admit of bad eraseblocks (e.g. NOR
2158		flash), this value is ignored.
2159
2160		NAND datasheets often specify the minimum and maximum NVM
2161		(Number of Valid Blocks) for the flashes' endurance lifetime.
2162		The maximum expected bad eraseblocks per 1024 eraseblocks
2163		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2164		which gives 20 for most NANDs (MaxNVB is basically the total
2165		count of eraseblocks on the chip).
2166
2167		To put it differently, if this value is 20, UBI will try to
2168		reserve about 1.9% of physical eraseblocks for bad blocks
2169		handling. And that will be 1.9% of eraseblocks on the entire
2170		NAND chip, not just the MTD partition UBI attaches. This means
2171		that if you have, say, a NAND flash chip admits maximum 40 bad
2172		eraseblocks, and it is split on two MTD partitions of the same
2173		size, UBI will reserve 40 eraseblocks when attaching a
2174		partition.
2175
2176		default: 20
2177
2178		CONFIG_MTD_UBI_FASTMAP
2179		Fastmap is a mechanism which allows attaching an UBI device
2180		in nearly constant time. Instead of scanning the whole MTD device it
2181		only has to locate a checkpoint (called fastmap) on the device.
2182		The on-flash fastmap contains all information needed to attach
2183		the device. Using fastmap makes only sense on large devices where
2184		attaching by scanning takes long. UBI will not automatically install
2185		a fastmap on old images, but you can set the UBI parameter
2186		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2187		that fastmap-enabled images are still usable with UBI implementations
2188		without	fastmap support. On typical flash devices the whole fastmap
2189		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2190
2191		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2192		Set this parameter to enable fastmap automatically on images
2193		without a fastmap.
2194		default: 0
2195
2196		CONFIG_MTD_UBI_FM_DEBUG
2197		Enable UBI fastmap debug
2198		default: 0
2199
2200- SPL framework
2201		CONFIG_SPL
2202		Enable building of SPL globally.
2203
2204		CONFIG_SPL_LDSCRIPT
2205		LDSCRIPT for linking the SPL binary.
2206
2207		CONFIG_SPL_MAX_FOOTPRINT
2208		Maximum size in memory allocated to the SPL, BSS included.
2209		When defined, the linker checks that the actual memory
2210		used by SPL from _start to __bss_end does not exceed it.
2211		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
2212		must not be both defined at the same time.
2213
2214		CONFIG_SPL_MAX_SIZE
2215		Maximum size of the SPL image (text, data, rodata, and
2216		linker lists sections), BSS excluded.
2217		When defined, the linker checks that the actual size does
2218		not exceed it.
2219
2220		CONFIG_SPL_RELOC_TEXT_BASE
2221		Address to relocate to.  If unspecified, this is equal to
2222		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2223
2224		CONFIG_SPL_BSS_START_ADDR
2225		Link address for the BSS within the SPL binary.
2226
2227		CONFIG_SPL_BSS_MAX_SIZE
2228		Maximum size in memory allocated to the SPL BSS.
2229		When defined, the linker checks that the actual memory used
2230		by SPL from __bss_start to __bss_end does not exceed it.
2231		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
2232		must not be both defined at the same time.
2233
2234		CONFIG_SPL_STACK
2235		Adress of the start of the stack SPL will use
2236
2237		CONFIG_SPL_PANIC_ON_RAW_IMAGE
2238		When defined, SPL will panic() if the image it has
2239		loaded does not have a signature.
2240		Defining this is useful when code which loads images
2241		in SPL cannot guarantee that absolutely all read errors
2242		will be caught.
2243		An example is the LPC32XX MLC NAND driver, which will
2244		consider that a completely unreadable NAND block is bad,
2245		and thus should be skipped silently.
2246
2247		CONFIG_SPL_RELOC_STACK
2248		Adress of the start of the stack SPL will use after
2249		relocation.  If unspecified, this is equal to
2250		CONFIG_SPL_STACK.
2251
2252		CONFIG_SYS_SPL_MALLOC_START
2253		Starting address of the malloc pool used in SPL.
2254		When this option is set the full malloc is used in SPL and
2255		it is set up by spl_init() and before that, the simple malloc()
2256		can be used if CONFIG_SYS_MALLOC_F is defined.
2257
2258		CONFIG_SYS_SPL_MALLOC_SIZE
2259		The size of the malloc pool used in SPL.
2260
2261		CONFIG_SPL_OS_BOOT
2262		Enable booting directly to an OS from SPL.
2263		See also: doc/README.falcon
2264
2265		CONFIG_SPL_DISPLAY_PRINT
2266		For ARM, enable an optional function to print more information
2267		about the running system.
2268
2269		CONFIG_SPL_INIT_MINIMAL
2270		Arch init code should be built for a very small image
2271
2272		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2273		Partition on the MMC to load U-Boot from when the MMC is being
2274		used in raw mode
2275
2276		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2277		Sector to load kernel uImage from when MMC is being
2278		used in raw mode (for Falcon mode)
2279
2280		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2281		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2282		Sector and number of sectors to load kernel argument
2283		parameters from when MMC is being used in raw mode
2284		(for falcon mode)
2285
2286		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2287		Partition on the MMC to load U-Boot from when the MMC is being
2288		used in fs mode
2289
2290		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2291		Filename to read to load U-Boot when reading from filesystem
2292
2293		CONFIG_SPL_FS_LOAD_KERNEL_NAME
2294		Filename to read to load kernel uImage when reading
2295		from filesystem (for Falcon mode)
2296
2297		CONFIG_SPL_FS_LOAD_ARGS_NAME
2298		Filename to read to load kernel argument parameters
2299		when reading from filesystem (for Falcon mode)
2300
2301		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2302		Set this for NAND SPL on PPC mpc83xx targets, so that
2303		start.S waits for the rest of the SPL to load before
2304		continuing (the hardware starts execution after just
2305		loading the first page rather than the full 4K).
2306
2307		CONFIG_SPL_SKIP_RELOCATE
2308		Avoid SPL relocation
2309
2310		CONFIG_SPL_NAND_BASE
2311		Include nand_base.c in the SPL.  Requires
2312		CONFIG_SPL_NAND_DRIVERS.
2313
2314		CONFIG_SPL_NAND_DRIVERS
2315		SPL uses normal NAND drivers, not minimal drivers.
2316
2317		CONFIG_SPL_NAND_IDENT
2318		SPL uses the chip ID list to identify the NAND flash.
2319		Requires CONFIG_SPL_NAND_BASE.
2320
2321		CONFIG_SPL_NAND_ECC
2322		Include standard software ECC in the SPL
2323
2324		CONFIG_SPL_NAND_SIMPLE
2325		Support for NAND boot using simple NAND drivers that
2326		expose the cmd_ctrl() interface.
2327
2328		CONFIG_SPL_UBI
2329		Support for a lightweight UBI (fastmap) scanner and
2330		loader
2331
2332		CONFIG_SPL_NAND_RAW_ONLY
2333		Support to boot only raw u-boot.bin images. Use this only
2334		if you need to save space.
2335
2336		CONFIG_SPL_COMMON_INIT_DDR
2337		Set for common ddr init with serial presence detect in
2338		SPL binary.
2339
2340		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2341		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2342		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2343		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2344		CONFIG_SYS_NAND_ECCBYTES
2345		Defines the size and behavior of the NAND that SPL uses
2346		to read U-Boot
2347
2348		CONFIG_SYS_NAND_U_BOOT_OFFS
2349		Location in NAND to read U-Boot from
2350
2351		CONFIG_SYS_NAND_U_BOOT_DST
2352		Location in memory to load U-Boot to
2353
2354		CONFIG_SYS_NAND_U_BOOT_SIZE
2355		Size of image to load
2356
2357		CONFIG_SYS_NAND_U_BOOT_START
2358		Entry point in loaded image to jump to
2359
2360		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2361		Define this if you need to first read the OOB and then the
2362		data. This is used, for example, on davinci platforms.
2363
2364		CONFIG_SPL_RAM_DEVICE
2365		Support for running image already present in ram, in SPL binary
2366
2367		CONFIG_SPL_PAD_TO
2368		Image offset to which the SPL should be padded before appending
2369		the SPL payload. By default, this is defined as
2370		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2371		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2372		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
2373
2374		CONFIG_SPL_TARGET
2375		Final target image containing SPL and payload.  Some SPLs
2376		use an arch-specific makefile fragment instead, for
2377		example if more than one image needs to be produced.
2378
2379		CONFIG_SPL_FIT_PRINT
2380		Printing information about a FIT image adds quite a bit of
2381		code to SPL. So this is normally disabled in SPL. Use this
2382		option to re-enable it. This will affect the output of the
2383		bootm command when booting a FIT image.
2384
2385- TPL framework
2386		CONFIG_TPL
2387		Enable building of TPL globally.
2388
2389		CONFIG_TPL_PAD_TO
2390		Image offset to which the TPL should be padded before appending
2391		the TPL payload. By default, this is defined as
2392		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2393		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2394		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
2395
2396- Interrupt support (PPC):
2397
2398		There are common interrupt_init() and timer_interrupt()
2399		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
2400		for CPU specific initialization. interrupt_init_cpu()
2401		should set decrementer_count to appropriate value. If
2402		CPU resets decrementer automatically after interrupt
2403		(ppc4xx) it should set decrementer_count to zero.
2404		timer_interrupt() calls timer_interrupt_cpu() for CPU
2405		specific handling. If board has watchdog / status_led
2406		/ other_activity_monitor it works automatically from
2407		general timer_interrupt().
2408
2409
2410Board initialization settings:
2411------------------------------
2412
2413During Initialization u-boot calls a number of board specific functions
2414to allow the preparation of board specific prerequisites, e.g. pin setup
2415before drivers are initialized. To enable these callbacks the
2416following configuration macros have to be defined. Currently this is
2417architecture specific, so please check arch/your_architecture/lib/board.c
2418typically in board_init_f() and board_init_r().
2419
2420- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2421- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2422- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2423- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2424
2425Configuration Settings:
2426-----------------------
2427
2428- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2429		Optionally it can be defined to support 64-bit memory commands.
2430
2431- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2432		undefine this when you're short of memory.
2433
2434- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2435		width of the commands listed in the 'help' command output.
2436
2437- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2438		prompt for user input.
2439
2440- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2441
2442- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2443
2444- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2445
2446- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2447		the application (usually a Linux kernel) when it is
2448		booted
2449
2450- CONFIG_SYS_BAUDRATE_TABLE:
2451		List of legal baudrate settings for this board.
2452
2453- CONFIG_SYS_MEM_RESERVE_SECURE
2454		Only implemented for ARMv8 for now.
2455		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2456		is substracted from total RAM and won't be reported to OS.
2457		This memory can be used as secure memory. A variable
2458		gd->arch.secure_ram is used to track the location. In systems
2459		the RAM base is not zero, or RAM is divided into banks,
2460		this variable needs to be recalcuated to get the address.
2461
2462- CONFIG_SYS_MEM_TOP_HIDE:
2463		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2464		this specified memory area will get subtracted from the top
2465		(end) of RAM and won't get "touched" at all by U-Boot. By
2466		fixing up gd->ram_size the Linux kernel should gets passed
2467		the now "corrected" memory size and won't touch it either.
2468		This should work for arch/ppc and arch/powerpc. Only Linux
2469		board ports in arch/powerpc with bootwrapper support that
2470		recalculate the memory size from the SDRAM controller setup
2471		will have to get fixed in Linux additionally.
2472
2473		This option can be used as a workaround for the 440EPx/GRx
2474		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2475		be touched.
2476
2477		WARNING: Please make sure that this value is a multiple of
2478		the Linux page size (normally 4k). If this is not the case,
2479		then the end address of the Linux memory will be located at a
2480		non page size aligned address and this could cause major
2481		problems.
2482
2483- CONFIG_SYS_LOADS_BAUD_CHANGE:
2484		Enable temporary baudrate change while serial download
2485
2486- CONFIG_SYS_SDRAM_BASE:
2487		Physical start address of SDRAM. _Must_ be 0 here.
2488
2489- CONFIG_SYS_FLASH_BASE:
2490		Physical start address of Flash memory.
2491
2492- CONFIG_SYS_MONITOR_BASE:
2493		Physical start address of boot monitor code (set by
2494		make config files to be same as the text base address
2495		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
2496		CONFIG_SYS_FLASH_BASE when booting from flash.
2497
2498- CONFIG_SYS_MONITOR_LEN:
2499		Size of memory reserved for monitor code, used to
2500		determine _at_compile_time_ (!) if the environment is
2501		embedded within the U-Boot image, or in a separate
2502		flash sector.
2503
2504- CONFIG_SYS_MALLOC_LEN:
2505		Size of DRAM reserved for malloc() use.
2506
2507- CONFIG_SYS_MALLOC_F_LEN
2508		Size of the malloc() pool for use before relocation. If
2509		this is defined, then a very simple malloc() implementation
2510		will become available before relocation. The address is just
2511		below the global data, and the stack is moved down to make
2512		space.
2513
2514		This feature allocates regions with increasing addresses
2515		within the region. calloc() is supported, but realloc()
2516		is not available. free() is supported but does nothing.
2517		The memory will be freed (or in fact just forgotten) when
2518		U-Boot relocates itself.
2519
2520- CONFIG_SYS_MALLOC_SIMPLE
2521		Provides a simple and small malloc() and calloc() for those
2522		boards which do not use the full malloc in SPL (which is
2523		enabled with CONFIG_SYS_SPL_MALLOC_START).
2524
2525- CONFIG_SYS_NONCACHED_MEMORY:
2526		Size of non-cached memory area. This area of memory will be
2527		typically located right below the malloc() area and mapped
2528		uncached in the MMU. This is useful for drivers that would
2529		otherwise require a lot of explicit cache maintenance. For
2530		some drivers it's also impossible to properly maintain the
2531		cache. For example if the regions that need to be flushed
2532		are not a multiple of the cache-line size, *and* padding
2533		cannot be allocated between the regions to align them (i.e.
2534		if the HW requires a contiguous array of regions, and the
2535		size of each region is not cache-aligned), then a flush of
2536		one region may result in overwriting data that hardware has
2537		written to another region in the same cache-line. This can
2538		happen for example in network drivers where descriptors for
2539		buffers are typically smaller than the CPU cache-line (e.g.
2540		16 bytes vs. 32 or 64 bytes).
2541
2542		Non-cached memory is only supported on 32-bit ARM at present.
2543
2544- CONFIG_SYS_BOOTM_LEN:
2545		Normally compressed uImages are limited to an
2546		uncompressed size of 8 MBytes. If this is not enough,
2547		you can define CONFIG_SYS_BOOTM_LEN in your board config file
2548		to adjust this setting to your needs.
2549
2550- CONFIG_SYS_BOOTMAPSZ:
2551		Maximum size of memory mapped by the startup code of
2552		the Linux kernel; all data that must be processed by
2553		the Linux kernel (bd_info, boot arguments, FDT blob if
2554		used) must be put below this limit, unless "bootm_low"
2555		environment variable is defined and non-zero. In such case
2556		all data for the Linux kernel must be between "bootm_low"
2557		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
2558		variable "bootm_mapsize" will override the value of
2559		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2560		then the value in "bootm_size" will be used instead.
2561
2562- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2563		Enable initrd_high functionality.  If defined then the
2564		initrd_high feature is enabled and the bootm ramdisk subcommand
2565		is enabled.
2566
2567- CONFIG_SYS_BOOT_GET_CMDLINE:
2568		Enables allocating and saving kernel cmdline in space between
2569		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2570
2571- CONFIG_SYS_BOOT_GET_KBD:
2572		Enables allocating and saving a kernel copy of the bd_info in
2573		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2574
2575- CONFIG_SYS_MAX_FLASH_BANKS:
2576		Max number of Flash memory banks
2577
2578- CONFIG_SYS_MAX_FLASH_SECT:
2579		Max number of sectors on a Flash chip
2580
2581- CONFIG_SYS_FLASH_ERASE_TOUT:
2582		Timeout for Flash erase operations (in ms)
2583
2584- CONFIG_SYS_FLASH_WRITE_TOUT:
2585		Timeout for Flash write operations (in ms)
2586
2587- CONFIG_SYS_FLASH_LOCK_TOUT
2588		Timeout for Flash set sector lock bit operation (in ms)
2589
2590- CONFIG_SYS_FLASH_UNLOCK_TOUT
2591		Timeout for Flash clear lock bits operation (in ms)
2592
2593- CONFIG_SYS_FLASH_PROTECTION
2594		If defined, hardware flash sectors protection is used
2595		instead of U-Boot software protection.
2596
2597- CONFIG_SYS_DIRECT_FLASH_TFTP:
2598
2599		Enable TFTP transfers directly to flash memory;
2600		without this option such a download has to be
2601		performed in two steps: (1) download to RAM, and (2)
2602		copy from RAM to flash.
2603
2604		The two-step approach is usually more reliable, since
2605		you can check if the download worked before you erase
2606		the flash, but in some situations (when system RAM is
2607		too limited to allow for a temporary copy of the
2608		downloaded image) this option may be very useful.
2609
2610- CONFIG_SYS_FLASH_CFI:
2611		Define if the flash driver uses extra elements in the
2612		common flash structure for storing flash geometry.
2613
2614- CONFIG_FLASH_CFI_DRIVER
2615		This option also enables the building of the cfi_flash driver
2616		in the drivers directory
2617
2618- CONFIG_FLASH_CFI_MTD
2619		This option enables the building of the cfi_mtd driver
2620		in the drivers directory. The driver exports CFI flash
2621		to the MTD layer.
2622
2623- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
2624		Use buffered writes to flash.
2625
2626- CONFIG_FLASH_SPANSION_S29WS_N
2627		s29ws-n MirrorBit flash has non-standard addresses for buffered
2628		write commands.
2629
2630- CONFIG_SYS_FLASH_QUIET_TEST
2631		If this option is defined, the common CFI flash doesn't
2632		print it's warning upon not recognized FLASH banks. This
2633		is useful, if some of the configured banks are only
2634		optionally available.
2635
2636- CONFIG_FLASH_SHOW_PROGRESS
2637		If defined (must be an integer), print out countdown
2638		digits and dots.  Recommended value: 45 (9..1) for 80
2639		column displays, 15 (3..1) for 40 column displays.
2640
2641- CONFIG_FLASH_VERIFY
2642		If defined, the content of the flash (destination) is compared
2643		against the source after the write operation. An error message
2644		will be printed when the contents are not identical.
2645		Please note that this option is useless in nearly all cases,
2646		since such flash programming errors usually are detected earlier
2647		while unprotecting/erasing/programming. Please only enable
2648		this option if you really know what you are doing.
2649
2650- CONFIG_SYS_RX_ETH_BUFFER:
2651		Defines the number of Ethernet receive buffers. On some
2652		Ethernet controllers it is recommended to set this value
2653		to 8 or even higher (EEPRO100 or 405 EMAC), since all
2654		buffers can be full shortly after enabling the interface
2655		on high Ethernet traffic.
2656		Defaults to 4 if not defined.
2657
2658- CONFIG_ENV_MAX_ENTRIES
2659
2660	Maximum number of entries in the hash table that is used
2661	internally to store the environment settings. The default
2662	setting is supposed to be generous and should work in most
2663	cases. This setting can be used to tune behaviour; see
2664	lib/hashtable.c for details.
2665
2666- CONFIG_ENV_FLAGS_LIST_DEFAULT
2667- CONFIG_ENV_FLAGS_LIST_STATIC
2668	Enable validation of the values given to environment variables when
2669	calling env set.  Variables can be restricted to only decimal,
2670	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
2671	the variables can also be restricted to IP address or MAC address.
2672
2673	The format of the list is:
2674		type_attribute = [s|d|x|b|i|m]
2675		access_attribute = [a|r|o|c]
2676		attributes = type_attribute[access_attribute]
2677		entry = variable_name[:attributes]
2678		list = entry[,list]
2679
2680	The type attributes are:
2681		s - String (default)
2682		d - Decimal
2683		x - Hexadecimal
2684		b - Boolean ([1yYtT|0nNfF])
2685		i - IP address
2686		m - MAC address
2687
2688	The access attributes are:
2689		a - Any (default)
2690		r - Read-only
2691		o - Write-once
2692		c - Change-default
2693
2694	- CONFIG_ENV_FLAGS_LIST_DEFAULT
2695		Define this to a list (string) to define the ".flags"
2696		environment variable in the default or embedded environment.
2697
2698	- CONFIG_ENV_FLAGS_LIST_STATIC
2699		Define this to a list (string) to define validation that
2700		should be done if an entry is not found in the ".flags"
2701		environment variable.  To override a setting in the static
2702		list, simply add an entry for the same variable name to the
2703		".flags" variable.
2704
2705	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2706	regular expression. This allows multiple variables to define the same
2707	flags without explicitly listing them for each variable.
2708
2709The following definitions that deal with the placement and management
2710of environment data (variable area); in general, we support the
2711following configurations:
2712
2713- CONFIG_BUILD_ENVCRC:
2714
2715	Builds up envcrc with the target environment so that external utils
2716	may easily extract it and embed it in final U-Boot images.
2717
2718BE CAREFUL! The first access to the environment happens quite early
2719in U-Boot initialization (when we try to get the setting of for the
2720console baudrate). You *MUST* have mapped your NVRAM area then, or
2721U-Boot will hang.
2722
2723Please note that even with NVRAM we still use a copy of the
2724environment in RAM: we could work on NVRAM directly, but we want to
2725keep settings there always unmodified except somebody uses "saveenv"
2726to save the current settings.
2727
2728BE CAREFUL! For some special cases, the local device can not use
2729"saveenv" command. For example, the local device will get the
2730environment stored in a remote NOR flash by SRIO or PCIE link,
2731but it can not erase, write this NOR flash by SRIO or PCIE interface.
2732
2733- CONFIG_NAND_ENV_DST
2734
2735	Defines address in RAM to which the nand_spl code should copy the
2736	environment. If redundant environment is used, it will be copied to
2737	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2738
2739Please note that the environment is read-only until the monitor
2740has been relocated to RAM and a RAM copy of the environment has been
2741created; also, when using EEPROM you will have to use env_get_f()
2742until then to read environment variables.
2743
2744The environment is protected by a CRC32 checksum. Before the monitor
2745is relocated into RAM, as a result of a bad CRC you will be working
2746with the compiled-in default environment - *silently*!!! [This is
2747necessary, because the first environment variable we need is the
2748"baudrate" setting for the console - if we have a bad CRC, we don't
2749have any device yet where we could complain.]
2750
2751Note: once the monitor has been relocated, then it will complain if
2752the default environment is used; a new CRC is computed as soon as you
2753use the "saveenv" command to store a valid environment.
2754
2755- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2756		Echo the inverted Ethernet link state to the fault LED.
2757
2758		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2759		      also needs to be defined.
2760
2761- CONFIG_SYS_FAULT_MII_ADDR:
2762		MII address of the PHY to check for the Ethernet link state.
2763
2764- CONFIG_NS16550_MIN_FUNCTIONS:
2765		Define this if you desire to only have use of the NS16550_init
2766		and NS16550_putc functions for the serial driver located at
2767		drivers/serial/ns16550.c.  This option is useful for saving
2768		space for already greatly restricted images, including but not
2769		limited to NAND_SPL configurations.
2770
2771- CONFIG_DISPLAY_BOARDINFO
2772		Display information about the board that U-Boot is running on
2773		when U-Boot starts up. The board function checkboard() is called
2774		to do this.
2775
2776- CONFIG_DISPLAY_BOARDINFO_LATE
2777		Similar to the previous option, but display this information
2778		later, once stdio is running and output goes to the LCD, if
2779		present.
2780
2781- CONFIG_BOARD_SIZE_LIMIT:
2782		Maximum size of the U-Boot image. When defined, the
2783		build system checks that the actual size does not
2784		exceed it.
2785
2786Low Level (hardware related) configuration options:
2787---------------------------------------------------
2788
2789- CONFIG_SYS_CACHELINE_SIZE:
2790		Cache Line Size of the CPU.
2791
2792- CONFIG_SYS_CCSRBAR_DEFAULT:
2793		Default (power-on reset) physical address of CCSR on Freescale
2794		PowerPC SOCs.
2795
2796- CONFIG_SYS_CCSRBAR:
2797		Virtual address of CCSR.  On a 32-bit build, this is typically
2798		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2799
2800- CONFIG_SYS_CCSRBAR_PHYS:
2801		Physical address of CCSR.  CCSR can be relocated to a new
2802		physical address, if desired.  In this case, this macro should
2803		be set to that address.	 Otherwise, it should be set to the
2804		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
2805		is typically relocated on 36-bit builds.  It is recommended
2806		that this macro be defined via the _HIGH and _LOW macros:
2807
2808		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2809			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2810
2811- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
2812		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
2813		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
2814		used in assembly code, so it must not contain typecasts or
2815		integer size suffixes (e.g. "ULL").
2816
2817- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2818		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
2819		used in assembly code, so it must not contain typecasts or
2820		integer size suffixes (e.g. "ULL").
2821
2822- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2823		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2824		forced to a value that ensures that CCSR is not relocated.
2825
2826- CONFIG_IDE_AHB:
2827		Most IDE controllers were designed to be connected with PCI
2828		interface. Only few of them were designed for AHB interface.
2829		When software is doing ATA command and data transfer to
2830		IDE devices through IDE-AHB controller, some additional
2831		registers accessing to these kind of IDE-AHB controller
2832		is required.
2833
2834- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
2835		DO NOT CHANGE unless you know exactly what you're
2836		doing! (11-4) [MPC8xx systems only]
2837
2838- CONFIG_SYS_INIT_RAM_ADDR:
2839
2840		Start address of memory area that can be used for
2841		initial data and stack; please note that this must be
2842		writable memory that is working WITHOUT special
2843		initialization, i. e. you CANNOT use normal RAM which
2844		will become available only after programming the
2845		memory controller and running certain initialization
2846		sequences.
2847
2848		U-Boot uses the following memory types:
2849		- MPC8xx: IMMR (internal memory of the CPU)
2850
2851- CONFIG_SYS_GBL_DATA_OFFSET:
2852
2853		Offset of the initial data structure in the memory
2854		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2855		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2856		data is located at the end of the available space
2857		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
2858		GENERATED_GBL_DATA_SIZE), and the initial stack is just
2859		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2860		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2861
2862	Note:
2863		On the MPC824X (or other systems that use the data
2864		cache for initial memory) the address chosen for
2865		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2866		point to an otherwise UNUSED address space between
2867		the top of RAM and the start of the PCI space.
2868
2869- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2870
2871- CONFIG_SYS_OR_TIMING_SDRAM:
2872		SDRAM timing
2873
2874- CONFIG_SYS_MAMR_PTA:
2875		periodic timer for refresh
2876
2877- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2878  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2879  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2880  CONFIG_SYS_BR1_PRELIM:
2881		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2882
2883- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2884  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2885  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2886		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2887
2888- CONFIG_PCI_ENUM_ONLY
2889		Only scan through and get the devices on the buses.
2890		Don't do any setup work, presumably because someone or
2891		something has already done it, and we don't need to do it
2892		a second time.	Useful for platforms that are pre-booted
2893		by coreboot or similar.
2894
2895- CONFIG_PCI_INDIRECT_BRIDGE:
2896		Enable support for indirect PCI bridges.
2897
2898- CONFIG_SYS_SRIO:
2899		Chip has SRIO or not
2900
2901- CONFIG_SRIO1:
2902		Board has SRIO 1 port available
2903
2904- CONFIG_SRIO2:
2905		Board has SRIO 2 port available
2906
2907- CONFIG_SRIO_PCIE_BOOT_MASTER
2908		Board can support master function for Boot from SRIO and PCIE
2909
2910- CONFIG_SYS_SRIOn_MEM_VIRT:
2911		Virtual Address of SRIO port 'n' memory region
2912
2913- CONFIG_SYS_SRIOn_MEM_PHYxS:
2914		Physical Address of SRIO port 'n' memory region
2915
2916- CONFIG_SYS_SRIOn_MEM_SIZE:
2917		Size of SRIO port 'n' memory region
2918
2919- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2920		Defined to tell the NAND controller that the NAND chip is using
2921		a 16 bit bus.
2922		Not all NAND drivers use this symbol.
2923		Example of drivers that use it:
2924		- drivers/mtd/nand/raw/ndfc.c
2925		- drivers/mtd/nand/raw/mxc_nand.c
2926
2927- CONFIG_SYS_NDFC_EBC0_CFG
2928		Sets the EBC0_CFG register for the NDFC. If not defined
2929		a default value will be used.
2930
2931- CONFIG_SPD_EEPROM
2932		Get DDR timing information from an I2C EEPROM. Common
2933		with pluggable memory modules such as SODIMMs
2934
2935  SPD_EEPROM_ADDRESS
2936		I2C address of the SPD EEPROM
2937
2938- CONFIG_SYS_SPD_BUS_NUM
2939		If SPD EEPROM is on an I2C bus other than the first
2940		one, specify here. Note that the value must resolve
2941		to something your driver can deal with.
2942
2943- CONFIG_SYS_DDR_RAW_TIMING
2944		Get DDR timing information from other than SPD. Common with
2945		soldered DDR chips onboard without SPD. DDR raw timing
2946		parameters are extracted from datasheet and hard-coded into
2947		header files or board specific files.
2948
2949- CONFIG_FSL_DDR_INTERACTIVE
2950		Enable interactive DDR debugging. See doc/README.fsl-ddr.
2951
2952- CONFIG_FSL_DDR_SYNC_REFRESH
2953		Enable sync of refresh for multiple controllers.
2954
2955- CONFIG_FSL_DDR_BIST
2956		Enable built-in memory test for Freescale DDR controllers.
2957
2958- CONFIG_SYS_83XX_DDR_USES_CS0
2959		Only for 83xx systems. If specified, then DDR should
2960		be configured using CS0 and CS1 instead of CS2 and CS3.
2961
2962- CONFIG_RMII
2963		Enable RMII mode for all FECs.
2964		Note that this is a global option, we can't
2965		have one FEC in standard MII mode and another in RMII mode.
2966
2967- CONFIG_CRC32_VERIFY
2968		Add a verify option to the crc32 command.
2969		The syntax is:
2970
2971		=> crc32 -v <address> <count> <crc32>
2972
2973		Where address/count indicate a memory area
2974		and crc32 is the correct crc32 which the
2975		area should have.
2976
2977- CONFIG_LOOPW
2978		Add the "loopw" memory command. This only takes effect if
2979		the memory commands are activated globally (CONFIG_CMD_MEMORY).
2980
2981- CONFIG_CMD_MX_CYCLIC
2982		Add the "mdc" and "mwc" memory commands. These are cyclic
2983		"md/mw" commands.
2984		Examples:
2985
2986		=> mdc.b 10 4 500
2987		This command will print 4 bytes (10,11,12,13) each 500 ms.
2988
2989		=> mwc.l 100 12345678 10
2990		This command will write 12345678 to address 100 all 10 ms.
2991
2992		This only takes effect if the memory commands are activated
2993		globally (CONFIG_CMD_MEMORY).
2994
2995- CONFIG_SKIP_LOWLEVEL_INIT
2996		[ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
2997		low level initializations (like setting up the memory
2998		controller) are omitted and/or U-Boot does not
2999		relocate itself into RAM.
3000
3001		Normally this variable MUST NOT be defined. The only
3002		exception is when U-Boot is loaded (to RAM) by some
3003		other boot loader or by a debugger which performs
3004		these initializations itself.
3005
3006- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3007		[ARM926EJ-S only] This allows just the call to lowlevel_init()
3008		to be skipped. The normal CP15 init (such as enabling the
3009		instruction cache) is still performed.
3010
3011- CONFIG_SPL_BUILD
3012		Set when the currently-running compilation is for an artifact
3013		that will end up in the SPL (as opposed to the TPL or U-Boot
3014		proper). Code that needs stage-specific behavior should check
3015		this.
3016
3017- CONFIG_TPL_BUILD
3018		Set when the currently-running compilation is for an artifact
3019		that will end up in the TPL (as opposed to the SPL or U-Boot
3020		proper). Code that needs stage-specific behavior should check
3021		this.
3022
3023- CONFIG_SYS_MPC85XX_NO_RESETVEC
3024		Only for 85xx systems. If this variable is specified, the section
3025		.resetvec is not kept and the section .bootpg is placed in the
3026		previous 4k of the .text section.
3027
3028- CONFIG_ARCH_MAP_SYSMEM
3029		Generally U-Boot (and in particular the md command) uses
3030		effective address. It is therefore not necessary to regard
3031		U-Boot address as virtual addresses that need to be translated
3032		to physical addresses. However, sandbox requires this, since
3033		it maintains its own little RAM buffer which contains all
3034		addressable memory. This option causes some memory accesses
3035		to be mapped through map_sysmem() / unmap_sysmem().
3036
3037- CONFIG_X86_RESET_VECTOR
3038		If defined, the x86 reset vector code is included. This is not
3039		needed when U-Boot is running from Coreboot.
3040
3041- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3042		Option to disable subpage write in NAND driver
3043		driver that uses this:
3044		drivers/mtd/nand/raw/davinci_nand.c
3045
3046Freescale QE/FMAN Firmware Support:
3047-----------------------------------
3048
3049The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3050loading of "firmware", which is encoded in the QE firmware binary format.
3051This firmware often needs to be loaded during U-Boot booting, so macros
3052are used to identify the storage device (NOR flash, SPI, etc) and the address
3053within that device.
3054
3055- CONFIG_SYS_FMAN_FW_ADDR
3056	The address in the storage device where the FMAN microcode is located.  The
3057	meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
3058	is also specified.
3059
3060- CONFIG_SYS_QE_FW_ADDR
3061	The address in the storage device where the QE microcode is located.  The
3062	meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
3063	is also specified.
3064
3065- CONFIG_SYS_QE_FMAN_FW_LENGTH
3066	The maximum possible size of the firmware.  The firmware binary format
3067	has a field that specifies the actual size of the firmware, but it
3068	might not be possible to read any part of the firmware unless some
3069	local storage is allocated to hold the entire firmware first.
3070
3071- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3072	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3073	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3074	virtual address in NOR flash.
3075
3076- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3077	Specifies that QE/FMAN firmware is located in NAND flash.
3078	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3079
3080- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3081	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3082	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3083
3084- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3085	Specifies that QE/FMAN firmware is located in the remote (master)
3086	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3087	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3088	window->master inbound window->master LAW->the ucode address in
3089	master's memory space.
3090
3091Freescale Layerscape Management Complex Firmware Support:
3092---------------------------------------------------------
3093The Freescale Layerscape Management Complex (MC) supports the loading of
3094"firmware".
3095This firmware often needs to be loaded during U-Boot booting, so macros
3096are used to identify the storage device (NOR flash, SPI, etc) and the address
3097within that device.
3098
3099- CONFIG_FSL_MC_ENET
3100	Enable the MC driver for Layerscape SoCs.
3101
3102Freescale Layerscape Debug Server Support:
3103-------------------------------------------
3104The Freescale Layerscape Debug Server Support supports the loading of
3105"Debug Server firmware" and triggering SP boot-rom.
3106This firmware often needs to be loaded during U-Boot booting.
3107
3108- CONFIG_SYS_MC_RSV_MEM_ALIGN
3109	Define alignment of reserved memory MC requires
3110
3111Reproducible builds
3112-------------------
3113
3114In order to achieve reproducible builds, timestamps used in the U-Boot build
3115process have to be set to a fixed value.
3116
3117This is done using the SOURCE_DATE_EPOCH environment variable.
3118SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3119option for U-Boot or an environment variable in U-Boot.
3120
3121SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3122
3123Building the Software:
3124======================
3125
3126Building U-Boot has been tested in several native build environments
3127and in many different cross environments. Of course we cannot support
3128all possibly existing versions of cross development tools in all
3129(potentially obsolete) versions. In case of tool chain problems we
3130recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3131which is extensively used to build and test U-Boot.
3132
3133If you are not using a native environment, it is assumed that you
3134have GNU cross compiling tools available in your path. In this case,
3135you must set the environment variable CROSS_COMPILE in your shell.
3136Note that no changes to the Makefile or any other source files are
3137necessary. For example using the ELDK on a 4xx CPU, please enter:
3138
3139	$ CROSS_COMPILE=ppc_4xx-
3140	$ export CROSS_COMPILE
3141
3142U-Boot is intended to be simple to build. After installing the
3143sources you must configure U-Boot for one specific board type. This
3144is done by typing:
3145
3146	make NAME_defconfig
3147
3148where "NAME_defconfig" is the name of one of the existing configu-
3149rations; see configs/*_defconfig for supported names.
3150
3151Note: for some boards special configuration names may exist; check if
3152      additional information is available from the board vendor; for
3153      instance, the TQM823L systems are available without (standard)
3154      or with LCD support. You can select such additional "features"
3155      when choosing the configuration, i. e.
3156
3157      make TQM823L_defconfig
3158	- will configure for a plain TQM823L, i. e. no LCD support
3159
3160      make TQM823L_LCD_defconfig
3161	- will configure for a TQM823L with U-Boot console on LCD
3162
3163      etc.
3164
3165
3166Finally, type "make all", and you should get some working U-Boot
3167images ready for download to / installation on your system:
3168
3169- "u-boot.bin" is a raw binary image
3170- "u-boot" is an image in ELF binary format
3171- "u-boot.srec" is in Motorola S-Record format
3172
3173By default the build is performed locally and the objects are saved
3174in the source directory. One of the two methods can be used to change
3175this behavior and build U-Boot to some external directory:
3176
31771. Add O= to the make command line invocations:
3178
3179	make O=/tmp/build distclean
3180	make O=/tmp/build NAME_defconfig
3181	make O=/tmp/build all
3182
31832. Set environment variable KBUILD_OUTPUT to point to the desired location:
3184
3185	export KBUILD_OUTPUT=/tmp/build
3186	make distclean
3187	make NAME_defconfig
3188	make all
3189
3190Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
3191variable.
3192
3193User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3194setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3195For example to treat all compiler warnings as errors:
3196
3197	make KCFLAGS=-Werror
3198
3199Please be aware that the Makefiles assume you are using GNU make, so
3200for instance on NetBSD you might need to use "gmake" instead of
3201native "make".
3202
3203
3204If the system board that you have is not listed, then you will need
3205to port U-Boot to your hardware platform. To do this, follow these
3206steps:
3207
32081.  Create a new directory to hold your board specific code. Add any
3209    files you need. In your board directory, you will need at least
3210    the "Makefile" and a "<board>.c".
32112.  Create a new configuration file "include/configs/<board>.h" for
3212    your board.
32133.  If you're porting U-Boot to a new CPU, then also create a new
3214    directory to hold your CPU specific code. Add any files you need.
32154.  Run "make <board>_defconfig" with your new name.
32165.  Type "make", and you should get a working "u-boot.srec" file
3217    to be installed on your target system.
32186.  Debug and solve any problems that might arise.
3219    [Of course, this last step is much harder than it sounds.]
3220
3221
3222Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3223==============================================================
3224
3225If you have modified U-Boot sources (for instance added a new board
3226or support for new devices, a new CPU, etc.) you are expected to
3227provide feedback to the other developers. The feedback normally takes
3228the form of a "patch", i.e. a context diff against a certain (latest
3229official or latest in the git repository) version of U-Boot sources.
3230
3231But before you submit such a patch, please verify that your modifi-
3232cation did not break existing code. At least make sure that *ALL* of
3233the supported boards compile WITHOUT ANY compiler warnings. To do so,
3234just run the buildman script (tools/buildman/buildman), which will
3235configure and build U-Boot for ALL supported system. Be warned, this
3236will take a while. Please see the buildman README, or run 'buildman -H'
3237for documentation.
3238
3239
3240See also "U-Boot Porting Guide" below.
3241
3242
3243Monitor Commands - Overview:
3244============================
3245
3246go	- start application at address 'addr'
3247run	- run commands in an environment variable
3248bootm	- boot application image from memory
3249bootp	- boot image via network using BootP/TFTP protocol
3250bootz   - boot zImage from memory
3251tftpboot- boot image via network using TFTP protocol
3252	       and env variables "ipaddr" and "serverip"
3253	       (and eventually "gatewayip")
3254tftpput - upload a file via network using TFTP protocol
3255rarpboot- boot image via network using RARP/TFTP protocol
3256diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3257loads	- load S-Record file over serial line
3258loadb	- load binary file over serial line (kermit mode)
3259md	- memory display
3260mm	- memory modify (auto-incrementing)
3261nm	- memory modify (constant address)
3262mw	- memory write (fill)
3263cp	- memory copy
3264cmp	- memory compare
3265crc32	- checksum calculation
3266i2c	- I2C sub-system
3267sspi	- SPI utility commands
3268base	- print or set address offset
3269printenv- print environment variables
3270setenv	- set environment variables
3271saveenv - save environment variables to persistent storage
3272protect - enable or disable FLASH write protection
3273erase	- erase FLASH memory
3274flinfo	- print FLASH memory information
3275nand	- NAND memory operations (see doc/README.nand)
3276bdinfo	- print Board Info structure
3277iminfo	- print header information for application image
3278coninfo - print console devices and informations
3279ide	- IDE sub-system
3280loop	- infinite loop on address range
3281loopw	- infinite write loop on address range
3282mtest	- simple RAM test
3283icache	- enable or disable instruction cache
3284dcache	- enable or disable data cache
3285reset	- Perform RESET of the CPU
3286echo	- echo args to console
3287version - print monitor version
3288help	- print online help
3289?	- alias for 'help'
3290
3291
3292Monitor Commands - Detailed Description:
3293========================================
3294
3295TODO.
3296
3297For now: just type "help <command>".
3298
3299
3300Environment Variables:
3301======================
3302
3303U-Boot supports user configuration using Environment Variables which
3304can be made persistent by saving to Flash memory.
3305
3306Environment Variables are set using "setenv", printed using
3307"printenv", and saved to Flash using "saveenv". Using "setenv"
3308without a value can be used to delete a variable from the
3309environment. As long as you don't save the environment you are
3310working with an in-memory copy. In case the Flash area containing the
3311environment is erased by accident, a default environment is provided.
3312
3313Some configuration options can be set using Environment Variables.
3314
3315List of environment variables (most likely not complete):
3316
3317  baudrate	- see CONFIG_BAUDRATE
3318
3319  bootdelay	- see CONFIG_BOOTDELAY
3320
3321  bootcmd	- see CONFIG_BOOTCOMMAND
3322
3323  bootargs	- Boot arguments when booting an RTOS image
3324
3325  bootfile	- Name of the image to load with TFTP
3326
3327  bootm_low	- Memory range available for image processing in the bootm
3328		  command can be restricted. This variable is given as
3329		  a hexadecimal number and defines lowest address allowed
3330		  for use by the bootm command. See also "bootm_size"
3331		  environment variable. Address defined by "bootm_low" is
3332		  also the base of the initial memory mapping for the Linux
3333		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3334		  bootm_mapsize.
3335
3336  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3337		  This variable is given as a hexadecimal number and it
3338		  defines the size of the memory region starting at base
3339		  address bootm_low that is accessible by the Linux kernel
3340		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3341		  as the default value if it is defined, and bootm_size is
3342		  used otherwise.
3343
3344  bootm_size	- Memory range available for image processing in the bootm
3345		  command can be restricted. This variable is given as
3346		  a hexadecimal number and defines the size of the region
3347		  allowed for use by the bootm command. See also "bootm_low"
3348		  environment variable.
3349
3350  bootstopkeysha256, bootdelaykey, bootstopkey	- See README.autoboot
3351
3352  updatefile	- Location of the software update file on a TFTP server, used
3353		  by the automatic software update feature. Please refer to
3354		  documentation in doc/README.update for more details.
3355
3356  autoload	- if set to "no" (any string beginning with 'n'),
3357		  "bootp" will just load perform a lookup of the
3358		  configuration from the BOOTP server, but not try to
3359		  load any image using TFTP
3360
3361  autostart	- if set to "yes", an image loaded using the "bootp",
3362		  "rarpboot", "tftpboot" or "diskboot" commands will
3363		  be automatically started (by internally calling
3364		  "bootm")
3365
3366		  If set to "no", a standalone image passed to the
3367		  "bootm" command will be copied to the load address
3368		  (and eventually uncompressed), but NOT be started.
3369		  This can be used to load and uncompress arbitrary
3370		  data.
3371
3372  fdt_high	- if set this restricts the maximum address that the
3373		  flattened device tree will be copied into upon boot.
3374		  For example, if you have a system with 1 GB memory
3375		  at physical address 0x10000000, while Linux kernel
3376		  only recognizes the first 704 MB as low memory, you
3377		  may need to set fdt_high as 0x3C000000 to have the
3378		  device tree blob be copied to the maximum address
3379		  of the 704 MB low memory, so that Linux kernel can
3380		  access it during the boot procedure.
3381
3382		  If this is set to the special value 0xFFFFFFFF then
3383		  the fdt will not be copied at all on boot.  For this
3384		  to work it must reside in writable memory, have
3385		  sufficient padding on the end of it for u-boot to
3386		  add the information it needs into it, and the memory
3387		  must be accessible by the kernel.
3388
3389  fdtcontroladdr- if set this is the address of the control flattened
3390		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3391		  defined.
3392
3393  i2cfast	- (PPC405GP|PPC405EP only)
3394		  if set to 'y' configures Linux I2C driver for fast
3395		  mode (400kHZ). This environment variable is used in
3396		  initialization code. So, for changes to be effective
3397		  it must be saved and board must be reset.
3398
3399  initrd_high	- restrict positioning of initrd images:
3400		  If this variable is not set, initrd images will be
3401		  copied to the highest possible address in RAM; this
3402		  is usually what you want since it allows for
3403		  maximum initrd size. If for some reason you want to
3404		  make sure that the initrd image is loaded below the
3405		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3406		  variable to a value of "no" or "off" or "0".
3407		  Alternatively, you can set it to a maximum upper
3408		  address to use (U-Boot will still check that it
3409		  does not overwrite the U-Boot stack and data).
3410
3411		  For instance, when you have a system with 16 MB
3412		  RAM, and want to reserve 4 MB from use by Linux,
3413		  you can do this by adding "mem=12M" to the value of
3414		  the "bootargs" variable. However, now you must make
3415		  sure that the initrd image is placed in the first
3416		  12 MB as well - this can be done with
3417
3418		  setenv initrd_high 00c00000
3419
3420		  If you set initrd_high to 0xFFFFFFFF, this is an
3421		  indication to U-Boot that all addresses are legal
3422		  for the Linux kernel, including addresses in flash
3423		  memory. In this case U-Boot will NOT COPY the
3424		  ramdisk at all. This may be useful to reduce the
3425		  boot time on your system, but requires that this
3426		  feature is supported by your Linux kernel.
3427
3428  ipaddr	- IP address; needed for tftpboot command
3429
3430  loadaddr	- Default load address for commands like "bootp",
3431		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3432
3433  loads_echo	- see CONFIG_LOADS_ECHO
3434
3435  serverip	- TFTP server IP address; needed for tftpboot command
3436
3437  bootretry	- see CONFIG_BOOT_RETRY_TIME
3438
3439  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3440
3441  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3442
3443  ethprime	- controls which interface is used first.
3444
3445  ethact	- controls which interface is currently active.
3446		  For example you can do the following
3447
3448		  => setenv ethact FEC
3449		  => ping 192.168.0.1 # traffic sent on FEC
3450		  => setenv ethact SCC
3451		  => ping 10.0.0.1 # traffic sent on SCC
3452
3453  ethrotate	- When set to "no" U-Boot does not go through all
3454		  available network interfaces.
3455		  It just stays at the currently selected interface.
3456
3457  netretry	- When set to "no" each network operation will
3458		  either succeed or fail without retrying.
3459		  When set to "once" the network operation will
3460		  fail when all the available network interfaces
3461		  are tried once without success.
3462		  Useful on scripts which control the retry operation
3463		  themselves.
3464
3465  npe_ucode	- set load address for the NPE microcode
3466
3467  silent_linux  - If set then Linux will be told to boot silently, by
3468		  changing the console to be empty. If "yes" it will be
3469		  made silent. If "no" it will not be made silent. If
3470		  unset, then it will be made silent if the U-Boot console
3471		  is silent.
3472
3473  tftpsrcp	- If this is set, the value is used for TFTP's
3474		  UDP source port.
3475
3476  tftpdstp	- If this is set, the value is used for TFTP's UDP
3477		  destination port instead of the Well Know Port 69.
3478
3479  tftpblocksize - Block size to use for TFTP transfers; if not set,
3480		  we use the TFTP server's default block size
3481
3482  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3483		  seconds, minimum value is 1000 = 1 second). Defines
3484		  when a packet is considered to be lost so it has to
3485		  be retransmitted. The default is 5000 = 5 seconds.
3486		  Lowering this value may make downloads succeed
3487		  faster in networks with high packet loss rates or
3488		  with unreliable TFTP servers.
3489
3490  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
3491		  unit, minimum value = 0). Defines how many timeouts
3492		  can happen during a single file transfer before that
3493		  transfer is aborted. The default is 10, and 0 means
3494		  'no timeouts allowed'. Increasing this value may help
3495		  downloads succeed with high packet loss rates, or with
3496		  unreliable TFTP servers or client hardware.
3497
3498  vlan		- When set to a value < 4095 the traffic over
3499		  Ethernet is encapsulated/received over 802.1q
3500		  VLAN tagged frames.
3501
3502  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
3503		  Unsigned value, in milliseconds. If not set, the period will
3504		  be either the default (28000), or a value based on
3505		  CONFIG_NET_RETRY_COUNT, if defined. This value has
3506		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3507
3508The following image location variables contain the location of images
3509used in booting. The "Image" column gives the role of the image and is
3510not an environment variable name. The other columns are environment
3511variable names. "File Name" gives the name of the file on a TFTP
3512server, "RAM Address" gives the location in RAM the image will be
3513loaded to, and "Flash Location" gives the image's address in NOR
3514flash or offset in NAND flash.
3515
3516*Note* - these variables don't have to be defined for all boards, some
3517boards currently use other variables for these purposes, and some
3518boards use these variables for other purposes.
3519
3520Image		    File Name	     RAM Address       Flash Location
3521-----		    ---------	     -----------       --------------
3522u-boot		    u-boot	     u-boot_addr_r     u-boot_addr
3523Linux kernel	    bootfile	     kernel_addr_r     kernel_addr
3524device tree blob    fdtfile	     fdt_addr_r	       fdt_addr
3525ramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
3526
3527The following environment variables may be used and automatically
3528updated by the network boot commands ("bootp" and "rarpboot"),
3529depending the information provided by your boot server:
3530
3531  bootfile	- see above
3532  dnsip		- IP address of your Domain Name Server
3533  dnsip2	- IP address of your secondary Domain Name Server
3534  gatewayip	- IP address of the Gateway (Router) to use
3535  hostname	- Target hostname
3536  ipaddr	- see above
3537  netmask	- Subnet Mask
3538  rootpath	- Pathname of the root filesystem on the NFS server
3539  serverip	- see above
3540
3541
3542There are two special Environment Variables:
3543
3544  serial#	- contains hardware identification information such
3545		  as type string and/or serial number
3546  ethaddr	- Ethernet address
3547
3548These variables can be set only once (usually during manufacturing of
3549the board). U-Boot refuses to delete or overwrite these variables
3550once they have been set once.
3551
3552
3553Further special Environment Variables:
3554
3555  ver		- Contains the U-Boot version string as printed
3556		  with the "version" command. This variable is
3557		  readonly (see CONFIG_VERSION_VARIABLE).
3558
3559
3560Please note that changes to some configuration parameters may take
3561only effect after the next boot (yes, that's just like Windoze :-).
3562
3563
3564Callback functions for environment variables:
3565---------------------------------------------
3566
3567For some environment variables, the behavior of u-boot needs to change
3568when their values are changed.  This functionality allows functions to
3569be associated with arbitrary variables.  On creation, overwrite, or
3570deletion, the callback will provide the opportunity for some side
3571effect to happen or for the change to be rejected.
3572
3573The callbacks are named and associated with a function using the
3574U_BOOT_ENV_CALLBACK macro in your board or driver code.
3575
3576These callbacks are associated with variables in one of two ways.  The
3577static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3578in the board configuration to a string that defines a list of
3579associations.  The list must be in the following format:
3580
3581	entry = variable_name[:callback_name]
3582	list = entry[,list]
3583
3584If the callback name is not specified, then the callback is deleted.
3585Spaces are also allowed anywhere in the list.
3586
3587Callbacks can also be associated by defining the ".callbacks" variable
3588with the same list format above.  Any association in ".callbacks" will
3589override any association in the static list. You can define
3590CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
3591".callbacks" environment variable in the default or embedded environment.
3592
3593If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3594regular expression. This allows multiple variables to be connected to
3595the same callback without explicitly listing them all out.
3596
3597The signature of the callback functions is:
3598
3599    int callback(const char *name, const char *value, enum env_op op, int flags)
3600
3601* name - changed environment variable
3602* value - new value of the environment variable
3603* op - operation (create, overwrite, or delete)
3604* flags - attributes of the environment variable change, see flags H_* in
3605  include/search.h
3606
3607The return value is 0 if the variable change is accepted and 1 otherwise.
3608
3609Command Line Parsing:
3610=====================
3611
3612There are two different command line parsers available with U-Boot:
3613the old "simple" one, and the much more powerful "hush" shell:
3614
3615Old, simple command line parser:
3616--------------------------------
3617
3618- supports environment variables (through setenv / saveenv commands)
3619- several commands on one line, separated by ';'
3620- variable substitution using "... ${name} ..." syntax
3621- special characters ('$', ';') can be escaped by prefixing with '\',
3622  for example:
3623	setenv bootcmd bootm \${address}
3624- You can also escape text by enclosing in single apostrophes, for example:
3625	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3626
3627Hush shell:
3628-----------
3629
3630- similar to Bourne shell, with control structures like
3631  if...then...else...fi, for...do...done; while...do...done,
3632  until...do...done, ...
3633- supports environment ("global") variables (through setenv / saveenv
3634  commands) and local shell variables (through standard shell syntax
3635  "name=value"); only environment variables can be used with "run"
3636  command
3637
3638General rules:
3639--------------
3640
3641(1) If a command line (or an environment variable executed by a "run"
3642    command) contains several commands separated by semicolon, and
3643    one of these commands fails, then the remaining commands will be
3644    executed anyway.
3645
3646(2) If you execute several variables with one call to run (i. e.
3647    calling run with a list of variables as arguments), any failing
3648    command will cause "run" to terminate, i. e. the remaining
3649    variables are not executed.
3650
3651Note for Redundant Ethernet Interfaces:
3652=======================================
3653
3654Some boards come with redundant Ethernet interfaces; U-Boot supports
3655such configurations and is capable of automatic selection of a
3656"working" interface when needed. MAC assignment works as follows:
3657
3658Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3659MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3660"eth1addr" (=>eth1), "eth2addr", ...
3661
3662If the network interface stores some valid MAC address (for instance
3663in SROM), this is used as default address if there is NO correspon-
3664ding setting in the environment; if the corresponding environment
3665variable is set, this overrides the settings in the card; that means:
3666
3667o If the SROM has a valid MAC address, and there is no address in the
3668  environment, the SROM's address is used.
3669
3670o If there is no valid address in the SROM, and a definition in the
3671  environment exists, then the value from the environment variable is
3672  used.
3673
3674o If both the SROM and the environment contain a MAC address, and
3675  both addresses are the same, this MAC address is used.
3676
3677o If both the SROM and the environment contain a MAC address, and the
3678  addresses differ, the value from the environment is used and a
3679  warning is printed.
3680
3681o If neither SROM nor the environment contain a MAC address, an error
3682  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3683  a random, locally-assigned MAC is used.
3684
3685If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3686will be programmed into hardware as part of the initialization process.	 This
3687may be skipped by setting the appropriate 'ethmacskip' environment variable.
3688The naming convention is as follows:
3689"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3690
3691Image Formats:
3692==============
3693
3694U-Boot is capable of booting (and performing other auxiliary operations on)
3695images in two formats:
3696
3697New uImage format (FIT)
3698-----------------------
3699
3700Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3701to Flattened Device Tree). It allows the use of images with multiple
3702components (several kernels, ramdisks, etc.), with contents protected by
3703SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3704
3705
3706Old uImage format
3707-----------------
3708
3709Old image format is based on binary files which can be basically anything,
3710preceded by a special header; see the definitions in include/image.h for
3711details; basically, the header defines the following image properties:
3712
3713* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3714  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3715  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3716  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3717  INTEGRITY).
3718* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
3719  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3720  Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
3721* Compression Type (uncompressed, gzip, bzip2)
3722* Load Address
3723* Entry Point
3724* Image Name
3725* Image Timestamp
3726
3727The header is marked by a special Magic Number, and both the header
3728and the data portions of the image are secured against corruption by
3729CRC32 checksums.
3730
3731
3732Linux Support:
3733==============
3734
3735Although U-Boot should support any OS or standalone application
3736easily, the main focus has always been on Linux during the design of
3737U-Boot.
3738
3739U-Boot includes many features that so far have been part of some
3740special "boot loader" code within the Linux kernel. Also, any
3741"initrd" images to be used are no longer part of one big Linux image;
3742instead, kernel and "initrd" are separate images. This implementation
3743serves several purposes:
3744
3745- the same features can be used for other OS or standalone
3746  applications (for instance: using compressed images to reduce the
3747  Flash memory footprint)
3748
3749- it becomes much easier to port new Linux kernel versions because
3750  lots of low-level, hardware dependent stuff are done by U-Boot
3751
3752- the same Linux kernel image can now be used with different "initrd"
3753  images; of course this also means that different kernel images can
3754  be run with the same "initrd". This makes testing easier (you don't
3755  have to build a new "zImage.initrd" Linux image when you just
3756  change a file in your "initrd"). Also, a field-upgrade of the
3757  software is easier now.
3758
3759
3760Linux HOWTO:
3761============
3762
3763Porting Linux to U-Boot based systems:
3764---------------------------------------
3765
3766U-Boot cannot save you from doing all the necessary modifications to
3767configure the Linux device drivers for use with your target hardware
3768(no, we don't intend to provide a full virtual machine interface to
3769Linux :-).
3770
3771But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3772
3773Just make sure your machine specific header file (for instance
3774include/asm-ppc/tqm8xx.h) includes the same definition of the Board
3775Information structure as we define in include/asm-<arch>/u-boot.h,
3776and make sure that your definition of IMAP_ADDR uses the same value
3777as your U-Boot configuration in CONFIG_SYS_IMMR.
3778
3779Note that U-Boot now has a driver model, a unified model for drivers.
3780If you are adding a new driver, plumb it into driver model. If there
3781is no uclass available, you are encouraged to create one. See
3782doc/driver-model.
3783
3784
3785Configuring the Linux kernel:
3786-----------------------------
3787
3788No specific requirements for U-Boot. Make sure you have some root
3789device (initial ramdisk, NFS) for your target system.
3790
3791
3792Building a Linux Image:
3793-----------------------
3794
3795With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3796not used. If you use recent kernel source, a new build target
3797"uImage" will exist which automatically builds an image usable by
3798U-Boot. Most older kernels also have support for a "pImage" target,
3799which was introduced for our predecessor project PPCBoot and uses a
3800100% compatible format.
3801
3802Example:
3803
3804	make TQM850L_defconfig
3805	make oldconfig
3806	make dep
3807	make uImage
3808
3809The "uImage" build target uses a special tool (in 'tools/mkimage') to
3810encapsulate a compressed Linux kernel image with header	 information,
3811CRC32 checksum etc. for use with U-Boot. This is what we are doing:
3812
3813* build a standard "vmlinux" kernel image (in ELF binary format):
3814
3815* convert the kernel into a raw binary image:
3816
3817	${CROSS_COMPILE}-objcopy -O binary \
3818				 -R .note -R .comment \
3819				 -S vmlinux linux.bin
3820
3821* compress the binary image:
3822
3823	gzip -9 linux.bin
3824
3825* package compressed binary image for U-Boot:
3826
3827	mkimage -A ppc -O linux -T kernel -C gzip \
3828		-a 0 -e 0 -n "Linux Kernel Image" \
3829		-d linux.bin.gz uImage
3830
3831
3832The "mkimage" tool can also be used to create ramdisk images for use
3833with U-Boot, either separated from the Linux kernel image, or
3834combined into one file. "mkimage" encapsulates the images with a 64
3835byte header containing information about target architecture,
3836operating system, image type, compression method, entry points, time
3837stamp, CRC32 checksums, etc.
3838
3839"mkimage" can be called in two ways: to verify existing images and
3840print the header information, or to build new images.
3841
3842In the first form (with "-l" option) mkimage lists the information
3843contained in the header of an existing U-Boot image; this includes
3844checksum verification:
3845
3846	tools/mkimage -l image
3847	  -l ==> list image header information
3848
3849The second form (with "-d" option) is used to build a U-Boot image
3850from a "data file" which is used as image payload:
3851
3852	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3853		      -n name -d data_file image
3854	  -A ==> set architecture to 'arch'
3855	  -O ==> set operating system to 'os'
3856	  -T ==> set image type to 'type'
3857	  -C ==> set compression type 'comp'
3858	  -a ==> set load address to 'addr' (hex)
3859	  -e ==> set entry point to 'ep' (hex)
3860	  -n ==> set image name to 'name'
3861	  -d ==> use image data from 'datafile'
3862
3863Right now, all Linux kernels for PowerPC systems use the same load
3864address (0x00000000), but the entry point address depends on the
3865kernel version:
3866
3867- 2.2.x kernels have the entry point at 0x0000000C,
3868- 2.3.x and later kernels have the entry point at 0x00000000.
3869
3870So a typical call to build a U-Boot image would read:
3871
3872	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3873	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3874	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
3875	> examples/uImage.TQM850L
3876	Image Name:   2.4.4 kernel for TQM850L
3877	Created:      Wed Jul 19 02:34:59 2000
3878	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3879	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3880	Load Address: 0x00000000
3881	Entry Point:  0x00000000
3882
3883To verify the contents of the image (or check for corruption):
3884
3885	-> tools/mkimage -l examples/uImage.TQM850L
3886	Image Name:   2.4.4 kernel for TQM850L
3887	Created:      Wed Jul 19 02:34:59 2000
3888	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3889	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3890	Load Address: 0x00000000
3891	Entry Point:  0x00000000
3892
3893NOTE: for embedded systems where boot time is critical you can trade
3894speed for memory and install an UNCOMPRESSED image instead: this
3895needs more space in Flash, but boots much faster since it does not
3896need to be uncompressed:
3897
3898	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
3899	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3900	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3901	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
3902	> examples/uImage.TQM850L-uncompressed
3903	Image Name:   2.4.4 kernel for TQM850L
3904	Created:      Wed Jul 19 02:34:59 2000
3905	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3906	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3907	Load Address: 0x00000000
3908	Entry Point:  0x00000000
3909
3910
3911Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3912when your kernel is intended to use an initial ramdisk:
3913
3914	-> tools/mkimage -n 'Simple Ramdisk Image' \
3915	> -A ppc -O linux -T ramdisk -C gzip \
3916	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3917	Image Name:   Simple Ramdisk Image
3918	Created:      Wed Jan 12 14:01:50 2000
3919	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3920	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3921	Load Address: 0x00000000
3922	Entry Point:  0x00000000
3923
3924The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
3925option performs the converse operation of the mkimage's second form (the "-d"
3926option). Given an image built by mkimage, the dumpimage extracts a "data file"
3927from the image:
3928
3929	tools/dumpimage -i image -T type -p position data_file
3930	  -i ==> extract from the 'image' a specific 'data_file'
3931	  -T ==> set image type to 'type'
3932	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
3933
3934
3935Installing a Linux Image:
3936-------------------------
3937
3938To downloading a U-Boot image over the serial (console) interface,
3939you must convert the image to S-Record format:
3940
3941	objcopy -I binary -O srec examples/image examples/image.srec
3942
3943The 'objcopy' does not understand the information in the U-Boot
3944image header, so the resulting S-Record file will be relative to
3945address 0x00000000. To load it to a given address, you need to
3946specify the target address as 'offset' parameter with the 'loads'
3947command.
3948
3949Example: install the image to address 0x40100000 (which on the
3950TQM8xxL is in the first Flash bank):
3951
3952	=> erase 40100000 401FFFFF
3953
3954	.......... done
3955	Erased 8 sectors
3956
3957	=> loads 40100000
3958	## Ready for S-Record download ...
3959	~>examples/image.srec
3960	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3961	...
3962	15989 15990 15991 15992
3963	[file transfer complete]
3964	[connected]
3965	## Start Addr = 0x00000000
3966
3967
3968You can check the success of the download using the 'iminfo' command;
3969this includes a checksum verification so you can be sure no data
3970corruption happened:
3971
3972	=> imi 40100000
3973
3974	## Checking Image at 40100000 ...
3975	   Image Name:	 2.2.13 for initrd on TQM850L
3976	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3977	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3978	   Load Address: 00000000
3979	   Entry Point:	 0000000c
3980	   Verifying Checksum ... OK
3981
3982
3983Boot Linux:
3984-----------
3985
3986The "bootm" command is used to boot an application that is stored in
3987memory (RAM or Flash). In case of a Linux kernel image, the contents
3988of the "bootargs" environment variable is passed to the kernel as
3989parameters. You can check and modify this variable using the
3990"printenv" and "setenv" commands:
3991
3992
3993	=> printenv bootargs
3994	bootargs=root=/dev/ram
3995
3996	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3997
3998	=> printenv bootargs
3999	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4000
4001	=> bootm 40020000
4002	## Booting Linux kernel at 40020000 ...
4003	   Image Name:	 2.2.13 for NFS on TQM850L
4004	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4005	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4006	   Load Address: 00000000
4007	   Entry Point:	 0000000c
4008	   Verifying Checksum ... OK
4009	   Uncompressing Kernel Image ... OK
4010	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
4011	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4012	time_init: decrementer frequency = 187500000/60
4013	Calibrating delay loop... 49.77 BogoMIPS
4014	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4015	...
4016
4017If you want to boot a Linux kernel with initial RAM disk, you pass
4018the memory addresses of both the kernel and the initrd image (PPBCOOT
4019format!) to the "bootm" command:
4020
4021	=> imi 40100000 40200000
4022
4023	## Checking Image at 40100000 ...
4024	   Image Name:	 2.2.13 for initrd on TQM850L
4025	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4026	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4027	   Load Address: 00000000
4028	   Entry Point:	 0000000c
4029	   Verifying Checksum ... OK
4030
4031	## Checking Image at 40200000 ...
4032	   Image Name:	 Simple Ramdisk Image
4033	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4034	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4035	   Load Address: 00000000
4036	   Entry Point:	 00000000
4037	   Verifying Checksum ... OK
4038
4039	=> bootm 40100000 40200000
4040	## Booting Linux kernel at 40100000 ...
4041	   Image Name:	 2.2.13 for initrd on TQM850L
4042	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4043	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4044	   Load Address: 00000000
4045	   Entry Point:	 0000000c
4046	   Verifying Checksum ... OK
4047	   Uncompressing Kernel Image ... OK
4048	## Loading RAMDisk Image at 40200000 ...
4049	   Image Name:	 Simple Ramdisk Image
4050	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4051	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4052	   Load Address: 00000000
4053	   Entry Point:	 00000000
4054	   Verifying Checksum ... OK
4055	   Loading Ramdisk ... OK
4056	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
4057	Boot arguments: root=/dev/ram
4058	time_init: decrementer frequency = 187500000/60
4059	Calibrating delay loop... 49.77 BogoMIPS
4060	...
4061	RAMDISK: Compressed image found at block 0
4062	VFS: Mounted root (ext2 filesystem).
4063
4064	bash#
4065
4066Boot Linux and pass a flat device tree:
4067-----------
4068
4069First, U-Boot must be compiled with the appropriate defines. See the section
4070titled "Linux Kernel Interface" above for a more in depth explanation. The
4071following is an example of how to start a kernel and pass an updated
4072flat device tree:
4073
4074=> print oftaddr
4075oftaddr=0x300000
4076=> print oft
4077oft=oftrees/mpc8540ads.dtb
4078=> tftp $oftaddr $oft
4079Speed: 1000, full duplex
4080Using TSEC0 device
4081TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4082Filename 'oftrees/mpc8540ads.dtb'.
4083Load address: 0x300000
4084Loading: #
4085done
4086Bytes transferred = 4106 (100a hex)
4087=> tftp $loadaddr $bootfile
4088Speed: 1000, full duplex
4089Using TSEC0 device
4090TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4091Filename 'uImage'.
4092Load address: 0x200000
4093Loading:############
4094done
4095Bytes transferred = 1029407 (fb51f hex)
4096=> print loadaddr
4097loadaddr=200000
4098=> print oftaddr
4099oftaddr=0x300000
4100=> bootm $loadaddr - $oftaddr
4101## Booting image at 00200000 ...
4102   Image Name:	 Linux-2.6.17-dirty
4103   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4104   Data Size:	 1029343 Bytes = 1005.2 kB
4105   Load Address: 00000000
4106   Entry Point:	 00000000
4107   Verifying Checksum ... OK
4108   Uncompressing Kernel Image ... OK
4109Booting using flat device tree at 0x300000
4110Using MPC85xx ADS machine description
4111Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4112[snip]
4113
4114
4115More About U-Boot Image Types:
4116------------------------------
4117
4118U-Boot supports the following image types:
4119
4120   "Standalone Programs" are directly runnable in the environment
4121	provided by U-Boot; it is expected that (if they behave
4122	well) you can continue to work in U-Boot after return from
4123	the Standalone Program.
4124   "OS Kernel Images" are usually images of some Embedded OS which
4125	will take over control completely. Usually these programs
4126	will install their own set of exception handlers, device
4127	drivers, set up the MMU, etc. - this means, that you cannot
4128	expect to re-enter U-Boot except by resetting the CPU.
4129   "RAMDisk Images" are more or less just data blocks, and their
4130	parameters (address, size) are passed to an OS kernel that is
4131	being started.
4132   "Multi-File Images" contain several images, typically an OS
4133	(Linux) kernel image and one or more data images like
4134	RAMDisks. This construct is useful for instance when you want
4135	to boot over the network using BOOTP etc., where the boot
4136	server provides just a single image file, but you want to get
4137	for instance an OS kernel and a RAMDisk image.
4138
4139	"Multi-File Images" start with a list of image sizes, each
4140	image size (in bytes) specified by an "uint32_t" in network
4141	byte order. This list is terminated by an "(uint32_t)0".
4142	Immediately after the terminating 0 follow the images, one by
4143	one, all aligned on "uint32_t" boundaries (size rounded up to
4144	a multiple of 4 bytes).
4145
4146   "Firmware Images" are binary images containing firmware (like
4147	U-Boot or FPGA images) which usually will be programmed to
4148	flash memory.
4149
4150   "Script files" are command sequences that will be executed by
4151	U-Boot's command interpreter; this feature is especially
4152	useful when you configure U-Boot to use a real shell (hush)
4153	as command interpreter.
4154
4155Booting the Linux zImage:
4156-------------------------
4157
4158On some platforms, it's possible to boot Linux zImage. This is done
4159using the "bootz" command. The syntax of "bootz" command is the same
4160as the syntax of "bootm" command.
4161
4162Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
4163kernel with raw initrd images. The syntax is slightly different, the
4164address of the initrd must be augmented by it's size, in the following
4165format: "<initrd addres>:<initrd size>".
4166
4167
4168Standalone HOWTO:
4169=================
4170
4171One of the features of U-Boot is that you can dynamically load and
4172run "standalone" applications, which can use some resources of
4173U-Boot like console I/O functions or interrupt services.
4174
4175Two simple examples are included with the sources:
4176
4177"Hello World" Demo:
4178-------------------
4179
4180'examples/hello_world.c' contains a small "Hello World" Demo
4181application; it is automatically compiled when you build U-Boot.
4182It's configured to run at address 0x00040004, so you can play with it
4183like that:
4184
4185	=> loads
4186	## Ready for S-Record download ...
4187	~>examples/hello_world.srec
4188	1 2 3 4 5 6 7 8 9 10 11 ...
4189	[file transfer complete]
4190	[connected]
4191	## Start Addr = 0x00040004
4192
4193	=> go 40004 Hello World! This is a test.
4194	## Starting application at 0x00040004 ...
4195	Hello World
4196	argc = 7
4197	argv[0] = "40004"
4198	argv[1] = "Hello"
4199	argv[2] = "World!"
4200	argv[3] = "This"
4201	argv[4] = "is"
4202	argv[5] = "a"
4203	argv[6] = "test."
4204	argv[7] = "<NULL>"
4205	Hit any key to exit ...
4206
4207	## Application terminated, rc = 0x0
4208
4209Another example, which demonstrates how to register a CPM interrupt
4210handler with the U-Boot code, can be found in 'examples/timer.c'.
4211Here, a CPM timer is set up to generate an interrupt every second.
4212The interrupt service routine is trivial, just printing a '.'
4213character, but this is just a demo program. The application can be
4214controlled by the following keys:
4215
4216	? - print current values og the CPM Timer registers
4217	b - enable interrupts and start timer
4218	e - stop timer and disable interrupts
4219	q - quit application
4220
4221	=> loads
4222	## Ready for S-Record download ...
4223	~>examples/timer.srec
4224	1 2 3 4 5 6 7 8 9 10 11 ...
4225	[file transfer complete]
4226	[connected]
4227	## Start Addr = 0x00040004
4228
4229	=> go 40004
4230	## Starting application at 0x00040004 ...
4231	TIMERS=0xfff00980
4232	Using timer 1
4233	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4234
4235Hit 'b':
4236	[q, b, e, ?] Set interval 1000000 us
4237	Enabling timer
4238Hit '?':
4239	[q, b, e, ?] ........
4240	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4241Hit '?':
4242	[q, b, e, ?] .
4243	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4244Hit '?':
4245	[q, b, e, ?] .
4246	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4247Hit '?':
4248	[q, b, e, ?] .
4249	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4250Hit 'e':
4251	[q, b, e, ?] ...Stopping timer
4252Hit 'q':
4253	[q, b, e, ?] ## Application terminated, rc = 0x0
4254
4255
4256Minicom warning:
4257================
4258
4259Over time, many people have reported problems when trying to use the
4260"minicom" terminal emulation program for serial download. I (wd)
4261consider minicom to be broken, and recommend not to use it. Under
4262Unix, I recommend to use C-Kermit for general purpose use (and
4263especially for kermit binary protocol download ("loadb" command), and
4264use "cu" for S-Record download ("loads" command).  See
4265http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4266for help with kermit.
4267
4268
4269Nevertheless, if you absolutely want to use it try adding this
4270configuration to your "File transfer protocols" section:
4271
4272	   Name	   Program			Name U/D FullScr IO-Red. Multi
4273	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
4274	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
4275
4276
4277NetBSD Notes:
4278=============
4279
4280Starting at version 0.9.2, U-Boot supports NetBSD both as host
4281(build U-Boot) and target system (boots NetBSD/mpc8xx).
4282
4283Building requires a cross environment; it is known to work on
4284NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4285need gmake since the Makefiles are not compatible with BSD make).
4286Note that the cross-powerpc package does not install include files;
4287attempting to build U-Boot will fail because <machine/ansi.h> is
4288missing.  This file has to be installed and patched manually:
4289
4290	# cd /usr/pkg/cross/powerpc-netbsd/include
4291	# mkdir powerpc
4292	# ln -s powerpc machine
4293	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4294	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4295
4296Native builds *don't* work due to incompatibilities between native
4297and U-Boot include files.
4298
4299Booting assumes that (the first part of) the image booted is a
4300stage-2 loader which in turn loads and then invokes the kernel
4301proper. Loader sources will eventually appear in the NetBSD source
4302tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
4303meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4304
4305
4306Implementation Internals:
4307=========================
4308
4309The following is not intended to be a complete description of every
4310implementation detail. However, it should help to understand the
4311inner workings of U-Boot and make it easier to port it to custom
4312hardware.
4313
4314
4315Initial Stack, Global Data:
4316---------------------------
4317
4318The implementation of U-Boot is complicated by the fact that U-Boot
4319starts running out of ROM (flash memory), usually without access to
4320system RAM (because the memory controller is not initialized yet).
4321This means that we don't have writable Data or BSS segments, and BSS
4322is not initialized as zero. To be able to get a C environment working
4323at all, we have to allocate at least a minimal stack. Implementation
4324options for this are defined and restricted by the CPU used: Some CPU
4325models provide on-chip memory (like the IMMR area on MPC8xx and
4326MPC826x processors), on others (parts of) the data cache can be
4327locked as (mis-) used as memory, etc.
4328
4329	Chris Hallinan posted a good summary of these issues to the
4330	U-Boot mailing list:
4331
4332	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4333	From: "Chris Hallinan" <clh@net1plus.com>
4334	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4335	...
4336
4337	Correct me if I'm wrong, folks, but the way I understand it
4338	is this: Using DCACHE as initial RAM for Stack, etc, does not
4339	require any physical RAM backing up the cache. The cleverness
4340	is that the cache is being used as a temporary supply of
4341	necessary storage before the SDRAM controller is setup. It's
4342	beyond the scope of this list to explain the details, but you
4343	can see how this works by studying the cache architecture and
4344	operation in the architecture and processor-specific manuals.
4345
4346	OCM is On Chip Memory, which I believe the 405GP has 4K. It
4347	is another option for the system designer to use as an
4348	initial stack/RAM area prior to SDRAM being available. Either
4349	option should work for you. Using CS 4 should be fine if your
4350	board designers haven't used it for something that would
4351	cause you grief during the initial boot! It is frequently not
4352	used.
4353
4354	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
4355	with your processor/board/system design. The default value
4356	you will find in any recent u-boot distribution in
4357	walnut.h should work for you. I'd set it to a value larger
4358	than your SDRAM module. If you have a 64MB SDRAM module, set
4359	it above 400_0000. Just make sure your board has no resources
4360	that are supposed to respond to that address! That code in
4361	start.S has been around a while and should work as is when
4362	you get the config right.
4363
4364	-Chris Hallinan
4365	DS4.COM, Inc.
4366
4367It is essential to remember this, since it has some impact on the C
4368code for the initialization procedures:
4369
4370* Initialized global data (data segment) is read-only. Do not attempt
4371  to write it.
4372
4373* Do not use any uninitialized global data (or implicitly initialized
4374  as zero data - BSS segment) at all - this is undefined, initiali-
4375  zation is performed later (when relocating to RAM).
4376
4377* Stack space is very limited. Avoid big data buffers or things like
4378  that.
4379
4380Having only the stack as writable memory limits means we cannot use
4381normal global data to share information between the code. But it
4382turned out that the implementation of U-Boot can be greatly
4383simplified by making a global data structure (gd_t) available to all
4384functions. We could pass a pointer to this data as argument to _all_
4385functions, but this would bloat the code. Instead we use a feature of
4386the GCC compiler (Global Register Variables) to share the data: we
4387place a pointer (gd) to the global data into a register which we
4388reserve for this purpose.
4389
4390When choosing a register for such a purpose we are restricted by the
4391relevant  (E)ABI  specifications for the current architecture, and by
4392GCC's implementation.
4393
4394For PowerPC, the following registers have specific use:
4395	R1:	stack pointer
4396	R2:	reserved for system use
4397	R3-R4:	parameter passing and return values
4398	R5-R10: parameter passing
4399	R13:	small data area pointer
4400	R30:	GOT pointer
4401	R31:	frame pointer
4402
4403	(U-Boot also uses R12 as internal GOT pointer. r12
4404	is a volatile register so r12 needs to be reset when
4405	going back and forth between asm and C)
4406
4407    ==> U-Boot will use R2 to hold a pointer to the global data
4408
4409    Note: on PPC, we could use a static initializer (since the
4410    address of the global data structure is known at compile time),
4411    but it turned out that reserving a register results in somewhat
4412    smaller code - although the code savings are not that big (on
4413    average for all boards 752 bytes for the whole U-Boot image,
4414    624 text + 127 data).
4415
4416On ARM, the following registers are used:
4417
4418	R0:	function argument word/integer result
4419	R1-R3:	function argument word
4420	R9:	platform specific
4421	R10:	stack limit (used only if stack checking is enabled)
4422	R11:	argument (frame) pointer
4423	R12:	temporary workspace
4424	R13:	stack pointer
4425	R14:	link register
4426	R15:	program counter
4427
4428    ==> U-Boot will use R9 to hold a pointer to the global data
4429
4430    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
4431
4432On Nios II, the ABI is documented here:
4433	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4434
4435    ==> U-Boot will use gp to hold a pointer to the global data
4436
4437    Note: on Nios II, we give "-G0" option to gcc and don't use gp
4438    to access small data sections, so gp is free.
4439
4440On NDS32, the following registers are used:
4441
4442	R0-R1:	argument/return
4443	R2-R5:	argument
4444	R15:	temporary register for assembler
4445	R16:	trampoline register
4446	R28:	frame pointer (FP)
4447	R29:	global pointer (GP)
4448	R30:	link register (LP)
4449	R31:	stack pointer (SP)
4450	PC:	program counter (PC)
4451
4452    ==> U-Boot will use R10 to hold a pointer to the global data
4453
4454NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4455or current versions of GCC may "optimize" the code too much.
4456
4457On RISC-V, the following registers are used:
4458
4459	x0: hard-wired zero (zero)
4460	x1: return address (ra)
4461	x2:	stack pointer (sp)
4462	x3:	global pointer (gp)
4463	x4:	thread pointer (tp)
4464	x5:	link register (t0)
4465	x8:	frame pointer (fp)
4466	x10-x11:	arguments/return values (a0-1)
4467	x12-x17:	arguments (a2-7)
4468	x28-31:	 temporaries (t3-6)
4469	pc:	program counter (pc)
4470
4471    ==> U-Boot will use gp to hold a pointer to the global data
4472
4473Memory Management:
4474------------------
4475
4476U-Boot runs in system state and uses physical addresses, i.e. the
4477MMU is not used either for address mapping nor for memory protection.
4478
4479The available memory is mapped to fixed addresses using the memory
4480controller. In this process, a contiguous block is formed for each
4481memory type (Flash, SDRAM, SRAM), even when it consists of several
4482physical memory banks.
4483
4484U-Boot is installed in the first 128 kB of the first Flash bank (on
4485TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4486booting and sizing and initializing DRAM, the code relocates itself
4487to the upper end of DRAM. Immediately below the U-Boot code some
4488memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4489configuration setting]. Below that, a structure with global Board
4490Info data is placed, followed by the stack (growing downward).
4491
4492Additionally, some exception handler code is copied to the low 8 kB
4493of DRAM (0x00000000 ... 0x00001FFF).
4494
4495So a typical memory configuration with 16 MB of DRAM could look like
4496this:
4497
4498	0x0000 0000	Exception Vector code
4499	      :
4500	0x0000 1FFF
4501	0x0000 2000	Free for Application Use
4502	      :
4503	      :
4504
4505	      :
4506	      :
4507	0x00FB FF20	Monitor Stack (Growing downward)
4508	0x00FB FFAC	Board Info Data and permanent copy of global data
4509	0x00FC 0000	Malloc Arena
4510	      :
4511	0x00FD FFFF
4512	0x00FE 0000	RAM Copy of Monitor Code
4513	...		eventually: LCD or video framebuffer
4514	...		eventually: pRAM (Protected RAM - unchanged by reset)
4515	0x00FF FFFF	[End of RAM]
4516
4517
4518System Initialization:
4519----------------------
4520
4521In the reset configuration, U-Boot starts at the reset entry point
4522(on most PowerPC systems at address 0x00000100). Because of the reset
4523configuration for CS0# this is a mirror of the on board Flash memory.
4524To be able to re-map memory U-Boot then jumps to its link address.
4525To be able to implement the initialization code in C, a (small!)
4526initial stack is set up in the internal Dual Ported RAM (in case CPUs
4527which provide such a feature like), or in a locked part of the data
4528cache. After that, U-Boot initializes the CPU core, the caches and
4529the SIU.
4530
4531Next, all (potentially) available memory banks are mapped using a
4532preliminary mapping. For example, we put them on 512 MB boundaries
4533(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4534on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4535programmed for SDRAM access. Using the temporary configuration, a
4536simple memory test is run that determines the size of the SDRAM
4537banks.
4538
4539When there is more than one SDRAM bank, and the banks are of
4540different size, the largest is mapped first. For equal size, the first
4541bank (CS2#) is mapped first. The first mapping is always for address
45420x00000000, with any additional banks following immediately to create
4543contiguous memory starting from 0.
4544
4545Then, the monitor installs itself at the upper end of the SDRAM area
4546and allocates memory for use by malloc() and for the global Board
4547Info data; also, the exception vector code is copied to the low RAM
4548pages, and the final stack is set up.
4549
4550Only after this relocation will you have a "normal" C environment;
4551until that you are restricted in several ways, mostly because you are
4552running from ROM, and because the code will have to be relocated to a
4553new address in RAM.
4554
4555
4556U-Boot Porting Guide:
4557----------------------
4558
4559[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4560list, October 2002]
4561
4562
4563int main(int argc, char *argv[])
4564{
4565	sighandler_t no_more_time;
4566
4567	signal(SIGALRM, no_more_time);
4568	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4569
4570	if (available_money > available_manpower) {
4571		Pay consultant to port U-Boot;
4572		return 0;
4573	}
4574
4575	Download latest U-Boot source;
4576
4577	Subscribe to u-boot mailing list;
4578
4579	if (clueless)
4580		email("Hi, I am new to U-Boot, how do I get started?");
4581
4582	while (learning) {
4583		Read the README file in the top level directory;
4584		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4585		Read applicable doc/README.*;
4586		Read the source, Luke;
4587		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4588	}
4589
4590	if (available_money > toLocalCurrency ($2500))
4591		Buy a BDI3000;
4592	else
4593		Add a lot of aggravation and time;
4594
4595	if (a similar board exists) {	/* hopefully... */
4596		cp -a board/<similar> board/<myboard>
4597		cp include/configs/<similar>.h include/configs/<myboard>.h
4598	} else {
4599		Create your own board support subdirectory;
4600		Create your own board include/configs/<myboard>.h file;
4601	}
4602	Edit new board/<myboard> files
4603	Edit new include/configs/<myboard>.h
4604
4605	while (!accepted) {
4606		while (!running) {
4607			do {
4608				Add / modify source code;
4609			} until (compiles);
4610			Debug;
4611			if (clueless)
4612				email("Hi, I am having problems...");
4613		}
4614		Send patch file to the U-Boot email list;
4615		if (reasonable critiques)
4616			Incorporate improvements from email list code review;
4617		else
4618			Defend code as written;
4619	}
4620
4621	return 0;
4622}
4623
4624void no_more_time (int sig)
4625{
4626      hire_a_guru();
4627}
4628
4629
4630Coding Standards:
4631-----------------
4632
4633All contributions to U-Boot should conform to the Linux kernel
4634coding style; see the kernel coding style guide at
4635https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4636script "scripts/Lindent" in your Linux kernel source directory.
4637
4638Source files originating from a different project (for example the
4639MTD subsystem) are generally exempt from these guidelines and are not
4640reformatted to ease subsequent migration to newer versions of those
4641sources.
4642
4643Please note that U-Boot is implemented in C (and to some small parts in
4644Assembler); no C++ is used, so please do not use C++ style comments (//)
4645in your code.
4646
4647Please also stick to the following formatting rules:
4648- remove any trailing white space
4649- use TAB characters for indentation and vertical alignment, not spaces
4650- make sure NOT to use DOS '\r\n' line feeds
4651- do not add more than 2 consecutive empty lines to source files
4652- do not add trailing empty lines to source files
4653
4654Submissions which do not conform to the standards may be returned
4655with a request to reformat the changes.
4656
4657
4658Submitting Patches:
4659-------------------
4660
4661Since the number of patches for U-Boot is growing, we need to
4662establish some rules. Submissions which do not conform to these rules
4663may be rejected, even when they contain important and valuable stuff.
4664
4665Please see http://www.denx.de/wiki/U-Boot/Patches for details.
4666
4667Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4668see https://lists.denx.de/listinfo/u-boot
4669
4670When you send a patch, please include the following information with
4671it:
4672
4673* For bug fixes: a description of the bug and how your patch fixes
4674  this bug. Please try to include a way of demonstrating that the
4675  patch actually fixes something.
4676
4677* For new features: a description of the feature and your
4678  implementation.
4679
4680* For major contributions, add a MAINTAINERS file with your
4681  information and associated file and directory references.
4682
4683* When you add support for a new board, don't forget to add a
4684  maintainer e-mail address to the boards.cfg file, too.
4685
4686* If your patch adds new configuration options, don't forget to
4687  document these in the README file.
4688
4689* The patch itself. If you are using git (which is *strongly*
4690  recommended) you can easily generate the patch using the
4691  "git format-patch". If you then use "git send-email" to send it to
4692  the U-Boot mailing list, you will avoid most of the common problems
4693  with some other mail clients.
4694
4695  If you cannot use git, use "diff -purN OLD NEW". If your version of
4696  diff does not support these options, then get the latest version of
4697  GNU diff.
4698
4699  The current directory when running this command shall be the parent
4700  directory of the U-Boot source tree (i. e. please make sure that
4701  your patch includes sufficient directory information for the
4702  affected files).
4703
4704  We prefer patches as plain text. MIME attachments are discouraged,
4705  and compressed attachments must not be used.
4706
4707* If one logical set of modifications affects or creates several
4708  files, all these changes shall be submitted in a SINGLE patch file.
4709
4710* Changesets that contain different, unrelated modifications shall be
4711  submitted as SEPARATE patches, one patch per changeset.
4712
4713
4714Notes:
4715
4716* Before sending the patch, run the buildman script on your patched
4717  source tree and make sure that no errors or warnings are reported
4718  for any of the boards.
4719
4720* Keep your modifications to the necessary minimum: A patch
4721  containing several unrelated changes or arbitrary reformats will be
4722  returned with a request to re-formatting / split it.
4723
4724* If you modify existing code, make sure that your new code does not
4725  add to the memory footprint of the code ;-) Small is beautiful!
4726  When adding new features, these should compile conditionally only
4727  (using #ifdef), and the resulting code with the new feature
4728  disabled must not need more memory than the old code without your
4729  modification.
4730
4731* Remember that there is a size limit of 100 kB per message on the
4732  u-boot mailing list. Bigger patches will be moderated. If they are
4733  reasonable and not too big, they will be acknowledged. But patches
4734  bigger than the size limit should be avoided.
4735