configs: Resync with savedefconfig
[ti-u-boot/ti-u-boot.git] / README
1 # SPDX-License-Identifier: GPL-2.0+
2 #
3 # (C) Copyright 2000 - 2013
4 # Wolfgang Denk, DENX Software Engineering,
6 Summary:
7 ========
9 This directory contains the source code for U-Boot, a boot loader for
10 Embedded boards based on PowerPC, ARM, MIPS and several other
11 processors, which can be installed in a boot ROM and used to
12 initialize and test the hardware or to download and run application
13 code.
15 The development of U-Boot is closely related to Linux: some parts of
16 the source code originate in the Linux source tree, we have some
17 header files in common, and special provision has been made to
18 support booting of Linux images.
20 Some attention has been paid to make this software easily
21 configurable and extendable. For instance, all monitor commands are
22 implemented with the same call interface, so that it's very easy to
23 add new commands. Also, instead of permanently adding rarely used
24 code (for instance hardware test utilities) to the monitor, you can
25 load and run it dynamically.
28 Status:
29 =======
31 In general, all boards for which a configuration option exists in the
32 Makefile have been tested to some extent and can be considered
33 "working". In fact, many of them are used in production systems.
35 In case of problems see the CHANGELOG file to find out who contributed
36 the specific port. In addition, there are various MAINTAINERS files
37 scattered throughout the U-Boot source identifying the people or
38 companies responsible for various boards and subsystems.
40 Note: As of August, 2010, there is no longer a CHANGELOG file in the
41 actual U-Boot source tree; however, it can be created dynamically
42 from the Git log using:
44         make CHANGELOG
47 Where to get help:
48 ==================
50 In case you have questions about, problems with or contributions for
51 U-Boot, you should send a message to the U-Boot mailing list at
52 <>. There is also an archive of previous traffic
53 on the mailing list - please search the archive before asking FAQ's.
54 Please see and
57 Where to get source code:
58 =========================
60 The U-Boot source code is maintained in the Git repository at
61 ; you can browse it online at
64 The "Tags" links on this page allow you to download tarballs of
65 any version you might be interested in. Official releases are also
66 available from the DENX file server through HTTPS or FTP.
71 Where we come from:
72 ===================
74 - start from 8xxrom sources
75 - create PPCBoot project (
76 - clean up code
77 - make it easier to add custom boards
78 - make it possible to add other [PowerPC] CPUs
79 - extend functions, especially:
80   * Provide extended interface to Linux boot loader
81   * S-Record download
82   * network boot
83   * ATA disk / SCSI ... boot
84 - create ARMBoot project (
85 - add other CPU families (starting with ARM)
86 - create U-Boot project (
87 - current project page: see
90 Names and Spelling:
91 ===================
93 The "official" name of this project is "Das U-Boot". The spelling
94 "U-Boot" shall be used in all written text (documentation, comments
95 in source files etc.). Example:
97         This is the README file for the U-Boot project.
99 File names etc. shall be based on the string "u-boot". Examples:
101         include/asm-ppc/u-boot.h
103         #include <asm/u-boot.h>
105 Variable names, preprocessor constants etc. shall be either based on
106 the string "u_boot" or on "U_BOOT". Example:
108         U_BOOT_VERSION          u_boot_logo
109         IH_OS_U_BOOT            u_boot_hush_start
112 Versioning:
113 ===========
115 Starting with the release in October 2008, the names of the releases
116 were changed from numerical release numbers without deeper meaning
117 into a time stamp based numbering. Regular releases are identified by
118 names consisting of the calendar year and month of the release date.
119 Additional fields (if present) indicate release candidates or bug fix
120 releases in "stable" maintenance trees.
122 Examples:
123         U-Boot v2009.11     - Release November 2009
124         U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
125         U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
128 Directory Hierarchy:
129 ====================
131 /arch                   Architecture specific files
132   /arc                  Files generic to ARC architecture
133   /arm                  Files generic to ARM architecture
134   /m68k                 Files generic to m68k architecture
135   /microblaze           Files generic to microblaze architecture
136   /mips                 Files generic to MIPS architecture
137   /nds32                Files generic to NDS32 architecture
138   /nios2                Files generic to Altera NIOS2 architecture
139   /powerpc              Files generic to PowerPC architecture
140   /riscv                Files generic to RISC-V architecture
141   /sandbox              Files generic to HW-independent "sandbox"
142   /sh                   Files generic to SH architecture
143   /x86                  Files generic to x86 architecture
144   /xtensa               Files generic to Xtensa architecture
145 /api                    Machine/arch independent API for external apps
146 /board                  Board dependent files
147 /cmd                    U-Boot commands functions
148 /common                 Misc architecture independent functions
149 /configs                Board default configuration files
150 /disk                   Code for disk drive partition handling
151 /doc                    Documentation (don't expect too much)
152 /drivers                Commonly used device drivers
153 /dts                    Contains Makefile for building internal U-Boot fdt.
154 /env                    Environment files
155 /examples               Example code for standalone applications, etc.
156 /fs                     Filesystem code (cramfs, ext2, jffs2, etc.)
157 /include                Header Files
158 /lib                    Library routines generic to all architectures
159 /Licenses               Various license files
160 /net                    Networking code
161 /post                   Power On Self Test
162 /scripts                Various build scripts and Makefiles
163 /test                   Various unit test files
164 /tools                  Tools to build S-Record or U-Boot images, etc.
166 Software Configuration:
167 =======================
169 Configuration is usually done using C preprocessor defines; the
170 rationale behind that is to avoid dead code whenever possible.
172 There are two classes of configuration variables:
174 * Configuration _OPTIONS_:
175   These are selectable by the user and have names beginning with
176   "CONFIG_".
178 * Configuration _SETTINGS_:
179   These depend on the hardware etc. and should not be meddled with if
180   you don't know what you're doing; they have names beginning with
181   "CONFIG_SYS_".
183 Previously, all configuration was done by hand, which involved creating
184 symbolic links and editing configuration files manually. More recently,
185 U-Boot has added the Kbuild infrastructure used by the Linux kernel,
186 allowing you to use the "make menuconfig" command to configure your
187 build.
190 Selection of Processor Architecture and Board Type:
191 ---------------------------------------------------
193 For all supported boards there are ready-to-use default
194 configurations available; just type "make <board_name>_defconfig".
196 Example: For a TQM823L module type:
198         cd u-boot
199         make TQM823L_defconfig
201 Note: If you're looking for the default configuration file for a board
202 you're sure used to be there but is now missing, check the file
203 doc/README.scrapyard for a list of no longer supported boards.
205 Sandbox Environment:
206 --------------------
208 U-Boot can be built natively to run on a Linux host using the 'sandbox'
209 board. This allows feature development which is not board- or architecture-
210 specific to be undertaken on a native platform. The sandbox is also used to
211 run some of U-Boot's tests.
213 See doc/arch/sandbox.rst for more details.
216 Board Initialisation Flow:
217 --------------------------
219 This is the intended start-up flow for boards. This should apply for both
220 SPL and U-Boot proper (i.e. they both follow the same rules).
222 Note: "SPL" stands for "Secondary Program Loader," which is explained in
223 more detail later in this file.
225 At present, SPL mostly uses a separate code path, but the function names
226 and roles of each function are the same. Some boards or architectures
227 may not conform to this.  At least most ARM boards which use
228 CONFIG_SPL_FRAMEWORK conform to this.
230 Execution typically starts with an architecture-specific (and possibly
231 CPU-specific) start.S file, such as:
233         - arch/arm/cpu/armv7/start.S
234         - arch/powerpc/cpu/mpc83xx/start.S
235         - arch/mips/cpu/start.S
237 and so on. From there, three functions are called; the purpose and
238 limitations of each of these functions are described below.
240 lowlevel_init():
241         - purpose: essential init to permit execution to reach board_init_f()
242         - no global_data or BSS
243         - there is no stack (ARMv7 may have one but it will soon be removed)
244         - must not set up SDRAM or use console
245         - must only do the bare minimum to allow execution to continue to
246                 board_init_f()
247         - this is almost never needed
248         - return normally from this function
250 board_init_f():
251         - purpose: set up the machine ready for running board_init_r():
252                 i.e. SDRAM and serial UART
253         - global_data is available
254         - stack is in SRAM
255         - BSS is not available, so you cannot use global/static variables,
256                 only stack variables and global_data
258         Non-SPL-specific notes:
259         - dram_init() is called to set up DRAM. If already done in SPL this
260                 can do nothing
262         SPL-specific notes:
263         - you can override the entire board_init_f() function with your own
264                 version as needed.
265         - preloader_console_init() can be called here in extremis
266         - should set up SDRAM, and anything needed to make the UART work
267         - there is no need to clear BSS, it will be done by crt0.S
268         - for specific scenarios on certain architectures an early BSS *can*
269           be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
270           of BSS prior to entering board_init_f()) but doing so is discouraged.
271           Instead it is strongly recommended to architect any code changes
272           or additions such to not depend on the availability of BSS during
273           board_init_f() as indicated in other sections of this README to
274           maintain compatibility and consistency across the entire code base.
275         - must return normally from this function (don't call board_init_r()
276                 directly)
278 Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
279 this point the stack and global_data are relocated to below
280 CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
281 memory.
283 board_init_r():
284         - purpose: main execution, common code
285         - global_data is available
286         - SDRAM is available
287         - BSS is available, all static/global variables can be used
288         - execution eventually continues to main_loop()
290         Non-SPL-specific notes:
291         - U-Boot is relocated to the top of memory and is now running from
292                 there.
294         SPL-specific notes:
295         - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
296                 CONFIG_SPL_STACK_R_ADDR points into SDRAM
297         - preloader_console_init() can be called here - typically this is
298                 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
299                 spl_board_init() function containing this call
300         - loads U-Boot or (in falcon mode) Linux
304 Configuration Options:
305 ----------------------
307 Configuration depends on the combination of board and CPU type; all
308 such information is kept in a configuration file
309 "include/configs/<board_name>.h".
311 Example: For a TQM823L module, all configuration settings are in
312 "include/configs/TQM823L.h".
315 Many of the options are named exactly as the corresponding Linux
316 kernel configuration options. The intention is to make it easier to
317 build a config tool - later.
319 - ARM Platform Bus Type(CCI):
320                 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
321                 provides full cache coherency between two clusters of multi-core
322                 CPUs and I/O coherency for devices and I/O masters
324                 CONFIG_SYS_FSL_HAS_CCI400
326                 Defined For SoC that has cache coherent interconnect
327                 CCN-400
329                 CONFIG_SYS_FSL_HAS_CCN504
331                 Defined for SoC that has cache coherent interconnect CCN-504
333 The following options need to be configured:
335 - CPU Type:     Define exactly one, e.g. CONFIG_MPC85XX.
337 - Board Type:   Define exactly one, e.g. CONFIG_MPC8540ADS.
339 - 85xx CPU Options:
340                 CONFIG_SYS_PPC64
342                 Specifies that the core is a 64-bit PowerPC implementation (implements
343                 the "64" category of the Power ISA). This is necessary for ePAPR
344                 compliance, among other possible reasons.
346                 CONFIG_SYS_FSL_TBCLK_DIV
348                 Defines the core time base clock divider ratio compared to the
349                 system clock.  On most PQ3 devices this is 8, on newer QorIQ
350                 devices it can be 16 or 32.  The ratio varies from SoC to Soc.
352                 CONFIG_SYS_FSL_PCIE_COMPAT
354                 Defines the string to utilize when trying to match PCIe device
355                 tree nodes for the given platform.
357                 CONFIG_SYS_FSL_ERRATUM_A004510
359                 Enables a workaround for erratum A004510.  If set,
360                 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
361                 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
363                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
364                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
366                 Defines one or two SoC revisions (low 8 bits of SVR)
367                 for which the A004510 workaround should be applied.
369                 The rest of SVR is either not relevant to the decision
370                 of whether the erratum is present (e.g. p2040 versus
371                 p2041) or is implied by the build target, which controls
372                 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
374                 See Freescale App Note 4493 for more information about
375                 this erratum.
377                 CONFIG_A003399_NOR_WORKAROUND
378                 Enables a workaround for IFC erratum A003399. It is only
379                 required during NOR boot.
381                 CONFIG_A008044_WORKAROUND
382                 Enables a workaround for T1040/T1042 erratum A008044. It is only
383                 required during NAND boot and valid for Rev 1.0 SoC revision
387                 This is the value to write into CCSR offset 0x18600
388                 according to the A004510 workaround.
390                 CONFIG_SYS_FSL_DSP_DDR_ADDR
391                 This value denotes start offset of DDR memory which is
392                 connected exclusively to the DSP cores.
394                 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
395                 This value denotes start offset of M2 memory
396                 which is directly connected to the DSP core.
398                 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
399                 This value denotes start offset of M3 memory which is directly
400                 connected to the DSP core.
403                 This value denotes start offset of DSP CCSR space.
406                 Single Source Clock is clocking mode present in some of FSL SoC's.
407                 In this mode, a single differential clock is used to supply
408                 clocks to the sysclock, ddrclock and usbclock.
410                 CONFIG_SYS_CPC_REINIT_F
411                 This CONFIG is defined when the CPC is configured as SRAM at the
412                 time of U-Boot entry and is required to be re-initialized.
414                 CONFIG_DEEP_SLEEP
415                 Indicates this SoC supports deep sleep feature. If deep sleep is
416                 supported, core will start to execute uboot when wakes up.
418 - Generic CPU options:
421                 Defines the endianess of the CPU. Implementation of those
422                 values is arch specific.
424                 CONFIG_SYS_FSL_DDR
425                 Freescale DDR driver in use. This type of DDR controller is
426                 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
427                 SoCs.
429                 CONFIG_SYS_FSL_DDR_ADDR
430                 Freescale DDR memory-mapped register base.
432                 CONFIG_SYS_FSL_DDR_EMU
433                 Specify emulator support for DDR. Some DDR features such as
434                 deskew training are not available.
436                 CONFIG_SYS_FSL_DDRC_GEN1
437                 Freescale DDR1 controller.
439                 CONFIG_SYS_FSL_DDRC_GEN2
440                 Freescale DDR2 controller.
442                 CONFIG_SYS_FSL_DDRC_GEN3
443                 Freescale DDR3 controller.
445                 CONFIG_SYS_FSL_DDRC_GEN4
446                 Freescale DDR4 controller.
448                 CONFIG_SYS_FSL_DDRC_ARM_GEN3
449                 Freescale DDR3 controller for ARM-based SoCs.
451                 CONFIG_SYS_FSL_DDR1
452                 Board config to use DDR1. It can be enabled for SoCs with
453                 Freescale DDR1 or DDR2 controllers, depending on the board
454                 implemetation.
456                 CONFIG_SYS_FSL_DDR2
457                 Board config to use DDR2. It can be enabled for SoCs with
458                 Freescale DDR2 or DDR3 controllers, depending on the board
459                 implementation.
461                 CONFIG_SYS_FSL_DDR3
462                 Board config to use DDR3. It can be enabled for SoCs with
463                 Freescale DDR3 or DDR3L controllers.
465                 CONFIG_SYS_FSL_DDR3L
466                 Board config to use DDR3L. It can be enabled for SoCs with
467                 DDR3L controllers.
469                 CONFIG_SYS_FSL_DDR4
470                 Board config to use DDR4. It can be enabled for SoCs with
471                 DDR4 controllers.
473                 CONFIG_SYS_FSL_IFC_BE
474                 Defines the IFC controller register space as Big Endian
476                 CONFIG_SYS_FSL_IFC_LE
477                 Defines the IFC controller register space as Little Endian
479                 CONFIG_SYS_FSL_IFC_CLK_DIV
480                 Defines divider of platform clock(clock input to IFC controller).
482                 CONFIG_SYS_FSL_LBC_CLK_DIV
483                 Defines divider of platform clock(clock input to eLBC controller).
485                 CONFIG_SYS_FSL_PBL_PBI
486                 It enables addition of RCW (Power on reset configuration) in built image.
487                 Please refer doc/README.pblimage for more details
489                 CONFIG_SYS_FSL_PBL_RCW
490                 It adds PBI(pre-boot instructions) commands in u-boot build image.
491                 PBI commands can be used to configure SoC before it starts the execution.
492                 Please refer doc/README.pblimage for more details
494                 CONFIG_SYS_FSL_DDR_BE
495                 Defines the DDR controller register space as Big Endian
497                 CONFIG_SYS_FSL_DDR_LE
498                 Defines the DDR controller register space as Little Endian
501                 Physical address from the view of DDR controllers. It is the
502                 same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
503                 it could be different for ARM SoCs.
505                 CONFIG_SYS_FSL_DDR_INTLV_256B
506                 DDR controller interleaving on 256-byte. This is a special
507                 interleaving mode, handled by Dickens for Freescale layerscape
508                 SoCs with ARM core.
511                 Number of controllers used as main memory.
514                 Number of controllers used for other than main memory.
516                 CONFIG_SYS_FSL_HAS_DP_DDR
517                 Defines the SoC has DP-DDR used for DPAA.
519                 CONFIG_SYS_FSL_SEC_BE
520                 Defines the SEC controller register space as Big Endian
522                 CONFIG_SYS_FSL_SEC_LE
523                 Defines the SEC controller register space as Little Endian
525 - MIPS CPU options:
526                 CONFIG_SYS_INIT_SP_OFFSET
528                 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
529                 pointer. This is needed for the temporary stack before
530                 relocation.
532                 CONFIG_XWAY_SWAP_BYTES
534                 Enable compilation of tools/xway-swap-bytes needed for Lantiq
535                 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
536                 be swapped if a flash programmer is used.
538 - ARM options:
541                 Select high exception vectors of the ARM core, e.g., do not
542                 clear the V bit of the c1 register of CP15.
544                 COUNTER_FREQUENCY
545                 Generic timer clock source frequency.
547                 COUNTER_FREQUENCY_REAL
548                 Generic timer clock source frequency if the real clock is
549                 different from COUNTER_FREQUENCY, and can only be determined
550                 at run time.
552 - Tegra SoC options:
555                 Support executing U-Boot in non-secure (NS) mode. Certain
556                 impossible actions will be skipped if the CPU is in NS mode,
557                 such as ARM architectural timer initialization.
559 - Linux Kernel Interface:
560                 CONFIG_MEMSIZE_IN_BYTES         [relevant for MIPS only]
562                 When transferring memsize parameter to Linux, some versions
563                 expect it to be in bytes, others in MB.
564                 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
566                 CONFIG_OF_LIBFDT
568                 New kernel versions are expecting firmware settings to be
569                 passed using flattened device trees (based on open firmware
570                 concepts).
572                 CONFIG_OF_LIBFDT
573                  * New libfdt-based support
574                  * Adds the "fdt" command
575                  * The bootm command automatically updates the fdt
577                 OF_TBCLK - The timebase frequency.
579                 boards with QUICC Engines require OF_QE to set UCC MAC
580                 addresses
582                 CONFIG_OF_BOARD_SETUP
584                 Board code has addition modification that it wants to make
585                 to the flat device tree before handing it off to the kernel
587                 CONFIG_OF_SYSTEM_SETUP
589                 Other code has addition modification that it wants to make
590                 to the flat device tree before handing it off to the kernel.
591                 This causes ft_system_setup() to be called before booting
592                 the kernel.
594                 CONFIG_OF_IDE_FIXUP
596                 U-Boot can detect if an IDE device is present or not.
597                 If not, and this new config option is activated, U-Boot
598                 removes the ATA node from the DTS before booting Linux,
599                 so the Linux IDE driver does not probe the device and
600                 crash. This is needed for buggy hardware (uc101) where
601                 no pull down resistor is connected to the signal IDE5V_DD7.
603                 CONFIG_MACH_TYPE        [relevant for ARM only][mandatory]
605                 This setting is mandatory for all boards that have only one
606                 machine type and must be used to specify the machine type
607                 number as it appears in the ARM machine registry
608                 (see
609                 Only boards that have multiple machine types supported
610                 in a single configuration file and the machine type is
611                 runtime discoverable, do not have to use this setting.
613 - vxWorks boot parameters:
615                 bootvx constructs a valid bootline using the following
616                 environments variables: bootdev, bootfile, ipaddr, netmask,
617                 serverip, gatewayip, hostname, othbootargs.
618                 It loads the vxWorks image pointed bootfile.
620                 Note: If a "bootargs" environment is defined, it will override
621                 the defaults discussed just above.
623 - Cache Configuration:
624                 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
626 - Cache Configuration for ARM:
627                 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
628                                       controller
629                 CONFIG_SYS_PL310_BASE - Physical base address of PL310
630                                         controller register space
632 - Serial Ports:
633                 CONFIG_PL010_SERIAL
635                 Define this if you want support for Amba PrimeCell PL010 UARTs.
637                 CONFIG_PL011_SERIAL
639                 Define this if you want support for Amba PrimeCell PL011 UARTs.
641                 CONFIG_PL011_CLOCK
643                 If you have Amba PrimeCell PL011 UARTs, set this variable to
644                 the clock speed of the UARTs.
646                 CONFIG_PL01x_PORTS
648                 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
649                 define this to a list of base addresses for each (supported)
650                 port. See e.g. include/configs/versatile.h
654                 Define this variable to enable hw flow control in serial driver.
655                 Current user of this option is drivers/serial/nsl16550.c driver
657 - Autoboot Command:
658                 CONFIG_BOOTCOMMAND
659                 Only needed when CONFIG_BOOTDELAY is enabled;
660                 define a command string that is automatically executed
661                 when no character is read on the console interface
662                 within "Boot Delay" after reset.
664                 CONFIG_RAMBOOT and CONFIG_NFSBOOT
665                 The value of these goes into the environment as
666                 "ramboot" and "nfsboot" respectively, and can be used
667                 as a convenience, when switching between booting from
668                 RAM and NFS.
670 - Serial Download Echo Mode:
671                 CONFIG_LOADS_ECHO
672                 If defined to 1, all characters received during a
673                 serial download (using the "loads" command) are
674                 echoed back. This might be needed by some terminal
675                 emulations (like "cu"), but may as well just take
676                 time on others. This setting #define's the initial
677                 value of the "loads_echo" environment variable.
679 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
680                 CONFIG_KGDB_BAUDRATE
681                 Select one of the baudrates listed in
682                 CONFIG_SYS_BAUDRATE_TABLE, see below.
684 - Removal of commands
685                 If no commands are needed to boot, you can disable
686                 CONFIG_CMDLINE to remove them. In this case, the command line
687                 will not be available, and when U-Boot wants to execute the
688                 boot command (on start-up) it will call board_run_command()
689                 instead. This can reduce image size significantly for very
690                 simple boot procedures.
692 - Regular expression support:
693                 CONFIG_REGEX
694                 If this variable is defined, U-Boot is linked against
695                 the SLRE (Super Light Regular Expression) library,
696                 which adds regex support to some commands, as for
697                 example "env grep" and "setexpr".
699 - Device tree:
700                 CONFIG_OF_CONTROL
701                 If this variable is defined, U-Boot will use a device tree
702                 to configure its devices, instead of relying on statically
703                 compiled #defines in the board file. This option is
704                 experimental and only available on a few boards. The device
705                 tree is available in the global data as gd->fdt_blob.
707                 U-Boot needs to get its device tree from somewhere. This can
708                 be done using one of the three options below:
710                 CONFIG_OF_EMBED
711                 If this variable is defined, U-Boot will embed a device tree
712                 binary in its image. This device tree file should be in the
713                 board directory and called <soc>-<board>.dts. The binary file
714                 is then picked up in board_init_f() and made available through
715                 the global data structure as gd->fdt_blob.
717                 CONFIG_OF_SEPARATE
718                 If this variable is defined, U-Boot will build a device tree
719                 binary. It will be called u-boot.dtb. Architecture-specific
720                 code will locate it at run-time. Generally this works by:
722                         cat u-boot.bin u-boot.dtb >image.bin
724                 and in fact, U-Boot does this for you, creating a file called
725                 u-boot-dtb.bin which is useful in the common case. You can
726                 still use the individual files if you need something more
727                 exotic.
729                 CONFIG_OF_BOARD
730                 If this variable is defined, U-Boot will use the device tree
731                 provided by the board at runtime instead of embedding one with
732                 the image. Only boards defining board_fdt_blob_setup() support
733                 this option (see include/fdtdec.h file).
735 - Watchdog:
736                 CONFIG_WATCHDOG
737                 If this variable is defined, it enables watchdog
738                 support for the SoC. There must be support in the SoC
739                 specific code for a watchdog. For the 8xx
740                 CPUs, the SIU Watchdog feature is enabled in the SYPCR
741                 register.  When supported for a specific SoC is
742                 available, then no further board specific code should
743                 be needed to use it.
745                 CONFIG_HW_WATCHDOG
746                 When using a watchdog circuitry external to the used
747                 SoC, then define this variable and provide board
748                 specific code for the "hw_watchdog_reset" function.
750 - Real-Time Clock:
752                 When CONFIG_CMD_DATE is selected, the type of the RTC
753                 has to be selected, too. Define exactly one of the
754                 following options:
756                 CONFIG_RTC_PCF8563      - use Philips PCF8563 RTC
757                 CONFIG_RTC_MC13XXX      - use MC13783 or MC13892 RTC
758                 CONFIG_RTC_MC146818     - use MC146818 RTC
759                 CONFIG_RTC_DS1307       - use Maxim, Inc. DS1307 RTC
760                 CONFIG_RTC_DS1337       - use Maxim, Inc. DS1337 RTC
761                 CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
762                 CONFIG_RTC_DS1339       - use Maxim, Inc. DS1339 RTC
763                 CONFIG_RTC_DS164x       - use Dallas DS164x RTC
764                 CONFIG_RTC_ISL1208      - use Intersil ISL1208 RTC
765                 CONFIG_RTC_MAX6900      - use Maxim, Inc. MAX6900 RTC
766                 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
767                 CONFIG_SYS_RV3029_TCR   - enable trickle charger on
768                                           RV3029 RTC.
770                 Note that if the RTC uses I2C, then the I2C interface
771                 must also be configured. See I2C Support, below.
773 - GPIO Support:
774                 CONFIG_PCA953X          - use NXP's PCA953X series I2C GPIO
776                 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
777                 chip-ngpio pairs that tell the PCA953X driver the number of
778                 pins supported by a particular chip.
780                 Note that if the GPIO device uses I2C, then the I2C interface
781                 must also be configured. See I2C Support, below.
783 - I/O tracing:
784                 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
785                 accesses and can checksum them or write a list of them out
786                 to memory. See the 'iotrace' command for details. This is
787                 useful for testing device drivers since it can confirm that
788                 the driver behaves the same way before and after a code
789                 change. Currently this is supported on sandbox and arm. To
790                 add support for your architecture, add '#include <iotrace.h>'
791                 to the bottom of arch/<arch>/include/asm/io.h and test.
793                 Example output from the 'iotrace stats' command is below.
794                 Note that if the trace buffer is exhausted, the checksum will
795                 still continue to operate.
797                         iotrace is enabled
798                         Start:  10000000        (buffer start address)
799                         Size:   00010000        (buffer size)
800                         Offset: 00000120        (current buffer offset)
801                         Output: 10000120        (start + offset)
802                         Count:  00000018        (number of trace records)
803                         CRC32:  9526fb66        (CRC32 of all trace records)
805 - Timestamp Support:
807                 When CONFIG_TIMESTAMP is selected, the timestamp
808                 (date and time) of an image is printed by image
809                 commands like bootm or iminfo. This option is
810                 automatically enabled when you select CONFIG_CMD_DATE .
812 - Partition Labels (disklabels) Supported:
813                 Zero or more of the following:
814                 CONFIG_MAC_PARTITION   Apple's MacOS partition table.
815                 CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
816                 CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
817                                        bootloader.  Note 2TB partition limit; see
818                                        disk/part_efi.c
819                 CONFIG_SCSI) you must configure support for at
820                 least one non-MTD partition type as well.
822 - IDE Reset method:
823                 CONFIG_IDE_RESET_ROUTINE - this is defined in several
824                 board configurations files but used nowhere!
826                 CONFIG_IDE_RESET - is this is defined, IDE Reset will
827                 be performed by calling the function
828                         ide_set_reset(int reset)
829                 which has to be defined in a board specific file
831 - ATAPI Support:
832                 CONFIG_ATAPI
834                 Set this to enable ATAPI support.
836 - LBA48 Support
837                 CONFIG_LBA48
839                 Set this to enable support for disks larger than 137GB
840                 Also look at CONFIG_SYS_64BIT_LBA.
841                 Whithout these , LBA48 support uses 32bit variables and will 'only'
842                 support disks up to 2.1TB.
844                 CONFIG_SYS_64BIT_LBA:
845                         When enabled, makes the IDE subsystem use 64bit sector addresses.
846                         Default is 32bit.
848 - SCSI Support:
849                 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
851                 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
852                 maximum numbers of LUNs, SCSI ID's and target
853                 devices.
855                 The environment variable 'scsidevs' is set to the number of
856                 SCSI devices found during the last scan.
858 - NETWORK Support (PCI):
859                 CONFIG_E1000
860                 Support for Intel 8254x/8257x gigabit chips.
862                 CONFIG_E1000_SPI
863                 Utility code for direct access to the SPI bus on Intel 8257x.
864                 This does not do anything useful unless you set at least one
865                 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
867                 CONFIG_E1000_SPI_GENERIC
868                 Allow generic access to the SPI bus on the Intel 8257x, for
869                 example with the "sspi" command.
871                 CONFIG_NATSEMI
872                 Support for National dp83815 chips.
874                 CONFIG_NS8382X
875                 Support for National dp8382[01] gigabit chips.
877 - NETWORK Support (other):
879                 CONFIG_DRIVER_AT91EMAC
880                 Support for AT91RM9200 EMAC.
882                         CONFIG_RMII
883                         Define this to use reduced MII inteface
885                         CONFIG_DRIVER_AT91EMAC_QUIET
886                         If this defined, the driver is quiet.
887                         The driver doen't show link status messages.
889                 CONFIG_CALXEDA_XGMAC
890                 Support for the Calxeda XGMAC device
892                 CONFIG_LAN91C96
893                 Support for SMSC's LAN91C96 chips.
895                         CONFIG_LAN91C96_USE_32_BIT
896                         Define this to enable 32 bit addressing
898                 CONFIG_SMC91111
899                 Support for SMSC's LAN91C111 chip
901                         CONFIG_SMC91111_BASE
902                         Define this to hold the physical address
903                         of the device (I/O space)
905                         CONFIG_SMC_USE_32_BIT
906                         Define this if data bus is 32 bits
908                         CONFIG_SMC_USE_IOFUNCS
909                         Define this to use i/o functions instead of macros
910                         (some hardware wont work with macros)
912                         CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
913                         Define this if you have more then 3 PHYs.
915                 CONFIG_FTGMAC100
916                 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
918                         CONFIG_FTGMAC100_EGIGA
919                         Define this to use GE link update with gigabit PHY.
920                         Define this if FTGMAC100 is connected to gigabit PHY.
921                         If your system has 10/100 PHY only, it might not occur
922                         wrong behavior. Because PHY usually return timeout or
923                         useless data when polling gigabit status and gigabit
924                         control registers. This behavior won't affect the
925                         correctnessof 10/100 link speed update.
927                 CONFIG_SH_ETHER
928                 Support for Renesas on-chip Ethernet controller
930                         CONFIG_SH_ETHER_USE_PORT
931                         Define the number of ports to be used
933                         CONFIG_SH_ETHER_PHY_ADDR
934                         Define the ETH PHY's address
936                         CONFIG_SH_ETHER_CACHE_WRITEBACK
937                         If this option is set, the driver enables cache flush.
939 - TPM Support:
940                 CONFIG_TPM
941                 Support TPM devices.
943                 CONFIG_TPM_TIS_INFINEON
944                 Support for Infineon i2c bus TPM devices. Only one device
945                 per system is supported at this time.
947                         CONFIG_TPM_TIS_I2C_BURST_LIMITATION
948                         Define the burst count bytes upper limit
950                 CONFIG_TPM_ST33ZP24
951                 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
953                         CONFIG_TPM_ST33ZP24_I2C
954                         Support for STMicroelectronics ST33ZP24 I2C devices.
955                         Requires TPM_ST33ZP24 and I2C.
957                         CONFIG_TPM_ST33ZP24_SPI
958                         Support for STMicroelectronics ST33ZP24 SPI devices.
959                         Requires TPM_ST33ZP24 and SPI.
961                 CONFIG_TPM_ATMEL_TWI
962                 Support for Atmel TWI TPM device. Requires I2C support.
964                 CONFIG_TPM_TIS_LPC
965                 Support for generic parallel port TPM devices. Only one device
966                 per system is supported at this time.
968                         CONFIG_TPM_TIS_BASE_ADDRESS
969                         Base address where the generic TPM device is mapped
970                         to. Contemporary x86 systems usually map it at
971                         0xfed40000.
973                 CONFIG_TPM
974                 Define this to enable the TPM support library which provides
975                 functional interfaces to some TPM commands.
976                 Requires support for a TPM device.
978                 CONFIG_TPM_AUTH_SESSIONS
979                 Define this to enable authorized functions in the TPM library.
980                 Requires CONFIG_TPM and CONFIG_SHA1.
982 - USB Support:
983                 At the moment only the UHCI host controller is
984                 supported (PIP405, MIP405); define
985                 CONFIG_USB_UHCI to enable it.
986                 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
987                 and define CONFIG_USB_STORAGE to enable the USB
988                 storage devices.
989                 Note:
990                 Supported are USB Keyboards and USB Floppy drives
991                 (TEAC FD-05PUB).
993                 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
994                 txfilltuning field in the EHCI controller on reset.
996                 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
997                 HW module registers.
999 - USB Device:
1000                 Define the below if you wish to use the USB console.
1001                 Once firmware is rebuilt from a serial console issue the
1002                 command "setenv stdin usbtty; setenv stdout usbtty" and
1003                 attach your USB cable. The Unix command "dmesg" should print
1004                 it has found a new device. The environment variable usbtty
1005                 can be set to gserial or cdc_acm to enable your device to
1006                 appear to a USB host as a Linux gserial device or a
1007                 Common Device Class Abstract Control Model serial device.
1008                 If you select usbtty = gserial you should be able to enumerate
1009                 a Linux host by
1010                 # modprobe usbserial vendor=0xVendorID product=0xProductID
1011                 else if using cdc_acm, simply setting the environment
1012                 variable usbtty to be cdc_acm should suffice. The following
1013                 might be defined in YourBoardName.h
1015                         CONFIG_USB_DEVICE
1016                         Define this to build a UDC device
1018                         CONFIG_USB_TTY
1019                         Define this to have a tty type of device available to
1020                         talk to the UDC device
1022                         CONFIG_USBD_HS
1023                         Define this to enable the high speed support for usb
1024                         device and usbtty. If this feature is enabled, a routine
1025                         int is_usbd_high_speed(void)
1026                         also needs to be defined by the driver to dynamically poll
1027                         whether the enumeration has succeded at high speed or full
1028                         speed.
1030                         CONFIG_SYS_CONSOLE_IS_IN_ENV
1031                         Define this if you want stdin, stdout &/or stderr to
1032                         be set to usbtty.
1034                 If you have a USB-IF assigned VendorID then you may wish to
1035                 define your own vendor specific values either in BoardName.h
1036                 or directly in usbd_vendor_info.h. If you don't define
1038                 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1039                 should pretend to be a Linux device to it's target host.
1041                         CONFIG_USBD_MANUFACTURER
1042                         Define this string as the name of your company for
1043                         - CONFIG_USBD_MANUFACTURER "my company"
1045                         CONFIG_USBD_PRODUCT_NAME
1046                         Define this string as the name of your product
1047                         - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1049                         CONFIG_USBD_VENDORID
1050                         Define this as your assigned Vendor ID from the USB
1051                         Implementors Forum. This *must* be a genuine Vendor ID
1052                         to avoid polluting the USB namespace.
1053                         - CONFIG_USBD_VENDORID 0xFFFF
1055                         CONFIG_USBD_PRODUCTID
1056                         Define this as the unique Product ID
1057                         for your device
1058                         - CONFIG_USBD_PRODUCTID 0xFFFF
1060 - ULPI Layer Support:
1061                 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1062                 the generic ULPI layer. The generic layer accesses the ULPI PHY
1063                 via the platform viewport, so you need both the genric layer and
1064                 the viewport enabled. Currently only Chipidea/ARC based
1065                 viewport is supported.
1066                 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1067                 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1068                 If your ULPI phy needs a different reference clock than the
1069                 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1070                 the appropriate value in Hz.
1072 - MMC Support:
1073                 The MMC controller on the Intel PXA is supported. To
1074                 enable this define CONFIG_MMC. The MMC can be
1075                 accessed from the boot prompt by mapping the device
1076                 to physical memory similar to flash. Command line is
1077                 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1078                 the FAT fs. This is enabled with CONFIG_CMD_FAT.
1080                 CONFIG_SH_MMCIF
1081                 Support for Renesas on-chip MMCIF controller
1083                         CONFIG_SH_MMCIF_ADDR
1084                         Define the base address of MMCIF registers
1086                         CONFIG_SH_MMCIF_CLK
1087                         Define the clock frequency for MMCIF
1089 - USB Device Firmware Update (DFU) class support:
1090                 CONFIG_DFU_OVER_USB
1091                 This enables the USB portion of the DFU USB class
1093                 CONFIG_DFU_NAND
1094                 This enables support for exposing NAND devices via DFU.
1096                 CONFIG_DFU_RAM
1097                 This enables support for exposing RAM via DFU.
1098                 Note: DFU spec refer to non-volatile memory usage, but
1099                 allow usages beyond the scope of spec - here RAM usage,
1100                 one that would help mostly the developer.
1102                 CONFIG_SYS_DFU_DATA_BUF_SIZE
1103                 Dfu transfer uses a buffer before writing data to the
1104                 raw storage device. Make the size (in bytes) of this buffer
1105                 configurable. The size of this buffer is also configurable
1106                 through the "dfu_bufsiz" environment variable.
1108                 CONFIG_SYS_DFU_MAX_FILE_SIZE
1109                 When updating files rather than the raw storage device,
1110                 we use a static buffer to copy the file into and then write
1111                 the buffer once we've been given the whole file.  Define
1112                 this to the maximum filesize (in bytes) for the buffer.
1113                 Default is 4 MiB if undefined.
1115                 DFU_DEFAULT_POLL_TIMEOUT
1116                 Poll timeout [ms], is the timeout a device can send to the
1117                 host. The host must wait for this timeout before sending
1118                 a subsequent DFU_GET_STATUS request to the device.
1120                 DFU_MANIFEST_POLL_TIMEOUT
1121                 Poll timeout [ms], which the device sends to the host when
1122                 entering dfuMANIFEST state. Host waits this timeout, before
1123                 sending again an USB request to the device.
1125 - Journaling Flash filesystem support:
1126                 CONFIG_JFFS2_NAND
1127                 Define these for a default partition on a NAND device
1129                 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1131                 Define these for a default partition on a NOR device
1133 - Keyboard Support:
1134                 See Kconfig help for available keyboard drivers.
1136                 CONFIG_KEYBOARD
1138                 Define this to enable a custom keyboard support.
1139                 This simply calls drv_keyboard_init() which must be
1140                 defined in your board-specific files. This option is deprecated
1141                 and is only used by novena. For new boards, use driver model
1142                 instead.
1144 - Video support:
1145                 CONFIG_FSL_DIU_FB
1146                 Enable the Freescale DIU video driver.  Reference boards for
1147                 SOCs that have a DIU should define this macro to enable DIU
1148                 support, and should also define these other macros:
1150                         CONFIG_SYS_DIU_ADDR
1151                         CONFIG_VIDEO
1152                         CONFIG_CFB_CONSOLE
1153                         CONFIG_VIDEO_SW_CURSOR
1154                         CONFIG_VGA_AS_SINGLE_DEVICE
1155                         CONFIG_VIDEO_LOGO
1156                         CONFIG_VIDEO_BMP_LOGO
1158                 The DIU driver will look for the 'video-mode' environment
1159                 variable, and if defined, enable the DIU as a console during
1160                 boot.  See the documentation file doc/ for a
1161                 description of this variable.
1163 - LCD Support:  CONFIG_LCD
1165                 Define this to enable LCD support (for output to LCD
1166                 display); also select one of the supported displays
1167                 by defining one of these:
1169                 CONFIG_ATMEL_LCD:
1171                         HITACHI TX09D70VM1CCA, 3.5", 240x320.
1173                 CONFIG_NEC_NL6448AC33:
1175                         NEC NL6448AC33-18. Active, color, single scan.
1177                 CONFIG_NEC_NL6448BC20
1179                         NEC NL6448BC20-08. 6.5", 640x480.
1180                         Active, color, single scan.
1182                 CONFIG_NEC_NL6448BC33_54
1184                         NEC NL6448BC33-54. 10.4", 640x480.
1185                         Active, color, single scan.
1187                 CONFIG_SHARP_16x9
1189                         Sharp 320x240. Active, color, single scan.
1190                         It isn't 16x9, and I am not sure what it is.
1192                 CONFIG_SHARP_LQ64D341
1194                         Sharp LQ64D341 display, 640x480.
1195                         Active, color, single scan.
1197                 CONFIG_HLD1045
1199                         HLD1045 display, 640x480.
1200                         Active, color, single scan.
1202                 CONFIG_OPTREX_BW
1204                         Optrex   CBL50840-2 NF-FW 99 22 M5
1205                         or
1206                         Hitachi  LMG6912RPFC-00T
1207                         or
1208                         Hitachi  SP14Q002
1210                         320x240. Black & white.
1212                 CONFIG_LCD_ALIGNMENT
1214                 Normally the LCD is page-aligned (typically 4KB). If this is
1215                 defined then the LCD will be aligned to this value instead.
1216                 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1217                 here, since it is cheaper to change data cache settings on
1218                 a per-section basis.
1221                 CONFIG_LCD_ROTATION
1223                 Sometimes, for example if the display is mounted in portrait
1224                 mode or even if it's mounted landscape but rotated by 180degree,
1225                 we need to rotate our content of the display relative to the
1226                 framebuffer, so that user can read the messages which are
1227                 printed out.
1228                 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1229                 initialized with a given rotation from "vl_rot" out of
1230                 "vidinfo_t" which is provided by the board specific code.
1231                 The value for vl_rot is coded as following (matching to
1232                 fbcon=rotate:<n> linux-kernel commandline):
1233                 0 = no rotation respectively 0 degree
1234                 1 = 90 degree rotation
1235                 2 = 180 degree rotation
1236                 3 = 270 degree rotation
1238                 If CONFIG_LCD_ROTATION is not defined, the console will be
1239                 initialized with 0degree rotation.
1241                 CONFIG_LCD_BMP_RLE8
1243                 Support drawing of RLE8-compressed bitmaps on the LCD.
1245                 CONFIG_I2C_EDID
1247                 Enables an 'i2c edid' command which can read EDID
1248                 information over I2C from an attached LCD display.
1250 - MII/PHY support:
1251                 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1253                 The clock frequency of the MII bus
1255                 CONFIG_PHY_RESET_DELAY
1257                 Some PHY like Intel LXT971A need extra delay after
1258                 reset before any MII register access is possible.
1259                 For such PHY, set this option to the usec delay
1260                 required. (minimum 300usec for LXT971A)
1262                 CONFIG_PHY_CMD_DELAY (ppc4xx)
1264                 Some PHY like Intel LXT971A need extra delay after
1265                 command issued before MII status register can be read
1267 - IP address:
1268                 CONFIG_IPADDR
1270                 Define a default value for the IP address to use for
1271                 the default Ethernet interface, in case this is not
1272                 determined through e.g. bootp.
1273                 (Environment variable "ipaddr")
1275 - Server IP address:
1276                 CONFIG_SERVERIP
1278                 Defines a default value for the IP address of a TFTP
1279                 server to contact when using the "tftboot" command.
1280                 (Environment variable "serverip")
1282                 CONFIG_KEEP_SERVERADDR
1284                 Keeps the server's MAC address, in the env 'serveraddr'
1285                 for passing to bootargs (like Linux's netconsole option)
1287 - Gateway IP address:
1288                 CONFIG_GATEWAYIP
1290                 Defines a default value for the IP address of the
1291                 default router where packets to other networks are
1292                 sent to.
1293                 (Environment variable "gatewayip")
1295 - Subnet mask:
1296                 CONFIG_NETMASK
1298                 Defines a default value for the subnet mask (or
1299                 routing prefix) which is used to determine if an IP
1300                 address belongs to the local subnet or needs to be
1301                 forwarded through a router.
1302                 (Environment variable "netmask")
1304 - BOOTP Recovery Mode:
1305                 CONFIG_BOOTP_RANDOM_DELAY
1307                 If you have many targets in a network that try to
1308                 boot using BOOTP, you may want to avoid that all
1309                 systems send out BOOTP requests at precisely the same
1310                 moment (which would happen for instance at recovery
1311                 from a power failure, when all systems will try to
1312                 boot, thus flooding the BOOTP server. Defining
1313                 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1314                 inserted before sending out BOOTP requests. The
1315                 following delays are inserted then:
1317                 1st BOOTP request:      delay 0 ... 1 sec
1318                 2nd BOOTP request:      delay 0 ... 2 sec
1319                 3rd BOOTP request:      delay 0 ... 4 sec
1320                 4th and following
1321                 BOOTP requests:         delay 0 ... 8 sec
1323                 CONFIG_BOOTP_ID_CACHE_SIZE
1325                 BOOTP packets are uniquely identified using a 32-bit ID. The
1326                 server will copy the ID from client requests to responses and
1327                 U-Boot will use this to determine if it is the destination of
1328                 an incoming response. Some servers will check that addresses
1329                 aren't in use before handing them out (usually using an ARP
1330                 ping) and therefore take up to a few hundred milliseconds to
1331                 respond. Network congestion may also influence the time it
1332                 takes for a response to make it back to the client. If that
1333                 time is too long, U-Boot will retransmit requests. In order
1334                 to allow earlier responses to still be accepted after these
1335                 retransmissions, U-Boot's BOOTP client keeps a small cache of
1336                 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1337                 cache. The default is to keep IDs for up to four outstanding
1338                 requests. Increasing this will allow U-Boot to accept offers
1339                 from a BOOTP client in networks with unusually high latency.
1341 - DHCP Advanced Options:
1342                 You can fine tune the DHCP functionality by defining
1343                 CONFIG_BOOTP_* symbols:
1345                 CONFIG_BOOTP_NISDOMAIN
1346                 CONFIG_BOOTP_BOOTFILESIZE
1347                 CONFIG_BOOTP_NTPSERVER
1348                 CONFIG_BOOTP_TIMEOFFSET
1349                 CONFIG_BOOTP_VENDOREX
1350                 CONFIG_BOOTP_MAY_FAIL
1352                 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1353                 environment variable, not the BOOTP server.
1355                 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1356                 after the configured retry count, the call will fail
1357                 instead of starting over.  This can be used to fail over
1358                 to Link-local IP address configuration if the DHCP server
1359                 is not available.
1363                 A 32bit value in microseconds for a delay between
1364                 receiving a "DHCP Offer" and sending the "DHCP Request".
1365                 This fixes a problem with certain DHCP servers that don't
1366                 respond 100% of the time to a "DHCP request". E.g. On an
1367                 AT91RM9200 processor running at 180MHz, this delay needed
1368                 to be *at least* 15,000 usec before a Windows Server 2003
1369                 DHCP server would reply 100% of the time. I recommend at
1370                 least 50,000 usec to be safe. The alternative is to hope
1371                 that one of the retries will be successful but note that
1372                 the DHCP timeout and retry process takes a longer than
1373                 this delay.
1375  - Link-local IP address negotiation:
1376                 Negotiate with other link-local clients on the local network
1377                 for an address that doesn't require explicit configuration.
1378                 This is especially useful if a DHCP server cannot be guaranteed
1379                 to exist in all environments that the device must operate.
1381                 See doc/ for more information.
1383  - MAC address from environment variables
1385                 FDT_SEQ_MACADDR_FROM_ENV
1387                 Fix-up device tree with MAC addresses fetched sequentially from
1388                 environment variables. This config work on assumption that
1389                 non-usable ethernet node of device-tree are either not present
1390                 or their status has been marked as "disabled".
1392  - CDP Options:
1393                 CONFIG_CDP_DEVICE_ID
1395                 The device id used in CDP trigger frames.
1397                 CONFIG_CDP_DEVICE_ID_PREFIX
1399                 A two character string which is prefixed to the MAC address
1400                 of the device.
1402                 CONFIG_CDP_PORT_ID
1404                 A printf format string which contains the ascii name of
1405                 the port. Normally is set to "eth%d" which sets
1406                 eth0 for the first Ethernet, eth1 for the second etc.
1408                 CONFIG_CDP_CAPABILITIES
1410                 A 32bit integer which indicates the device capabilities;
1411                 0x00000010 for a normal host which does not forwards.
1413                 CONFIG_CDP_VERSION
1415                 An ascii string containing the version of the software.
1417                 CONFIG_CDP_PLATFORM
1419                 An ascii string containing the name of the platform.
1421                 CONFIG_CDP_TRIGGER
1423                 A 32bit integer sent on the trigger.
1427                 A 16bit integer containing the power consumption of the
1428                 device in .1 of milliwatts.
1432                 A byte containing the id of the VLAN.
1434 - Status LED:   CONFIG_LED_STATUS
1436                 Several configurations allow to display the current
1437                 status using a LED. For instance, the LED will blink
1438                 fast while running U-Boot code, stop blinking as
1439                 soon as a reply to a BOOTP request was received, and
1440                 start blinking slow once the Linux kernel is running
1441                 (supported by a status LED driver in the Linux
1442                 kernel). Defining CONFIG_LED_STATUS enables this
1443                 feature in U-Boot.
1445                 Additional options:
1447                 CONFIG_LED_STATUS_GPIO
1448                 The status LED can be connected to a GPIO pin.
1449                 In such cases, the gpio_led driver can be used as a
1450                 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1451                 to include the gpio_led driver in the U-Boot binary.
1454                 Some GPIO connected LEDs may have inverted polarity in which
1455                 case the GPIO high value corresponds to LED off state and
1456                 GPIO low value corresponds to LED on state.
1457                 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1458                 with a list of GPIO LEDs that have inverted polarity.
1460 - I2C Support:  CONFIG_SYS_I2C
1462                 This enable the NEW i2c subsystem, and will allow you to use
1463                 i2c commands at the u-boot command line (as long as you set
1464                     CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1465                     for defining speed and slave address
1466                   - activate second bus with I2C_SOFT_DECLARATIONS2 define
1467                     CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1468                     for defining speed and slave address
1469                   - activate third bus with I2C_SOFT_DECLARATIONS3 define
1470                     CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1471                     for defining speed and slave address
1472                   - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1473                     CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1474                     for defining speed and slave address
1476                 - drivers/i2c/fsl_i2c.c:
1477                   - activate i2c driver with CONFIG_SYS_I2C_FSL
1478                     define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1479                     offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1480                     CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1481                     bus.
1482                   - If your board supports a second fsl i2c bus, define
1483                     CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1484                     CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1485                     CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1486                     second bus.
1488                 - drivers/i2c/tegra_i2c.c:
1489                   - activate this driver with CONFIG_SYS_I2C_TEGRA
1490                   - This driver adds 4 i2c buses with a fix speed from
1491                     100000 and the slave addr 0!
1493                 - drivers/i2c/ppc4xx_i2c.c
1494                   - activate this driver with CONFIG_SYS_I2C_PPC4XX
1495                   - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1496                   - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1498                 - drivers/i2c/i2c_mxc.c
1499                   - activate this driver with CONFIG_SYS_I2C_MXC
1500                   - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1501                   - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1502                   - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1503                   - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
1504                   - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1505                   - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1506                   - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1507                   - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1508                   - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1509                   - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
1510                   - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1511                   - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
1512                 If those defines are not set, default value is 100000
1513                 for speed, and 0 for slave.
1515                 - drivers/i2c/rcar_i2c.c:
1516                   - activate this driver with CONFIG_SYS_I2C_RCAR
1517                   - This driver adds 4 i2c buses
1519                 - drivers/i2c/sh_i2c.c:
1520                   - activate this driver with CONFIG_SYS_I2C_SH
1521                   - This driver adds from 2 to 5 i2c buses
1523                   - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1524                   - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1525                   - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1526                   - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1527                   - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1528                   - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1529                   - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1530                   - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1531                   - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1532                   - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
1533                   - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
1535                 - drivers/i2c/omap24xx_i2c.c
1536                   - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1537                   - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1538                   - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1539                   - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1540                   - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1541                   - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1542                   - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1543                   - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1544                   - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1545                   - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1546                   - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1548                 - drivers/i2c/s3c24x0_i2c.c:
1549                   - activate this driver with CONFIG_SYS_I2C_S3C24X0
1550                   - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1551                     9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1552                     with a fix speed from 100000 and the slave addr 0!
1554                 - drivers/i2c/ihs_i2c.c
1555                   - activate this driver with CONFIG_SYS_I2C_IHS
1556                   - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1557                   - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1558                   - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1559                   - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1560                   - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1561                   - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1562                   - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1563                   - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1564                   - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1565                   - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1566                   - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1567                   - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
1568                   - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1569                   - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1570                   - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1571                   - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1572                   - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1573                   - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1574                   - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1575                   - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1576                   - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
1578                 additional defines:
1580                 CONFIG_SYS_NUM_I2C_BUSES
1581                 Hold the number of i2c buses you want to use.
1583                 CONFIG_SYS_I2C_DIRECT_BUS
1584                 define this, if you don't use i2c muxes on your hardware.
1585                 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1586                 omit this define.
1588                 CONFIG_SYS_I2C_MAX_HOPS
1589                 define how many muxes are maximal consecutively connected
1590                 on one i2c bus. If you not use i2c muxes, omit this
1591                 define.
1593                 CONFIG_SYS_I2C_BUSES
1594                 hold a list of buses you want to use, only used if
1595                 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1596                 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1597                 CONFIG_SYS_NUM_I2C_BUSES = 9:
1599                  CONFIG_SYS_I2C_BUSES   {{0, {I2C_NULL_HOP}}, \
1600                                         {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1601                                         {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1602                                         {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1603                                         {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1604                                         {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1605                                         {1, {I2C_NULL_HOP}}, \
1606                                         {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1607                                         {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1608                                         }
1610                 which defines
1611                         bus 0 on adapter 0 without a mux
1612                         bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1613                         bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1614                         bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1615                         bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1616                         bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
1617                         bus 6 on adapter 1 without a mux
1618                         bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1619                         bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
1621                 If you do not have i2c muxes on your board, omit this define.
1623 - Legacy I2C Support:
1624                 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
1625                 then the following macros need to be defined (examples are
1626                 from include/configs/lwmon.h):
1628                 I2C_INIT
1630                 (Optional). Any commands necessary to enable the I2C
1631                 controller or configure ports.
1633                 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=  PB_SCL)
1635                 I2C_ACTIVE
1637                 The code necessary to make the I2C data line active
1638                 (driven).  If the data line is open collector, this
1639                 define can be null.
1641                 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1643                 I2C_TRISTATE
1645                 The code necessary to make the I2C data line tri-stated
1646                 (inactive).  If the data line is open collector, this
1647                 define can be null.
1649                 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1651                 I2C_READ
1653                 Code that returns true if the I2C data line is high,
1654                 false if it is low.
1656                 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1658                 I2C_SDA(bit)
1660                 If <bit> is true, sets the I2C data line high. If it
1661                 is false, it clears it (low).
1663                 eg: #define I2C_SDA(bit) \
1664                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1665                         else    immr->im_cpm.cp_pbdat &= ~PB_SDA
1667                 I2C_SCL(bit)
1669                 If <bit> is true, sets the I2C clock line high. If it
1670                 is false, it clears it (low).
1672                 eg: #define I2C_SCL(bit) \
1673                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1674                         else    immr->im_cpm.cp_pbdat &= ~PB_SCL
1676                 I2C_DELAY
1678                 This delay is invoked four times per clock cycle so this
1679                 controls the rate of data transfer.  The data rate thus
1680                 is 1 / (I2C_DELAY * 4). Often defined to be something
1681                 like:
1683                 #define I2C_DELAY  udelay(2)
1687                 If your arch supports the generic GPIO framework (asm/gpio.h),
1688                 then you may alternatively define the two GPIOs that are to be
1689                 used as SCL / SDA.  Any of the previous I2C_xxx macros will
1690                 have GPIO-based defaults assigned to them as appropriate.
1692                 You should define these to the GPIO value as given directly to
1693                 the generic GPIO functions.
1695                 CONFIG_SYS_I2C_INIT_BOARD
1697                 When a board is reset during an i2c bus transfer
1698                 chips might think that the current transfer is still
1699                 in progress. On some boards it is possible to access
1700                 the i2c SCLK line directly, either by using the
1701                 processor pin as a GPIO or by having a second pin
1702                 connected to the bus. If this option is defined a
1703                 custom i2c_init_board() routine in boards/xxx/board.c
1704                 is run early in the boot sequence.
1706                 CONFIG_I2C_MULTI_BUS
1708                 This option allows the use of multiple I2C buses, each of which
1709                 must have a controller.  At any point in time, only one bus is
1710                 active.  To switch to a different bus, use the 'i2c dev' command.
1711                 Note that bus numbering is zero-based.
1713                 CONFIG_SYS_I2C_NOPROBES
1715                 This option specifies a list of I2C devices that will be skipped
1716                 when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
1717                 is set, specify a list of bus-device pairs.  Otherwise, specify
1718                 a 1D array of device addresses
1720                 e.g.
1721                         #undef  CONFIG_I2C_MULTI_BUS
1722                         #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1724                 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1726                         #define CONFIG_I2C_MULTI_BUS
1727                         #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1729                 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1731                 CONFIG_SYS_SPD_BUS_NUM
1733                 If defined, then this indicates the I2C bus number for DDR SPD.
1734                 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1736                 CONFIG_SYS_RTC_BUS_NUM
1738                 If defined, then this indicates the I2C bus number for the RTC.
1739                 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1743                 defining this will force the i2c_read() function in
1744                 the soft_i2c driver to perform an I2C repeated start
1745                 between writing the address pointer and reading the
1746                 data.  If this define is omitted the default behaviour
1747                 of doing a stop-start sequence will be used.  Most I2C
1748                 devices can use either method, but some require one or
1749                 the other.
1751 - SPI Support:  CONFIG_SPI
1753                 Enables SPI driver (so far only tested with
1754                 SPI EEPROM, also an instance works with Crystal A/D and
1755                 D/As on the SACSng board)
1757                 CONFIG_SOFT_SPI
1759                 Enables a software (bit-bang) SPI driver rather than
1760                 using hardware support. This is a general purpose
1761                 driver that only requires three general I/O port pins
1762                 (two outputs, one input) to function. If this is
1763                 defined, the board configuration must define several
1764                 SPI configuration items (port pins to use, etc). For
1765                 an example, see include/configs/sacsng.h.
1767                 CONFIG_SYS_SPI_MXC_WAIT
1768                 Timeout for waiting until spi transfer completed.
1769                 default: (CONFIG_SYS_HZ/100)     /* 10 ms */
1771 - FPGA Support: CONFIG_FPGA
1773                 Enables FPGA subsystem.
1775                 CONFIG_FPGA_<vendor>
1777                 Enables support for specific chip vendors.
1778                 (ALTERA, XILINX)
1780                 CONFIG_FPGA_<family>
1782                 Enables support for FPGA family.
1783                 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1785                 CONFIG_FPGA_COUNT
1787                 Specify the number of FPGA devices to support.
1789                 CONFIG_SYS_FPGA_PROG_FEEDBACK
1791                 Enable printing of hash marks during FPGA configuration.
1793                 CONFIG_SYS_FPGA_CHECK_BUSY
1795                 Enable checks on FPGA configuration interface busy
1796                 status by the configuration function. This option
1797                 will require a board or device specific function to
1798                 be written.
1800                 CONFIG_FPGA_DELAY
1802                 If defined, a function that provides delays in the FPGA
1803                 configuration driver.
1805                 CONFIG_SYS_FPGA_CHECK_CTRLC
1806                 Allow Control-C to interrupt FPGA configuration
1808                 CONFIG_SYS_FPGA_CHECK_ERROR
1810                 Check for configuration errors during FPGA bitfile
1811                 loading. For example, abort during Virtex II
1812                 configuration if the INIT_B line goes low (which
1813                 indicated a CRC error).
1815                 CONFIG_SYS_FPGA_WAIT_INIT
1817                 Maximum time to wait for the INIT_B line to de-assert
1818                 after PROB_B has been de-asserted during a Virtex II
1819                 FPGA configuration sequence. The default time is 500
1820                 ms.
1822                 CONFIG_SYS_FPGA_WAIT_BUSY
1824                 Maximum time to wait for BUSY to de-assert during
1825                 Virtex II FPGA configuration. The default is 5 ms.
1827                 CONFIG_SYS_FPGA_WAIT_CONFIG
1829                 Time to wait after FPGA configuration. The default is
1830                 200 ms.
1832 - Configuration Management:
1834                 CONFIG_IDENT_STRING
1836                 If defined, this string will be added to the U-Boot
1837                 version information (U_BOOT_VERSION)
1839 - Vendor Parameter Protection:
1841                 U-Boot considers the values of the environment
1842                 variables "serial#" (Board Serial Number) and
1843                 "ethaddr" (Ethernet Address) to be parameters that
1844                 are set once by the board vendor / manufacturer, and
1845                 protects these variables from casual modification by
1846                 the user. Once set, these variables are read-only,
1847                 and write or delete attempts are rejected. You can
1848                 change this behaviour:
1850                 If CONFIG_ENV_OVERWRITE is #defined in your config
1851                 file, the write protection for vendor parameters is
1852                 completely disabled. Anybody can change or delete
1853                 these parameters.
1855                 Alternatively, if you define _both_ an ethaddr in the
1856                 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1857                 Ethernet address is installed in the environment,
1858                 which can be changed exactly ONCE by the user. [The
1859                 serial# is unaffected by this, i. e. it remains
1860                 read-only.]
1862                 The same can be accomplished in a more flexible way
1863                 for any variable by configuring the type of access
1864                 to allow for those variables in the ".flags" variable
1865                 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1867 - Protected RAM:
1868                 CONFIG_PRAM
1870                 Define this variable to enable the reservation of
1871                 "protected RAM", i. e. RAM which is not overwritten
1872                 by U-Boot. Define CONFIG_PRAM to hold the number of
1873                 kB you want to reserve for pRAM. You can overwrite
1874                 this default value by defining an environment
1875                 variable "pram" to the number of kB you want to
1876                 reserve. Note that the board info structure will
1877                 still show the full amount of RAM. If pRAM is
1878                 reserved, a new environment variable "mem" will
1879                 automatically be defined to hold the amount of
1880                 remaining RAM in a form that can be passed as boot
1881                 argument to Linux, for instance like that:
1883                         setenv bootargs ... mem=\${mem}
1884                         saveenv
1886                 This way you can tell Linux not to use this memory,
1887                 either, which results in a memory region that will
1888                 not be affected by reboots.
1890                 *WARNING* If your board configuration uses automatic
1891                 detection of the RAM size, you must make sure that
1892                 this memory test is non-destructive. So far, the
1893                 following board configurations are known to be
1894                 "pRAM-clean":
1896                         IVMS8, IVML24, SPD8xx,
1897                         HERMES, IP860, RPXlite, LWMON,
1898                         FLAGADM
1900 - Access to physical memory region (> 4GB)
1901                 Some basic support is provided for operations on memory not
1902                 normally accessible to U-Boot - e.g. some architectures
1903                 support access to more than 4GB of memory on 32-bit
1904                 machines using physical address extension or similar.
1905                 Define CONFIG_PHYSMEM to access this basic support, which
1906                 currently only supports clearing the memory.
1908 - Error Recovery:
1909                 CONFIG_NET_RETRY_COUNT
1911                 This variable defines the number of retries for
1912                 network operations like ARP, RARP, TFTP, or BOOTP
1913                 before giving up the operation. If not defined, a
1914                 default value of 5 is used.
1916                 CONFIG_ARP_TIMEOUT
1918                 Timeout waiting for an ARP reply in milliseconds.
1920                 CONFIG_NFS_TIMEOUT
1922                 Timeout in milliseconds used in NFS protocol.
1923                 If you encounter "ERROR: Cannot umount" in nfs command,
1924                 try longer timeout such as
1925                 #define CONFIG_NFS_TIMEOUT 10000UL
1927         Note:
1929                 In the current implementation, the local variables
1930                 space and global environment variables space are
1931                 separated. Local variables are those you define by
1932                 simply typing `name=value'. To access a local
1933                 variable later on, you have write `$name' or
1934                 `${name}'; to execute the contents of a variable
1935                 directly type `$name' at the command prompt.
1937                 Global environment variables are those you use
1938                 setenv/printenv to work with. To run a command stored
1939                 in such a variable, you need to use the run command,
1940                 and you must not use the '$' sign to access them.
1942                 To store commands and special characters in a
1943                 variable, please use double quotation marks
1944                 surrounding the whole text of the variable, instead
1945                 of the backslashes before semicolons and special
1946                 symbols.
1948 - Command Line Editing and History:
1949                 CONFIG_CMDLINE_PS_SUPPORT
1951                 Enable support for changing the command prompt string
1952                 at run-time. Only static string is supported so far.
1953                 The string is obtained from environment variables PS1
1954                 and PS2.
1956 - Default Environment:
1957                 CONFIG_EXTRA_ENV_SETTINGS
1959                 Define this to contain any number of null terminated
1960                 strings (variable = value pairs) that will be part of
1961                 the default environment compiled into the boot image.
1963                 For example, place something like this in your
1964                 board's config file:
1966                 #define CONFIG_EXTRA_ENV_SETTINGS \
1967                         "myvar1=value1\0" \
1968                         "myvar2=value2\0"
1970                 Warning: This method is based on knowledge about the
1971                 internal format how the environment is stored by the
1972                 U-Boot code. This is NOT an official, exported
1973                 interface! Although it is unlikely that this format
1974                 will change soon, there is no guarantee either.
1975                 You better know what you are doing here.
1977                 Note: overly (ab)use of the default environment is
1978                 discouraged. Make sure to check other ways to preset
1979                 the environment like the "source" command or the
1980                 boot command first.
1982                 CONFIG_DELAY_ENVIRONMENT
1984                 Normally the environment is loaded when the board is
1985                 initialised so that it is available to U-Boot. This inhibits
1986                 that so that the environment is not available until
1987                 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1988                 this is instead controlled by the value of
1989                 /config/load-environment.
1991 - TFTP Fixed UDP Port:
1992                 CONFIG_TFTP_PORT
1994                 If this is defined, the environment variable tftpsrcp
1995                 is used to supply the TFTP UDP source port value.
1996                 If tftpsrcp isn't defined, the normal pseudo-random port
1997                 number generator is used.
1999                 Also, the environment variable tftpdstp is used to supply
2000                 the TFTP UDP destination port value.  If tftpdstp isn't
2001                 defined, the normal port 69 is used.
2003                 The purpose for tftpsrcp is to allow a TFTP server to
2004                 blindly start the TFTP transfer using the pre-configured
2005                 target IP address and UDP port. This has the effect of
2006                 "punching through" the (Windows XP) firewall, allowing
2007                 the remainder of the TFTP transfer to proceed normally.
2008                 A better solution is to properly configure the firewall,
2009                 but sometimes that is not allowed.
2011                 CONFIG_STANDALONE_LOAD_ADDR
2013                 This option defines a board specific value for the
2014                 address where standalone program gets loaded, thus
2015                 overwriting the architecture dependent default
2016                 settings.
2018 - Frame Buffer Address:
2019                 CONFIG_FB_ADDR
2021                 Define CONFIG_FB_ADDR if you want to use specific
2022                 address for frame buffer.  This is typically the case
2023                 when using a graphics controller has separate video
2024                 memory.  U-Boot will then place the frame buffer at
2025                 the given address instead of dynamically reserving it
2026                 in system RAM by calling lcd_setmem(), which grabs
2027                 the memory for the frame buffer depending on the
2028                 configured panel size.
2030                 Please see board_init_f function.
2032 - Automatic software updates via TFTP server
2033                 CONFIG_UPDATE_TFTP
2034                 CONFIG_UPDATE_TFTP_CNT_MAX
2035                 CONFIG_UPDATE_TFTP_MSEC_MAX
2037                 These options enable and control the auto-update feature;
2038                 for a more detailed description refer to doc/README.update.
2040 - MTD Support (mtdparts command, UBI support)
2041                 CONFIG_MTD_UBI_WL_THRESHOLD
2042                 This parameter defines the maximum difference between the highest
2043                 erase counter value and the lowest erase counter value of eraseblocks
2044                 of UBI devices. When this threshold is exceeded, UBI starts performing
2045                 wear leveling by means of moving data from eraseblock with low erase
2046                 counter to eraseblocks with high erase counter.
2048                 The default value should be OK for SLC NAND flashes, NOR flashes and
2049                 other flashes which have eraseblock life-cycle 100000 or more.
2050                 However, in case of MLC NAND flashes which typically have eraseblock
2051                 life-cycle less than 10000, the threshold should be lessened (e.g.,
2052                 to 128 or 256, although it does not have to be power of 2).
2054                 default: 4096
2056                 CONFIG_MTD_UBI_BEB_LIMIT
2057                 This option specifies the maximum bad physical eraseblocks UBI
2058                 expects on the MTD device (per 1024 eraseblocks). If the
2059                 underlying flash does not admit of bad eraseblocks (e.g. NOR
2060                 flash), this value is ignored.
2062                 NAND datasheets often specify the minimum and maximum NVM
2063                 (Number of Valid Blocks) for the flashes' endurance lifetime.
2064                 The maximum expected bad eraseblocks per 1024 eraseblocks
2065                 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2066                 which gives 20 for most NANDs (MaxNVB is basically the total
2067                 count of eraseblocks on the chip).
2069                 To put it differently, if this value is 20, UBI will try to
2070                 reserve about 1.9% of physical eraseblocks for bad blocks
2071                 handling. And that will be 1.9% of eraseblocks on the entire
2072                 NAND chip, not just the MTD partition UBI attaches. This means
2073                 that if you have, say, a NAND flash chip admits maximum 40 bad
2074                 eraseblocks, and it is split on two MTD partitions of the same
2075                 size, UBI will reserve 40 eraseblocks when attaching a
2076                 partition.
2078                 default: 20
2080                 CONFIG_MTD_UBI_FASTMAP
2081                 Fastmap is a mechanism which allows attaching an UBI device
2082                 in nearly constant time. Instead of scanning the whole MTD device it
2083                 only has to locate a checkpoint (called fastmap) on the device.
2084                 The on-flash fastmap contains all information needed to attach
2085                 the device. Using fastmap makes only sense on large devices where
2086                 attaching by scanning takes long. UBI will not automatically install
2087                 a fastmap on old images, but you can set the UBI parameter
2088                 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2089                 that fastmap-enabled images are still usable with UBI implementations
2090                 without fastmap support. On typical flash devices the whole fastmap
2091                 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2094                 Set this parameter to enable fastmap automatically on images
2095                 without a fastmap.
2096                 default: 0
2098                 CONFIG_MTD_UBI_FM_DEBUG
2099                 Enable UBI fastmap debug
2100                 default: 0
2102 - SPL framework
2103                 CONFIG_SPL
2104                 Enable building of SPL globally.
2106                 CONFIG_SPL_LDSCRIPT
2107                 LDSCRIPT for linking the SPL binary.
2109                 CONFIG_SPL_MAX_FOOTPRINT
2110                 Maximum size in memory allocated to the SPL, BSS included.
2111                 When defined, the linker checks that the actual memory
2112                 used by SPL from _start to __bss_end does not exceed it.
2114                 must not be both defined at the same time.
2116                 CONFIG_SPL_MAX_SIZE
2117                 Maximum size of the SPL image (text, data, rodata, and
2118                 linker lists sections), BSS excluded.
2119                 When defined, the linker checks that the actual size does
2120                 not exceed it.
2122                 CONFIG_SPL_RELOC_TEXT_BASE
2123                 Address to relocate to.  If unspecified, this is equal to
2124                 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2126                 CONFIG_SPL_BSS_START_ADDR
2127                 Link address for the BSS within the SPL binary.
2129                 CONFIG_SPL_BSS_MAX_SIZE
2130                 Maximum size in memory allocated to the SPL BSS.
2131                 When defined, the linker checks that the actual memory used
2132                 by SPL from __bss_start to __bss_end does not exceed it.
2134                 must not be both defined at the same time.
2136                 CONFIG_SPL_STACK
2137                 Adress of the start of the stack SPL will use
2139                 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2140                 When defined, SPL will panic() if the image it has
2141                 loaded does not have a signature.
2142                 Defining this is useful when code which loads images
2143                 in SPL cannot guarantee that absolutely all read errors
2144                 will be caught.
2145                 An example is the LPC32XX MLC NAND driver, which will
2146                 consider that a completely unreadable NAND block is bad,
2147                 and thus should be skipped silently.
2149                 CONFIG_SPL_RELOC_STACK
2150                 Adress of the start of the stack SPL will use after
2151                 relocation.  If unspecified, this is equal to
2152                 CONFIG_SPL_STACK.
2154                 CONFIG_SYS_SPL_MALLOC_START
2155                 Starting address of the malloc pool used in SPL.
2156                 When this option is set the full malloc is used in SPL and
2157                 it is set up by spl_init() and before that, the simple malloc()
2158                 can be used if CONFIG_SYS_MALLOC_F is defined.
2160                 CONFIG_SYS_SPL_MALLOC_SIZE
2161                 The size of the malloc pool used in SPL.
2163                 CONFIG_SPL_OS_BOOT
2164                 Enable booting directly to an OS from SPL.
2165                 See also: doc/README.falcon
2167                 CONFIG_SPL_DISPLAY_PRINT
2168                 For ARM, enable an optional function to print more information
2169                 about the running system.
2171                 CONFIG_SPL_INIT_MINIMAL
2172                 Arch init code should be built for a very small image
2175                 Partition on the MMC to load U-Boot from when the MMC is being
2176                 used in raw mode
2179                 Sector to load kernel uImage from when MMC is being
2180                 used in raw mode (for Falcon mode)
2184                 Sector and number of sectors to load kernel argument
2185                 parameters from when MMC is being used in raw mode
2186                 (for falcon mode)
2188                 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2189                 Filename to read to load U-Boot when reading from filesystem
2191                 CONFIG_SPL_FS_LOAD_KERNEL_NAME
2192                 Filename to read to load kernel uImage when reading
2193                 from filesystem (for Falcon mode)
2195                 CONFIG_SPL_FS_LOAD_ARGS_NAME
2196                 Filename to read to load kernel argument parameters
2197                 when reading from filesystem (for Falcon mode)
2199                 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2200                 Set this for NAND SPL on PPC mpc83xx targets, so that
2201                 start.S waits for the rest of the SPL to load before
2202                 continuing (the hardware starts execution after just
2203                 loading the first page rather than the full 4K).
2205                 CONFIG_SPL_SKIP_RELOCATE
2206                 Avoid SPL relocation
2208                 CONFIG_SPL_NAND_IDENT
2209                 SPL uses the chip ID list to identify the NAND flash.
2210                 Requires CONFIG_SPL_NAND_BASE.
2212                 CONFIG_SPL_UBI
2213                 Support for a lightweight UBI (fastmap) scanner and
2214                 loader
2216                 CONFIG_SPL_NAND_RAW_ONLY
2217                 Support to boot only raw u-boot.bin images. Use this only
2218                 if you need to save space.
2220                 CONFIG_SPL_COMMON_INIT_DDR
2221                 Set for common ddr init with serial presence detect in
2222                 SPL binary.
2228                 CONFIG_SYS_NAND_ECCBYTES
2229                 Defines the size and behavior of the NAND that SPL uses
2230                 to read U-Boot
2232                 CONFIG_SYS_NAND_U_BOOT_OFFS
2233                 Location in NAND to read U-Boot from
2235                 CONFIG_SYS_NAND_U_BOOT_DST
2236                 Location in memory to load U-Boot to
2238                 CONFIG_SYS_NAND_U_BOOT_SIZE
2239                 Size of image to load
2241                 CONFIG_SYS_NAND_U_BOOT_START
2242                 Entry point in loaded image to jump to
2244                 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2245                 Define this if you need to first read the OOB and then the
2246                 data. This is used, for example, on davinci platforms.
2248                 CONFIG_SPL_RAM_DEVICE
2249                 Support for running image already present in ram, in SPL binary
2251                 CONFIG_SPL_PAD_TO
2252                 Image offset to which the SPL should be padded before appending
2253                 the SPL payload. By default, this is defined as
2254                 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2255                 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2256                 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
2258                 CONFIG_SPL_TARGET
2259                 Final target image containing SPL and payload.  Some SPLs
2260                 use an arch-specific makefile fragment instead, for
2261                 example if more than one image needs to be produced.
2263                 CONFIG_SPL_FIT_PRINT
2264                 Printing information about a FIT image adds quite a bit of
2265                 code to SPL. So this is normally disabled in SPL. Use this
2266                 option to re-enable it. This will affect the output of the
2267                 bootm command when booting a FIT image.
2269 - TPL framework
2270                 CONFIG_TPL
2271                 Enable building of TPL globally.
2273                 CONFIG_TPL_PAD_TO
2274                 Image offset to which the TPL should be padded before appending
2275                 the TPL payload. By default, this is defined as
2276                 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2277                 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2278                 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
2280 - Interrupt support (PPC):
2282                 There are common interrupt_init() and timer_interrupt()
2283                 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
2284                 for CPU specific initialization. interrupt_init_cpu()
2285                 should set decrementer_count to appropriate value. If
2286                 CPU resets decrementer automatically after interrupt
2287                 (ppc4xx) it should set decrementer_count to zero.
2288                 timer_interrupt() calls timer_interrupt_cpu() for CPU
2289                 specific handling. If board has watchdog / status_led
2290                 / other_activity_monitor it works automatically from
2291                 general timer_interrupt().
2294 Board initialization settings:
2295 ------------------------------
2297 During Initialization u-boot calls a number of board specific functions
2298 to allow the preparation of board specific prerequisites, e.g. pin setup
2299 before drivers are initialized. To enable these callbacks the
2300 following configuration macros have to be defined. Currently this is
2301 architecture specific, so please check arch/your_architecture/lib/board.c
2302 typically in board_init_f() and board_init_r().
2304 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2305 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2306 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
2307 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2309 Configuration Settings:
2310 -----------------------
2312 - MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2313                 Optionally it can be defined to support 64-bit memory commands.
2315 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2316                 undefine this when you're short of memory.
2318 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2319                 width of the commands listed in the 'help' command output.
2321 - CONFIG_SYS_PROMPT:    This is what U-Boot prints on the console to
2322                 prompt for user input.
2324 - CONFIG_SYS_CBSIZE:    Buffer size for input from the Console
2326 - CONFIG_SYS_PBSIZE:    Buffer size for Console output
2328 - CONFIG_SYS_MAXARGS:   max. Number of arguments accepted for monitor commands
2330 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2331                 the application (usually a Linux kernel) when it is
2332                 booted
2335                 List of legal baudrate settings for this board.
2338                 Only implemented for ARMv8 for now.
2339                 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2340                 is substracted from total RAM and won't be reported to OS.
2341                 This memory can be used as secure memory. A variable
2342                 gd->arch.secure_ram is used to track the location. In systems
2343                 the RAM base is not zero, or RAM is divided into banks,
2344                 this variable needs to be recalcuated to get the address.
2347                 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2348                 this specified memory area will get subtracted from the top
2349                 (end) of RAM and won't get "touched" at all by U-Boot. By
2350                 fixing up gd->ram_size the Linux kernel should gets passed
2351                 the now "corrected" memory size and won't touch it either.
2352                 This should work for arch/ppc and arch/powerpc. Only Linux
2353                 board ports in arch/powerpc with bootwrapper support that
2354                 recalculate the memory size from the SDRAM controller setup
2355                 will have to get fixed in Linux additionally.
2357                 This option can be used as a workaround for the 440EPx/GRx
2358                 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2359                 be touched.
2361                 WARNING: Please make sure that this value is a multiple of
2362                 the Linux page size (normally 4k). If this is not the case,
2363                 then the end address of the Linux memory will be located at a
2364                 non page size aligned address and this could cause major
2365                 problems.
2368                 Enable temporary baudrate change while serial download
2371                 Physical start address of SDRAM. _Must_ be 0 here.
2374                 Physical start address of Flash memory.
2377                 Physical start address of boot monitor code (set by
2378                 make config files to be same as the text base address
2379                 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
2380                 CONFIG_SYS_FLASH_BASE when booting from flash.
2383                 Size of memory reserved for monitor code, used to
2384                 determine _at_compile_time_ (!) if the environment is
2385                 embedded within the U-Boot image, or in a separate
2386                 flash sector.
2389                 Size of DRAM reserved for malloc() use.
2392                 Size of the malloc() pool for use before relocation. If
2393                 this is defined, then a very simple malloc() implementation
2394                 will become available before relocation. The address is just
2395                 below the global data, and the stack is moved down to make
2396                 space.
2398                 This feature allocates regions with increasing addresses
2399                 within the region. calloc() is supported, but realloc()
2400                 is not available. free() is supported but does nothing.
2401                 The memory will be freed (or in fact just forgotten) when
2402                 U-Boot relocates itself.
2405                 Provides a simple and small malloc() and calloc() for those
2406                 boards which do not use the full malloc in SPL (which is
2407                 enabled with CONFIG_SYS_SPL_MALLOC_START).
2410                 Size of non-cached memory area. This area of memory will be
2411                 typically located right below the malloc() area and mapped
2412                 uncached in the MMU. This is useful for drivers that would
2413                 otherwise require a lot of explicit cache maintenance. For
2414                 some drivers it's also impossible to properly maintain the
2415                 cache. For example if the regions that need to be flushed
2416                 are not a multiple of the cache-line size, *and* padding
2417                 cannot be allocated between the regions to align them (i.e.
2418                 if the HW requires a contiguous array of regions, and the
2419                 size of each region is not cache-aligned), then a flush of
2420                 one region may result in overwriting data that hardware has
2421                 written to another region in the same cache-line. This can
2422                 happen for example in network drivers where descriptors for
2423                 buffers are typically smaller than the CPU cache-line (e.g.
2424                 16 bytes vs. 32 or 64 bytes).
2426                 Non-cached memory is only supported on 32-bit ARM at present.
2429                 Normally compressed uImages are limited to an
2430                 uncompressed size of 8 MBytes. If this is not enough,
2431                 you can define CONFIG_SYS_BOOTM_LEN in your board config file
2432                 to adjust this setting to your needs.
2435                 Maximum size of memory mapped by the startup code of
2436                 the Linux kernel; all data that must be processed by
2437                 the Linux kernel (bd_info, boot arguments, FDT blob if
2438                 used) must be put below this limit, unless "bootm_low"
2439                 environment variable is defined and non-zero. In such case
2440                 all data for the Linux kernel must be between "bootm_low"
2441                 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
2442                 variable "bootm_mapsize" will override the value of
2443                 CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2444                 then the value in "bootm_size" will be used instead.
2447                 Enable initrd_high functionality.  If defined then the
2448                 initrd_high feature is enabled and the bootm ramdisk subcommand
2449                 is enabled.
2452                 Enables allocating and saving kernel cmdline in space between
2453                 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2456                 Enables allocating and saving a kernel copy of the bd_info in
2457                 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2460                 Max number of Flash memory banks
2463                 Max number of sectors on a Flash chip
2466                 Timeout for Flash erase operations (in ms)
2469                 Timeout for Flash write operations (in ms)
2472                 Timeout for Flash set sector lock bit operation (in ms)
2475                 Timeout for Flash clear lock bits operation (in ms)
2478                 If defined, hardware flash sectors protection is used
2479                 instead of U-Boot software protection.
2483                 Enable TFTP transfers directly to flash memory;
2484                 without this option such a download has to be
2485                 performed in two steps: (1) download to RAM, and (2)
2486                 copy from RAM to flash.
2488                 The two-step approach is usually more reliable, since
2489                 you can check if the download worked before you erase
2490                 the flash, but in some situations (when system RAM is
2491                 too limited to allow for a temporary copy of the
2492                 downloaded image) this option may be very useful.
2495                 Define if the flash driver uses extra elements in the
2496                 common flash structure for storing flash geometry.
2499                 This option also enables the building of the cfi_flash driver
2500                 in the drivers directory
2503                 This option enables the building of the cfi_mtd driver
2504                 in the drivers directory. The driver exports CFI flash
2505                 to the MTD layer.
2508                 Use buffered writes to flash.
2511                 s29ws-n MirrorBit flash has non-standard addresses for buffered
2512                 write commands.
2515                 If this option is defined, the common CFI flash doesn't
2516                 print it's warning upon not recognized FLASH banks. This
2517                 is useful, if some of the configured banks are only
2518                 optionally available.
2521                 If defined (must be an integer), print out countdown
2522                 digits and dots.  Recommended value: 45 (9..1) for 80
2523                 column displays, 15 (3..1) for 40 column displays.
2526                 If defined, the content of the flash (destination) is compared
2527                 against the source after the write operation. An error message
2528                 will be printed when the contents are not identical.
2529                 Please note that this option is useless in nearly all cases,
2530                 since such flash programming errors usually are detected earlier
2531                 while unprotecting/erasing/programming. Please only enable
2532                 this option if you really know what you are doing.
2535                 Defines the number of Ethernet receive buffers. On some
2536                 Ethernet controllers it is recommended to set this value
2537                 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2538                 buffers can be full shortly after enabling the interface
2539                 on high Ethernet traffic.
2540                 Defaults to 4 if not defined.
2544         Maximum number of entries in the hash table that is used
2545         internally to store the environment settings. The default
2546         setting is supposed to be generous and should work in most
2547         cases. This setting can be used to tune behaviour; see
2548         lib/hashtable.c for details.
2552         Enable validation of the values given to environment variables when
2553         calling env set.  Variables can be restricted to only decimal,
2554         hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
2555         the variables can also be restricted to IP address or MAC address.
2557         The format of the list is:
2558                 type_attribute = [s|d|x|b|i|m]
2559                 access_attribute = [a|r|o|c]
2560                 attributes = type_attribute[access_attribute]
2561                 entry = variable_name[:attributes]
2562                 list = entry[,list]
2564         The type attributes are:
2565                 s - String (default)
2566                 d - Decimal
2567                 x - Hexadecimal
2568                 b - Boolean ([1yYtT|0nNfF])
2569                 i - IP address
2570                 m - MAC address
2572         The access attributes are:
2573                 a - Any (default)
2574                 r - Read-only
2575                 o - Write-once
2576                 c - Change-default
2579                 Define this to a list (string) to define the ".flags"
2580                 environment variable in the default or embedded environment.
2583                 Define this to a list (string) to define validation that
2584                 should be done if an entry is not found in the ".flags"
2585                 environment variable.  To override a setting in the static
2586                 list, simply add an entry for the same variable name to the
2587                 ".flags" variable.
2589         If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2590         regular expression. This allows multiple variables to define the same
2591         flags without explicitly listing them for each variable.
2593 The following definitions that deal with the placement and management
2594 of environment data (variable area); in general, we support the
2595 following configurations:
2599         Builds up envcrc with the target environment so that external utils
2600         may easily extract it and embed it in final U-Boot images.
2602 BE CAREFUL! The first access to the environment happens quite early
2603 in U-Boot initialization (when we try to get the setting of for the
2604 console baudrate). You *MUST* have mapped your NVRAM area then, or
2605 U-Boot will hang.
2607 Please note that even with NVRAM we still use a copy of the
2608 environment in RAM: we could work on NVRAM directly, but we want to
2609 keep settings there always unmodified except somebody uses "saveenv"
2610 to save the current settings.
2612 BE CAREFUL! For some special cases, the local device can not use
2613 "saveenv" command. For example, the local device will get the
2614 environment stored in a remote NOR flash by SRIO or PCIE link,
2615 but it can not erase, write this NOR flash by SRIO or PCIE interface.
2619         Defines address in RAM to which the nand_spl code should copy the
2620         environment. If redundant environment is used, it will be copied to
2623 Please note that the environment is read-only until the monitor
2624 has been relocated to RAM and a RAM copy of the environment has been
2625 created; also, when using EEPROM you will have to use env_get_f()
2626 until then to read environment variables.
2628 The environment is protected by a CRC32 checksum. Before the monitor
2629 is relocated into RAM, as a result of a bad CRC you will be working
2630 with the compiled-in default environment - *silently*!!! [This is
2631 necessary, because the first environment variable we need is the
2632 "baudrate" setting for the console - if we have a bad CRC, we don't
2633 have any device yet where we could complain.]
2635 Note: once the monitor has been relocated, then it will complain if
2636 the default environment is used; a new CRC is computed as soon as you
2637 use the "saveenv" command to store a valid environment.
2640                 Echo the inverted Ethernet link state to the fault LED.
2642                 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2643                       also needs to be defined.
2646                 MII address of the PHY to check for the Ethernet link state.
2649                 Define this if you desire to only have use of the NS16550_init
2650                 and NS16550_putc functions for the serial driver located at
2651                 drivers/serial/ns16550.c.  This option is useful for saving
2652                 space for already greatly restricted images, including but not
2653                 limited to NAND_SPL configurations.
2656                 Display information about the board that U-Boot is running on
2657                 when U-Boot starts up. The board function checkboard() is called
2658                 to do this.
2661                 Similar to the previous option, but display this information
2662                 later, once stdio is running and output goes to the LCD, if
2663                 present.
2666                 Maximum size of the U-Boot image. When defined, the
2667                 build system checks that the actual size does not
2668                 exceed it.
2670 Low Level (hardware related) configuration options:
2671 ---------------------------------------------------
2674                 Cache Line Size of the CPU.
2677                 Default (power-on reset) physical address of CCSR on Freescale
2678                 PowerPC SOCs.
2681                 Virtual address of CCSR.  On a 32-bit build, this is typically
2682                 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2685                 Physical address of CCSR.  CCSR can be relocated to a new
2686                 physical address, if desired.  In this case, this macro should
2687                 be set to that address.  Otherwise, it should be set to the
2688                 same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
2689                 is typically relocated on 36-bit builds.  It is recommended
2690                 that this macro be defined via the _HIGH and _LOW macros:
2693                         * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2696                 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.  This value is typically
2697                 either 0 (32-bit build) or 0xF (36-bit build).  This macro is
2698                 used in assembly code, so it must not contain typecasts or
2699                 integer size suffixes (e.g. "ULL").
2702                 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
2703                 used in assembly code, so it must not contain typecasts or
2704                 integer size suffixes (e.g. "ULL").
2707                 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2708                 forced to a value that ensures that CCSR is not relocated.
2711                 Most IDE controllers were designed to be connected with PCI
2712                 interface. Only few of them were designed for AHB interface.
2713                 When software is doing ATA command and data transfer to
2714                 IDE devices through IDE-AHB controller, some additional
2715                 registers accessing to these kind of IDE-AHB controller
2716                 is required.
2718 - CONFIG_SYS_IMMR:      Physical address of the Internal Memory.
2719                 DO NOT CHANGE unless you know exactly what you're
2720                 doing! (11-4) [MPC8xx systems only]
2724                 Start address of memory area that can be used for
2725                 initial data and stack; please note that this must be
2726                 writable memory that is working WITHOUT special
2727                 initialization, i. e. you CANNOT use normal RAM which
2728                 will become available only after programming the
2729                 memory controller and running certain initialization
2730                 sequences.
2732                 U-Boot uses the following memory types:
2733                 - MPC8xx: IMMR (internal memory of the CPU)
2737                 Offset of the initial data structure in the memory
2738                 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2739                 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2740                 data is located at the end of the available space
2741                 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
2742                 GENERATED_GBL_DATA_SIZE), and the initial stack is just
2743                 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2744                 CONFIG_SYS_GBL_DATA_OFFSET) downward.
2746         Note:
2747                 On the MPC824X (or other systems that use the data
2748                 cache for initial memory) the address chosen for
2749                 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2750                 point to an otherwise UNUSED address space between
2751                 the top of RAM and the start of the PCI space.
2753 - CONFIG_SYS_SCCR:      System Clock and reset Control Register (15-27)
2756                 SDRAM timing
2759                 periodic timer for refresh
2765                 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2770                 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2773                 Enable support for indirect PCI bridges.
2776                 Chip has SRIO or not
2778 - CONFIG_SRIO1:
2779                 Board has SRIO 1 port available
2781 - CONFIG_SRIO2:
2782                 Board has SRIO 2 port available
2785                 Board can support master function for Boot from SRIO and PCIE
2788                 Virtual Address of SRIO port 'n' memory region
2791                 Physical Address of SRIO port 'n' memory region
2794                 Size of SRIO port 'n' memory region
2797                 Defined to tell the NAND controller that the NAND chip is using
2798                 a 16 bit bus.
2799                 Not all NAND drivers use this symbol.
2800                 Example of drivers that use it:
2801                 - drivers/mtd/nand/raw/ndfc.c
2802                 - drivers/mtd/nand/raw/mxc_nand.c
2805                 Sets the EBC0_CFG register for the NDFC. If not defined
2806                 a default value will be used.
2809                 Get DDR timing information from an I2C EEPROM. Common
2810                 with pluggable memory modules such as SODIMMs
2813                 I2C address of the SPD EEPROM
2816                 If SPD EEPROM is on an I2C bus other than the first
2817                 one, specify here. Note that the value must resolve
2818                 to something your driver can deal with.
2821                 Get DDR timing information from other than SPD. Common with
2822                 soldered DDR chips onboard without SPD. DDR raw timing
2823                 parameters are extracted from datasheet and hard-coded into
2824                 header files or board specific files.
2827                 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2830                 Enable sync of refresh for multiple controllers.
2833                 Enable built-in memory test for Freescale DDR controllers.
2836                 Only for 83xx systems. If specified, then DDR should
2837                 be configured using CS0 and CS1 instead of CS2 and CS3.
2840                 Enable RMII mode for all FECs.
2841                 Note that this is a global option, we can't
2842                 have one FEC in standard MII mode and another in RMII mode.
2845                 Add a verify option to the crc32 command.
2846                 The syntax is:
2848                 => crc32 -v <address> <count> <crc32>
2850                 Where address/count indicate a memory area
2851                 and crc32 is the correct crc32 which the
2852                 area should have.
2855                 Add the "loopw" memory command. This only takes effect if
2856                 the memory commands are activated globally (CONFIG_CMD_MEMORY).
2859                 Add the "mdc" and "mwc" memory commands. These are cyclic
2860                 "md/mw" commands.
2861                 Examples:
2863                 => mdc.b 10 4 500
2864                 This command will print 4 bytes (10,11,12,13) each 500 ms.
2866                 => mwc.l 100 12345678 10
2867                 This command will write 12345678 to address 100 all 10 ms.
2869                 This only takes effect if the memory commands are activated
2870                 globally (CONFIG_CMD_MEMORY).
2873                 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
2874                 low level initializations (like setting up the memory
2875                 controller) are omitted and/or U-Boot does not
2876                 relocate itself into RAM.
2878                 Normally this variable MUST NOT be defined. The only
2879                 exception is when U-Boot is loaded (to RAM) by some
2880                 other boot loader or by a debugger which performs
2881                 these initializations itself.
2884                 [ARM926EJ-S only] This allows just the call to lowlevel_init()
2885                 to be skipped. The normal CP15 init (such as enabling the
2886                 instruction cache) is still performed.
2889                 Set when the currently-running compilation is for an artifact
2890                 that will end up in the SPL (as opposed to the TPL or U-Boot
2891                 proper). Code that needs stage-specific behavior should check
2892                 this.
2895                 Set when the currently-running compilation is for an artifact
2896                 that will end up in the TPL (as opposed to the SPL or U-Boot
2897                 proper). Code that needs stage-specific behavior should check
2898                 this.
2901                 Only for 85xx systems. If this variable is specified, the section
2902                 .resetvec is not kept and the section .bootpg is placed in the
2903                 previous 4k of the .text section.
2906                 Generally U-Boot (and in particular the md command) uses
2907                 effective address. It is therefore not necessary to regard
2908                 U-Boot address as virtual addresses that need to be translated
2909                 to physical addresses. However, sandbox requires this, since
2910                 it maintains its own little RAM buffer which contains all
2911                 addressable memory. This option causes some memory accesses
2912                 to be mapped through map_sysmem() / unmap_sysmem().
2915                 If defined, the x86 reset vector code is included. This is not
2916                 needed when U-Boot is running from Coreboot.
2919                 Option to disable subpage write in NAND driver
2920                 driver that uses this:
2921                 drivers/mtd/nand/raw/davinci_nand.c
2923 Freescale QE/FMAN Firmware Support:
2924 -----------------------------------
2926 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2927 loading of "firmware", which is encoded in the QE firmware binary format.
2928 This firmware often needs to be loaded during U-Boot booting, so macros
2929 are used to identify the storage device (NOR flash, SPI, etc) and the address
2930 within that device.
2933         The address in the storage device where the FMAN microcode is located.  The
2934         meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
2935         is also specified.
2938         The address in the storage device where the QE microcode is located.  The
2939         meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
2940         is also specified.
2943         The maximum possible size of the firmware.  The firmware binary format
2944         has a field that specifies the actual size of the firmware, but it
2945         might not be possible to read any part of the firmware unless some
2946         local storage is allocated to hold the entire firmware first.
2949         Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2950         normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
2951         virtual address in NOR flash.
2954         Specifies that QE/FMAN firmware is located in NAND flash.
2955         CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2958         Specifies that QE/FMAN firmware is located on the primary SD/MMC
2959         device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2962         Specifies that QE/FMAN firmware is located in the remote (master)
2963         memory space.   CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
2964         can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2965         window->master inbound window->master LAW->the ucode address in
2966         master's memory space.
2968 Freescale Layerscape Management Complex Firmware Support:
2969 ---------------------------------------------------------
2970 The Freescale Layerscape Management Complex (MC) supports the loading of
2971 "firmware".
2972 This firmware often needs to be loaded during U-Boot booting, so macros
2973 are used to identify the storage device (NOR flash, SPI, etc) and the address
2974 within that device.
2977         Enable the MC driver for Layerscape SoCs.
2979 Freescale Layerscape Debug Server Support:
2980 -------------------------------------------
2981 The Freescale Layerscape Debug Server Support supports the loading of
2982 "Debug Server firmware" and triggering SP boot-rom.
2983 This firmware often needs to be loaded during U-Boot booting.
2986         Define alignment of reserved memory MC requires
2988 Reproducible builds
2989 -------------------
2991 In order to achieve reproducible builds, timestamps used in the U-Boot build
2992 process have to be set to a fixed value.
2994 This is done using the SOURCE_DATE_EPOCH environment variable.
2995 SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
2996 option for U-Boot or an environment variable in U-Boot.
2998 SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3000 Building the Software:
3001 ======================
3003 Building U-Boot has been tested in several native build environments
3004 and in many different cross environments. Of course we cannot support
3005 all possibly existing versions of cross development tools in all
3006 (potentially obsolete) versions. In case of tool chain problems we
3007 recommend to use the ELDK (see
3008 which is extensively used to build and test U-Boot.
3010 If you are not using a native environment, it is assumed that you
3011 have GNU cross compiling tools available in your path. In this case,
3012 you must set the environment variable CROSS_COMPILE in your shell.
3013 Note that no changes to the Makefile or any other source files are
3014 necessary. For example using the ELDK on a 4xx CPU, please enter:
3016         $ CROSS_COMPILE=ppc_4xx-
3017         $ export CROSS_COMPILE
3019 U-Boot is intended to be simple to build. After installing the
3020 sources you must configure U-Boot for one specific board type. This
3021 is done by typing:
3023         make NAME_defconfig
3025 where "NAME_defconfig" is the name of one of the existing configu-
3026 rations; see configs/*_defconfig for supported names.
3028 Note: for some boards special configuration names may exist; check if
3029       additional information is available from the board vendor; for
3030       instance, the TQM823L systems are available without (standard)
3031       or with LCD support. You can select such additional "features"
3032       when choosing the configuration, i. e.
3034       make TQM823L_defconfig
3035         - will configure for a plain TQM823L, i. e. no LCD support
3037       make TQM823L_LCD_defconfig
3038         - will configure for a TQM823L with U-Boot console on LCD
3040       etc.
3043 Finally, type "make all", and you should get some working U-Boot
3044 images ready for download to / installation on your system:
3046 - "u-boot.bin" is a raw binary image
3047 - "u-boot" is an image in ELF binary format
3048 - "u-boot.srec" is in Motorola S-Record format
3050 By default the build is performed locally and the objects are saved
3051 in the source directory. One of the two methods can be used to change
3052 this behavior and build U-Boot to some external directory:
3054 1. Add O= to the make command line invocations:
3056         make O=/tmp/build distclean
3057         make O=/tmp/build NAME_defconfig
3058         make O=/tmp/build all
3060 2. Set environment variable KBUILD_OUTPUT to point to the desired location:
3062         export KBUILD_OUTPUT=/tmp/build
3063         make distclean
3064         make NAME_defconfig
3065         make all
3067 Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
3068 variable.
3070 User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3071 setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3072 For example to treat all compiler warnings as errors:
3074         make KCFLAGS=-Werror
3076 Please be aware that the Makefiles assume you are using GNU make, so
3077 for instance on NetBSD you might need to use "gmake" instead of
3078 native "make".
3081 If the system board that you have is not listed, then you will need
3082 to port U-Boot to your hardware platform. To do this, follow these
3083 steps:
3085 1.  Create a new directory to hold your board specific code. Add any
3086     files you need. In your board directory, you will need at least
3087     the "Makefile" and a "<board>.c".
3088 2.  Create a new configuration file "include/configs/<board>.h" for
3089     your board.
3090 3.  If you're porting U-Boot to a new CPU, then also create a new
3091     directory to hold your CPU specific code. Add any files you need.
3092 4.  Run "make <board>_defconfig" with your new name.
3093 5.  Type "make", and you should get a working "u-boot.srec" file
3094     to be installed on your target system.
3095 6.  Debug and solve any problems that might arise.
3096     [Of course, this last step is much harder than it sounds.]
3099 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3100 ==============================================================
3102 If you have modified U-Boot sources (for instance added a new board
3103 or support for new devices, a new CPU, etc.) you are expected to
3104 provide feedback to the other developers. The feedback normally takes
3105 the form of a "patch", i.e. a context diff against a certain (latest
3106 official or latest in the git repository) version of U-Boot sources.
3108 But before you submit such a patch, please verify that your modifi-
3109 cation did not break existing code. At least make sure that *ALL* of
3110 the supported boards compile WITHOUT ANY compiler warnings. To do so,
3111 just run the buildman script (tools/buildman/buildman), which will
3112 configure and build U-Boot for ALL supported system. Be warned, this
3113 will take a while. Please see the buildman README, or run 'buildman -H'
3114 for documentation.
3117 See also "U-Boot Porting Guide" below.
3120 Monitor Commands - Overview:
3121 ============================
3123 go      - start application at address 'addr'
3124 run     - run commands in an environment variable
3125 bootm   - boot application image from memory
3126 bootp   - boot image via network using BootP/TFTP protocol
3127 bootz   - boot zImage from memory
3128 tftpboot- boot image via network using TFTP protocol
3129                and env variables "ipaddr" and "serverip"
3130                (and eventually "gatewayip")
3131 tftpput - upload a file via network using TFTP protocol
3132 rarpboot- boot image via network using RARP/TFTP protocol
3133 diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3134 loads   - load S-Record file over serial line
3135 loadb   - load binary file over serial line (kermit mode)
3136 md      - memory display
3137 mm      - memory modify (auto-incrementing)
3138 nm      - memory modify (constant address)
3139 mw      - memory write (fill)
3140 ms      - memory search
3141 cp      - memory copy
3142 cmp     - memory compare
3143 crc32   - checksum calculation
3144 i2c     - I2C sub-system
3145 sspi    - SPI utility commands
3146 base    - print or set address offset
3147 printenv- print environment variables
3148 pwm     - control pwm channels
3149 setenv  - set environment variables
3150 saveenv - save environment variables to persistent storage
3151 protect - enable or disable FLASH write protection
3152 erase   - erase FLASH memory
3153 flinfo  - print FLASH memory information
3154 nand    - NAND memory operations (see doc/README.nand)
3155 bdinfo  - print Board Info structure
3156 iminfo  - print header information for application image
3157 coninfo - print console devices and informations
3158 ide     - IDE sub-system
3159 loop    - infinite loop on address range
3160 loopw   - infinite write loop on address range
3161 mtest   - simple RAM test
3162 icache  - enable or disable instruction cache
3163 dcache  - enable or disable data cache
3164 reset   - Perform RESET of the CPU
3165 echo    - echo args to console
3166 version - print monitor version
3167 help    - print online help
3168 ?       - alias for 'help'
3171 Monitor Commands - Detailed Description:
3172 ========================================
3174 TODO.
3176 For now: just type "help <command>".
3179 Environment Variables:
3180 ======================
3182 U-Boot supports user configuration using Environment Variables which
3183 can be made persistent by saving to Flash memory.
3185 Environment Variables are set using "setenv", printed using
3186 "printenv", and saved to Flash using "saveenv". Using "setenv"
3187 without a value can be used to delete a variable from the
3188 environment. As long as you don't save the environment you are
3189 working with an in-memory copy. In case the Flash area containing the
3190 environment is erased by accident, a default environment is provided.
3192 Some configuration options can be set using Environment Variables.
3194 List of environment variables (most likely not complete):
3196   baudrate      - see CONFIG_BAUDRATE
3198   bootdelay     - see CONFIG_BOOTDELAY
3200   bootcmd       - see CONFIG_BOOTCOMMAND
3202   bootargs      - Boot arguments when booting an RTOS image
3204   bootfile      - Name of the image to load with TFTP
3206   bootm_low     - Memory range available for image processing in the bootm
3207                   command can be restricted. This variable is given as
3208                   a hexadecimal number and defines lowest address allowed
3209                   for use by the bootm command. See also "bootm_size"
3210                   environment variable. Address defined by "bootm_low" is
3211                   also the base of the initial memory mapping for the Linux
3212                   kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3213                   bootm_mapsize.
3215   bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3216                   This variable is given as a hexadecimal number and it
3217                   defines the size of the memory region starting at base
3218                   address bootm_low that is accessible by the Linux kernel
3219                   during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3220                   as the default value if it is defined, and bootm_size is
3221                   used otherwise.
3223   bootm_size    - Memory range available for image processing in the bootm
3224                   command can be restricted. This variable is given as
3225                   a hexadecimal number and defines the size of the region
3226                   allowed for use by the bootm command. See also "bootm_low"
3227                   environment variable.
3229   bootstopkeysha256, bootdelaykey, bootstopkey  - See README.autoboot
3231   updatefile    - Location of the software update file on a TFTP server, used
3232                   by the automatic software update feature. Please refer to
3233                   documentation in doc/README.update for more details.
3235   autoload      - if set to "no" (any string beginning with 'n'),
3236                   "bootp" will just load perform a lookup of the
3237                   configuration from the BOOTP server, but not try to
3238                   load any image using TFTP
3240   autostart     - if set to "yes", an image loaded using the "bootp",
3241                   "rarpboot", "tftpboot" or "diskboot" commands will
3242                   be automatically started (by internally calling
3243                   "bootm")
3245                   If set to "no", a standalone image passed to the
3246                   "bootm" command will be copied to the load address
3247                   (and eventually uncompressed), but NOT be started.
3248                   This can be used to load and uncompress arbitrary
3249                   data.
3251   fdt_high      - if set this restricts the maximum address that the
3252                   flattened device tree will be copied into upon boot.
3253                   For example, if you have a system with 1 GB memory
3254                   at physical address 0x10000000, while Linux kernel
3255                   only recognizes the first 704 MB as low memory, you
3256                   may need to set fdt_high as 0x3C000000 to have the
3257                   device tree blob be copied to the maximum address
3258                   of the 704 MB low memory, so that Linux kernel can
3259                   access it during the boot procedure.
3261                   If this is set to the special value 0xFFFFFFFF then
3262                   the fdt will not be copied at all on boot.  For this
3263                   to work it must reside in writable memory, have
3264                   sufficient padding on the end of it for u-boot to
3265                   add the information it needs into it, and the memory
3266                   must be accessible by the kernel.
3268   fdtcontroladdr- if set this is the address of the control flattened
3269                   device tree used by U-Boot when CONFIG_OF_CONTROL is
3270                   defined.
3272   i2cfast       - (PPC405GP|PPC405EP only)
3273                   if set to 'y' configures Linux I2C driver for fast
3274                   mode (400kHZ). This environment variable is used in
3275                   initialization code. So, for changes to be effective
3276                   it must be saved and board must be reset.
3278   initrd_high   - restrict positioning of initrd images:
3279                   If this variable is not set, initrd images will be
3280                   copied to the highest possible address in RAM; this
3281                   is usually what you want since it allows for
3282                   maximum initrd size. If for some reason you want to
3283                   make sure that the initrd image is loaded below the
3284                   CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3285                   variable to a value of "no" or "off" or "0".
3286                   Alternatively, you can set it to a maximum upper
3287                   address to use (U-Boot will still check that it
3288                   does not overwrite the U-Boot stack and data).
3290                   For instance, when you have a system with 16 MB
3291                   RAM, and want to reserve 4 MB from use by Linux,
3292                   you can do this by adding "mem=12M" to the value of
3293                   the "bootargs" variable. However, now you must make
3294                   sure that the initrd image is placed in the first
3295                   12 MB as well - this can be done with
3297                   setenv initrd_high 00c00000
3299                   If you set initrd_high to 0xFFFFFFFF, this is an
3300                   indication to U-Boot that all addresses are legal
3301                   for the Linux kernel, including addresses in flash
3302                   memory. In this case U-Boot will NOT COPY the
3303                   ramdisk at all. This may be useful to reduce the
3304                   boot time on your system, but requires that this
3305                   feature is supported by your Linux kernel.
3307   ipaddr        - IP address; needed for tftpboot command
3309   loadaddr      - Default load address for commands like "bootp",
3310                   "rarpboot", "tftpboot", "loadb" or "diskboot"
3312   loads_echo    - see CONFIG_LOADS_ECHO
3314   serverip      - TFTP server IP address; needed for tftpboot command
3316   bootretry     - see CONFIG_BOOT_RETRY_TIME
3318   bootdelaykey  - see CONFIG_AUTOBOOT_DELAY_STR
3320   bootstopkey   - see CONFIG_AUTOBOOT_STOP_STR
3322   ethprime      - controls which interface is used first.
3324   ethact        - controls which interface is currently active.
3325                   For example you can do the following
3327                   => setenv ethact FEC
3328                   => ping # traffic sent on FEC
3329                   => setenv ethact SCC
3330                   => ping # traffic sent on SCC
3332   ethrotate     - When set to "no" U-Boot does not go through all
3333                   available network interfaces.
3334                   It just stays at the currently selected interface.
3336   netretry      - When set to "no" each network operation will
3337                   either succeed or fail without retrying.
3338                   When set to "once" the network operation will
3339                   fail when all the available network interfaces
3340                   are tried once without success.
3341                   Useful on scripts which control the retry operation
3342                   themselves.
3344   npe_ucode     - set load address for the NPE microcode
3346   silent_linux  - If set then Linux will be told to boot silently, by
3347                   changing the console to be empty. If "yes" it will be
3348                   made silent. If "no" it will not be made silent. If
3349                   unset, then it will be made silent if the U-Boot console
3350                   is silent.
3352   tftpsrcp      - If this is set, the value is used for TFTP's
3353                   UDP source port.
3355   tftpdstp      - If this is set, the value is used for TFTP's UDP
3356                   destination port instead of the Well Know Port 69.
3358   tftpblocksize - Block size to use for TFTP transfers; if not set,
3359                   we use the TFTP server's default block size
3361   tftptimeout   - Retransmission timeout for TFTP packets (in milli-
3362                   seconds, minimum value is 1000 = 1 second). Defines
3363                   when a packet is considered to be lost so it has to
3364                   be retransmitted. The default is 5000 = 5 seconds.
3365                   Lowering this value may make downloads succeed
3366                   faster in networks with high packet loss rates or
3367                   with unreliable TFTP servers.
3369   tftptimeoutcountmax   - maximum count of TFTP timeouts (no
3370                   unit, minimum value = 0). Defines how many timeouts
3371                   can happen during a single file transfer before that
3372                   transfer is aborted. The default is 10, and 0 means
3373                   'no timeouts allowed'. Increasing this value may help
3374                   downloads succeed with high packet loss rates, or with
3375                   unreliable TFTP servers or client hardware.
3377   tftpwindowsize        - if this is set, the value is used for TFTP's
3378                   window size as described by RFC 7440.
3379                   This means the count of blocks we can receive before
3380                   sending ack to server.
3382   vlan          - When set to a value < 4095 the traffic over
3383                   Ethernet is encapsulated/received over 802.1q
3384                   VLAN tagged frames.
3386   bootpretryperiod      - Period during which BOOTP/DHCP sends retries.
3387                   Unsigned value, in milliseconds. If not set, the period will
3388                   be either the default (28000), or a value based on
3389                   CONFIG_NET_RETRY_COUNT, if defined. This value has
3390                   precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3392   memmatches    - Number of matches found by the last 'ms' command, in hex
3394   memaddr       - Address of the last match found by the 'ms' command, in hex,
3395                   or 0 if none
3397   mempos        - Index position of the last match found by the 'ms' command,
3398                   in units of the size (.b, .w, .l) of the search
3400   zbootbase     - (x86 only) Base address of the bzImage 'setup' block
3402   zbootaddr     - (x86 only) Address of the loaded bzImage, typically
3403                   BZIMAGE_LOAD_ADDR which is 0x100000
3405 The following image location variables contain the location of images
3406 used in booting. The "Image" column gives the role of the image and is
3407 not an environment variable name. The other columns are environment
3408 variable names. "File Name" gives the name of the file on a TFTP
3409 server, "RAM Address" gives the location in RAM the image will be
3410 loaded to, and "Flash Location" gives the image's address in NOR
3411 flash or offset in NAND flash.
3413 *Note* - these variables don't have to be defined for all boards, some
3414 boards currently use other variables for these purposes, and some
3415 boards use these variables for other purposes.
3417 Image               File Name        RAM Address       Flash Location
3418 -----               ---------        -----------       --------------
3419 u-boot              u-boot           u-boot_addr_r     u-boot_addr
3420 Linux kernel        bootfile         kernel_addr_r     kernel_addr
3421 device tree blob    fdtfile          fdt_addr_r        fdt_addr
3422 ramdisk             ramdiskfile      ramdisk_addr_r    ramdisk_addr
3424 The following environment variables may be used and automatically
3425 updated by the network boot commands ("bootp" and "rarpboot"),
3426 depending the information provided by your boot server:
3428   bootfile      - see above
3429   dnsip         - IP address of your Domain Name Server
3430   dnsip2        - IP address of your secondary Domain Name Server
3431   gatewayip     - IP address of the Gateway (Router) to use
3432   hostname      - Target hostname
3433   ipaddr        - see above
3434   netmask       - Subnet Mask
3435   rootpath      - Pathname of the root filesystem on the NFS server
3436   serverip      - see above
3439 There are two special Environment Variables:
3441   serial#       - contains hardware identification information such
3442                   as type string and/or serial number
3443   ethaddr       - Ethernet address
3445 These variables can be set only once (usually during manufacturing of
3446 the board). U-Boot refuses to delete or overwrite these variables
3447 once they have been set once.
3450 Further special Environment Variables:
3452   ver           - Contains the U-Boot version string as printed
3453                   with the "version" command. This variable is
3454                   readonly (see CONFIG_VERSION_VARIABLE).
3457 Please note that changes to some configuration parameters may take
3458 only effect after the next boot (yes, that's just like Windoze :-).
3461 Callback functions for environment variables:
3462 ---------------------------------------------
3464 For some environment variables, the behavior of u-boot needs to change
3465 when their values are changed.  This functionality allows functions to
3466 be associated with arbitrary variables.  On creation, overwrite, or
3467 deletion, the callback will provide the opportunity for some side
3468 effect to happen or for the change to be rejected.
3470 The callbacks are named and associated with a function using the
3471 U_BOOT_ENV_CALLBACK macro in your board or driver code.
3473 These callbacks are associated with variables in one of two ways.  The
3474 static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3475 in the board configuration to a string that defines a list of
3476 associations.  The list must be in the following format:
3478         entry = variable_name[:callback_name]
3479         list = entry[,list]
3481 If the callback name is not specified, then the callback is deleted.
3482 Spaces are also allowed anywhere in the list.
3484 Callbacks can also be associated by defining the ".callbacks" variable
3485 with the same list format above.  Any association in ".callbacks" will
3486 override any association in the static list. You can define
3487 CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
3488 ".callbacks" environment variable in the default or embedded environment.
3490 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3491 regular expression. This allows multiple variables to be connected to
3492 the same callback without explicitly listing them all out.
3494 The signature of the callback functions is:
3496     int callback(const char *name, const char *value, enum env_op op, int flags)
3498 * name - changed environment variable
3499 * value - new value of the environment variable
3500 * op - operation (create, overwrite, or delete)
3501 * flags - attributes of the environment variable change, see flags H_* in
3502   include/search.h
3504 The return value is 0 if the variable change is accepted and 1 otherwise.
3506 Command Line Parsing:
3507 =====================
3509 There are two different command line parsers available with U-Boot:
3510 the old "simple" one, and the much more powerful "hush" shell:
3512 Old, simple command line parser:
3513 --------------------------------
3515 - supports environment variables (through setenv / saveenv commands)
3516 - several commands on one line, separated by ';'
3517 - variable substitution using "... ${name} ..." syntax
3518 - special characters ('$', ';') can be escaped by prefixing with '\',
3519   for example:
3520         setenv bootcmd bootm \${address}
3521 - You can also escape text by enclosing in single apostrophes, for example:
3522         setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3524 Hush shell:
3525 -----------
3527 - similar to Bourne shell, with control structures like
3529, ...
3530 - supports environment ("global") variables (through setenv / saveenv
3531   commands) and local shell variables (through standard shell syntax
3532   "name=value"); only environment variables can be used with "run"
3533   command
3535 General rules:
3536 --------------
3538 (1) If a command line (or an environment variable executed by a "run"
3539     command) contains several commands separated by semicolon, and
3540     one of these commands fails, then the remaining commands will be
3541     executed anyway.
3543 (2) If you execute several variables with one call to run (i. e.
3544     calling run with a list of variables as arguments), any failing
3545     command will cause "run" to terminate, i. e. the remaining
3546     variables are not executed.
3548 Note for Redundant Ethernet Interfaces:
3549 =======================================
3551 Some boards come with redundant Ethernet interfaces; U-Boot supports
3552 such configurations and is capable of automatic selection of a
3553 "working" interface when needed. MAC assignment works as follows:
3555 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3556 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3557 "eth1addr" (=>eth1), "eth2addr", ...
3559 If the network interface stores some valid MAC address (for instance
3560 in SROM), this is used as default address if there is NO correspon-
3561 ding setting in the environment; if the corresponding environment
3562 variable is set, this overrides the settings in the card; that means:
3564 o If the SROM has a valid MAC address, and there is no address in the
3565   environment, the SROM's address is used.
3567 o If there is no valid address in the SROM, and a definition in the
3568   environment exists, then the value from the environment variable is
3569   used.
3571 o If both the SROM and the environment contain a MAC address, and
3572   both addresses are the same, this MAC address is used.
3574 o If both the SROM and the environment contain a MAC address, and the
3575   addresses differ, the value from the environment is used and a
3576   warning is printed.
3578 o If neither SROM nor the environment contain a MAC address, an error
3579   is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3580   a random, locally-assigned MAC is used.
3582 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3583 will be programmed into hardware as part of the initialization process.  This
3584 may be skipped by setting the appropriate 'ethmacskip' environment variable.
3585 The naming convention is as follows:
3586 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3588 Image Formats:
3589 ==============
3591 U-Boot is capable of booting (and performing other auxiliary operations on)
3592 images in two formats:
3594 New uImage format (FIT)
3595 -----------------------
3597 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3598 to Flattened Device Tree). It allows the use of images with multiple
3599 components (several kernels, ramdisks, etc.), with contents protected by
3600 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3603 Old uImage format
3604 -----------------
3606 Old image format is based on binary files which can be basically anything,
3607 preceded by a special header; see the definitions in include/image.h for
3608 details; basically, the header defines the following image properties:
3610 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3611   4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3613   Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3614   INTEGRITY).
3615 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
3616   IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3617   Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
3618 * Compression Type (uncompressed, gzip, bzip2)
3619 * Load Address
3620 * Entry Point
3621 * Image Name
3622 * Image Timestamp