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