README: Drop CONFIG_LAN91C96_BASE
[platform/kernel/u-boot.git] / README
1 #
2 # (C) Copyright 2000 - 2013
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 #
5 # SPDX-License-Identifier:      GPL-2.0+
6 #
7
8 Summary:
9 ========
10
11 This directory contains the source code for U-Boot, a boot loader for
12 Embedded boards based on PowerPC, ARM, MIPS and several other
13 processors, which can be installed in a boot ROM and used to
14 initialize and test the hardware or to download and run application
15 code.
16
17 The development of U-Boot is closely related to Linux: some parts of
18 the source code originate in the Linux source tree, we have some
19 header files in common, and special provision has been made to
20 support booting of Linux images.
21
22 Some attention has been paid to make this software easily
23 configurable and extendable. For instance, all monitor commands are
24 implemented with the same call interface, so that it's very easy to
25 add new commands. Also, instead of permanently adding rarely used
26 code (for instance hardware test utilities) to the monitor, you can
27 load and run it dynamically.
28
29
30 Status:
31 =======
32
33 In general, all boards for which a configuration option exists in the
34 Makefile have been tested to some extent and can be considered
35 "working". In fact, many of them are used in production systems.
36
37 In case of problems see the CHANGELOG file to find out who contributed
38 the specific port. In addition, there are various MAINTAINERS files
39 scattered throughout the U-Boot source identifying the people or
40 companies responsible for various boards and subsystems.
41
42 Note: As of August, 2010, there is no longer a CHANGELOG file in the
43 actual U-Boot source tree; however, it can be created dynamically
44 from the Git log using:
45
46         make CHANGELOG
47
48
49 Where to get help:
50 ==================
51
52 In case you have questions about, problems with or contributions for
53 U-Boot, you should send a message to the U-Boot mailing list at
54 <u-boot@lists.denx.de>. There is also an archive of previous traffic
55 on the mailing list - please search the archive before asking FAQ's.
56 Please see http://lists.denx.de/pipermail/u-boot and
57 http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
58
59
60 Where to get source code:
61 =========================
62
63 The U-Boot source code is maintained in the Git repository at
64 git://www.denx.de/git/u-boot.git ; you can browse it online at
65 http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67 The "snapshot" links on this page allow you to download tarballs of
68 any version you might be interested in. Official releases are also
69 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70 directory.
71
72 Pre-built (and tested) images are available from
73 ftp://ftp.denx.de/pub/u-boot/images/
74
75
76 Where we come from:
77 ===================
78
79 - start from 8xxrom sources
80 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
81 - clean up code
82 - make it easier to add custom boards
83 - make it possible to add other [PowerPC] CPUs
84 - extend functions, especially:
85   * Provide extended interface to Linux boot loader
86   * S-Record download
87   * network boot
88   * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
89 - create ARMBoot project (http://sourceforge.net/projects/armboot)
90 - add other CPU families (starting with ARM)
91 - create U-Boot project (http://sourceforge.net/projects/u-boot)
92 - current project page: see http://www.denx.de/wiki/U-Boot
93
94
95 Names and Spelling:
96 ===================
97
98 The "official" name of this project is "Das U-Boot". The spelling
99 "U-Boot" shall be used in all written text (documentation, comments
100 in source files etc.). Example:
101
102         This is the README file for the U-Boot project.
103
104 File names etc. shall be based on the string "u-boot". Examples:
105
106         include/asm-ppc/u-boot.h
107
108         #include <asm/u-boot.h>
109
110 Variable names, preprocessor constants etc. shall be either based on
111 the string "u_boot" or on "U_BOOT". Example:
112
113         U_BOOT_VERSION          u_boot_logo
114         IH_OS_U_BOOT            u_boot_hush_start
115
116
117 Versioning:
118 ===========
119
120 Starting with the release in October 2008, the names of the releases
121 were changed from numerical release numbers without deeper meaning
122 into a time stamp based numbering. Regular releases are identified by
123 names consisting of the calendar year and month of the release date.
124 Additional fields (if present) indicate release candidates or bug fix
125 releases in "stable" maintenance trees.
126
127 Examples:
128         U-Boot v2009.11     - Release November 2009
129         U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
130         U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
131
132
133 Directory Hierarchy:
134 ====================
135
136 /arch                   Architecture specific files
137   /arc                  Files generic to ARC architecture
138   /arm                  Files generic to ARM architecture
139   /avr32                Files generic to AVR32 architecture
140   /blackfin             Files generic to Analog Devices Blackfin architecture
141   /m68k                 Files generic to m68k architecture
142   /microblaze           Files generic to microblaze architecture
143   /mips                 Files generic to MIPS architecture
144   /nds32                Files generic to NDS32 architecture
145   /nios2                Files generic to Altera NIOS2 architecture
146   /openrisc             Files generic to OpenRISC architecture
147   /powerpc              Files generic to PowerPC architecture
148   /sandbox              Files generic to HW-independent "sandbox"
149   /sh                   Files generic to SH architecture
150   /sparc                Files generic to SPARC architecture
151   /x86                  Files generic to x86 architecture
152 /api                    Machine/arch independent API for external apps
153 /board                  Board dependent files
154 /cmd                    U-Boot commands functions
155 /common                 Misc architecture independent functions
156 /configs                Board default configuration files
157 /disk                   Code for disk drive partition handling
158 /doc                    Documentation (don't expect too much)
159 /drivers                Commonly used device drivers
160 /dts                    Contains Makefile for building internal U-Boot fdt.
161 /examples               Example code for standalone applications, etc.
162 /fs                     Filesystem code (cramfs, ext2, jffs2, etc.)
163 /include                Header Files
164 /lib                    Library routines generic to all architectures
165 /Licenses               Various license files
166 /net                    Networking code
167 /post                   Power On Self Test
168 /scripts                Various build scripts and Makefiles
169 /test                   Various unit test files
170 /tools                  Tools to build S-Record or U-Boot images, etc.
171
172 Software Configuration:
173 =======================
174
175 Configuration is usually done using C preprocessor defines; the
176 rationale behind that is to avoid dead code whenever possible.
177
178 There are two classes of configuration variables:
179
180 * Configuration _OPTIONS_:
181   These are selectable by the user and have names beginning with
182   "CONFIG_".
183
184 * Configuration _SETTINGS_:
185   These depend on the hardware etc. and should not be meddled with if
186   you don't know what you're doing; they have names beginning with
187   "CONFIG_SYS_".
188
189 Previously, all configuration was done by hand, which involved creating
190 symbolic links and editing configuration files manually. More recently,
191 U-Boot has added the Kbuild infrastructure used by the Linux kernel,
192 allowing you to use the "make menuconfig" command to configure your
193 build.
194
195
196 Selection of Processor Architecture and Board Type:
197 ---------------------------------------------------
198
199 For all supported boards there are ready-to-use default
200 configurations available; just type "make <board_name>_defconfig".
201
202 Example: For a TQM823L module type:
203
204         cd u-boot
205         make TQM823L_defconfig
206
207 Note: If you're looking for the default configuration file for a board
208 you're sure used to be there but is now missing, check the file
209 doc/README.scrapyard for a list of no longer supported boards.
210
211 Sandbox Environment:
212 --------------------
213
214 U-Boot can be built natively to run on a Linux host using the 'sandbox'
215 board. This allows feature development which is not board- or architecture-
216 specific to be undertaken on a native platform. The sandbox is also used to
217 run some of U-Boot's tests.
218
219 See board/sandbox/README.sandbox for more details.
220
221
222 Board Initialisation Flow:
223 --------------------------
224
225 This is the intended start-up flow for boards. This should apply for both
226 SPL and U-Boot proper (i.e. they both follow the same rules).
227
228 Note: "SPL" stands for "Secondary Program Loader," which is explained in
229 more detail later in this file.
230
231 At present, SPL mostly uses a separate code path, but the function names
232 and roles of each function are the same. Some boards or architectures
233 may not conform to this.  At least most ARM boards which use
234 CONFIG_SPL_FRAMEWORK conform to this.
235
236 Execution typically starts with an architecture-specific (and possibly
237 CPU-specific) start.S file, such as:
238
239         - arch/arm/cpu/armv7/start.S
240         - arch/powerpc/cpu/mpc83xx/start.S
241         - arch/mips/cpu/start.S
242
243 and so on. From there, three functions are called; the purpose and
244 limitations of each of these functions are described below.
245
246 lowlevel_init():
247         - purpose: essential init to permit execution to reach board_init_f()
248         - no global_data or BSS
249         - there is no stack (ARMv7 may have one but it will soon be removed)
250         - must not set up SDRAM or use console
251         - must only do the bare minimum to allow execution to continue to
252                 board_init_f()
253         - this is almost never needed
254         - return normally from this function
255
256 board_init_f():
257         - purpose: set up the machine ready for running board_init_r():
258                 i.e. SDRAM and serial UART
259         - global_data is available
260         - stack is in SRAM
261         - BSS is not available, so you cannot use global/static variables,
262                 only stack variables and global_data
263
264         Non-SPL-specific notes:
265         - dram_init() is called to set up DRAM. If already done in SPL this
266                 can do nothing
267
268         SPL-specific notes:
269         - you can override the entire board_init_f() function with your own
270                 version as needed.
271         - preloader_console_init() can be called here in extremis
272         - should set up SDRAM, and anything needed to make the UART work
273         - these is no need to clear BSS, it will be done by crt0.S
274         - must return normally from this function (don't call board_init_r()
275                 directly)
276
277 Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
278 this point the stack and global_data are relocated to below
279 CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
280 memory.
281
282 board_init_r():
283         - purpose: main execution, common code
284         - global_data is available
285         - SDRAM is available
286         - BSS is available, all static/global variables can be used
287         - execution eventually continues to main_loop()
288
289         Non-SPL-specific notes:
290         - U-Boot is relocated to the top of memory and is now running from
291                 there.
292
293         SPL-specific notes:
294         - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
295                 CONFIG_SPL_STACK_R_ADDR points into SDRAM
296         - preloader_console_init() can be called here - typically this is
297                 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
298                 spl_board_init() function containing this call
299         - loads U-Boot or (in falcon mode) Linux
300
301
302
303 Configuration Options:
304 ----------------------
305
306 Configuration depends on the combination of board and CPU type; all
307 such information is kept in a configuration file
308 "include/configs/<board_name>.h".
309
310 Example: For a TQM823L module, all configuration settings are in
311 "include/configs/TQM823L.h".
312
313
314 Many of the options are named exactly as the corresponding Linux
315 kernel configuration options. The intention is to make it easier to
316 build a config tool - later.
317
318
319 The following options need to be configured:
320
321 - CPU Type:     Define exactly one, e.g. CONFIG_MPC85XX.
322
323 - Board Type:   Define exactly one, e.g. CONFIG_MPC8540ADS.
324
325 - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
326                 Define exactly one, e.g. CONFIG_ATSTK1002
327
328 - Marvell Family Member
329                 CONFIG_SYS_MVFS         - define it if you want to enable
330                                           multiple fs option at one time
331                                           for marvell soc family
332
333 - 8xx CPU Options: (if using an MPC8xx CPU)
334                 CONFIG_8xx_GCLK_FREQ    - deprecated: CPU clock if
335                                           get_gclk_freq() cannot work
336                                           e.g. if there is no 32KHz
337                                           reference PIT/RTC clock
338                 CONFIG_8xx_OSCLK        - PLL input clock (either EXTCLK
339                                           or XTAL/EXTAL)
340
341 - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
342                 CONFIG_SYS_8xx_CPUCLK_MIN
343                 CONFIG_SYS_8xx_CPUCLK_MAX
344                 CONFIG_8xx_CPUCLK_DEFAULT
345                         See doc/README.MPC866
346
347                 CONFIG_SYS_MEASURE_CPUCLK
348
349                 Define this to measure the actual CPU clock instead
350                 of relying on the correctness of the configured
351                 values. Mostly useful for board bringup to make sure
352                 the PLL is locked at the intended frequency. Note
353                 that this requires a (stable) reference clock (32 kHz
354                 RTC clock or CONFIG_SYS_8XX_XIN)
355
356                 CONFIG_SYS_DELAYED_ICACHE
357
358                 Define this option if you want to enable the
359                 ICache only when Code runs from RAM.
360
361 - 85xx CPU Options:
362                 CONFIG_SYS_PPC64
363
364                 Specifies that the core is a 64-bit PowerPC implementation (implements
365                 the "64" category of the Power ISA). This is necessary for ePAPR
366                 compliance, among other possible reasons.
367
368                 CONFIG_SYS_FSL_TBCLK_DIV
369
370                 Defines the core time base clock divider ratio compared to the
371                 system clock.  On most PQ3 devices this is 8, on newer QorIQ
372                 devices it can be 16 or 32.  The ratio varies from SoC to Soc.
373
374                 CONFIG_SYS_FSL_PCIE_COMPAT
375
376                 Defines the string to utilize when trying to match PCIe device
377                 tree nodes for the given platform.
378
379                 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381                 Enables a temporary TLB entry to be used during boot to work
382                 around limitations in e500v1 and e500v2 external debugger
383                 support. This reduces the portions of the boot code where
384                 breakpoints and single stepping do not work.  The value of this
385                 symbol should be set to the TLB1 entry to be used for this
386                 purpose.
387
388                 CONFIG_SYS_FSL_ERRATUM_A004510
389
390                 Enables a workaround for erratum A004510.  If set,
391                 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392                 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395                 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397                 Defines one or two SoC revisions (low 8 bits of SVR)
398                 for which the A004510 workaround should be applied.
399
400                 The rest of SVR is either not relevant to the decision
401                 of whether the erratum is present (e.g. p2040 versus
402                 p2041) or is implied by the build target, which controls
403                 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405                 See Freescale App Note 4493 for more information about
406                 this erratum.
407
408                 CONFIG_A003399_NOR_WORKAROUND
409                 Enables a workaround for IFC erratum A003399. It is only
410                 required during NOR boot.
411
412                 CONFIG_A008044_WORKAROUND
413                 Enables a workaround for T1040/T1042 erratum A008044. It is only
414                 required during NAND boot and valid for Rev 1.0 SoC revision
415
416                 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
417
418                 This is the value to write into CCSR offset 0x18600
419                 according to the A004510 workaround.
420
421                 CONFIG_SYS_FSL_DSP_DDR_ADDR
422                 This value denotes start offset of DDR memory which is
423                 connected exclusively to the DSP cores.
424
425                 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426                 This value denotes start offset of M2 memory
427                 which is directly connected to the DSP core.
428
429                 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
430                 This value denotes start offset of M3 memory which is directly
431                 connected to the DSP core.
432
433                 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
434                 This value denotes start offset of DSP CCSR space.
435
436                 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
437                 Single Source Clock is clocking mode present in some of FSL SoC's.
438                 In this mode, a single differential clock is used to supply
439                 clocks to the sysclock, ddrclock and usbclock.
440
441                 CONFIG_SYS_CPC_REINIT_F
442                 This CONFIG is defined when the CPC is configured as SRAM at the
443                 time of U-Boot entry and is required to be re-initialized.
444
445                 CONFIG_DEEP_SLEEP
446                 Indicates this SoC supports deep sleep feature. If deep sleep is
447                 supported, core will start to execute uboot when wakes up.
448
449 - Generic CPU options:
450                 CONFIG_SYS_GENERIC_GLOBAL_DATA
451                 Defines global data is initialized in generic board board_init_f().
452                 If this macro is defined, global data is created and cleared in
453                 generic board board_init_f(). Without this macro, architecture/board
454                 should initialize global data before calling board_init_f().
455
456                 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
457
458                 Defines the endianess of the CPU. Implementation of those
459                 values is arch specific.
460
461                 CONFIG_SYS_FSL_DDR
462                 Freescale DDR driver in use. This type of DDR controller is
463                 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
464                 SoCs.
465
466                 CONFIG_SYS_FSL_DDR_ADDR
467                 Freescale DDR memory-mapped register base.
468
469                 CONFIG_SYS_FSL_DDR_EMU
470                 Specify emulator support for DDR. Some DDR features such as
471                 deskew training are not available.
472
473                 CONFIG_SYS_FSL_DDRC_GEN1
474                 Freescale DDR1 controller.
475
476                 CONFIG_SYS_FSL_DDRC_GEN2
477                 Freescale DDR2 controller.
478
479                 CONFIG_SYS_FSL_DDRC_GEN3
480                 Freescale DDR3 controller.
481
482                 CONFIG_SYS_FSL_DDRC_GEN4
483                 Freescale DDR4 controller.
484
485                 CONFIG_SYS_FSL_DDRC_ARM_GEN3
486                 Freescale DDR3 controller for ARM-based SoCs.
487
488                 CONFIG_SYS_FSL_DDR1
489                 Board config to use DDR1. It can be enabled for SoCs with
490                 Freescale DDR1 or DDR2 controllers, depending on the board
491                 implemetation.
492
493                 CONFIG_SYS_FSL_DDR2
494                 Board config to use DDR2. It can be enabled for SoCs with
495                 Freescale DDR2 or DDR3 controllers, depending on the board
496                 implementation.
497
498                 CONFIG_SYS_FSL_DDR3
499                 Board config to use DDR3. It can be enabled for SoCs with
500                 Freescale DDR3 or DDR3L controllers.
501
502                 CONFIG_SYS_FSL_DDR3L
503                 Board config to use DDR3L. It can be enabled for SoCs with
504                 DDR3L controllers.
505
506                 CONFIG_SYS_FSL_DDR4
507                 Board config to use DDR4. It can be enabled for SoCs with
508                 DDR4 controllers.
509
510                 CONFIG_SYS_FSL_IFC_BE
511                 Defines the IFC controller register space as Big Endian
512
513                 CONFIG_SYS_FSL_IFC_LE
514                 Defines the IFC controller register space as Little Endian
515
516                 CONFIG_SYS_FSL_PBL_PBI
517                 It enables addition of RCW (Power on reset configuration) in built image.
518                 Please refer doc/README.pblimage for more details
519
520                 CONFIG_SYS_FSL_PBL_RCW
521                 It adds PBI(pre-boot instructions) commands in u-boot build image.
522                 PBI commands can be used to configure SoC before it starts the execution.
523                 Please refer doc/README.pblimage for more details
524
525                 CONFIG_SPL_FSL_PBL
526                 It adds a target to create boot binary having SPL binary in PBI format
527                 concatenated with u-boot binary.
528
529                 CONFIG_SYS_FSL_DDR_BE
530                 Defines the DDR controller register space as Big Endian
531
532                 CONFIG_SYS_FSL_DDR_LE
533                 Defines the DDR controller register space as Little Endian
534
535                 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
536                 Physical address from the view of DDR controllers. It is the
537                 same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
538                 it could be different for ARM SoCs.
539
540                 CONFIG_SYS_FSL_DDR_INTLV_256B
541                 DDR controller interleaving on 256-byte. This is a special
542                 interleaving mode, handled by Dickens for Freescale layerscape
543                 SoCs with ARM core.
544
545                 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
546                 Number of controllers used as main memory.
547
548                 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
549                 Number of controllers used for other than main memory.
550
551                 CONFIG_SYS_FSL_HAS_DP_DDR
552                 Defines the SoC has DP-DDR used for DPAA.
553
554                 CONFIG_SYS_FSL_SEC_BE
555                 Defines the SEC controller register space as Big Endian
556
557                 CONFIG_SYS_FSL_SEC_LE
558                 Defines the SEC controller register space as Little Endian
559
560 - MIPS CPU options:
561                 CONFIG_SYS_INIT_SP_OFFSET
562
563                 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
564                 pointer. This is needed for the temporary stack before
565                 relocation.
566
567                 CONFIG_SYS_MIPS_CACHE_MODE
568
569                 Cache operation mode for the MIPS CPU.
570                 See also arch/mips/include/asm/mipsregs.h.
571                 Possible values are:
572                         CONF_CM_CACHABLE_NO_WA
573                         CONF_CM_CACHABLE_WA
574                         CONF_CM_UNCACHED
575                         CONF_CM_CACHABLE_NONCOHERENT
576                         CONF_CM_CACHABLE_CE
577                         CONF_CM_CACHABLE_COW
578                         CONF_CM_CACHABLE_CUW
579                         CONF_CM_CACHABLE_ACCELERATED
580
581                 CONFIG_SYS_XWAY_EBU_BOOTCFG
582
583                 Special option for Lantiq XWAY SoCs for booting from NOR flash.
584                 See also arch/mips/cpu/mips32/start.S.
585
586                 CONFIG_XWAY_SWAP_BYTES
587
588                 Enable compilation of tools/xway-swap-bytes needed for Lantiq
589                 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
590                 be swapped if a flash programmer is used.
591
592 - ARM options:
593                 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
594
595                 Select high exception vectors of the ARM core, e.g., do not
596                 clear the V bit of the c1 register of CP15.
597
598                 CONFIG_SYS_THUMB_BUILD
599
600                 Use this flag to build U-Boot using the Thumb instruction
601                 set for ARM architectures. Thumb instruction set provides
602                 better code density. For ARM architectures that support
603                 Thumb2 this flag will result in Thumb2 code generated by
604                 GCC.
605
606                 CONFIG_ARM_ERRATA_716044
607                 CONFIG_ARM_ERRATA_742230
608                 CONFIG_ARM_ERRATA_743622
609                 CONFIG_ARM_ERRATA_751472
610                 CONFIG_ARM_ERRATA_761320
611                 CONFIG_ARM_ERRATA_773022
612                 CONFIG_ARM_ERRATA_774769
613                 CONFIG_ARM_ERRATA_794072
614
615                 If set, the workarounds for these ARM errata are applied early
616                 during U-Boot startup. Note that these options force the
617                 workarounds to be applied; no CPU-type/version detection
618                 exists, unlike the similar options in the Linux kernel. Do not
619                 set these options unless they apply!
620
621                 COUNTER_FREQUENCY
622                 Generic timer clock source frequency.
623
624                 COUNTER_FREQUENCY_REAL
625                 Generic timer clock source frequency if the real clock is
626                 different from COUNTER_FREQUENCY, and can only be determined
627                 at run time.
628
629                 NOTE: The following can be machine specific errata. These
630                 do have ability to provide rudimentary version and machine
631                 specific checks, but expect no product checks.
632                 CONFIG_ARM_ERRATA_430973
633                 CONFIG_ARM_ERRATA_454179
634                 CONFIG_ARM_ERRATA_621766
635                 CONFIG_ARM_ERRATA_798870
636                 CONFIG_ARM_ERRATA_801819
637
638 - Tegra SoC options:
639                 CONFIG_TEGRA_SUPPORT_NON_SECURE
640
641                 Support executing U-Boot in non-secure (NS) mode. Certain
642                 impossible actions will be skipped if the CPU is in NS mode,
643                 such as ARM architectural timer initialization.
644
645 - Linux Kernel Interface:
646                 CONFIG_CLOCKS_IN_MHZ
647
648                 U-Boot stores all clock information in Hz
649                 internally. For binary compatibility with older Linux
650                 kernels (which expect the clocks passed in the
651                 bd_info data to be in MHz) the environment variable
652                 "clocks_in_mhz" can be defined so that U-Boot
653                 converts clock data to MHZ before passing it to the
654                 Linux kernel.
655                 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
656                 "clocks_in_mhz=1" is automatically included in the
657                 default environment.
658
659                 CONFIG_MEMSIZE_IN_BYTES         [relevant for MIPS only]
660
661                 When transferring memsize parameter to Linux, some versions
662                 expect it to be in bytes, others in MB.
663                 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
664
665                 CONFIG_OF_LIBFDT
666
667                 New kernel versions are expecting firmware settings to be
668                 passed using flattened device trees (based on open firmware
669                 concepts).
670
671                 CONFIG_OF_LIBFDT
672                  * New libfdt-based support
673                  * Adds the "fdt" command
674                  * The bootm command automatically updates the fdt
675
676                 OF_CPU - The proper name of the cpus node (only required for
677                         MPC512X and MPC5xxx based boards).
678                 OF_SOC - The proper name of the soc node (only required for
679                         MPC512X and MPC5xxx based boards).
680                 OF_TBCLK - The timebase frequency.
681                 OF_STDOUT_PATH - The path to the console device
682
683                 boards with QUICC Engines require OF_QE to set UCC MAC
684                 addresses
685
686                 CONFIG_OF_BOARD_SETUP
687
688                 Board code has addition modification that it wants to make
689                 to the flat device tree before handing it off to the kernel
690
691                 CONFIG_OF_SYSTEM_SETUP
692
693                 Other code has addition modification that it wants to make
694                 to the flat device tree before handing it off to the kernel.
695                 This causes ft_system_setup() to be called before booting
696                 the kernel.
697
698                 CONFIG_OF_IDE_FIXUP
699
700                 U-Boot can detect if an IDE device is present or not.
701                 If not, and this new config option is activated, U-Boot
702                 removes the ATA node from the DTS before booting Linux,
703                 so the Linux IDE driver does not probe the device and
704                 crash. This is needed for buggy hardware (uc101) where
705                 no pull down resistor is connected to the signal IDE5V_DD7.
706
707                 CONFIG_MACH_TYPE        [relevant for ARM only][mandatory]
708
709                 This setting is mandatory for all boards that have only one
710                 machine type and must be used to specify the machine type
711                 number as it appears in the ARM machine registry
712                 (see http://www.arm.linux.org.uk/developer/machines/).
713                 Only boards that have multiple machine types supported
714                 in a single configuration file and the machine type is
715                 runtime discoverable, do not have to use this setting.
716
717 - vxWorks boot parameters:
718
719                 bootvx constructs a valid bootline using the following
720                 environments variables: bootdev, bootfile, ipaddr, netmask,
721                 serverip, gatewayip, hostname, othbootargs.
722                 It loads the vxWorks image pointed bootfile.
723
724                 Note: If a "bootargs" environment is defined, it will overwride
725                 the defaults discussed just above.
726
727 - Cache Configuration:
728                 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
729                 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
730                 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
731
732 - Cache Configuration for ARM:
733                 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
734                                       controller
735                 CONFIG_SYS_PL310_BASE - Physical base address of PL310
736                                         controller register space
737
738 - Serial Ports:
739                 CONFIG_PL010_SERIAL
740
741                 Define this if you want support for Amba PrimeCell PL010 UARTs.
742
743                 CONFIG_PL011_SERIAL
744
745                 Define this if you want support for Amba PrimeCell PL011 UARTs.
746
747                 CONFIG_PL011_CLOCK
748
749                 If you have Amba PrimeCell PL011 UARTs, set this variable to
750                 the clock speed of the UARTs.
751
752                 CONFIG_PL01x_PORTS
753
754                 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
755                 define this to a list of base addresses for each (supported)
756                 port. See e.g. include/configs/versatile.h
757
758                 CONFIG_SERIAL_HW_FLOW_CONTROL
759
760                 Define this variable to enable hw flow control in serial driver.
761                 Current user of this option is drivers/serial/nsl16550.c driver
762
763 - Console Interface:
764                 Depending on board, define exactly one serial port
765                 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
766                 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
767                 console by defining CONFIG_8xx_CONS_NONE
768
769                 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
770                 port routines must be defined elsewhere
771                 (i.e. serial_init(), serial_getc(), ...)
772
773                 CONFIG_CFB_CONSOLE
774                 Enables console device for a color framebuffer. Needs following
775                 defines (cf. smiLynxEM, i8042)
776                         VIDEO_FB_LITTLE_ENDIAN  graphic memory organisation
777                                                 (default big endian)
778                         VIDEO_HW_RECTFILL       graphic chip supports
779                                                 rectangle fill
780                                                 (cf. smiLynxEM)
781                         VIDEO_HW_BITBLT         graphic chip supports
782                                                 bit-blit (cf. smiLynxEM)
783                         VIDEO_VISIBLE_COLS      visible pixel columns
784                                                 (cols=pitch)
785                         VIDEO_VISIBLE_ROWS      visible pixel rows
786                         VIDEO_PIXEL_SIZE        bytes per pixel
787                         VIDEO_DATA_FORMAT       graphic data format
788                                                 (0-5, cf. cfb_console.c)
789                         VIDEO_FB_ADRS           framebuffer address
790                         VIDEO_KBD_INIT_FCT      keyboard int fct
791                                                 (i.e. rx51_kp_init())
792                         VIDEO_TSTC_FCT          test char fct
793                                                 (i.e. rx51_kp_tstc)
794                         VIDEO_GETC_FCT          get char fct
795                                                 (i.e. rx51_kp_getc)
796                         CONFIG_VIDEO_LOGO       display Linux logo in
797                                                 upper left corner
798                         CONFIG_VIDEO_BMP_LOGO   use bmp_logo.h instead of
799                                                 linux_logo.h for logo.
800                                                 Requires CONFIG_VIDEO_LOGO
801                         CONFIG_CONSOLE_EXTRA_INFO
802                                                 additional board info beside
803                                                 the logo
804                         CONFIG_HIDE_LOGO_VERSION
805                                                 do not display bootloader
806                                                 version string
807
808                 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
809                 a limited number of ANSI escape sequences (cursor control,
810                 erase functions and limited graphics rendition control).
811
812                 When CONFIG_CFB_CONSOLE is defined, video console is
813                 default i/o. Serial console can be forced with
814                 environment 'console=serial'.
815
816                 When CONFIG_SILENT_CONSOLE is defined, all console
817                 messages (by U-Boot and Linux!) can be silenced with
818                 the "silent" environment variable. See
819                 doc/README.silent for more information.
820
821                 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
822                         is 0x00.
823                 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
824                         is 0xa0.
825
826 - Console Baudrate:
827                 CONFIG_BAUDRATE - in bps
828                 Select one of the baudrates listed in
829                 CONFIG_SYS_BAUDRATE_TABLE, see below.
830                 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
831
832 - Console Rx buffer length
833                 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
834                 the maximum receive buffer length for the SMC.
835                 This option is actual only for 82xx and 8xx possible.
836                 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
837                 must be defined, to setup the maximum idle timeout for
838                 the SMC.
839
840 - Pre-Console Buffer:
841                 Prior to the console being initialised (i.e. serial UART
842                 initialised etc) all console output is silently discarded.
843                 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
844                 buffer any console messages prior to the console being
845                 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
846                 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
847                 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
848                 bytes are output before the console is initialised, the
849                 earlier bytes are discarded.
850
851                 Note that when printing the buffer a copy is made on the
852                 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
853
854                 'Sane' compilers will generate smaller code if
855                 CONFIG_PRE_CON_BUF_SZ is a power of 2
856
857 - Autoboot Command:
858                 CONFIG_BOOTCOMMAND
859                 Only needed when CONFIG_BOOTDELAY is enabled;
860                 define a command string that is automatically executed
861                 when no character is read on the console interface
862                 within "Boot Delay" after reset.
863
864                 CONFIG_BOOTARGS
865                 This can be used to pass arguments to the bootm
866                 command. The value of CONFIG_BOOTARGS goes into the
867                 environment value "bootargs".
868
869                 CONFIG_RAMBOOT and CONFIG_NFSBOOT
870                 The value of these goes into the environment as
871                 "ramboot" and "nfsboot" respectively, and can be used
872                 as a convenience, when switching between booting from
873                 RAM and NFS.
874
875 - Bootcount:
876                 CONFIG_BOOTCOUNT_LIMIT
877                 Implements a mechanism for detecting a repeating reboot
878                 cycle, see:
879                 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
880
881                 CONFIG_BOOTCOUNT_ENV
882                 If no softreset save registers are found on the hardware
883                 "bootcount" is stored in the environment. To prevent a
884                 saveenv on all reboots, the environment variable
885                 "upgrade_available" is used. If "upgrade_available" is
886                 0, "bootcount" is always 0, if "upgrade_available" is
887                 1 "bootcount" is incremented in the environment.
888                 So the Userspace Applikation must set the "upgrade_available"
889                 and "bootcount" variable to 0, if a boot was successfully.
890
891 - Pre-Boot Commands:
892                 CONFIG_PREBOOT
893
894                 When this option is #defined, the existence of the
895                 environment variable "preboot" will be checked
896                 immediately before starting the CONFIG_BOOTDELAY
897                 countdown and/or running the auto-boot command resp.
898                 entering interactive mode.
899
900                 This feature is especially useful when "preboot" is
901                 automatically generated or modified. For an example
902                 see the LWMON board specific code: here "preboot" is
903                 modified when the user holds down a certain
904                 combination of keys on the (special) keyboard when
905                 booting the systems
906
907 - Serial Download Echo Mode:
908                 CONFIG_LOADS_ECHO
909                 If defined to 1, all characters received during a
910                 serial download (using the "loads" command) are
911                 echoed back. This might be needed by some terminal
912                 emulations (like "cu"), but may as well just take
913                 time on others. This setting #define's the initial
914                 value of the "loads_echo" environment variable.
915
916 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
917                 CONFIG_KGDB_BAUDRATE
918                 Select one of the baudrates listed in
919                 CONFIG_SYS_BAUDRATE_TABLE, see below.
920
921 - Monitor Functions:
922                 Monitor commands can be included or excluded
923                 from the build by using the #include files
924                 <config_cmd_all.h> and #undef'ing unwanted
925                 commands, or adding #define's for wanted commands.
926
927                 The default command configuration includes all commands
928                 except those marked below with a "*".
929
930                 CONFIG_CMD_AES            AES 128 CBC encrypt/decrypt
931                 CONFIG_CMD_ASKENV       * ask for env variable
932                 CONFIG_CMD_BDI            bdinfo
933                 CONFIG_CMD_BEDBUG       * Include BedBug Debugger
934                 CONFIG_CMD_BMP          * BMP support
935                 CONFIG_CMD_BSP          * Board specific commands
936                 CONFIG_CMD_BOOTD          bootd
937                 CONFIG_CMD_BOOTI        * ARM64 Linux kernel Image support
938                 CONFIG_CMD_CACHE        * icache, dcache
939                 CONFIG_CMD_CLK          * clock command support
940                 CONFIG_CMD_CONSOLE        coninfo
941                 CONFIG_CMD_CRC32        * crc32
942                 CONFIG_CMD_DATE         * support for RTC, date/time...
943                 CONFIG_CMD_DHCP         * DHCP support
944                 CONFIG_CMD_DIAG         * Diagnostics
945                 CONFIG_CMD_DS4510       * ds4510 I2C gpio commands
946                 CONFIG_CMD_DS4510_INFO  * ds4510 I2C info command
947                 CONFIG_CMD_DS4510_MEM   * ds4510 I2C eeprom/sram commansd
948                 CONFIG_CMD_DS4510_RST   * ds4510 I2C rst command
949                 CONFIG_CMD_DTT          * Digital Therm and Thermostat
950                 CONFIG_CMD_ECHO           echo arguments
951                 CONFIG_CMD_EDITENV        edit env variable
952                 CONFIG_CMD_EEPROM       * EEPROM read/write support
953                 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
954                 CONFIG_CMD_ELF          * bootelf, bootvx
955                 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
956                 CONFIG_CMD_ENV_FLAGS    * display details about env flags
957                 CONFIG_CMD_ENV_EXISTS   * check existence of env variable
958                 CONFIG_CMD_EXPORTENV    * export the environment
959                 CONFIG_CMD_EXT2         * ext2 command support
960                 CONFIG_CMD_EXT4         * ext4 command support
961                 CONFIG_CMD_FS_GENERIC   * filesystem commands (e.g. load, ls)
962                                           that work for multiple fs types
963                 CONFIG_CMD_FS_UUID      * Look up a filesystem UUID
964                 CONFIG_CMD_SAVEENV        saveenv
965                 CONFIG_CMD_FDC          * Floppy Disk Support
966                 CONFIG_CMD_FAT          * FAT command support
967                 CONFIG_CMD_FLASH          flinfo, erase, protect
968                 CONFIG_CMD_FPGA           FPGA device initialization support
969                 CONFIG_CMD_FUSE         * Device fuse support
970                 CONFIG_CMD_GETTIME      * Get time since boot
971                 CONFIG_CMD_GO           * the 'go' command (exec code)
972                 CONFIG_CMD_GREPENV      * search environment
973                 CONFIG_CMD_HASH         * calculate hash / digest
974                 CONFIG_CMD_I2C          * I2C serial bus support
975                 CONFIG_CMD_IDE          * IDE harddisk support
976                 CONFIG_CMD_IMI            iminfo
977                 CONFIG_CMD_IMLS           List all images found in NOR flash
978                 CONFIG_CMD_IMLS_NAND    * List all images found in NAND flash
979                 CONFIG_CMD_IMMAP        * IMMR dump support
980                 CONFIG_CMD_IOTRACE      * I/O tracing for debugging
981                 CONFIG_CMD_IMPORTENV    * import an environment
982                 CONFIG_CMD_INI          * import data from an ini file into the env
983                 CONFIG_CMD_IRQ          * irqinfo
984                 CONFIG_CMD_ITEST          Integer/string test of 2 values
985                 CONFIG_CMD_JFFS2        * JFFS2 Support
986                 CONFIG_CMD_KGDB         * kgdb
987                 CONFIG_CMD_LDRINFO      * ldrinfo (display Blackfin loader)
988                 CONFIG_CMD_LINK_LOCAL   * link-local IP address auto-configuration
989                                           (169.254.*.*)
990                 CONFIG_CMD_LOADB          loadb
991                 CONFIG_CMD_LOADS          loads
992                 CONFIG_CMD_MD5SUM       * print md5 message digest
993                                           (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
994                 CONFIG_CMD_MEMINFO      * Display detailed memory information
995                 CONFIG_CMD_MEMORY         md, mm, nm, mw, cp, cmp, crc, base,
996                                           loop, loopw
997                 CONFIG_CMD_MEMTEST      * mtest
998                 CONFIG_CMD_MISC           Misc functions like sleep etc
999                 CONFIG_CMD_MMC          * MMC memory mapped support
1000                 CONFIG_CMD_MII          * MII utility commands
1001                 CONFIG_CMD_MTDPARTS     * MTD partition support
1002                 CONFIG_CMD_NAND         * NAND support
1003                 CONFIG_CMD_NET            bootp, tftpboot, rarpboot
1004                 CONFIG_CMD_NFS            NFS support
1005                 CONFIG_CMD_PCA953X      * PCA953x I2C gpio commands
1006                 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1007                 CONFIG_CMD_PCI          * pciinfo
1008                 CONFIG_CMD_PCMCIA               * PCMCIA support
1009                 CONFIG_CMD_PING         * send ICMP ECHO_REQUEST to network
1010                                           host
1011                 CONFIG_CMD_PORTIO       * Port I/O
1012                 CONFIG_CMD_READ         * Read raw data from partition
1013                 CONFIG_CMD_REGINFO      * Register dump
1014                 CONFIG_CMD_RUN            run command in env variable
1015                 CONFIG_CMD_SANDBOX      * sb command to access sandbox features
1016                 CONFIG_CMD_SAVES        * save S record dump
1017                 CONFIG_SCSI             * SCSI Support
1018                 CONFIG_CMD_SDRAM        * print SDRAM configuration information
1019                                           (requires CONFIG_CMD_I2C)
1020                 CONFIG_CMD_SETGETDCR      Support for DCR Register access
1021                                           (4xx only)
1022                 CONFIG_CMD_SF           * Read/write/erase SPI NOR flash
1023                 CONFIG_CMD_SHA1SUM      * print sha1 memory digest
1024                                           (requires CONFIG_CMD_MEMORY)
1025                 CONFIG_CMD_SOFTSWITCH   * Soft switch setting command for BF60x
1026                 CONFIG_CMD_SOURCE         "source" command Support
1027                 CONFIG_CMD_SPI          * SPI serial bus support
1028                 CONFIG_CMD_TFTPSRV      * TFTP transfer in server mode
1029                 CONFIG_CMD_TFTPPUT      * TFTP put command (upload)
1030                 CONFIG_CMD_TIME         * run command and report execution time (ARM specific)
1031                 CONFIG_CMD_TIMER        * access to the system tick timer
1032                 CONFIG_CMD_USB          * USB support
1033                 CONFIG_CMD_CDP          * Cisco Discover Protocol support
1034                 CONFIG_CMD_MFSL         * Microblaze FSL support
1035                 CONFIG_CMD_XIMG           Load part of Multi Image
1036                 CONFIG_CMD_UUID         * Generate random UUID or GUID string
1037
1038                 EXAMPLE: If you want all functions except of network
1039                 support you can write:
1040
1041                 #include "config_cmd_all.h"
1042                 #undef CONFIG_CMD_NET
1043
1044         Other Commands:
1045                 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1046
1047         Note:   Don't enable the "icache" and "dcache" commands
1048                 (configuration option CONFIG_CMD_CACHE) unless you know
1049                 what you (and your U-Boot users) are doing. Data
1050                 cache cannot be enabled on systems like the 8xx or
1051                 8260 (where accesses to the IMMR region must be
1052                 uncached), and it cannot be disabled on all other
1053                 systems where we (mis-) use the data cache to hold an
1054                 initial stack and some data.
1055
1056
1057                 XXX - this list needs to get updated!
1058
1059 - Removal of commands
1060                 If no commands are needed to boot, you can disable
1061                 CONFIG_CMDLINE to remove them. In this case, the command line
1062                 will not be available, and when U-Boot wants to execute the
1063                 boot command (on start-up) it will call board_run_command()
1064                 instead. This can reduce image size significantly for very
1065                 simple boot procedures.
1066
1067 - Regular expression support:
1068                 CONFIG_REGEX
1069                 If this variable is defined, U-Boot is linked against
1070                 the SLRE (Super Light Regular Expression) library,
1071                 which adds regex support to some commands, as for
1072                 example "env grep" and "setexpr".
1073
1074 - Device tree:
1075                 CONFIG_OF_CONTROL
1076                 If this variable is defined, U-Boot will use a device tree
1077                 to configure its devices, instead of relying on statically
1078                 compiled #defines in the board file. This option is
1079                 experimental and only available on a few boards. The device
1080                 tree is available in the global data as gd->fdt_blob.
1081
1082                 U-Boot needs to get its device tree from somewhere. This can
1083                 be done using one of the two options below:
1084
1085                 CONFIG_OF_EMBED
1086                 If this variable is defined, U-Boot will embed a device tree
1087                 binary in its image. This device tree file should be in the
1088                 board directory and called <soc>-<board>.dts. The binary file
1089                 is then picked up in board_init_f() and made available through
1090                 the global data structure as gd->blob.
1091
1092                 CONFIG_OF_SEPARATE
1093                 If this variable is defined, U-Boot will build a device tree
1094                 binary. It will be called u-boot.dtb. Architecture-specific
1095                 code will locate it at run-time. Generally this works by:
1096
1097                         cat u-boot.bin u-boot.dtb >image.bin
1098
1099                 and in fact, U-Boot does this for you, creating a file called
1100                 u-boot-dtb.bin which is useful in the common case. You can
1101                 still use the individual files if you need something more
1102                 exotic.
1103
1104 - Watchdog:
1105                 CONFIG_WATCHDOG
1106                 If this variable is defined, it enables watchdog
1107                 support for the SoC. There must be support in the SoC
1108                 specific code for a watchdog. For the 8xx and 8260
1109                 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1110                 register.  When supported for a specific SoC is
1111                 available, then no further board specific code should
1112                 be needed to use it.
1113
1114                 CONFIG_HW_WATCHDOG
1115                 When using a watchdog circuitry external to the used
1116                 SoC, then define this variable and provide board
1117                 specific code for the "hw_watchdog_reset" function.
1118
1119                 CONFIG_AT91_HW_WDT_TIMEOUT
1120                 specify the timeout in seconds. default 2 seconds.
1121
1122 - U-Boot Version:
1123                 CONFIG_VERSION_VARIABLE
1124                 If this variable is defined, an environment variable
1125                 named "ver" is created by U-Boot showing the U-Boot
1126                 version as printed by the "version" command.
1127                 Any change to this variable will be reverted at the
1128                 next reset.
1129
1130 - Real-Time Clock:
1131
1132                 When CONFIG_CMD_DATE is selected, the type of the RTC
1133                 has to be selected, too. Define exactly one of the
1134                 following options:
1135
1136                 CONFIG_RTC_MPC8xx       - use internal RTC of MPC8xx
1137                 CONFIG_RTC_PCF8563      - use Philips PCF8563 RTC
1138                 CONFIG_RTC_MC13XXX      - use MC13783 or MC13892 RTC
1139                 CONFIG_RTC_MC146818     - use MC146818 RTC
1140                 CONFIG_RTC_DS1307       - use Maxim, Inc. DS1307 RTC
1141                 CONFIG_RTC_DS1337       - use Maxim, Inc. DS1337 RTC
1142                 CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
1143                 CONFIG_RTC_DS1339       - use Maxim, Inc. DS1339 RTC
1144                 CONFIG_RTC_DS164x       - use Dallas DS164x RTC
1145                 CONFIG_RTC_ISL1208      - use Intersil ISL1208 RTC
1146                 CONFIG_RTC_MAX6900      - use Maxim, Inc. MAX6900 RTC
1147                 CONFIG_SYS_RTC_DS1337_NOOSC     - Turn off the OSC output for DS1337
1148                 CONFIG_SYS_RV3029_TCR   - enable trickle charger on
1149                                           RV3029 RTC.
1150
1151                 Note that if the RTC uses I2C, then the I2C interface
1152                 must also be configured. See I2C Support, below.
1153
1154 - GPIO Support:
1155                 CONFIG_PCA953X          - use NXP's PCA953X series I2C GPIO
1156
1157                 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1158                 chip-ngpio pairs that tell the PCA953X driver the number of
1159                 pins supported by a particular chip.
1160
1161                 Note that if the GPIO device uses I2C, then the I2C interface
1162                 must also be configured. See I2C Support, below.
1163
1164 - I/O tracing:
1165                 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1166                 accesses and can checksum them or write a list of them out
1167                 to memory. See the 'iotrace' command for details. This is
1168                 useful for testing device drivers since it can confirm that
1169                 the driver behaves the same way before and after a code
1170                 change. Currently this is supported on sandbox and arm. To
1171                 add support for your architecture, add '#include <iotrace.h>'
1172                 to the bottom of arch/<arch>/include/asm/io.h and test.
1173
1174                 Example output from the 'iotrace stats' command is below.
1175                 Note that if the trace buffer is exhausted, the checksum will
1176                 still continue to operate.
1177
1178                         iotrace is enabled
1179                         Start:  10000000        (buffer start address)
1180                         Size:   00010000        (buffer size)
1181                         Offset: 00000120        (current buffer offset)
1182                         Output: 10000120        (start + offset)
1183                         Count:  00000018        (number of trace records)
1184                         CRC32:  9526fb66        (CRC32 of all trace records)
1185
1186 - Timestamp Support:
1187
1188                 When CONFIG_TIMESTAMP is selected, the timestamp
1189                 (date and time) of an image is printed by image
1190                 commands like bootm or iminfo. This option is
1191                 automatically enabled when you select CONFIG_CMD_DATE .
1192
1193 - Partition Labels (disklabels) Supported:
1194                 Zero or more of the following:
1195                 CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1196                 CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1197                                        Intel architecture, USB sticks, etc.
1198                 CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1199                 CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1200                                        bootloader.  Note 2TB partition limit; see
1201                                        disk/part_efi.c
1202                 CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1203
1204                 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1205                 CONFIG_SCSI) you must configure support for at
1206                 least one non-MTD partition type as well.
1207
1208 - IDE Reset method:
1209                 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1210                 board configurations files but used nowhere!
1211
1212                 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1213                 be performed by calling the function
1214                         ide_set_reset(int reset)
1215                 which has to be defined in a board specific file
1216
1217 - ATAPI Support:
1218                 CONFIG_ATAPI
1219
1220                 Set this to enable ATAPI support.
1221
1222 - LBA48 Support
1223                 CONFIG_LBA48
1224
1225                 Set this to enable support for disks larger than 137GB
1226                 Also look at CONFIG_SYS_64BIT_LBA.
1227                 Whithout these , LBA48 support uses 32bit variables and will 'only'
1228                 support disks up to 2.1TB.
1229
1230                 CONFIG_SYS_64BIT_LBA:
1231                         When enabled, makes the IDE subsystem use 64bit sector addresses.
1232                         Default is 32bit.
1233
1234 - SCSI Support:
1235                 At the moment only there is only support for the
1236                 SYM53C8XX SCSI controller; define
1237                 CONFIG_SCSI_SYM53C8XX to enable it.
1238
1239                 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1240                 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1241                 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1242                 maximum numbers of LUNs, SCSI ID's and target
1243                 devices.
1244                 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1245
1246                 The environment variable 'scsidevs' is set to the number of
1247                 SCSI devices found during the last scan.
1248
1249 - NETWORK Support (PCI):
1250                 CONFIG_E1000
1251                 Support for Intel 8254x/8257x gigabit chips.
1252
1253                 CONFIG_E1000_SPI
1254                 Utility code for direct access to the SPI bus on Intel 8257x.
1255                 This does not do anything useful unless you set at least one
1256                 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1257
1258                 CONFIG_E1000_SPI_GENERIC
1259                 Allow generic access to the SPI bus on the Intel 8257x, for
1260                 example with the "sspi" command.
1261
1262                 CONFIG_CMD_E1000
1263                 Management command for E1000 devices.  When used on devices
1264                 with SPI support you can reprogram the EEPROM from U-Boot.
1265
1266                 CONFIG_EEPRO100
1267                 Support for Intel 82557/82559/82559ER chips.
1268                 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1269                 write routine for first time initialisation.
1270
1271                 CONFIG_TULIP
1272                 Support for Digital 2114x chips.
1273                 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1274                 modem chip initialisation (KS8761/QS6611).
1275
1276                 CONFIG_NATSEMI
1277                 Support for National dp83815 chips.
1278
1279                 CONFIG_NS8382X
1280                 Support for National dp8382[01] gigabit chips.
1281
1282 - NETWORK Support (other):
1283
1284                 CONFIG_DRIVER_AT91EMAC
1285                 Support for AT91RM9200 EMAC.
1286
1287                         CONFIG_RMII
1288                         Define this to use reduced MII inteface
1289
1290                         CONFIG_DRIVER_AT91EMAC_QUIET
1291                         If this defined, the driver is quiet.
1292                         The driver doen't show link status messages.
1293
1294                 CONFIG_CALXEDA_XGMAC
1295                 Support for the Calxeda XGMAC device
1296
1297                 CONFIG_LAN91C96
1298                 Support for SMSC's LAN91C96 chips.
1299
1300                         CONFIG_LAN91C96_USE_32_BIT
1301                         Define this to enable 32 bit addressing
1302
1303                 CONFIG_SMC91111
1304                 Support for SMSC's LAN91C111 chip
1305
1306                         CONFIG_SMC91111_BASE
1307                         Define this to hold the physical address
1308                         of the device (I/O space)
1309
1310                         CONFIG_SMC_USE_32_BIT
1311                         Define this if data bus is 32 bits
1312
1313                         CONFIG_SMC_USE_IOFUNCS
1314                         Define this to use i/o functions instead of macros
1315                         (some hardware wont work with macros)
1316
1317                 CONFIG_DRIVER_TI_EMAC
1318                 Support for davinci emac
1319
1320                         CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1321                         Define this if you have more then 3 PHYs.
1322
1323                 CONFIG_FTGMAC100
1324                 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1325
1326                         CONFIG_FTGMAC100_EGIGA
1327                         Define this to use GE link update with gigabit PHY.
1328                         Define this if FTGMAC100 is connected to gigabit PHY.
1329                         If your system has 10/100 PHY only, it might not occur
1330                         wrong behavior. Because PHY usually return timeout or
1331                         useless data when polling gigabit status and gigabit
1332                         control registers. This behavior won't affect the
1333                         correctnessof 10/100 link speed update.
1334
1335                 CONFIG_SMC911X
1336                 Support for SMSC's LAN911x and LAN921x chips
1337
1338                         CONFIG_SMC911X_BASE
1339                         Define this to hold the physical address
1340                         of the device (I/O space)
1341
1342                         CONFIG_SMC911X_32_BIT
1343                         Define this if data bus is 32 bits
1344
1345                         CONFIG_SMC911X_16_BIT
1346                         Define this if data bus is 16 bits. If your processor
1347                         automatically converts one 32 bit word to two 16 bit
1348                         words you may also try CONFIG_SMC911X_32_BIT.
1349
1350                 CONFIG_SH_ETHER
1351                 Support for Renesas on-chip Ethernet controller
1352
1353                         CONFIG_SH_ETHER_USE_PORT
1354                         Define the number of ports to be used
1355
1356                         CONFIG_SH_ETHER_PHY_ADDR
1357                         Define the ETH PHY's address
1358
1359                         CONFIG_SH_ETHER_CACHE_WRITEBACK
1360                         If this option is set, the driver enables cache flush.
1361
1362 - PWM Support:
1363                 CONFIG_PWM_IMX
1364                 Support for PWM modul on the imx6.
1365
1366 - TPM Support:
1367                 CONFIG_TPM
1368                 Support TPM devices.
1369
1370                 CONFIG_TPM_TIS_INFINEON
1371                 Support for Infineon i2c bus TPM devices. Only one device
1372                 per system is supported at this time.
1373
1374                         CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1375                         Define the burst count bytes upper limit
1376
1377                 CONFIG_TPM_ST33ZP24
1378                 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1379
1380                         CONFIG_TPM_ST33ZP24_I2C
1381                         Support for STMicroelectronics ST33ZP24 I2C devices.
1382                         Requires TPM_ST33ZP24 and I2C.
1383
1384                         CONFIG_TPM_ST33ZP24_SPI
1385                         Support for STMicroelectronics ST33ZP24 SPI devices.
1386                         Requires TPM_ST33ZP24 and SPI.
1387
1388                 CONFIG_TPM_ATMEL_TWI
1389                 Support for Atmel TWI TPM device. Requires I2C support.
1390
1391                 CONFIG_TPM_TIS_LPC
1392                 Support for generic parallel port TPM devices. Only one device
1393                 per system is supported at this time.
1394
1395                         CONFIG_TPM_TIS_BASE_ADDRESS
1396                         Base address where the generic TPM device is mapped
1397                         to. Contemporary x86 systems usually map it at
1398                         0xfed40000.
1399
1400                 CONFIG_CMD_TPM
1401                 Add tpm monitor functions.
1402                 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1403                 provides monitor access to authorized functions.
1404
1405                 CONFIG_TPM
1406                 Define this to enable the TPM support library which provides
1407                 functional interfaces to some TPM commands.
1408                 Requires support for a TPM device.
1409
1410                 CONFIG_TPM_AUTH_SESSIONS
1411                 Define this to enable authorized functions in the TPM library.
1412                 Requires CONFIG_TPM and CONFIG_SHA1.
1413
1414 - USB Support:
1415                 At the moment only the UHCI host controller is
1416                 supported (PIP405, MIP405, MPC5200); define
1417                 CONFIG_USB_UHCI to enable it.
1418                 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1419                 and define CONFIG_USB_STORAGE to enable the USB
1420                 storage devices.
1421                 Note:
1422                 Supported are USB Keyboards and USB Floppy drives
1423                 (TEAC FD-05PUB).
1424                 MPC5200 USB requires additional defines:
1425                         CONFIG_USB_CLOCK
1426                                 for 528 MHz Clock: 0x0001bbbb
1427                         CONFIG_PSC3_USB
1428                                 for USB on PSC3
1429                         CONFIG_USB_CONFIG
1430                                 for differential drivers: 0x00001000
1431                                 for single ended drivers: 0x00005000
1432                                 for differential drivers on PSC3: 0x00000100
1433                                 for single ended drivers on PSC3: 0x00004100
1434                         CONFIG_SYS_USB_EVENT_POLL
1435                                 May be defined to allow interrupt polling
1436                                 instead of using asynchronous interrupts
1437
1438                 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1439                 txfilltuning field in the EHCI controller on reset.
1440
1441                 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1442                 HW module registers.
1443
1444 - USB Device:
1445                 Define the below if you wish to use the USB console.
1446                 Once firmware is rebuilt from a serial console issue the
1447                 command "setenv stdin usbtty; setenv stdout usbtty" and
1448                 attach your USB cable. The Unix command "dmesg" should print
1449                 it has found a new device. The environment variable usbtty
1450                 can be set to gserial or cdc_acm to enable your device to
1451                 appear to a USB host as a Linux gserial device or a
1452                 Common Device Class Abstract Control Model serial device.
1453                 If you select usbtty = gserial you should be able to enumerate
1454                 a Linux host by
1455                 # modprobe usbserial vendor=0xVendorID product=0xProductID
1456                 else if using cdc_acm, simply setting the environment
1457                 variable usbtty to be cdc_acm should suffice. The following
1458                 might be defined in YourBoardName.h
1459
1460                         CONFIG_USB_DEVICE
1461                         Define this to build a UDC device
1462
1463                         CONFIG_USB_TTY
1464                         Define this to have a tty type of device available to
1465                         talk to the UDC device
1466
1467                         CONFIG_USBD_HS
1468                         Define this to enable the high speed support for usb
1469                         device and usbtty. If this feature is enabled, a routine
1470                         int is_usbd_high_speed(void)
1471                         also needs to be defined by the driver to dynamically poll
1472                         whether the enumeration has succeded at high speed or full
1473                         speed.
1474
1475                         CONFIG_SYS_CONSOLE_IS_IN_ENV
1476                         Define this if you want stdin, stdout &/or stderr to
1477                         be set to usbtty.
1478
1479                         mpc8xx:
1480                                 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1481                                 Derive USB clock from external clock "blah"
1482                                 - CONFIG_SYS_USB_EXTC_CLK 0x02
1483
1484                                 CONFIG_SYS_USB_BRG_CLK 0xBLAH
1485                                 Derive USB clock from brgclk
1486                                 - CONFIG_SYS_USB_BRG_CLK 0x04
1487
1488                 If you have a USB-IF assigned VendorID then you may wish to
1489                 define your own vendor specific values either in BoardName.h
1490                 or directly in usbd_vendor_info.h. If you don't define
1491                 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1492                 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1493                 should pretend to be a Linux device to it's target host.
1494
1495                         CONFIG_USBD_MANUFACTURER
1496                         Define this string as the name of your company for
1497                         - CONFIG_USBD_MANUFACTURER "my company"
1498
1499                         CONFIG_USBD_PRODUCT_NAME
1500                         Define this string as the name of your product
1501                         - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1502
1503                         CONFIG_USBD_VENDORID
1504                         Define this as your assigned Vendor ID from the USB
1505                         Implementors Forum. This *must* be a genuine Vendor ID
1506                         to avoid polluting the USB namespace.
1507                         - CONFIG_USBD_VENDORID 0xFFFF
1508
1509                         CONFIG_USBD_PRODUCTID
1510                         Define this as the unique Product ID
1511                         for your device
1512                         - CONFIG_USBD_PRODUCTID 0xFFFF
1513
1514 - ULPI Layer Support:
1515                 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1516                 the generic ULPI layer. The generic layer accesses the ULPI PHY
1517                 via the platform viewport, so you need both the genric layer and
1518                 the viewport enabled. Currently only Chipidea/ARC based
1519                 viewport is supported.
1520                 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1521                 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1522                 If your ULPI phy needs a different reference clock than the
1523                 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1524                 the appropriate value in Hz.
1525
1526 - MMC Support:
1527                 The MMC controller on the Intel PXA is supported. To
1528                 enable this define CONFIG_MMC. The MMC can be
1529                 accessed from the boot prompt by mapping the device
1530                 to physical memory similar to flash. Command line is
1531                 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1532                 the FAT fs. This is enabled with CONFIG_CMD_FAT.
1533
1534                 CONFIG_SH_MMCIF
1535                 Support for Renesas on-chip MMCIF controller
1536
1537                         CONFIG_SH_MMCIF_ADDR
1538                         Define the base address of MMCIF registers
1539
1540                         CONFIG_SH_MMCIF_CLK
1541                         Define the clock frequency for MMCIF
1542
1543                 CONFIG_GENERIC_MMC
1544                 Enable the generic MMC driver
1545
1546                 CONFIG_SUPPORT_EMMC_BOOT
1547                 Enable some additional features of the eMMC boot partitions.
1548
1549                 CONFIG_SUPPORT_EMMC_RPMB
1550                 Enable the commands for reading, writing and programming the
1551                 key for the Replay Protection Memory Block partition in eMMC.
1552
1553 - USB Device Firmware Update (DFU) class support:
1554                 CONFIG_USB_FUNCTION_DFU
1555                 This enables the USB portion of the DFU USB class
1556
1557                 CONFIG_CMD_DFU
1558                 This enables the command "dfu" which is used to have
1559                 U-Boot create a DFU class device via USB.  This command
1560                 requires that the "dfu_alt_info" environment variable be
1561                 set and define the alt settings to expose to the host.
1562
1563                 CONFIG_DFU_MMC
1564                 This enables support for exposing (e)MMC devices via DFU.
1565
1566                 CONFIG_DFU_NAND
1567                 This enables support for exposing NAND devices via DFU.
1568
1569                 CONFIG_DFU_RAM
1570                 This enables support for exposing RAM via DFU.
1571                 Note: DFU spec refer to non-volatile memory usage, but
1572                 allow usages beyond the scope of spec - here RAM usage,
1573                 one that would help mostly the developer.
1574
1575                 CONFIG_SYS_DFU_DATA_BUF_SIZE
1576                 Dfu transfer uses a buffer before writing data to the
1577                 raw storage device. Make the size (in bytes) of this buffer
1578                 configurable. The size of this buffer is also configurable
1579                 through the "dfu_bufsiz" environment variable.
1580
1581                 CONFIG_SYS_DFU_MAX_FILE_SIZE
1582                 When updating files rather than the raw storage device,
1583                 we use a static buffer to copy the file into and then write
1584                 the buffer once we've been given the whole file.  Define
1585                 this to the maximum filesize (in bytes) for the buffer.
1586                 Default is 4 MiB if undefined.
1587
1588                 DFU_DEFAULT_POLL_TIMEOUT
1589                 Poll timeout [ms], is the timeout a device can send to the
1590                 host. The host must wait for this timeout before sending
1591                 a subsequent DFU_GET_STATUS request to the device.
1592
1593                 DFU_MANIFEST_POLL_TIMEOUT
1594                 Poll timeout [ms], which the device sends to the host when
1595                 entering dfuMANIFEST state. Host waits this timeout, before
1596                 sending again an USB request to the device.
1597
1598 - USB Device Android Fastboot support:
1599                 CONFIG_USB_FUNCTION_FASTBOOT
1600                 This enables the USB part of the fastboot gadget
1601
1602                 CONFIG_CMD_FASTBOOT
1603                 This enables the command "fastboot" which enables the Android
1604                 fastboot mode for the platform's USB device. Fastboot is a USB
1605                 protocol for downloading images, flashing and device control
1606                 used on Android devices.
1607                 See doc/README.android-fastboot for more information.
1608
1609                 CONFIG_ANDROID_BOOT_IMAGE
1610                 This enables support for booting images which use the Android
1611                 image format header.
1612
1613                 CONFIG_FASTBOOT_BUF_ADDR
1614                 The fastboot protocol requires a large memory buffer for
1615                 downloads. Define this to the starting RAM address to use for
1616                 downloaded images.
1617
1618                 CONFIG_FASTBOOT_BUF_SIZE
1619                 The fastboot protocol requires a large memory buffer for
1620                 downloads. This buffer should be as large as possible for a
1621                 platform. Define this to the size available RAM for fastboot.
1622
1623                 CONFIG_FASTBOOT_FLASH
1624                 The fastboot protocol includes a "flash" command for writing
1625                 the downloaded image to a non-volatile storage device. Define
1626                 this to enable the "fastboot flash" command.
1627
1628                 CONFIG_FASTBOOT_FLASH_MMC_DEV
1629                 The fastboot "flash" command requires additional information
1630                 regarding the non-volatile storage device. Define this to
1631                 the eMMC device that fastboot should use to store the image.
1632
1633                 CONFIG_FASTBOOT_GPT_NAME
1634                 The fastboot "flash" command supports writing the downloaded
1635                 image to the Protective MBR and the Primary GUID Partition
1636                 Table. (Additionally, this downloaded image is post-processed
1637                 to generate and write the Backup GUID Partition Table.)
1638                 This occurs when the specified "partition name" on the
1639                 "fastboot flash" command line matches this value.
1640                 The default is "gpt" if undefined.
1641
1642                 CONFIG_FASTBOOT_MBR_NAME
1643                 The fastboot "flash" command supports writing the downloaded
1644                 image to DOS MBR.
1645                 This occurs when the "partition name" specified on the
1646                 "fastboot flash" command line matches this value.
1647                 If not defined the default value "mbr" is used.
1648
1649 - Journaling Flash filesystem support:
1650                 CONFIG_JFFS2_NAND
1651                 Define these for a default partition on a NAND device
1652
1653                 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1654                 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1655                 Define these for a default partition on a NOR device
1656
1657 - FAT(File Allocation Table) filesystem write function support:
1658                 CONFIG_FAT_WRITE
1659
1660                 Define this to enable support for saving memory data as a
1661                 file in FAT formatted partition.
1662
1663                 This will also enable the command "fatwrite" enabling the
1664                 user to write files to FAT.
1665
1666 CBFS (Coreboot Filesystem) support
1667                 CONFIG_CMD_CBFS
1668
1669                 Define this to enable support for reading from a Coreboot
1670                 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1671                 and cbfsload.
1672
1673 - FAT(File Allocation Table) filesystem cluster size:
1674                 CONFIG_FS_FAT_MAX_CLUSTSIZE
1675
1676                 Define the max cluster size for fat operations else
1677                 a default value of 65536 will be defined.
1678
1679 - Keyboard Support:
1680                 See Kconfig help for available keyboard drivers.
1681
1682                 CONFIG_KEYBOARD
1683
1684                 Define this to enable a custom keyboard support.
1685                 This simply calls drv_keyboard_init() which must be
1686                 defined in your board-specific files. This option is deprecated
1687                 and is only used by novena. For new boards, use driver model
1688                 instead.
1689
1690 - Video support:
1691                 CONFIG_VIDEO
1692
1693                 Define this to enable video support (for output to
1694                 video).
1695
1696                 CONFIG_VIDEO_CT69000
1697
1698                 Enable Chips & Technologies 69000 Video chip
1699
1700                 CONFIG_VIDEO_SMI_LYNXEM
1701                 Enable Silicon Motion SMI 712/710/810 Video chip. The
1702                 video output is selected via environment 'videoout'
1703                 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1704                 assumed.
1705
1706                 For the CT69000 and SMI_LYNXEM drivers, videomode is
1707                 selected via environment 'videomode'. Two different ways
1708                 are possible:
1709                 - "videomode=num"   'num' is a standard LiLo mode numbers.
1710                 Following standard modes are supported  (* is default):
1711
1712                       Colors    640x480 800x600 1024x768 1152x864 1280x1024
1713                 -------------+---------------------------------------------
1714                       8 bits |  0x301*  0x303    0x305    0x161     0x307
1715                      15 bits |  0x310   0x313    0x316    0x162     0x319
1716                      16 bits |  0x311   0x314    0x317    0x163     0x31A
1717                      24 bits |  0x312   0x315    0x318      ?       0x31B
1718                 -------------+---------------------------------------------
1719                 (i.e. setenv videomode 317; saveenv; reset;)
1720
1721                 - "videomode=bootargs" all the video parameters are parsed
1722                 from the bootargs. (See drivers/video/videomodes.c)
1723
1724
1725                 CONFIG_VIDEO_SED13806
1726                 Enable Epson SED13806 driver. This driver supports 8bpp
1727                 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1728                 or CONFIG_VIDEO_SED13806_16BPP
1729
1730                 CONFIG_FSL_DIU_FB
1731                 Enable the Freescale DIU video driver.  Reference boards for
1732                 SOCs that have a DIU should define this macro to enable DIU
1733                 support, and should also define these other macros:
1734
1735                         CONFIG_SYS_DIU_ADDR
1736                         CONFIG_VIDEO
1737                         CONFIG_CMD_BMP
1738                         CONFIG_CFB_CONSOLE
1739                         CONFIG_VIDEO_SW_CURSOR
1740                         CONFIG_VGA_AS_SINGLE_DEVICE
1741                         CONFIG_VIDEO_LOGO
1742                         CONFIG_VIDEO_BMP_LOGO
1743
1744                 The DIU driver will look for the 'video-mode' environment
1745                 variable, and if defined, enable the DIU as a console during
1746                 boot.  See the documentation file doc/README.video for a
1747                 description of this variable.
1748
1749 - LCD Support:  CONFIG_LCD
1750
1751                 Define this to enable LCD support (for output to LCD
1752                 display); also select one of the supported displays
1753                 by defining one of these:
1754
1755                 CONFIG_ATMEL_LCD:
1756
1757                         HITACHI TX09D70VM1CCA, 3.5", 240x320.
1758
1759                 CONFIG_NEC_NL6448AC33:
1760
1761                         NEC NL6448AC33-18. Active, color, single scan.
1762
1763                 CONFIG_NEC_NL6448BC20
1764
1765                         NEC NL6448BC20-08. 6.5", 640x480.
1766                         Active, color, single scan.
1767
1768                 CONFIG_NEC_NL6448BC33_54
1769
1770                         NEC NL6448BC33-54. 10.4", 640x480.
1771                         Active, color, single scan.
1772
1773                 CONFIG_SHARP_16x9
1774
1775                         Sharp 320x240. Active, color, single scan.
1776                         It isn't 16x9, and I am not sure what it is.
1777
1778                 CONFIG_SHARP_LQ64D341
1779
1780                         Sharp LQ64D341 display, 640x480.
1781                         Active, color, single scan.
1782
1783                 CONFIG_HLD1045
1784
1785                         HLD1045 display, 640x480.
1786                         Active, color, single scan.
1787
1788                 CONFIG_OPTREX_BW
1789
1790                         Optrex   CBL50840-2 NF-FW 99 22 M5
1791                         or
1792                         Hitachi  LMG6912RPFC-00T
1793                         or
1794                         Hitachi  SP14Q002
1795
1796                         320x240. Black & white.
1797
1798                 Normally display is black on white background; define
1799                 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1800
1801                 CONFIG_LCD_ALIGNMENT
1802
1803                 Normally the LCD is page-aligned (typically 4KB). If this is
1804                 defined then the LCD will be aligned to this value instead.
1805                 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1806                 here, since it is cheaper to change data cache settings on
1807                 a per-section basis.
1808
1809                 CONFIG_CONSOLE_SCROLL_LINES
1810
1811                 When the console need to be scrolled, this is the number of
1812                 lines to scroll by. It defaults to 1. Increasing this makes
1813                 the console jump but can help speed up operation when scrolling
1814                 is slow.
1815
1816                 CONFIG_LCD_ROTATION
1817
1818                 Sometimes, for example if the display is mounted in portrait
1819                 mode or even if it's mounted landscape but rotated by 180degree,
1820                 we need to rotate our content of the display relative to the
1821                 framebuffer, so that user can read the messages which are
1822                 printed out.
1823                 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1824                 initialized with a given rotation from "vl_rot" out of
1825                 "vidinfo_t" which is provided by the board specific code.
1826                 The value for vl_rot is coded as following (matching to
1827                 fbcon=rotate:<n> linux-kernel commandline):
1828                 0 = no rotation respectively 0 degree
1829                 1 = 90 degree rotation
1830                 2 = 180 degree rotation
1831                 3 = 270 degree rotation
1832
1833                 If CONFIG_LCD_ROTATION is not defined, the console will be
1834                 initialized with 0degree rotation.
1835
1836                 CONFIG_LCD_BMP_RLE8
1837
1838                 Support drawing of RLE8-compressed bitmaps on the LCD.
1839
1840                 CONFIG_I2C_EDID
1841
1842                 Enables an 'i2c edid' command which can read EDID
1843                 information over I2C from an attached LCD display.
1844
1845 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1846
1847                 If this option is set, the environment is checked for
1848                 a variable "splashimage". If found, the usual display
1849                 of logo, copyright and system information on the LCD
1850                 is suppressed and the BMP image at the address
1851                 specified in "splashimage" is loaded instead. The
1852                 console is redirected to the "nulldev", too. This
1853                 allows for a "silent" boot where a splash screen is
1854                 loaded very quickly after power-on.
1855
1856                 CONFIG_SPLASHIMAGE_GUARD
1857
1858                 If this option is set, then U-Boot will prevent the environment
1859                 variable "splashimage" from being set to a problematic address
1860                 (see doc/README.displaying-bmps).
1861                 This option is useful for targets where, due to alignment
1862                 restrictions, an improperly aligned BMP image will cause a data
1863                 abort. If you think you will not have problems with unaligned
1864                 accesses (for example because your toolchain prevents them)
1865                 there is no need to set this option.
1866
1867                 CONFIG_SPLASH_SCREEN_ALIGN
1868
1869                 If this option is set the splash image can be freely positioned
1870                 on the screen. Environment variable "splashpos" specifies the
1871                 position as "x,y". If a positive number is given it is used as
1872                 number of pixel from left/top. If a negative number is given it
1873                 is used as number of pixel from right/bottom. You can also
1874                 specify 'm' for centering the image.
1875
1876                 Example:
1877                 setenv splashpos m,m
1878                         => image at center of screen
1879
1880                 setenv splashpos 30,20
1881                         => image at x = 30 and y = 20
1882
1883                 setenv splashpos -10,m
1884                         => vertically centered image
1885                            at x = dspWidth - bmpWidth - 9
1886
1887 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1888
1889                 If this option is set, additionally to standard BMP
1890                 images, gzipped BMP images can be displayed via the
1891                 splashscreen support or the bmp command.
1892
1893 - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1894
1895                 If this option is set, 8-bit RLE compressed BMP images
1896                 can be displayed via the splashscreen support or the
1897                 bmp command.
1898
1899 - Do compressing for memory range:
1900                 CONFIG_CMD_ZIP
1901
1902                 If this option is set, it would use zlib deflate method
1903                 to compress the specified memory at its best effort.
1904
1905 - Compression support:
1906                 CONFIG_GZIP
1907
1908                 Enabled by default to support gzip compressed images.
1909
1910                 CONFIG_BZIP2
1911
1912                 If this option is set, support for bzip2 compressed
1913                 images is included. If not, only uncompressed and gzip
1914                 compressed images are supported.
1915
1916                 NOTE: the bzip2 algorithm requires a lot of RAM, so
1917                 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1918                 be at least 4MB.
1919
1920                 CONFIG_LZMA
1921
1922                 If this option is set, support for lzma compressed
1923                 images is included.
1924
1925                 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1926                 requires an amount of dynamic memory that is given by the
1927                 formula:
1928
1929                         (1846 + 768 << (lc + lp)) * sizeof(uint16)
1930
1931                 Where lc and lp stand for, respectively, Literal context bits
1932                 and Literal pos bits.
1933
1934                 This value is upper-bounded by 14MB in the worst case. Anyway,
1935                 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1936                 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1937                 a very small buffer.
1938
1939                 Use the lzmainfo tool to determinate the lc and lp values and
1940                 then calculate the amount of needed dynamic memory (ensuring
1941                 the appropriate CONFIG_SYS_MALLOC_LEN value).
1942
1943                 CONFIG_LZO
1944
1945                 If this option is set, support for LZO compressed images
1946                 is included.
1947
1948 - MII/PHY support:
1949                 CONFIG_PHY_ADDR
1950
1951                 The address of PHY on MII bus.
1952
1953                 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1954
1955                 The clock frequency of the MII bus
1956
1957                 CONFIG_PHY_GIGE
1958
1959                 If this option is set, support for speed/duplex
1960                 detection of gigabit PHY is included.
1961
1962                 CONFIG_PHY_RESET_DELAY
1963
1964                 Some PHY like Intel LXT971A need extra delay after
1965                 reset before any MII register access is possible.
1966                 For such PHY, set this option to the usec delay
1967                 required. (minimum 300usec for LXT971A)
1968
1969                 CONFIG_PHY_CMD_DELAY (ppc4xx)
1970
1971                 Some PHY like Intel LXT971A need extra delay after
1972                 command issued before MII status register can be read
1973
1974 - IP address:
1975                 CONFIG_IPADDR
1976
1977                 Define a default value for the IP address to use for
1978                 the default Ethernet interface, in case this is not
1979                 determined through e.g. bootp.
1980                 (Environment variable "ipaddr")
1981
1982 - Server IP address:
1983                 CONFIG_SERVERIP
1984
1985                 Defines a default value for the IP address of a TFTP
1986                 server to contact when using the "tftboot" command.
1987                 (Environment variable "serverip")
1988
1989                 CONFIG_KEEP_SERVERADDR
1990
1991                 Keeps the server's MAC address, in the env 'serveraddr'
1992                 for passing to bootargs (like Linux's netconsole option)
1993
1994 - Gateway IP address:
1995                 CONFIG_GATEWAYIP
1996
1997                 Defines a default value for the IP address of the
1998                 default router where packets to other networks are
1999                 sent to.
2000                 (Environment variable "gatewayip")
2001
2002 - Subnet mask:
2003                 CONFIG_NETMASK
2004
2005                 Defines a default value for the subnet mask (or
2006                 routing prefix) which is used to determine if an IP
2007                 address belongs to the local subnet or needs to be
2008                 forwarded through a router.
2009                 (Environment variable "netmask")
2010
2011 - Multicast TFTP Mode:
2012                 CONFIG_MCAST_TFTP
2013
2014                 Defines whether you want to support multicast TFTP as per
2015                 rfc-2090; for example to work with atftp.  Lets lots of targets
2016                 tftp down the same boot image concurrently.  Note: the Ethernet
2017                 driver in use must provide a function: mcast() to join/leave a
2018                 multicast group.
2019
2020 - BOOTP Recovery Mode:
2021                 CONFIG_BOOTP_RANDOM_DELAY
2022
2023                 If you have many targets in a network that try to
2024                 boot using BOOTP, you may want to avoid that all
2025                 systems send out BOOTP requests at precisely the same
2026                 moment (which would happen for instance at recovery
2027                 from a power failure, when all systems will try to
2028                 boot, thus flooding the BOOTP server. Defining
2029                 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2030                 inserted before sending out BOOTP requests. The
2031                 following delays are inserted then:
2032
2033                 1st BOOTP request:      delay 0 ... 1 sec
2034                 2nd BOOTP request:      delay 0 ... 2 sec
2035                 3rd BOOTP request:      delay 0 ... 4 sec
2036                 4th and following
2037                 BOOTP requests:         delay 0 ... 8 sec
2038
2039                 CONFIG_BOOTP_ID_CACHE_SIZE
2040
2041                 BOOTP packets are uniquely identified using a 32-bit ID. The
2042                 server will copy the ID from client requests to responses and
2043                 U-Boot will use this to determine if it is the destination of
2044                 an incoming response. Some servers will check that addresses
2045                 aren't in use before handing them out (usually using an ARP
2046                 ping) and therefore take up to a few hundred milliseconds to
2047                 respond. Network congestion may also influence the time it
2048                 takes for a response to make it back to the client. If that
2049                 time is too long, U-Boot will retransmit requests. In order
2050                 to allow earlier responses to still be accepted after these
2051                 retransmissions, U-Boot's BOOTP client keeps a small cache of
2052                 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2053                 cache. The default is to keep IDs for up to four outstanding
2054                 requests. Increasing this will allow U-Boot to accept offers
2055                 from a BOOTP client in networks with unusually high latency.
2056
2057 - DHCP Advanced Options:
2058                 You can fine tune the DHCP functionality by defining
2059                 CONFIG_BOOTP_* symbols:
2060
2061                 CONFIG_BOOTP_SUBNETMASK
2062                 CONFIG_BOOTP_GATEWAY
2063                 CONFIG_BOOTP_HOSTNAME
2064                 CONFIG_BOOTP_NISDOMAIN
2065                 CONFIG_BOOTP_BOOTPATH
2066                 CONFIG_BOOTP_BOOTFILESIZE
2067                 CONFIG_BOOTP_DNS
2068                 CONFIG_BOOTP_DNS2
2069                 CONFIG_BOOTP_SEND_HOSTNAME
2070                 CONFIG_BOOTP_NTPSERVER
2071                 CONFIG_BOOTP_TIMEOFFSET
2072                 CONFIG_BOOTP_VENDOREX
2073                 CONFIG_BOOTP_MAY_FAIL
2074
2075                 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2076                 environment variable, not the BOOTP server.
2077
2078                 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2079                 after the configured retry count, the call will fail
2080                 instead of starting over.  This can be used to fail over
2081                 to Link-local IP address configuration if the DHCP server
2082                 is not available.
2083
2084                 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2085                 serverip from a DHCP server, it is possible that more
2086                 than one DNS serverip is offered to the client.
2087                 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2088                 serverip will be stored in the additional environment
2089                 variable "dnsip2". The first DNS serverip is always
2090                 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
2091                 is defined.
2092
2093                 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2094                 to do a dynamic update of a DNS server. To do this, they
2095                 need the hostname of the DHCP requester.
2096                 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
2097                 of the "hostname" environment variable is passed as
2098                 option 12 to the DHCP server.
2099
2100                 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2101
2102                 A 32bit value in microseconds for a delay between
2103                 receiving a "DHCP Offer" and sending the "DHCP Request".
2104                 This fixes a problem with certain DHCP servers that don't
2105                 respond 100% of the time to a "DHCP request". E.g. On an
2106                 AT91RM9200 processor running at 180MHz, this delay needed
2107                 to be *at least* 15,000 usec before a Windows Server 2003
2108                 DHCP server would reply 100% of the time. I recommend at
2109                 least 50,000 usec to be safe. The alternative is to hope
2110                 that one of the retries will be successful but note that
2111                 the DHCP timeout and retry process takes a longer than
2112                 this delay.
2113
2114  - Link-local IP address negotiation:
2115                 Negotiate with other link-local clients on the local network
2116                 for an address that doesn't require explicit configuration.
2117                 This is especially useful if a DHCP server cannot be guaranteed
2118                 to exist in all environments that the device must operate.
2119
2120                 See doc/README.link-local for more information.
2121
2122  - CDP Options:
2123                 CONFIG_CDP_DEVICE_ID
2124
2125                 The device id used in CDP trigger frames.
2126
2127                 CONFIG_CDP_DEVICE_ID_PREFIX
2128
2129                 A two character string which is prefixed to the MAC address
2130                 of the device.
2131
2132                 CONFIG_CDP_PORT_ID
2133
2134                 A printf format string which contains the ascii name of
2135                 the port. Normally is set to "eth%d" which sets
2136                 eth0 for the first Ethernet, eth1 for the second etc.
2137
2138                 CONFIG_CDP_CAPABILITIES
2139
2140                 A 32bit integer which indicates the device capabilities;
2141                 0x00000010 for a normal host which does not forwards.
2142
2143                 CONFIG_CDP_VERSION
2144
2145                 An ascii string containing the version of the software.
2146
2147                 CONFIG_CDP_PLATFORM
2148
2149                 An ascii string containing the name of the platform.
2150
2151                 CONFIG_CDP_TRIGGER
2152
2153                 A 32bit integer sent on the trigger.
2154
2155                 CONFIG_CDP_POWER_CONSUMPTION
2156
2157                 A 16bit integer containing the power consumption of the
2158                 device in .1 of milliwatts.
2159
2160                 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2161
2162                 A byte containing the id of the VLAN.
2163
2164 - Status LED:   CONFIG_STATUS_LED
2165
2166                 Several configurations allow to display the current
2167                 status using a LED. For instance, the LED will blink
2168                 fast while running U-Boot code, stop blinking as
2169                 soon as a reply to a BOOTP request was received, and
2170                 start blinking slow once the Linux kernel is running
2171                 (supported by a status LED driver in the Linux
2172                 kernel). Defining CONFIG_STATUS_LED enables this
2173                 feature in U-Boot.
2174
2175                 Additional options:
2176
2177                 CONFIG_GPIO_LED
2178                 The status LED can be connected to a GPIO pin.
2179                 In such cases, the gpio_led driver can be used as a
2180                 status LED backend implementation. Define CONFIG_GPIO_LED
2181                 to include the gpio_led driver in the U-Boot binary.
2182
2183                 CONFIG_GPIO_LED_INVERTED_TABLE
2184                 Some GPIO connected LEDs may have inverted polarity in which
2185                 case the GPIO high value corresponds to LED off state and
2186                 GPIO low value corresponds to LED on state.
2187                 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2188                 with a list of GPIO LEDs that have inverted polarity.
2189
2190 - CAN Support:  CONFIG_CAN_DRIVER
2191
2192                 Defining CONFIG_CAN_DRIVER enables CAN driver support
2193                 on those systems that support this (optional)
2194                 feature, like the TQM8xxL modules.
2195
2196 - I2C Support:  CONFIG_SYS_I2C
2197
2198                 This enable the NEW i2c subsystem, and will allow you to use
2199                 i2c commands at the u-boot command line (as long as you set
2200                 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2201                 based realtime clock chips or other i2c devices. See
2202                 common/cmd_i2c.c for a description of the command line
2203                 interface.
2204
2205                 ported i2c driver to the new framework:
2206                 - drivers/i2c/soft_i2c.c:
2207                   - activate first bus with CONFIG_SYS_I2C_SOFT define
2208                     CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2209                     for defining speed and slave address
2210                   - activate second bus with I2C_SOFT_DECLARATIONS2 define
2211                     CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2212                     for defining speed and slave address
2213                   - activate third bus with I2C_SOFT_DECLARATIONS3 define
2214                     CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2215                     for defining speed and slave address
2216                   - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2217                     CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2218                     for defining speed and slave address
2219
2220                 - drivers/i2c/fsl_i2c.c:
2221                   - activate i2c driver with CONFIG_SYS_I2C_FSL
2222                     define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2223                     offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2224                     CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2225                     bus.
2226                   - If your board supports a second fsl i2c bus, define
2227                     CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2228                     CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2229                     CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2230                     second bus.
2231
2232                 - drivers/i2c/tegra_i2c.c:
2233                   - activate this driver with CONFIG_SYS_I2C_TEGRA
2234                   - This driver adds 4 i2c buses with a fix speed from
2235                     100000 and the slave addr 0!
2236
2237                 - drivers/i2c/ppc4xx_i2c.c
2238                   - activate this driver with CONFIG_SYS_I2C_PPC4XX
2239                   - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2240                   - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2241
2242                 - drivers/i2c/i2c_mxc.c
2243                   - activate this driver with CONFIG_SYS_I2C_MXC
2244                   - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2245                   - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2246                   - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2247                   - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
2248                   - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2249                   - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2250                   - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2251                   - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2252                   - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2253                   - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2254                   - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2255                   - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
2256                 If those defines are not set, default value is 100000
2257                 for speed, and 0 for slave.
2258
2259                 - drivers/i2c/rcar_i2c.c:
2260                   - activate this driver with CONFIG_SYS_I2C_RCAR
2261                   - This driver adds 4 i2c buses
2262
2263                   - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2264                   - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2265                   - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2266                   - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2267                   - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2268                   - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2269                   - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2270                   - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2271                   - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2272
2273                 - drivers/i2c/sh_i2c.c:
2274                   - activate this driver with CONFIG_SYS_I2C_SH
2275                   - This driver adds from 2 to 5 i2c buses
2276
2277                   - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2278                   - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2279                   - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2280                   - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2281                   - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2282                   - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2283                   - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2284                   - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2285                   - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2286                   - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2287                   - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2288                   - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2289                   - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
2290
2291                 - drivers/i2c/omap24xx_i2c.c
2292                   - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2293                   - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2294                   - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2295                   - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2296                   - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2297                   - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2298                   - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2299                   - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2300                   - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2301                   - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2302                   - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2303
2304                 - drivers/i2c/zynq_i2c.c
2305                   - activate this driver with CONFIG_SYS_I2C_ZYNQ
2306                   - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2307                   - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2308
2309                 - drivers/i2c/s3c24x0_i2c.c:
2310                   - activate this driver with CONFIG_SYS_I2C_S3C24X0
2311                   - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2312                     9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2313                     with a fix speed from 100000 and the slave addr 0!
2314
2315                 - drivers/i2c/ihs_i2c.c
2316                   - activate this driver with CONFIG_SYS_I2C_IHS
2317                   - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2318                   - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2319                   - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2320                   - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2321                   - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2322                   - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2323                   - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2324                   - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2325                   - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2326                   - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2327                   - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2328                   - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2329                   - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2330                   - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2331                   - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2332                   - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2333                   - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2334                   - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2335                   - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2336                   - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2337                   - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
2338
2339                 additional defines:
2340
2341                 CONFIG_SYS_NUM_I2C_BUSES
2342                 Hold the number of i2c buses you want to use. If you
2343                 don't use/have i2c muxes on your i2c bus, this
2344                 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2345                 omit this define.
2346
2347                 CONFIG_SYS_I2C_DIRECT_BUS
2348                 define this, if you don't use i2c muxes on your hardware.
2349                 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2350                 omit this define.
2351
2352                 CONFIG_SYS_I2C_MAX_HOPS
2353                 define how many muxes are maximal consecutively connected
2354                 on one i2c bus. If you not use i2c muxes, omit this
2355                 define.
2356
2357                 CONFIG_SYS_I2C_BUSES
2358                 hold a list of buses you want to use, only used if
2359                 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2360                 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2361                 CONFIG_SYS_NUM_I2C_BUSES = 9:
2362
2363                  CONFIG_SYS_I2C_BUSES   {{0, {I2C_NULL_HOP}}, \
2364                                         {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2365                                         {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2366                                         {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2367                                         {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2368                                         {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2369                                         {1, {I2C_NULL_HOP}}, \
2370                                         {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2371                                         {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2372                                         }
2373
2374                 which defines
2375                         bus 0 on adapter 0 without a mux
2376                         bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2377                         bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2378                         bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2379                         bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2380                         bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
2381                         bus 6 on adapter 1 without a mux
2382                         bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2383                         bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
2384
2385                 If you do not have i2c muxes on your board, omit this define.
2386
2387 - Legacy I2C Support:   CONFIG_HARD_I2C
2388
2389                 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2390                 provides the following compelling advantages:
2391
2392                 - more than one i2c adapter is usable
2393                 - approved multibus support
2394                 - better i2c mux support
2395
2396                 ** Please consider updating your I2C driver now. **
2397
2398                 These enable legacy I2C serial bus commands. Defining
2399                 CONFIG_HARD_I2C will include the appropriate I2C driver
2400                 for the selected CPU.
2401
2402                 This will allow you to use i2c commands at the u-boot
2403                 command line (as long as you set CONFIG_CMD_I2C in
2404                 CONFIG_COMMANDS) and communicate with i2c based realtime
2405                 clock chips. See common/cmd_i2c.c for a description of the
2406                 command line interface.
2407
2408                 CONFIG_HARD_I2C selects a hardware I2C controller.
2409
2410                 There are several other quantities that must also be
2411                 defined when you define CONFIG_HARD_I2C.
2412
2413                 In both cases you will need to define CONFIG_SYS_I2C_SPEED
2414                 to be the frequency (in Hz) at which you wish your i2c bus
2415                 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
2416                 the CPU's i2c node address).
2417
2418                 Now, the u-boot i2c code for the mpc8xx
2419                 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
2420                 and so its address should therefore be cleared to 0 (See,
2421                 eg, MPC823e User's Manual p.16-473). So, set
2422                 CONFIG_SYS_I2C_SLAVE to 0.
2423
2424                 CONFIG_SYS_I2C_INIT_MPC5XXX
2425
2426                 When a board is reset during an i2c bus transfer
2427                 chips might think that the current transfer is still
2428                 in progress.  Reset the slave devices by sending start
2429                 commands until the slave device responds.
2430
2431                 That's all that's required for CONFIG_HARD_I2C.
2432
2433                 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2434                 then the following macros need to be defined (examples are
2435                 from include/configs/lwmon.h):
2436
2437                 I2C_INIT
2438
2439                 (Optional). Any commands necessary to enable the I2C
2440                 controller or configure ports.
2441
2442                 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=  PB_SCL)
2443
2444                 I2C_PORT
2445
2446                 (Only for MPC8260 CPU). The I/O port to use (the code
2447                 assumes both bits are on the same port). Valid values
2448                 are 0..3 for ports A..D.
2449
2450                 I2C_ACTIVE
2451
2452                 The code necessary to make the I2C data line active
2453                 (driven).  If the data line is open collector, this
2454                 define can be null.
2455
2456                 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2457
2458                 I2C_TRISTATE
2459
2460                 The code necessary to make the I2C data line tri-stated
2461                 (inactive).  If the data line is open collector, this
2462                 define can be null.
2463
2464                 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2465
2466                 I2C_READ
2467
2468                 Code that returns true if the I2C data line is high,
2469                 false if it is low.
2470
2471                 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2472
2473                 I2C_SDA(bit)
2474
2475                 If <bit> is true, sets the I2C data line high. If it
2476                 is false, it clears it (low).
2477
2478                 eg: #define I2C_SDA(bit) \
2479                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2480                         else    immr->im_cpm.cp_pbdat &= ~PB_SDA
2481
2482                 I2C_SCL(bit)
2483
2484                 If <bit> is true, sets the I2C clock line high. If it
2485                 is false, it clears it (low).
2486
2487                 eg: #define I2C_SCL(bit) \
2488                         if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2489                         else    immr->im_cpm.cp_pbdat &= ~PB_SCL
2490
2491                 I2C_DELAY
2492
2493                 This delay is invoked four times per clock cycle so this
2494                 controls the rate of data transfer.  The data rate thus
2495                 is 1 / (I2C_DELAY * 4). Often defined to be something
2496                 like:
2497
2498                 #define I2C_DELAY  udelay(2)
2499
2500                 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2501
2502                 If your arch supports the generic GPIO framework (asm/gpio.h),
2503                 then you may alternatively define the two GPIOs that are to be
2504                 used as SCL / SDA.  Any of the previous I2C_xxx macros will
2505                 have GPIO-based defaults assigned to them as appropriate.
2506
2507                 You should define these to the GPIO value as given directly to
2508                 the generic GPIO functions.
2509
2510                 CONFIG_SYS_I2C_INIT_BOARD
2511
2512                 When a board is reset during an i2c bus transfer
2513                 chips might think that the current transfer is still
2514                 in progress. On some boards it is possible to access
2515                 the i2c SCLK line directly, either by using the
2516                 processor pin as a GPIO or by having a second pin
2517                 connected to the bus. If this option is defined a
2518                 custom i2c_init_board() routine in boards/xxx/board.c
2519                 is run early in the boot sequence.
2520
2521                 CONFIG_SYS_I2C_BOARD_LATE_INIT
2522
2523                 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2524                 defined a custom i2c_board_late_init() routine in
2525                 boards/xxx/board.c is run AFTER the operations in i2c_init()
2526                 is completed. This callpoint can be used to unreset i2c bus
2527                 using CPU i2c controller register accesses for CPUs whose i2c
2528                 controller provide such a method. It is called at the end of
2529                 i2c_init() to allow i2c_init operations to setup the i2c bus
2530                 controller on the CPU (e.g. setting bus speed & slave address).
2531
2532                 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2533
2534                 This option enables configuration of bi_iic_fast[] flags
2535                 in u-boot bd_info structure based on u-boot environment
2536                 variable "i2cfast". (see also i2cfast)
2537
2538                 CONFIG_I2C_MULTI_BUS
2539
2540                 This option allows the use of multiple I2C buses, each of which
2541                 must have a controller.  At any point in time, only one bus is
2542                 active.  To switch to a different bus, use the 'i2c dev' command.
2543                 Note that bus numbering is zero-based.
2544
2545                 CONFIG_SYS_I2C_NOPROBES
2546
2547                 This option specifies a list of I2C devices that will be skipped
2548                 when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
2549                 is set, specify a list of bus-device pairs.  Otherwise, specify
2550                 a 1D array of device addresses
2551
2552                 e.g.
2553                         #undef  CONFIG_I2C_MULTI_BUS
2554                         #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2555
2556                 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2557
2558                         #define CONFIG_I2C_MULTI_BUS
2559                         #define CONFIG_SYS_I2C_MULTI_NOPROBES   {{0,0x50},{0,0x68},{1,0x54}}
2560
2561                 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2562
2563                 CONFIG_SYS_SPD_BUS_NUM
2564
2565                 If defined, then this indicates the I2C bus number for DDR SPD.
2566                 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2567
2568                 CONFIG_SYS_RTC_BUS_NUM
2569
2570                 If defined, then this indicates the I2C bus number for the RTC.
2571                 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2572
2573                 CONFIG_SYS_DTT_BUS_NUM
2574
2575                 If defined, then this indicates the I2C bus number for the DTT.
2576                 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2577
2578                 CONFIG_SYS_I2C_DTT_ADDR:
2579
2580                 If defined, specifies the I2C address of the DTT device.
2581                 If not defined, then U-Boot uses predefined value for
2582                 specified DTT device.
2583
2584                 CONFIG_SOFT_I2C_READ_REPEATED_START
2585
2586                 defining this will force the i2c_read() function in
2587                 the soft_i2c driver to perform an I2C repeated start
2588                 between writing the address pointer and reading the
2589                 data.  If this define is omitted the default behaviour
2590                 of doing a stop-start sequence will be used.  Most I2C
2591                 devices can use either method, but some require one or
2592                 the other.
2593
2594 - SPI Support:  CONFIG_SPI
2595
2596                 Enables SPI driver (so far only tested with
2597                 SPI EEPROM, also an instance works with Crystal A/D and
2598                 D/As on the SACSng board)
2599
2600                 CONFIG_SH_SPI
2601
2602                 Enables the driver for SPI controller on SuperH. Currently
2603                 only SH7757 is supported.
2604
2605                 CONFIG_SOFT_SPI
2606
2607                 Enables a software (bit-bang) SPI driver rather than
2608                 using hardware support. This is a general purpose
2609                 driver that only requires three general I/O port pins
2610                 (two outputs, one input) to function. If this is
2611                 defined, the board configuration must define several
2612                 SPI configuration items (port pins to use, etc). For
2613                 an example, see include/configs/sacsng.h.
2614
2615                 CONFIG_HARD_SPI
2616
2617                 Enables a hardware SPI driver for general-purpose reads
2618                 and writes.  As with CONFIG_SOFT_SPI, the board configuration
2619                 must define a list of chip-select function pointers.
2620                 Currently supported on some MPC8xxx processors.  For an
2621                 example, see include/configs/mpc8349emds.h.
2622
2623                 CONFIG_MXC_SPI
2624
2625                 Enables the driver for the SPI controllers on i.MX and MXC
2626                 SoCs. Currently i.MX31/35/51 are supported.
2627
2628                 CONFIG_SYS_SPI_MXC_WAIT
2629                 Timeout for waiting until spi transfer completed.
2630                 default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2631
2632 - FPGA Support: CONFIG_FPGA
2633
2634                 Enables FPGA subsystem.
2635
2636                 CONFIG_FPGA_<vendor>
2637
2638                 Enables support for specific chip vendors.
2639                 (ALTERA, XILINX)
2640
2641                 CONFIG_FPGA_<family>
2642
2643                 Enables support for FPGA family.
2644                 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2645
2646                 CONFIG_FPGA_COUNT
2647
2648                 Specify the number of FPGA devices to support.
2649
2650                 CONFIG_CMD_FPGA_LOADMK
2651
2652                 Enable support for fpga loadmk command
2653
2654                 CONFIG_CMD_FPGA_LOADP
2655
2656                 Enable support for fpga loadp command - load partial bitstream
2657
2658                 CONFIG_CMD_FPGA_LOADBP
2659
2660                 Enable support for fpga loadbp command - load partial bitstream
2661                 (Xilinx only)
2662
2663                 CONFIG_SYS_FPGA_PROG_FEEDBACK
2664
2665                 Enable printing of hash marks during FPGA configuration.
2666
2667                 CONFIG_SYS_FPGA_CHECK_BUSY
2668
2669                 Enable checks on FPGA configuration interface busy
2670                 status by the configuration function. This option
2671                 will require a board or device specific function to
2672                 be written.
2673
2674                 CONFIG_FPGA_DELAY
2675
2676                 If defined, a function that provides delays in the FPGA
2677                 configuration driver.
2678
2679                 CONFIG_SYS_FPGA_CHECK_CTRLC
2680                 Allow Control-C to interrupt FPGA configuration
2681
2682                 CONFIG_SYS_FPGA_CHECK_ERROR
2683
2684                 Check for configuration errors during FPGA bitfile
2685                 loading. For example, abort during Virtex II
2686                 configuration if the INIT_B line goes low (which
2687                 indicated a CRC error).
2688
2689                 CONFIG_SYS_FPGA_WAIT_INIT
2690
2691                 Maximum time to wait for the INIT_B line to de-assert
2692                 after PROB_B has been de-asserted during a Virtex II
2693                 FPGA configuration sequence. The default time is 500
2694                 ms.
2695
2696                 CONFIG_SYS_FPGA_WAIT_BUSY
2697
2698                 Maximum time to wait for BUSY to de-assert during
2699                 Virtex II FPGA configuration. The default is 5 ms.
2700
2701                 CONFIG_SYS_FPGA_WAIT_CONFIG
2702
2703                 Time to wait after FPGA configuration. The default is
2704                 200 ms.
2705
2706 - Configuration Management:
2707                 CONFIG_BUILD_TARGET
2708
2709                 Some SoCs need special image types (e.g. U-Boot binary
2710                 with a special header) as build targets. By defining
2711                 CONFIG_BUILD_TARGET in the SoC / board header, this
2712                 special image will be automatically built upon calling
2713                 make / buildman.
2714
2715                 CONFIG_IDENT_STRING
2716
2717                 If defined, this string will be added to the U-Boot
2718                 version information (U_BOOT_VERSION)
2719
2720 - Vendor Parameter Protection:
2721
2722                 U-Boot considers the values of the environment
2723                 variables "serial#" (Board Serial Number) and
2724                 "ethaddr" (Ethernet Address) to be parameters that
2725                 are set once by the board vendor / manufacturer, and
2726                 protects these variables from casual modification by
2727                 the user. Once set, these variables are read-only,
2728                 and write or delete attempts are rejected. You can
2729                 change this behaviour:
2730
2731                 If CONFIG_ENV_OVERWRITE is #defined in your config
2732                 file, the write protection for vendor parameters is
2733                 completely disabled. Anybody can change or delete
2734                 these parameters.
2735
2736                 Alternatively, if you define _both_ an ethaddr in the
2737                 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
2738                 Ethernet address is installed in the environment,
2739                 which can be changed exactly ONCE by the user. [The
2740                 serial# is unaffected by this, i. e. it remains
2741                 read-only.]
2742
2743                 The same can be accomplished in a more flexible way
2744                 for any variable by configuring the type of access
2745                 to allow for those variables in the ".flags" variable
2746                 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2747
2748 - Protected RAM:
2749                 CONFIG_PRAM
2750
2751                 Define this variable to enable the reservation of
2752                 "protected RAM", i. e. RAM which is not overwritten
2753                 by U-Boot. Define CONFIG_PRAM to hold the number of
2754                 kB you want to reserve for pRAM. You can overwrite
2755                 this default value by defining an environment
2756                 variable "pram" to the number of kB you want to
2757                 reserve. Note that the board info structure will
2758                 still show the full amount of RAM. If pRAM is
2759                 reserved, a new environment variable "mem" will
2760                 automatically be defined to hold the amount of
2761                 remaining RAM in a form that can be passed as boot
2762                 argument to Linux, for instance like that:
2763
2764                         setenv bootargs ... mem=\${mem}
2765                         saveenv
2766
2767                 This way you can tell Linux not to use this memory,
2768                 either, which results in a memory region that will
2769                 not be affected by reboots.
2770
2771                 *WARNING* If your board configuration uses automatic
2772                 detection of the RAM size, you must make sure that
2773                 this memory test is non-destructive. So far, the
2774                 following board configurations are known to be
2775                 "pRAM-clean":
2776
2777                         IVMS8, IVML24, SPD8xx, TQM8xxL,
2778                         HERMES, IP860, RPXlite, LWMON,
2779                         FLAGADM, TQM8260
2780
2781 - Access to physical memory region (> 4GB)
2782                 Some basic support is provided for operations on memory not
2783                 normally accessible to U-Boot - e.g. some architectures
2784                 support access to more than 4GB of memory on 32-bit
2785                 machines using physical address extension or similar.
2786                 Define CONFIG_PHYSMEM to access this basic support, which
2787                 currently only supports clearing the memory.
2788
2789 - Error Recovery:
2790                 CONFIG_PANIC_HANG
2791
2792                 Define this variable to stop the system in case of a
2793                 fatal error, so that you have to reset it manually.
2794                 This is probably NOT a good idea for an embedded
2795                 system where you want the system to reboot
2796                 automatically as fast as possible, but it may be
2797                 useful during development since you can try to debug
2798                 the conditions that lead to the situation.
2799
2800                 CONFIG_NET_RETRY_COUNT
2801
2802                 This variable defines the number of retries for
2803                 network operations like ARP, RARP, TFTP, or BOOTP
2804                 before giving up the operation. If not defined, a
2805                 default value of 5 is used.
2806
2807                 CONFIG_ARP_TIMEOUT
2808
2809                 Timeout waiting for an ARP reply in milliseconds.
2810
2811                 CONFIG_NFS_TIMEOUT
2812
2813                 Timeout in milliseconds used in NFS protocol.
2814                 If you encounter "ERROR: Cannot umount" in nfs command,
2815                 try longer timeout such as
2816                 #define CONFIG_NFS_TIMEOUT 10000UL
2817
2818 - Command Interpreter:
2819                 CONFIG_AUTO_COMPLETE
2820
2821                 Enable auto completion of commands using TAB.
2822
2823                 CONFIG_SYS_PROMPT_HUSH_PS2
2824
2825                 This defines the secondary prompt string, which is
2826                 printed when the command interpreter needs more input
2827                 to complete a command. Usually "> ".
2828
2829         Note:
2830
2831                 In the current implementation, the local variables
2832                 space and global environment variables space are
2833                 separated. Local variables are those you define by
2834                 simply typing `name=value'. To access a local
2835                 variable later on, you have write `$name' or
2836                 `${name}'; to execute the contents of a variable
2837                 directly type `$name' at the command prompt.
2838
2839                 Global environment variables are those you use
2840                 setenv/printenv to work with. To run a command stored
2841                 in such a variable, you need to use the run command,
2842                 and you must not use the '$' sign to access them.
2843
2844                 To store commands and special characters in a
2845                 variable, please use double quotation marks
2846                 surrounding the whole text of the variable, instead
2847                 of the backslashes before semicolons and special
2848                 symbols.
2849
2850 - Command Line Editing and History:
2851                 CONFIG_CMDLINE_EDITING
2852
2853                 Enable editing and History functions for interactive
2854                 command line input operations
2855
2856 - Command Line PS1/PS2 support:
2857                 CONFIG_CMDLINE_PS_SUPPORT
2858
2859                 Enable support for changing the command prompt string
2860                 at run-time. Only static string is supported so far.
2861                 The string is obtained from environment variables PS1
2862                 and PS2.
2863
2864 - Default Environment:
2865                 CONFIG_EXTRA_ENV_SETTINGS
2866
2867                 Define this to contain any number of null terminated
2868                 strings (variable = value pairs) that will be part of
2869                 the default environment compiled into the boot image.
2870
2871                 For example, place something like this in your
2872                 board's config file:
2873
2874                 #define CONFIG_EXTRA_ENV_SETTINGS \
2875                         "myvar1=value1\0" \
2876                         "myvar2=value2\0"
2877
2878                 Warning: This method is based on knowledge about the
2879                 internal format how the environment is stored by the
2880                 U-Boot code. This is NOT an official, exported
2881                 interface! Although it is unlikely that this format
2882                 will change soon, there is no guarantee either.
2883                 You better know what you are doing here.
2884
2885                 Note: overly (ab)use of the default environment is
2886                 discouraged. Make sure to check other ways to preset
2887                 the environment like the "source" command or the
2888                 boot command first.
2889
2890                 CONFIG_ENV_VARS_UBOOT_CONFIG
2891
2892                 Define this in order to add variables describing the
2893                 U-Boot build configuration to the default environment.
2894                 These will be named arch, cpu, board, vendor, and soc.
2895
2896                 Enabling this option will cause the following to be defined:
2897
2898                 - CONFIG_SYS_ARCH
2899                 - CONFIG_SYS_CPU
2900                 - CONFIG_SYS_BOARD
2901                 - CONFIG_SYS_VENDOR
2902                 - CONFIG_SYS_SOC
2903
2904                 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2905
2906                 Define this in order to add variables describing certain
2907                 run-time determined information about the hardware to the
2908                 environment.  These will be named board_name, board_rev.
2909
2910                 CONFIG_DELAY_ENVIRONMENT
2911
2912                 Normally the environment is loaded when the board is
2913                 initialised so that it is available to U-Boot. This inhibits
2914                 that so that the environment is not available until
2915                 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2916                 this is instead controlled by the value of
2917                 /config/load-environment.
2918
2919 - Parallel Flash support:
2920                 CONFIG_SYS_NO_FLASH
2921
2922                 Traditionally U-Boot was run on systems with parallel NOR
2923                 flash. This option is used to disable support for parallel NOR
2924                 flash. This option should be defined if the board does not have
2925                 parallel flash.
2926
2927                 If this option is not defined one of the generic flash drivers
2928                 (e.g.  CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2929                 selected or the board must provide an implementation of the
2930                 flash API (see include/flash.h).
2931
2932 - DataFlash Support:
2933                 CONFIG_HAS_DATAFLASH
2934
2935                 Defining this option enables DataFlash features and
2936                 allows to read/write in Dataflash via the standard
2937                 commands cp, md...
2938
2939 - Serial Flash support
2940                 CONFIG_CMD_SF
2941
2942                 Defining this option enables SPI flash commands
2943                 'sf probe/read/write/erase/update'.
2944
2945                 Usage requires an initial 'probe' to define the serial
2946                 flash parameters, followed by read/write/erase/update
2947                 commands.
2948
2949                 The following defaults may be provided by the platform
2950                 to handle the common case when only a single serial
2951                 flash is present on the system.
2952
2953                 CONFIG_SF_DEFAULT_BUS           Bus identifier
2954                 CONFIG_SF_DEFAULT_CS            Chip-select
2955                 CONFIG_SF_DEFAULT_MODE          (see include/spi.h)
2956                 CONFIG_SF_DEFAULT_SPEED         in Hz
2957
2958                 CONFIG_CMD_SF_TEST
2959
2960                 Define this option to include a destructive SPI flash
2961                 test ('sf test').
2962
2963                 CONFIG_SF_DUAL_FLASH            Dual flash memories
2964
2965                 Define this option to use dual flash support where two flash
2966                 memories can be connected with a given cs line.
2967                 Currently Xilinx Zynq qspi supports these type of connections.
2968
2969 - SystemACE Support:
2970                 CONFIG_SYSTEMACE
2971
2972                 Adding this option adds support for Xilinx SystemACE
2973                 chips attached via some sort of local bus. The address
2974                 of the chip must also be defined in the
2975                 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
2976
2977                 #define CONFIG_SYSTEMACE
2978                 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
2979
2980                 When SystemACE support is added, the "ace" device type
2981                 becomes available to the fat commands, i.e. fatls.
2982
2983 - TFTP Fixed UDP Port:
2984                 CONFIG_TFTP_PORT
2985
2986                 If this is defined, the environment variable tftpsrcp
2987                 is used to supply the TFTP UDP source port value.
2988                 If tftpsrcp isn't defined, the normal pseudo-random port
2989                 number generator is used.
2990
2991                 Also, the environment variable tftpdstp is used to supply
2992                 the TFTP UDP destination port value.  If tftpdstp isn't
2993                 defined, the normal port 69 is used.
2994
2995                 The purpose for tftpsrcp is to allow a TFTP server to
2996                 blindly start the TFTP transfer using the pre-configured
2997                 target IP address and UDP port. This has the effect of
2998                 "punching through" the (Windows XP) firewall, allowing
2999                 the remainder of the TFTP transfer to proceed normally.
3000                 A better solution is to properly configure the firewall,
3001                 but sometimes that is not allowed.
3002
3003 - Hashing support:
3004                 CONFIG_CMD_HASH
3005
3006                 This enables a generic 'hash' command which can produce
3007                 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3008
3009                 CONFIG_HASH_VERIFY
3010
3011                 Enable the hash verify command (hash -v). This adds to code
3012                 size a little.
3013
3014                 CONFIG_SHA1 - This option enables support of hashing using SHA1
3015                 algorithm. The hash is calculated in software.
3016                 CONFIG_SHA256 - This option enables support of hashing using
3017                 SHA256 algorithm. The hash is calculated in software.
3018                 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3019                 for SHA1/SHA256 hashing.
3020                 This affects the 'hash' command and also the
3021                 hash_lookup_algo() function.
3022                 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3023                 hardware-acceleration for SHA1/SHA256 progressive hashing.
3024                 Data can be streamed in a block at a time and the hashing
3025                 is performed in hardware.
3026
3027                 Note: There is also a sha1sum command, which should perhaps
3028                 be deprecated in favour of 'hash sha1'.
3029
3030 - Freescale i.MX specific commands:
3031                 CONFIG_CMD_HDMIDETECT
3032                 This enables 'hdmidet' command which returns true if an
3033                 HDMI monitor is detected.  This command is i.MX 6 specific.
3034
3035                 CONFIG_CMD_BMODE
3036                 This enables the 'bmode' (bootmode) command for forcing
3037                 a boot from specific media.
3038
3039                 This is useful for forcing the ROM's usb downloader to
3040                 activate upon a watchdog reset which is nice when iterating
3041                 on U-Boot.  Using the reset button or running bmode normal
3042                 will set it back to normal.  This command currently
3043                 supports i.MX53 and i.MX6.
3044
3045 - bootcount support:
3046                 CONFIG_BOOTCOUNT_LIMIT
3047
3048                 This enables the bootcounter support, see:
3049                 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3050
3051                 CONFIG_AT91SAM9XE
3052                 enable special bootcounter support on at91sam9xe based boards.
3053                 CONFIG_BLACKFIN
3054                 enable special bootcounter support on blackfin based boards.
3055                 CONFIG_SOC_DA8XX
3056                 enable special bootcounter support on da850 based boards.
3057                 CONFIG_BOOTCOUNT_RAM
3058                 enable support for the bootcounter in RAM
3059                 CONFIG_BOOTCOUNT_I2C
3060                 enable support for the bootcounter on an i2c (like RTC) device.
3061                         CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3062                         CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3063                                                     the bootcounter.
3064                         CONFIG_BOOTCOUNT_ALEN = address len
3065
3066 - Show boot progress:
3067                 CONFIG_SHOW_BOOT_PROGRESS
3068
3069                 Defining this option allows to add some board-
3070                 specific code (calling a user-provided function
3071                 "show_boot_progress(int)") that enables you to show
3072                 the system's boot progress on some display (for
3073                 example, some LED's) on your board. At the moment,
3074                 the following checkpoints are implemented:
3075
3076
3077 Legacy uImage format:
3078
3079   Arg   Where                   When
3080     1   common/cmd_bootm.c      before attempting to boot an image
3081    -1   common/cmd_bootm.c      Image header has bad     magic number
3082     2   common/cmd_bootm.c      Image header has correct magic number
3083    -2   common/cmd_bootm.c      Image header has bad     checksum
3084     3   common/cmd_bootm.c      Image header has correct checksum
3085    -3   common/cmd_bootm.c      Image data   has bad     checksum
3086     4   common/cmd_bootm.c      Image data   has correct checksum
3087    -4   common/cmd_bootm.c      Image is for unsupported architecture
3088     5   common/cmd_bootm.c      Architecture check OK
3089    -5   common/cmd_bootm.c      Wrong Image Type (not kernel, multi)
3090     6   common/cmd_bootm.c      Image Type check OK
3091    -6   common/cmd_bootm.c      gunzip uncompression error
3092    -7   common/cmd_bootm.c      Unimplemented compression type
3093     7   common/cmd_bootm.c      Uncompression OK
3094     8   common/cmd_bootm.c      No uncompress/copy overwrite error
3095    -9   common/cmd_bootm.c      Unsupported OS (not Linux, BSD, VxWorks, QNX)
3096
3097     9   common/image.c          Start initial ramdisk verification
3098   -10   common/image.c          Ramdisk header has bad     magic number
3099   -11   common/image.c          Ramdisk header has bad     checksum
3100    10   common/image.c          Ramdisk header is OK
3101   -12   common/image.c          Ramdisk data   has bad     checksum
3102    11   common/image.c          Ramdisk data   has correct checksum
3103    12   common/image.c          Ramdisk verification complete, start loading
3104   -13   common/image.c          Wrong Image Type (not PPC Linux ramdisk)
3105    13   common/image.c          Start multifile image verification
3106    14   common/image.c          No initial ramdisk, no multifile, continue.
3107
3108    15   arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3109
3110   -30   arch/powerpc/lib/board.c        Fatal error, hang the system
3111   -31   post/post.c             POST test failed, detected by post_output_backlog()
3112   -32   post/post.c             POST test failed, detected by post_run_single()
3113
3114    34   common/cmd_doc.c        before loading a Image from a DOC device
3115   -35   common/cmd_doc.c        Bad usage of "doc" command
3116    35   common/cmd_doc.c        correct usage of "doc" command
3117   -36   common/cmd_doc.c        No boot device
3118    36   common/cmd_doc.c        correct boot device
3119   -37   common/cmd_doc.c        Unknown Chip ID on boot device
3120    37   common/cmd_doc.c        correct chip ID found, device available
3121   -38   common/cmd_doc.c        Read Error on boot device
3122    38   common/cmd_doc.c        reading Image header from DOC device OK
3123   -39   common/cmd_doc.c        Image header has bad magic number
3124    39   common/cmd_doc.c        Image header has correct magic number
3125   -40   common/cmd_doc.c        Error reading Image from DOC device
3126    40   common/cmd_doc.c        Image header has correct magic number
3127    41   common/cmd_ide.c        before loading a Image from a IDE device
3128   -42   common/cmd_ide.c        Bad usage of "ide" command
3129    42   common/cmd_ide.c        correct usage of "ide" command
3130   -43   common/cmd_ide.c        No boot device
3131    43   common/cmd_ide.c        boot device found
3132   -44   common/cmd_ide.c        Device not available
3133    44   common/cmd_ide.c        Device available
3134   -45   common/cmd_ide.c        wrong partition selected
3135    45   common/cmd_ide.c        partition selected
3136   -46   common/cmd_ide.c        Unknown partition table
3137    46   common/cmd_ide.c        valid partition table found
3138   -47   common/cmd_ide.c        Invalid partition type
3139    47   common/cmd_ide.c        correct partition type
3140   -48   common/cmd_ide.c        Error reading Image Header on boot device
3141    48   common/cmd_ide.c        reading Image Header from IDE device OK
3142   -49   common/cmd_ide.c        Image header has bad magic number
3143    49   common/cmd_ide.c        Image header has correct magic number
3144   -50   common/cmd_ide.c        Image header has bad     checksum
3145    50   common/cmd_ide.c        Image header has correct checksum
3146   -51   common/cmd_ide.c        Error reading Image from IDE device
3147    51   common/cmd_ide.c        reading Image from IDE device OK
3148    52   common/cmd_nand.c       before loading a Image from a NAND device
3149   -53   common/cmd_nand.c       Bad usage of "nand" command
3150    53   common/cmd_nand.c       correct usage of "nand" command
3151   -54   common/cmd_nand.c       No boot device
3152    54   common/cmd_nand.c       boot device found
3153   -55   common/cmd_nand.c       Unknown Chip ID on boot device
3154    55   common/cmd_nand.c       correct chip ID found, device available
3155   -56   common/cmd_nand.c       Error reading Image Header on boot device
3156    56   common/cmd_nand.c       reading Image Header from NAND device OK
3157   -57   common/cmd_nand.c       Image header has bad magic number
3158    57   common/cmd_nand.c       Image header has correct magic number
3159   -58   common/cmd_nand.c       Error reading Image from NAND device
3160    58   common/cmd_nand.c       reading Image from NAND device OK
3161
3162   -60   common/env_common.c     Environment has a bad CRC, using default
3163
3164    64   net/eth.c               starting with Ethernet configuration.
3165   -64   net/eth.c               no Ethernet found.
3166    65   net/eth.c               Ethernet found.
3167
3168   -80   common/cmd_net.c        usage wrong
3169    80   common/cmd_net.c        before calling net_loop()
3170   -81   common/cmd_net.c        some error in net_loop() occurred
3171    81   common/cmd_net.c        net_loop() back without error
3172   -82   common/cmd_net.c        size == 0 (File with size 0 loaded)
3173    82   common/cmd_net.c        trying automatic boot
3174    83   common/cmd_net.c        running "source" command
3175   -83   common/cmd_net.c        some error in automatic boot or "source" command
3176    84   common/cmd_net.c        end without errors
3177
3178 FIT uImage format:
3179
3180   Arg   Where                   When
3181   100   common/cmd_bootm.c      Kernel FIT Image has correct format
3182  -100   common/cmd_bootm.c      Kernel FIT Image has incorrect format
3183   101   common/cmd_bootm.c      No Kernel subimage unit name, using configuration
3184  -101   common/cmd_bootm.c      Can't get configuration for kernel subimage
3185   102   common/cmd_bootm.c      Kernel unit name specified
3186  -103   common/cmd_bootm.c      Can't get kernel subimage node offset
3187   103   common/cmd_bootm.c      Found configuration node
3188   104   common/cmd_bootm.c      Got kernel subimage node offset
3189  -104   common/cmd_bootm.c      Kernel subimage hash verification failed
3190   105   common/cmd_bootm.c      Kernel subimage hash verification OK
3191  -105   common/cmd_bootm.c      Kernel subimage is for unsupported architecture
3192   106   common/cmd_bootm.c      Architecture check OK
3193  -106   common/cmd_bootm.c      Kernel subimage has wrong type
3194   107   common/cmd_bootm.c      Kernel subimage type OK
3195  -107   common/cmd_bootm.c      Can't get kernel subimage data/size
3196   108   common/cmd_bootm.c      Got kernel subimage data/size
3197  -108   common/cmd_bootm.c      Wrong image type (not legacy, FIT)
3198  -109   common/cmd_bootm.c      Can't get kernel subimage type
3199  -110   common/cmd_bootm.c      Can't get kernel subimage comp
3200  -111   common/cmd_bootm.c      Can't get kernel subimage os
3201  -112   common/cmd_bootm.c      Can't get kernel subimage load address
3202  -113   common/cmd_bootm.c      Image uncompress/copy overwrite error
3203
3204   120   common/image.c          Start initial ramdisk verification
3205  -120   common/image.c          Ramdisk FIT image has incorrect format
3206   121   common/image.c          Ramdisk FIT image has correct format
3207   122   common/image.c          No ramdisk subimage unit name, using configuration
3208  -122   common/image.c          Can't get configuration for ramdisk subimage
3209   123   common/image.c          Ramdisk unit name specified
3210  -124   common/image.c          Can't get ramdisk subimage node offset
3211   125   common/image.c          Got ramdisk subimage node offset
3212  -125   common/image.c          Ramdisk subimage hash verification failed
3213   126   common/image.c          Ramdisk subimage hash verification OK
3214  -126   common/image.c          Ramdisk subimage for unsupported architecture
3215   127   common/image.c          Architecture check OK
3216  -127   common/image.c          Can't get ramdisk subimage data/size
3217   128   common/image.c          Got ramdisk subimage data/size
3218   129   common/image.c          Can't get ramdisk load address
3219  -129   common/image.c          Got ramdisk load address
3220
3221  -130   common/cmd_doc.c        Incorrect FIT image format
3222   131   common/cmd_doc.c        FIT image format OK
3223
3224  -140   common/cmd_ide.c        Incorrect FIT image format
3225   141   common/cmd_ide.c        FIT image format OK
3226
3227  -150   common/cmd_nand.c       Incorrect FIT image format
3228   151   common/cmd_nand.c       FIT image format OK
3229
3230 - legacy image format:
3231                 CONFIG_IMAGE_FORMAT_LEGACY
3232                 enables the legacy image format support in U-Boot.
3233
3234                 Default:
3235                 enabled if CONFIG_FIT_SIGNATURE is not defined.
3236
3237                 CONFIG_DISABLE_IMAGE_LEGACY
3238                 disable the legacy image format
3239
3240                 This define is introduced, as the legacy image format is
3241                 enabled per default for backward compatibility.
3242
3243 - FIT image support:
3244                 CONFIG_FIT_DISABLE_SHA256
3245                 Supporting SHA256 hashes has quite an impact on binary size.
3246                 For constrained systems sha256 hash support can be disabled
3247                 with this option.
3248
3249                 TODO(sjg@chromium.org): Adjust this option to be positive,
3250                 and move it to Kconfig
3251
3252 - Standalone program support:
3253                 CONFIG_STANDALONE_LOAD_ADDR
3254
3255                 This option defines a board specific value for the
3256                 address where standalone program gets loaded, thus
3257                 overwriting the architecture dependent default
3258                 settings.
3259
3260 - Frame Buffer Address:
3261                 CONFIG_FB_ADDR
3262
3263                 Define CONFIG_FB_ADDR if you want to use specific
3264                 address for frame buffer.  This is typically the case
3265                 when using a graphics controller has separate video
3266                 memory.  U-Boot will then place the frame buffer at
3267                 the given address instead of dynamically reserving it
3268                 in system RAM by calling lcd_setmem(), which grabs
3269                 the memory for the frame buffer depending on the
3270                 configured panel size.
3271
3272                 Please see board_init_f function.
3273
3274 - Automatic software updates via TFTP server
3275                 CONFIG_UPDATE_TFTP
3276                 CONFIG_UPDATE_TFTP_CNT_MAX
3277                 CONFIG_UPDATE_TFTP_MSEC_MAX
3278
3279                 These options enable and control the auto-update feature;
3280                 for a more detailed description refer to doc/README.update.
3281
3282 - MTD Support (mtdparts command, UBI support)
3283                 CONFIG_MTD_DEVICE
3284
3285                 Adds the MTD device infrastructure from the Linux kernel.
3286                 Needed for mtdparts command support.
3287
3288                 CONFIG_MTD_PARTITIONS
3289
3290                 Adds the MTD partitioning infrastructure from the Linux
3291                 kernel. Needed for UBI support.
3292
3293 - UBI support
3294                 CONFIG_CMD_UBI
3295
3296                 Adds commands for interacting with MTD partitions formatted
3297                 with the UBI flash translation layer
3298
3299                 Requires also defining CONFIG_RBTREE
3300
3301                 CONFIG_UBI_SILENCE_MSG
3302
3303                 Make the verbose messages from UBI stop printing.  This leaves
3304                 warnings and errors enabled.
3305
3306
3307                 CONFIG_MTD_UBI_WL_THRESHOLD
3308                 This parameter defines the maximum difference between the highest
3309                 erase counter value and the lowest erase counter value of eraseblocks
3310                 of UBI devices. When this threshold is exceeded, UBI starts performing
3311                 wear leveling by means of moving data from eraseblock with low erase
3312                 counter to eraseblocks with high erase counter.
3313
3314                 The default value should be OK for SLC NAND flashes, NOR flashes and
3315                 other flashes which have eraseblock life-cycle 100000 or more.
3316                 However, in case of MLC NAND flashes which typically have eraseblock
3317                 life-cycle less than 10000, the threshold should be lessened (e.g.,
3318                 to 128 or 256, although it does not have to be power of 2).
3319
3320                 default: 4096
3321
3322                 CONFIG_MTD_UBI_BEB_LIMIT
3323                 This option specifies the maximum bad physical eraseblocks UBI
3324                 expects on the MTD device (per 1024 eraseblocks). If the
3325                 underlying flash does not admit of bad eraseblocks (e.g. NOR
3326                 flash), this value is ignored.
3327
3328                 NAND datasheets often specify the minimum and maximum NVM
3329                 (Number of Valid Blocks) for the flashes' endurance lifetime.
3330                 The maximum expected bad eraseblocks per 1024 eraseblocks
3331                 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3332                 which gives 20 for most NANDs (MaxNVB is basically the total
3333                 count of eraseblocks on the chip).
3334
3335                 To put it differently, if this value is 20, UBI will try to
3336                 reserve about 1.9% of physical eraseblocks for bad blocks
3337                 handling. And that will be 1.9% of eraseblocks on the entire
3338                 NAND chip, not just the MTD partition UBI attaches. This means
3339                 that if you have, say, a NAND flash chip admits maximum 40 bad
3340                 eraseblocks, and it is split on two MTD partitions of the same
3341                 size, UBI will reserve 40 eraseblocks when attaching a
3342                 partition.
3343
3344                 default: 20
3345
3346                 CONFIG_MTD_UBI_FASTMAP
3347                 Fastmap is a mechanism which allows attaching an UBI device
3348                 in nearly constant time. Instead of scanning the whole MTD device it
3349                 only has to locate a checkpoint (called fastmap) on the device.
3350                 The on-flash fastmap contains all information needed to attach
3351                 the device. Using fastmap makes only sense on large devices where
3352                 attaching by scanning takes long. UBI will not automatically install
3353                 a fastmap on old images, but you can set the UBI parameter
3354                 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3355                 that fastmap-enabled images are still usable with UBI implementations
3356                 without fastmap support. On typical flash devices the whole fastmap
3357                 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3358
3359                 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3360                 Set this parameter to enable fastmap automatically on images
3361                 without a fastmap.
3362                 default: 0
3363
3364                 CONFIG_MTD_UBI_FM_DEBUG
3365                 Enable UBI fastmap debug
3366                 default: 0
3367
3368 - UBIFS support
3369                 CONFIG_CMD_UBIFS
3370
3371                 Adds commands for interacting with UBI volumes formatted as
3372                 UBIFS.  UBIFS is read-only in u-boot.
3373
3374                 Requires UBI support as well as CONFIG_LZO
3375
3376                 CONFIG_UBIFS_SILENCE_MSG
3377
3378                 Make the verbose messages from UBIFS stop printing.  This leaves
3379                 warnings and errors enabled.
3380
3381 - SPL framework
3382                 CONFIG_SPL
3383                 Enable building of SPL globally.
3384
3385                 CONFIG_SPL_LDSCRIPT
3386                 LDSCRIPT for linking the SPL binary.
3387
3388                 CONFIG_SPL_MAX_FOOTPRINT
3389                 Maximum size in memory allocated to the SPL, BSS included.
3390                 When defined, the linker checks that the actual memory
3391                 used by SPL from _start to __bss_end does not exceed it.
3392                 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3393                 must not be both defined at the same time.
3394
3395                 CONFIG_SPL_MAX_SIZE
3396                 Maximum size of the SPL image (text, data, rodata, and
3397                 linker lists sections), BSS excluded.
3398                 When defined, the linker checks that the actual size does
3399                 not exceed it.
3400
3401                 CONFIG_SPL_TEXT_BASE
3402                 TEXT_BASE for linking the SPL binary.
3403
3404                 CONFIG_SPL_RELOC_TEXT_BASE
3405                 Address to relocate to.  If unspecified, this is equal to
3406                 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3407
3408                 CONFIG_SPL_BSS_START_ADDR
3409                 Link address for the BSS within the SPL binary.
3410
3411                 CONFIG_SPL_BSS_MAX_SIZE
3412                 Maximum size in memory allocated to the SPL BSS.
3413                 When defined, the linker checks that the actual memory used
3414                 by SPL from __bss_start to __bss_end does not exceed it.
3415                 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3416                 must not be both defined at the same time.
3417
3418                 CONFIG_SPL_STACK
3419                 Adress of the start of the stack SPL will use
3420
3421                 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3422                 When defined, SPL will panic() if the image it has
3423                 loaded does not have a signature.
3424                 Defining this is useful when code which loads images
3425                 in SPL cannot guarantee that absolutely all read errors
3426                 will be caught.
3427                 An example is the LPC32XX MLC NAND driver, which will
3428                 consider that a completely unreadable NAND block is bad,
3429                 and thus should be skipped silently.
3430
3431                 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3432                 When defined, SPL will proceed to another boot method
3433                 if the image it has loaded does not have a signature.
3434
3435                 CONFIG_SPL_RELOC_STACK
3436                 Adress of the start of the stack SPL will use after
3437                 relocation.  If unspecified, this is equal to
3438                 CONFIG_SPL_STACK.
3439
3440                 CONFIG_SYS_SPL_MALLOC_START
3441                 Starting address of the malloc pool used in SPL.
3442                 When this option is set the full malloc is used in SPL and
3443                 it is set up by spl_init() and before that, the simple malloc()
3444                 can be used if CONFIG_SYS_MALLOC_F is defined.
3445
3446                 CONFIG_SYS_SPL_MALLOC_SIZE
3447                 The size of the malloc pool used in SPL.
3448
3449                 CONFIG_SPL_FRAMEWORK
3450                 Enable the SPL framework under common/.  This framework
3451                 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3452                 NAND loading of the Linux Kernel.
3453
3454                 CONFIG_SPL_OS_BOOT
3455                 Enable booting directly to an OS from SPL.
3456                 See also: doc/README.falcon
3457
3458                 CONFIG_SPL_DISPLAY_PRINT
3459                 For ARM, enable an optional function to print more information
3460                 about the running system.
3461
3462                 CONFIG_SPL_INIT_MINIMAL
3463                 Arch init code should be built for a very small image
3464
3465                 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3466                 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3467                 Address and partition on the MMC to load U-Boot from
3468                 when the MMC is being used in raw mode.
3469
3470                 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3471                 Partition on the MMC to load U-Boot from when the MMC is being
3472                 used in raw mode
3473
3474                 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3475                 Sector to load kernel uImage from when MMC is being
3476                 used in raw mode (for Falcon mode)
3477
3478                 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3479                 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3480                 Sector and number of sectors to load kernel argument
3481                 parameters from when MMC is being used in raw mode
3482                 (for falcon mode)
3483
3484                 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3485                 Partition on the MMC to load U-Boot from when the MMC is being
3486                 used in fs mode
3487
3488                 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3489                 Filename to read to load U-Boot when reading from filesystem
3490
3491                 CONFIG_SPL_FS_LOAD_KERNEL_NAME
3492                 Filename to read to load kernel uImage when reading
3493                 from filesystem (for Falcon mode)
3494
3495                 CONFIG_SPL_FS_LOAD_ARGS_NAME
3496                 Filename to read to load kernel argument parameters
3497                 when reading from filesystem (for Falcon mode)
3498
3499                 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3500                 Set this for NAND SPL on PPC mpc83xx targets, so that
3501                 start.S waits for the rest of the SPL to load before
3502                 continuing (the hardware starts execution after just
3503                 loading the first page rather than the full 4K).
3504
3505                 CONFIG_SPL_SKIP_RELOCATE
3506                 Avoid SPL relocation
3507
3508                 CONFIG_SPL_NAND_BASE
3509                 Include nand_base.c in the SPL.  Requires
3510                 CONFIG_SPL_NAND_DRIVERS.
3511
3512                 CONFIG_SPL_NAND_DRIVERS
3513                 SPL uses normal NAND drivers, not minimal drivers.
3514
3515                 CONFIG_SPL_NAND_ECC
3516                 Include standard software ECC in the SPL
3517
3518                 CONFIG_SPL_NAND_SIMPLE
3519                 Support for NAND boot using simple NAND drivers that
3520                 expose the cmd_ctrl() interface.
3521
3522                 CONFIG_SPL_UBI
3523                 Support for a lightweight UBI (fastmap) scanner and
3524                 loader
3525
3526                 CONFIG_SPL_NAND_RAW_ONLY
3527                 Support to boot only raw u-boot.bin images. Use this only
3528                 if you need to save space.
3529
3530                 CONFIG_SPL_COMMON_INIT_DDR
3531                 Set for common ddr init with serial presence detect in
3532                 SPL binary.
3533
3534                 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3535                 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3536                 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3537                 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3538                 CONFIG_SYS_NAND_ECCBYTES
3539                 Defines the size and behavior of the NAND that SPL uses
3540                 to read U-Boot
3541
3542                 CONFIG_SPL_NAND_BOOT
3543                 Add support NAND boot
3544
3545                 CONFIG_SYS_NAND_U_BOOT_OFFS
3546                 Location in NAND to read U-Boot from
3547
3548                 CONFIG_SYS_NAND_U_BOOT_DST
3549                 Location in memory to load U-Boot to
3550
3551                 CONFIG_SYS_NAND_U_BOOT_SIZE
3552                 Size of image to load
3553
3554                 CONFIG_SYS_NAND_U_BOOT_START
3555                 Entry point in loaded image to jump to
3556
3557                 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3558                 Define this if you need to first read the OOB and then the
3559                 data. This is used, for example, on davinci platforms.
3560
3561                 CONFIG_SPL_OMAP3_ID_NAND
3562                 Support for an OMAP3-specific set of functions to return the
3563                 ID and MFR of the first attached NAND chip, if present.
3564
3565                 CONFIG_SPL_RAM_DEVICE
3566                 Support for running image already present in ram, in SPL binary
3567
3568                 CONFIG_SPL_PAD_TO
3569                 Image offset to which the SPL should be padded before appending
3570                 the SPL payload. By default, this is defined as
3571                 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3572                 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3573                 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3574
3575                 CONFIG_SPL_TARGET
3576                 Final target image containing SPL and payload.  Some SPLs
3577                 use an arch-specific makefile fragment instead, for
3578                 example if more than one image needs to be produced.
3579
3580                 CONFIG_FIT_SPL_PRINT
3581                 Printing information about a FIT image adds quite a bit of
3582                 code to SPL. So this is normally disabled in SPL. Use this
3583                 option to re-enable it. This will affect the output of the
3584                 bootm command when booting a FIT image.
3585
3586 - TPL framework
3587                 CONFIG_TPL
3588                 Enable building of TPL globally.
3589
3590                 CONFIG_TPL_PAD_TO
3591                 Image offset to which the TPL should be padded before appending
3592                 the TPL payload. By default, this is defined as
3593                 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3594                 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3595                 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3596
3597 - Interrupt support (PPC):
3598
3599                 There are common interrupt_init() and timer_interrupt()
3600                 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
3601                 for CPU specific initialization. interrupt_init_cpu()
3602                 should set decrementer_count to appropriate value. If
3603                 CPU resets decrementer automatically after interrupt
3604                 (ppc4xx) it should set decrementer_count to zero.
3605                 timer_interrupt() calls timer_interrupt_cpu() for CPU
3606                 specific handling. If board has watchdog / status_led
3607                 / other_activity_monitor it works automatically from
3608                 general timer_interrupt().
3609
3610
3611 Board initialization settings:
3612 ------------------------------
3613
3614 During Initialization u-boot calls a number of board specific functions
3615 to allow the preparation of board specific prerequisites, e.g. pin setup
3616 before drivers are initialized. To enable these callbacks the
3617 following configuration macros have to be defined. Currently this is
3618 architecture specific, so please check arch/your_architecture/lib/board.c
3619 typically in board_init_f() and board_init_r().
3620
3621 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3622 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3623 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
3624 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3625
3626 Configuration Settings:
3627 -----------------------
3628
3629 - CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3630                 Optionally it can be defined to support 64-bit memory commands.
3631
3632 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3633                 undefine this when you're short of memory.
3634
3635 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3636                 width of the commands listed in the 'help' command output.
3637
3638 - CONFIG_SYS_PROMPT:    This is what U-Boot prints on the console to
3639                 prompt for user input.
3640
3641 - CONFIG_SYS_CBSIZE:    Buffer size for input from the Console
3642
3643 - CONFIG_SYS_PBSIZE:    Buffer size for Console output
3644
3645 - CONFIG_SYS_MAXARGS:   max. Number of arguments accepted for monitor commands
3646
3647 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3648                 the application (usually a Linux kernel) when it is
3649                 booted
3650
3651 - CONFIG_SYS_BAUDRATE_TABLE:
3652                 List of legal baudrate settings for this board.
3653
3654 - CONFIG_SYS_CONSOLE_INFO_QUIET
3655                 Suppress display of console information at boot.
3656
3657 - CONFIG_SYS_CONSOLE_IS_IN_ENV
3658                 If the board specific function
3659                         extern int overwrite_console (void);
3660                 returns 1, the stdin, stderr and stdout are switched to the
3661                 serial port, else the settings in the environment are used.
3662
3663 - CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3664                 Enable the call to overwrite_console().
3665
3666 - CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3667                 Enable overwrite of previous console environment settings.
3668
3669 - CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3670                 Begin and End addresses of the area used by the
3671                 simple memory test.
3672
3673 - CONFIG_SYS_ALT_MEMTEST:
3674                 Enable an alternate, more extensive memory test.
3675
3676 - CONFIG_SYS_MEMTEST_SCRATCH:
3677                 Scratch address used by the alternate memory test
3678                 You only need to set this if address zero isn't writeable
3679
3680 - CONFIG_SYS_MEM_RESERVE_SECURE
3681                 Only implemented for ARMv8 for now.
3682                 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3683                 is substracted from total RAM and won't be reported to OS.
3684                 This memory can be used as secure memory. A variable
3685                 gd->arch.secure_ram is used to track the location. In systems
3686                 the RAM base is not zero, or RAM is divided into banks,
3687                 this variable needs to be recalcuated to get the address.
3688
3689 - CONFIG_SYS_MEM_TOP_HIDE:
3690                 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
3691                 this specified memory area will get subtracted from the top
3692                 (end) of RAM and won't get "touched" at all by U-Boot. By
3693                 fixing up gd->ram_size the Linux kernel should gets passed
3694                 the now "corrected" memory size and won't touch it either.
3695                 This should work for arch/ppc and arch/powerpc. Only Linux
3696                 board ports in arch/powerpc with bootwrapper support that
3697                 recalculate the memory size from the SDRAM controller setup
3698                 will have to get fixed in Linux additionally.
3699
3700                 This option can be used as a workaround for the 440EPx/GRx
3701                 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3702                 be touched.
3703
3704                 WARNING: Please make sure that this value is a multiple of
3705                 the Linux page size (normally 4k). If this is not the case,
3706                 then the end address of the Linux memory will be located at a
3707                 non page size aligned address and this could cause major
3708                 problems.
3709
3710 - CONFIG_SYS_LOADS_BAUD_CHANGE:
3711                 Enable temporary baudrate change while serial download
3712
3713 - CONFIG_SYS_SDRAM_BASE:
3714                 Physical start address of SDRAM. _Must_ be 0 here.
3715
3716 - CONFIG_SYS_FLASH_BASE:
3717                 Physical start address of Flash memory.
3718
3719 - CONFIG_SYS_MONITOR_BASE:
3720                 Physical start address of boot monitor code (set by
3721                 make config files to be same as the text base address
3722                 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
3723                 CONFIG_SYS_FLASH_BASE when booting from flash.
3724
3725 - CONFIG_SYS_MONITOR_LEN:
3726                 Size of memory reserved for monitor code, used to
3727                 determine _at_compile_time_ (!) if the environment is
3728                 embedded within the U-Boot image, or in a separate
3729                 flash sector.
3730
3731 - CONFIG_SYS_MALLOC_LEN:
3732                 Size of DRAM reserved for malloc() use.
3733
3734 - CONFIG_SYS_MALLOC_F_LEN
3735                 Size of the malloc() pool for use before relocation. If
3736                 this is defined, then a very simple malloc() implementation
3737                 will become available before relocation. The address is just
3738                 below the global data, and the stack is moved down to make
3739                 space.
3740
3741                 This feature allocates regions with increasing addresses
3742                 within the region. calloc() is supported, but realloc()
3743                 is not available. free() is supported but does nothing.
3744                 The memory will be freed (or in fact just forgotten) when
3745                 U-Boot relocates itself.
3746
3747 - CONFIG_SYS_MALLOC_SIMPLE
3748                 Provides a simple and small malloc() and calloc() for those
3749                 boards which do not use the full malloc in SPL (which is
3750                 enabled with CONFIG_SYS_SPL_MALLOC_START).
3751
3752 - CONFIG_SYS_NONCACHED_MEMORY:
3753                 Size of non-cached memory area. This area of memory will be
3754                 typically located right below the malloc() area and mapped
3755                 uncached in the MMU. This is useful for drivers that would
3756                 otherwise require a lot of explicit cache maintenance. For
3757                 some drivers it's also impossible to properly maintain the
3758                 cache. For example if the regions that need to be flushed
3759                 are not a multiple of the cache-line size, *and* padding
3760                 cannot be allocated between the regions to align them (i.e.
3761                 if the HW requires a contiguous array of regions, and the
3762                 size of each region is not cache-aligned), then a flush of
3763                 one region may result in overwriting data that hardware has
3764                 written to another region in the same cache-line. This can
3765                 happen for example in network drivers where descriptors for
3766                 buffers are typically smaller than the CPU cache-line (e.g.
3767                 16 bytes vs. 32 or 64 bytes).
3768
3769                 Non-cached memory is only supported on 32-bit ARM at present.
3770
3771 - CONFIG_SYS_BOOTM_LEN:
3772                 Normally compressed uImages are limited to an
3773                 uncompressed size of 8 MBytes. If this is not enough,
3774                 you can define CONFIG_SYS_BOOTM_LEN in your board config file
3775                 to adjust this setting to your needs.
3776
3777 - CONFIG_SYS_BOOTMAPSZ:
3778                 Maximum size of memory mapped by the startup code of
3779                 the Linux kernel; all data that must be processed by
3780                 the Linux kernel (bd_info, boot arguments, FDT blob if
3781                 used) must be put below this limit, unless "bootm_low"
3782                 environment variable is defined and non-zero. In such case
3783                 all data for the Linux kernel must be between "bootm_low"
3784                 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
3785                 variable "bootm_mapsize" will override the value of
3786                 CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3787                 then the value in "bootm_size" will be used instead.
3788
3789 - CONFIG_SYS_BOOT_RAMDISK_HIGH:
3790                 Enable initrd_high functionality.  If defined then the
3791                 initrd_high feature is enabled and the bootm ramdisk subcommand
3792                 is enabled.
3793
3794 - CONFIG_SYS_BOOT_GET_CMDLINE:
3795                 Enables allocating and saving kernel cmdline in space between
3796                 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3797
3798 - CONFIG_SYS_BOOT_GET_KBD:
3799                 Enables allocating and saving a kernel copy of the bd_info in
3800                 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3801
3802 - CONFIG_SYS_MAX_FLASH_BANKS:
3803                 Max number of Flash memory banks
3804
3805 - CONFIG_SYS_MAX_FLASH_SECT:
3806                 Max number of sectors on a Flash chip
3807
3808 - CONFIG_SYS_FLASH_ERASE_TOUT:
3809                 Timeout for Flash erase operations (in ms)
3810
3811 - CONFIG_SYS_FLASH_WRITE_TOUT:
3812                 Timeout for Flash write operations (in ms)
3813
3814 - CONFIG_SYS_FLASH_LOCK_TOUT
3815                 Timeout for Flash set sector lock bit operation (in ms)
3816
3817 - CONFIG_SYS_FLASH_UNLOCK_TOUT
3818                 Timeout for Flash clear lock bits operation (in ms)
3819
3820 - CONFIG_SYS_FLASH_PROTECTION
3821                 If defined, hardware flash sectors protection is used
3822                 instead of U-Boot software protection.
3823
3824 - CONFIG_SYS_DIRECT_FLASH_TFTP:
3825
3826                 Enable TFTP transfers directly to flash memory;
3827                 without this option such a download has to be
3828                 performed in two steps: (1) download to RAM, and (2)
3829                 copy from RAM to flash.
3830
3831                 The two-step approach is usually more reliable, since
3832                 you can check if the download worked before you erase
3833                 the flash, but in some situations (when system RAM is
3834                 too limited to allow for a temporary copy of the
3835                 downloaded image) this option may be very useful.
3836
3837 - CONFIG_SYS_FLASH_CFI:
3838                 Define if the flash driver uses extra elements in the
3839                 common flash structure for storing flash geometry.
3840
3841 - CONFIG_FLASH_CFI_DRIVER
3842                 This option also enables the building of the cfi_flash driver
3843                 in the drivers directory
3844
3845 - CONFIG_FLASH_CFI_MTD
3846                 This option enables the building of the cfi_mtd driver
3847                 in the drivers directory. The driver exports CFI flash
3848                 to the MTD layer.
3849
3850 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
3851                 Use buffered writes to flash.
3852
3853 - CONFIG_FLASH_SPANSION_S29WS_N
3854                 s29ws-n MirrorBit flash has non-standard addresses for buffered
3855                 write commands.
3856
3857 - CONFIG_SYS_FLASH_QUIET_TEST
3858                 If this option is defined, the common CFI flash doesn't
3859                 print it's warning upon not recognized FLASH banks. This
3860                 is useful, if some of the configured banks are only
3861                 optionally available.
3862
3863 - CONFIG_FLASH_SHOW_PROGRESS
3864                 If defined (must be an integer), print out countdown
3865                 digits and dots.  Recommended value: 45 (9..1) for 80
3866                 column displays, 15 (3..1) for 40 column displays.
3867
3868 - CONFIG_FLASH_VERIFY
3869                 If defined, the content of the flash (destination) is compared
3870                 against the source after the write operation. An error message
3871                 will be printed when the contents are not identical.
3872                 Please note that this option is useless in nearly all cases,
3873                 since such flash programming errors usually are detected earlier
3874                 while unprotecting/erasing/programming. Please only enable
3875                 this option if you really know what you are doing.
3876
3877 - CONFIG_SYS_RX_ETH_BUFFER:
3878                 Defines the number of Ethernet receive buffers. On some
3879                 Ethernet controllers it is recommended to set this value
3880                 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3881                 buffers can be full shortly after enabling the interface
3882                 on high Ethernet traffic.
3883                 Defaults to 4 if not defined.
3884
3885 - CONFIG_ENV_MAX_ENTRIES
3886
3887         Maximum number of entries in the hash table that is used
3888         internally to store the environment settings. The default
3889         setting is supposed to be generous and should work in most
3890         cases. This setting can be used to tune behaviour; see
3891         lib/hashtable.c for details.
3892
3893 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3894 - CONFIG_ENV_FLAGS_LIST_STATIC
3895         Enable validation of the values given to environment variables when
3896         calling env set.  Variables can be restricted to only decimal,
3897         hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
3898         the variables can also be restricted to IP address or MAC address.
3899
3900         The format of the list is:
3901                 type_attribute = [s|d|x|b|i|m]
3902                 access_attribute = [a|r|o|c]
3903                 attributes = type_attribute[access_attribute]
3904                 entry = variable_name[:attributes]
3905                 list = entry[,list]
3906
3907         The type attributes are:
3908                 s - String (default)
3909                 d - Decimal
3910                 x - Hexadecimal
3911                 b - Boolean ([1yYtT|0nNfF])
3912                 i - IP address
3913                 m - MAC address
3914
3915         The access attributes are:
3916                 a - Any (default)
3917                 r - Read-only
3918                 o - Write-once
3919                 c - Change-default
3920
3921         - CONFIG_ENV_FLAGS_LIST_DEFAULT
3922                 Define this to a list (string) to define the ".flags"
3923                 environment variable in the default or embedded environment.
3924
3925         - CONFIG_ENV_FLAGS_LIST_STATIC
3926                 Define this to a list (string) to define validation that
3927                 should be done if an entry is not found in the ".flags"
3928                 environment variable.  To override a setting in the static
3929                 list, simply add an entry for the same variable name to the
3930                 ".flags" variable.
3931
3932         If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3933         regular expression. This allows multiple variables to define the same
3934         flags without explicitly listing them for each variable.
3935
3936 - CONFIG_ENV_ACCESS_IGNORE_FORCE
3937         If defined, don't allow the -f switch to env set override variable
3938         access flags.
3939
3940 - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3941         This is set by OMAP boards for the max time that reset should
3942         be asserted. See doc/README.omap-reset-time for details on how
3943         the value can be calculated on a given board.
3944
3945 - CONFIG_USE_STDINT
3946         If stdint.h is available with your toolchain you can define this
3947         option to enable it. You can provide option 'USE_STDINT=1' when
3948         building U-Boot to enable this.
3949
3950 The following definitions that deal with the placement and management
3951 of environment data (variable area); in general, we support the
3952 following configurations:
3953
3954 - CONFIG_BUILD_ENVCRC:
3955
3956         Builds up envcrc with the target environment so that external utils
3957         may easily extract it and embed it in final U-Boot images.
3958
3959 - CONFIG_ENV_IS_IN_FLASH:
3960
3961         Define this if the environment is in flash memory.
3962
3963         a) The environment occupies one whole flash sector, which is
3964            "embedded" in the text segment with the U-Boot code. This
3965            happens usually with "bottom boot sector" or "top boot
3966            sector" type flash chips, which have several smaller
3967            sectors at the start or the end. For instance, such a
3968            layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3969            such a case you would place the environment in one of the
3970            4 kB sectors - with U-Boot code before and after it. With
3971            "top boot sector" type flash chips, you would put the
3972            environment in one of the last sectors, leaving a gap
3973            between U-Boot and the environment.
3974
3975         - CONFIG_ENV_OFFSET:
3976
3977            Offset of environment data (variable area) to the
3978            beginning of flash memory; for instance, with bottom boot
3979            type flash chips the second sector can be used: the offset
3980            for this sector is given here.
3981
3982            CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3983
3984         - CONFIG_ENV_ADDR:
3985
3986            This is just another way to specify the start address of
3987            the flash sector containing the environment (instead of
3988            CONFIG_ENV_OFFSET).
3989
3990         - CONFIG_ENV_SECT_SIZE:
3991
3992            Size of the sector containing the environment.
3993
3994
3995         b) Sometimes flash chips have few, equal sized, BIG sectors.
3996            In such a case you don't want to spend a whole sector for
3997            the environment.
3998
3999         - CONFIG_ENV_SIZE:
4000
4001            If you use this in combination with CONFIG_ENV_IS_IN_FLASH
4002            and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
4003            of this flash sector for the environment. This saves
4004            memory for the RAM copy of the environment.
4005
4006            It may also save flash memory if you decide to use this
4007            when your environment is "embedded" within U-Boot code,
4008            since then the remainder of the flash sector could be used
4009            for U-Boot code. It should be pointed out that this is
4010            STRONGLY DISCOURAGED from a robustness point of view:
4011            updating the environment in flash makes it always
4012            necessary to erase the WHOLE sector. If something goes
4013            wrong before the contents has been restored from a copy in
4014            RAM, your target system will be dead.
4015
4016         - CONFIG_ENV_ADDR_REDUND
4017           CONFIG_ENV_SIZE_REDUND
4018
4019            These settings describe a second storage area used to hold
4020            a redundant copy of the environment data, so that there is
4021            a valid backup copy in case there is a power failure during
4022            a "saveenv" operation.
4023
4024 BE CAREFUL! Any changes to the flash layout, and some changes to the
4025 source code will make it necessary to adapt <board>/u-boot.lds*
4026 accordingly!
4027
4028
4029 - CONFIG_ENV_IS_IN_NVRAM:
4030
4031         Define this if you have some non-volatile memory device
4032         (NVRAM, battery buffered SRAM) which you want to use for the
4033         environment.
4034
4035         - CONFIG_ENV_ADDR:
4036         - CONFIG_ENV_SIZE:
4037
4038           These two #defines are used to determine the memory area you
4039           want to use for environment. It is assumed that this memory
4040           can just be read and written to, without any special
4041           provision.
4042
4043 BE CAREFUL! The first access to the environment happens quite early
4044 in U-Boot initialization (when we try to get the setting of for the
4045 console baudrate). You *MUST* have mapped your NVRAM area then, or
4046 U-Boot will hang.
4047
4048 Please note that even with NVRAM we still use a copy of the
4049 environment in RAM: we could work on NVRAM directly, but we want to
4050 keep settings there always unmodified except somebody uses "saveenv"
4051 to save the current settings.
4052
4053
4054 - CONFIG_ENV_IS_IN_EEPROM:
4055
4056         Use this if you have an EEPROM or similar serial access
4057         device and a driver for it.
4058
4059         - CONFIG_ENV_OFFSET:
4060         - CONFIG_ENV_SIZE:
4061
4062           These two #defines specify the offset and size of the
4063           environment area within the total memory of your EEPROM.
4064
4065         - CONFIG_SYS_I2C_EEPROM_ADDR:
4066           If defined, specified the chip address of the EEPROM device.
4067           The default address is zero.
4068
4069         - CONFIG_SYS_I2C_EEPROM_BUS:
4070           If defined, specified the i2c bus of the EEPROM device.
4071
4072         - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4073           If defined, the number of bits used to address bytes in a
4074           single page in the EEPROM device.  A 64 byte page, for example
4075           would require six bits.
4076
4077         - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4078           If defined, the number of milliseconds to delay between
4079           page writes.  The default is zero milliseconds.
4080
4081         - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4082           The length in bytes of the EEPROM memory array address.  Note
4083           that this is NOT the chip address length!
4084
4085         - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
4086           EEPROM chips that implement "address overflow" are ones
4087           like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4088           address and the extra bits end up in the "chip address" bit
4089           slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4090           byte chips.
4091
4092           Note that we consider the length of the address field to
4093           still be one byte because the extra address bits are hidden
4094           in the chip address.
4095
4096         - CONFIG_SYS_EEPROM_SIZE:
4097           The size in bytes of the EEPROM device.
4098
4099         - CONFIG_ENV_EEPROM_IS_ON_I2C
4100           define this, if you have I2C and SPI activated, and your
4101           EEPROM, which holds the environment, is on the I2C bus.
4102
4103         - CONFIG_I2C_ENV_EEPROM_BUS
4104           if you have an Environment on an EEPROM reached over
4105           I2C muxes, you can define here, how to reach this
4106           EEPROM. For example:
4107
4108           #define CONFIG_I2C_ENV_EEPROM_BUS       1
4109
4110           EEPROM which holds the environment, is reached over
4111           a pca9547 i2c mux with address 0x70, channel 3.
4112
4113 - CONFIG_ENV_IS_IN_DATAFLASH:
4114
4115         Define this if you have a DataFlash memory device which you
4116         want to use for the environment.
4117
4118         - CONFIG_ENV_OFFSET:
4119         - CONFIG_ENV_ADDR:
4120         - CONFIG_ENV_SIZE:
4121
4122           These three #defines specify the offset and size of the
4123           environment area within the total memory of your DataFlash placed
4124           at the specified address.
4125
4126 - CONFIG_ENV_IS_IN_SPI_FLASH:
4127
4128         Define this if you have a SPI Flash memory device which you
4129         want to use for the environment.
4130
4131         - CONFIG_ENV_OFFSET:
4132         - CONFIG_ENV_SIZE:
4133
4134           These two #defines specify the offset and size of the
4135           environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4136           aligned to an erase sector boundary.
4137
4138         - CONFIG_ENV_SECT_SIZE:
4139
4140           Define the SPI flash's sector size.
4141
4142         - CONFIG_ENV_OFFSET_REDUND (optional):
4143
4144           This setting describes a second storage area of CONFIG_ENV_SIZE
4145           size used to hold a redundant copy of the environment data, so
4146           that there is a valid backup copy in case there is a power failure
4147           during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
4148           aligned to an erase sector boundary.
4149
4150         - CONFIG_ENV_SPI_BUS (optional):
4151         - CONFIG_ENV_SPI_CS (optional):
4152
4153           Define the SPI bus and chip select. If not defined they will be 0.
4154
4155         - CONFIG_ENV_SPI_MAX_HZ (optional):
4156
4157           Define the SPI max work clock. If not defined then use 1MHz.
4158
4159         - CONFIG_ENV_SPI_MODE (optional):
4160
4161           Define the SPI work mode. If not defined then use SPI_MODE_3.
4162
4163 - CONFIG_ENV_IS_IN_REMOTE:
4164
4165         Define this if you have a remote memory space which you
4166         want to use for the local device's environment.
4167
4168         - CONFIG_ENV_ADDR:
4169         - CONFIG_ENV_SIZE:
4170
4171           These two #defines specify the address and size of the
4172           environment area within the remote memory space. The
4173           local device can get the environment from remote memory
4174           space by SRIO or PCIE links.
4175
4176 BE CAREFUL! For some special cases, the local device can not use
4177 "saveenv" command. For example, the local device will get the
4178 environment stored in a remote NOR flash by SRIO or PCIE link,
4179 but it can not erase, write this NOR flash by SRIO or PCIE interface.
4180
4181 - CONFIG_ENV_IS_IN_NAND:
4182
4183         Define this if you have a NAND device which you want to use
4184         for the environment.
4185
4186         - CONFIG_ENV_OFFSET:
4187         - CONFIG_ENV_SIZE:
4188
4189           These two #defines specify the offset and size of the environment
4190           area within the first NAND device.  CONFIG_ENV_OFFSET must be
4191           aligned to an erase block boundary.
4192
4193         - CONFIG_ENV_OFFSET_REDUND (optional):
4194
4195           This setting describes a second storage area of CONFIG_ENV_SIZE
4196           size used to hold a redundant copy of the environment data, so
4197           that there is a valid backup copy in case there is a power failure
4198           during a "saveenv" operation.  CONFIG_ENV_OFFSET_REDUND must be
4199           aligned to an erase block boundary.
4200
4201         - CONFIG_ENV_RANGE (optional):
4202
4203           Specifies the length of the region in which the environment
4204           can be written.  This should be a multiple of the NAND device's
4205           block size.  Specifying a range with more erase blocks than
4206           are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4207           the range to be avoided.
4208
4209         - CONFIG_ENV_OFFSET_OOB (optional):
4210
4211           Enables support for dynamically retrieving the offset of the
4212           environment from block zero's out-of-band data.  The
4213           "nand env.oob" command can be used to record this offset.
4214           Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4215           using CONFIG_ENV_OFFSET_OOB.
4216
4217 - CONFIG_NAND_ENV_DST
4218
4219         Defines address in RAM to which the nand_spl code should copy the
4220         environment. If redundant environment is used, it will be copied to
4221         CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4222
4223 - CONFIG_ENV_IS_IN_UBI:
4224
4225         Define this if you have an UBI volume that you want to use for the
4226         environment.  This has the benefit of wear-leveling the environment
4227         accesses, which is important on NAND.
4228
4229         - CONFIG_ENV_UBI_PART:
4230
4231           Define this to a string that is the mtd partition containing the UBI.
4232
4233         - CONFIG_ENV_UBI_VOLUME:
4234
4235           Define this to the name of the volume that you want to store the
4236           environment in.
4237
4238         - CONFIG_ENV_UBI_VOLUME_REDUND:
4239
4240           Define this to the name of another volume to store a second copy of
4241           the environment in.  This will enable redundant environments in UBI.
4242           It is assumed that both volumes are in the same MTD partition.
4243
4244         - CONFIG_UBI_SILENCE_MSG
4245         - CONFIG_UBIFS_SILENCE_MSG
4246
4247           You will probably want to define these to avoid a really noisy system
4248           when storing the env in UBI.
4249
4250 - CONFIG_ENV_IS_IN_FAT:
4251        Define this if you want to use the FAT file system for the environment.
4252
4253        - FAT_ENV_INTERFACE:
4254
4255          Define this to a string that is the name of the block device.
4256
4257        - FAT_ENV_DEV_AND_PART:
4258
4259          Define this to a string to specify the partition of the device. It can
4260          be as following:
4261
4262            "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4263                - "D:P": device D partition P. Error occurs if device D has no
4264                         partition table.
4265                - "D:0": device D.
4266                - "D" or "D:": device D partition 1 if device D has partition
4267                               table, or the whole device D if has no partition
4268                               table.
4269                - "D:auto": first partition in device D with bootable flag set.
4270                            If none, first valid partition in device D. If no
4271                            partition table then means device D.
4272
4273        - FAT_ENV_FILE:
4274
4275          It's a string of the FAT file name. This file use to store the
4276          environment.
4277
4278        - CONFIG_FAT_WRITE:
4279          This should be defined. Otherwise it cannot save the environment file.
4280
4281 - CONFIG_ENV_IS_IN_MMC:
4282
4283         Define this if you have an MMC device which you want to use for the
4284         environment.
4285
4286         - CONFIG_SYS_MMC_ENV_DEV:
4287
4288           Specifies which MMC device the environment is stored in.
4289
4290         - CONFIG_SYS_MMC_ENV_PART (optional):
4291
4292           Specifies which MMC partition the environment is stored in. If not
4293           set, defaults to partition 0, the user area. Common values might be
4294           1 (first MMC boot partition), 2 (second MMC boot partition).
4295
4296         - CONFIG_ENV_OFFSET:
4297         - CONFIG_ENV_SIZE:
4298
4299           These two #defines specify the offset and size of the environment
4300           area within the specified MMC device.
4301
4302           If offset is positive (the usual case), it is treated as relative to
4303           the start of the MMC partition. If offset is negative, it is treated
4304           as relative to the end of the MMC partition. This can be useful if
4305           your board may be fitted with different MMC devices, which have
4306           different sizes for the MMC partitions, and you always want the
4307           environment placed at the very end of the partition, to leave the
4308           maximum possible space before it, to store other data.
4309
4310           These two values are in units of bytes, but must be aligned to an
4311           MMC sector boundary.
4312
4313         - CONFIG_ENV_OFFSET_REDUND (optional):
4314
4315           Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4316           hold a redundant copy of the environment data. This provides a
4317           valid backup copy in case the other copy is corrupted, e.g. due
4318           to a power failure during a "saveenv" operation.
4319
4320           This value may also be positive or negative; this is handled in the
4321           same way as CONFIG_ENV_OFFSET.
4322
4323           This value is also in units of bytes, but must also be aligned to
4324           an MMC sector boundary.
4325
4326         - CONFIG_ENV_SIZE_REDUND (optional):
4327
4328           This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4329           set. If this value is set, it must be set to the same value as
4330           CONFIG_ENV_SIZE.
4331
4332 - CONFIG_SYS_SPI_INIT_OFFSET
4333
4334         Defines offset to the initial SPI buffer area in DPRAM. The
4335         area is used at an early stage (ROM part) if the environment
4336         is configured to reside in the SPI EEPROM: We need a 520 byte
4337         scratch DPRAM area. It is used between the two initialization
4338         calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4339         to be a good choice since it makes it far enough from the
4340         start of the data area as well as from the stack pointer.
4341
4342 Please note that the environment is read-only until the monitor
4343 has been relocated to RAM and a RAM copy of the environment has been
4344 created; also, when using EEPROM you will have to use getenv_f()
4345 until then to read environment variables.
4346
4347 The environment is protected by a CRC32 checksum. Before the monitor
4348 is relocated into RAM, as a result of a bad CRC you will be working
4349 with the compiled-in default environment - *silently*!!! [This is
4350 necessary, because the first environment variable we need is the
4351 "baudrate" setting for the console - if we have a bad CRC, we don't
4352 have any device yet where we could complain.]
4353
4354 Note: once the monitor has been relocated, then it will complain if
4355 the default environment is used; a new CRC is computed as soon as you
4356 use the "saveenv" command to store a valid environment.
4357
4358 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4359                 Echo the inverted Ethernet link state to the fault LED.
4360
4361                 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4362                       also needs to be defined.
4363
4364 - CONFIG_SYS_FAULT_MII_ADDR:
4365                 MII address of the PHY to check for the Ethernet link state.
4366
4367 - CONFIG_NS16550_MIN_FUNCTIONS:
4368                 Define this if you desire to only have use of the NS16550_init
4369                 and NS16550_putc functions for the serial driver located at
4370                 drivers/serial/ns16550.c.  This option is useful for saving
4371                 space for already greatly restricted images, including but not
4372                 limited to NAND_SPL configurations.
4373
4374 - CONFIG_DISPLAY_BOARDINFO
4375                 Display information about the board that U-Boot is running on
4376                 when U-Boot starts up. The board function checkboard() is called
4377                 to do this.
4378
4379 - CONFIG_DISPLAY_BOARDINFO_LATE
4380                 Similar to the previous option, but display this information
4381                 later, once stdio is running and output goes to the LCD, if
4382                 present.
4383
4384 - CONFIG_BOARD_SIZE_LIMIT:
4385                 Maximum size of the U-Boot image. When defined, the
4386                 build system checks that the actual size does not
4387                 exceed it.
4388
4389 Low Level (hardware related) configuration options:
4390 ---------------------------------------------------
4391
4392 - CONFIG_SYS_CACHELINE_SIZE:
4393                 Cache Line Size of the CPU.
4394
4395 - CONFIG_SYS_DEFAULT_IMMR:
4396                 Default address of the IMMR after system reset.
4397
4398                 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4399                 and RPXsuper) to be able to adjust the position of
4400                 the IMMR register after a reset.
4401
4402 - CONFIG_SYS_CCSRBAR_DEFAULT:
4403                 Default (power-on reset) physical address of CCSR on Freescale
4404                 PowerPC SOCs.
4405
4406 - CONFIG_SYS_CCSRBAR:
4407                 Virtual address of CCSR.  On a 32-bit build, this is typically
4408                 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4409
4410                 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4411                 for cross-platform code that uses that macro instead.
4412
4413 - CONFIG_SYS_CCSRBAR_PHYS:
4414                 Physical address of CCSR.  CCSR can be relocated to a new
4415                 physical address, if desired.  In this case, this macro should
4416                 be set to that address.  Otherwise, it should be set to the
4417                 same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4418                 is typically relocated on 36-bit builds.  It is recommended
4419                 that this macro be defined via the _HIGH and _LOW macros:
4420
4421                 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4422                         * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4423
4424 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4425                 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.  This value is typically
4426                 either 0 (32-bit build) or 0xF (36-bit build).  This macro is
4427                 used in assembly code, so it must not contain typecasts or
4428                 integer size suffixes (e.g. "ULL").
4429
4430 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
4431                 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4432                 used in assembly code, so it must not contain typecasts or
4433                 integer size suffixes (e.g. "ULL").
4434
4435 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4436                 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4437                 forced to a value that ensures that CCSR is not relocated.
4438
4439 - Floppy Disk Support:
4440                 CONFIG_SYS_FDC_DRIVE_NUMBER
4441
4442                 the default drive number (default value 0)
4443
4444                 CONFIG_SYS_ISA_IO_STRIDE
4445
4446                 defines the spacing between FDC chipset registers
4447                 (default value 1)
4448
4449                 CONFIG_SYS_ISA_IO_OFFSET
4450
4451                 defines the offset of register from address. It
4452                 depends on which part of the data bus is connected to
4453                 the FDC chipset. (default value 0)
4454
4455                 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4456                 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
4457                 default value.
4458
4459                 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
4460                 fdc_hw_init() is called at the beginning of the FDC
4461                 setup. fdc_hw_init() must be provided by the board
4462                 source code. It is used to make hardware-dependent
4463                 initializations.
4464
4465 - CONFIG_IDE_AHB:
4466                 Most IDE controllers were designed to be connected with PCI
4467                 interface. Only few of them were designed for AHB interface.
4468                 When software is doing ATA command and data transfer to
4469                 IDE devices through IDE-AHB controller, some additional
4470                 registers accessing to these kind of IDE-AHB controller
4471                 is required.
4472
4473 - CONFIG_SYS_IMMR:      Physical address of the Internal Memory.
4474                 DO NOT CHANGE unless you know exactly what you're
4475                 doing! (11-4) [MPC8xx/82xx systems only]
4476
4477 - CONFIG_SYS_INIT_RAM_ADDR:
4478
4479                 Start address of memory area that can be used for
4480                 initial data and stack; please note that this must be
4481                 writable memory that is working WITHOUT special
4482                 initialization, i. e. you CANNOT use normal RAM which
4483                 will become available only after programming the
4484                 memory controller and running certain initialization
4485                 sequences.
4486
4487                 U-Boot uses the following memory types:
4488                 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4489                 - MPC824X: data cache
4490                 - PPC4xx:  data cache
4491
4492 - CONFIG_SYS_GBL_DATA_OFFSET:
4493
4494                 Offset of the initial data structure in the memory
4495                 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4496                 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4497                 data is located at the end of the available space
4498                 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
4499                 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4500                 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4501                 CONFIG_SYS_GBL_DATA_OFFSET) downward.
4502
4503         Note:
4504                 On the MPC824X (or other systems that use the data
4505                 cache for initial memory) the address chosen for
4506                 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4507                 point to an otherwise UNUSED address space between
4508                 the top of RAM and the start of the PCI space.
4509
4510 - CONFIG_SYS_SIUMCR:    SIU Module Configuration (11-6)
4511
4512 - CONFIG_SYS_SYPCR:     System Protection Control (11-9)
4513
4514 - CONFIG_SYS_TBSCR:     Time Base Status and Control (11-26)
4515
4516 - CONFIG_SYS_PISCR:     Periodic Interrupt Status and Control (11-31)
4517
4518 - CONFIG_SYS_PLPRCR:    PLL, Low-Power, and Reset Control Register (15-30)
4519
4520 - CONFIG_SYS_SCCR:      System Clock and reset Control Register (15-27)
4521
4522 - CONFIG_SYS_OR_TIMING_SDRAM:
4523                 SDRAM timing
4524
4525 - CONFIG_SYS_MAMR_PTA:
4526                 periodic timer for refresh
4527
4528 - CONFIG_SYS_DER:       Debug Event Register (37-47)
4529
4530 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4531   CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4532   CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4533   CONFIG_SYS_BR1_PRELIM:
4534                 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4535
4536 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
4537   CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4538   CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4539                 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4540
4541 - CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4542   CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4543                 Machine Mode Register and Memory Periodic Timer
4544                 Prescaler definitions (SDRAM timing)
4545
4546 - CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4547                 enable I2C microcode relocation patch (MPC8xx);
4548                 define relocation offset in DPRAM [DSP2]
4549
4550 - CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4551                 enable SMC microcode relocation patch (MPC8xx);
4552                 define relocation offset in DPRAM [SMC1]
4553
4554 - CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4555                 enable SPI microcode relocation patch (MPC8xx);
4556                 define relocation offset in DPRAM [SCC4]
4557
4558 - CONFIG_SYS_USE_OSCCLK:
4559                 Use OSCM clock mode on MBX8xx board. Be careful,
4560                 wrong setting might damage your board. Read
4561                 doc/README.MBX before setting this variable!
4562
4563 - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4564                 Offset of the bootmode word in DPRAM used by post
4565                 (Power On Self Tests). This definition overrides
4566                 #define'd default value in commproc.h resp.
4567                 cpm_8260.h.
4568
4569 - CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4570   CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4571   CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4572   CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4573   CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4574   CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4575   CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4576   CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4577                 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
4578
4579 - CONFIG_PCI_DISABLE_PCIE:
4580                 Disable PCI-Express on systems where it is supported but not
4581                 required.
4582
4583 - CONFIG_PCI_ENUM_ONLY
4584                 Only scan through and get the devices on the buses.
4585                 Don't do any setup work, presumably because someone or
4586                 something has already done it, and we don't need to do it
4587                 a second time.  Useful for platforms that are pre-booted
4588                 by coreboot or similar.
4589
4590 - CONFIG_PCI_INDIRECT_BRIDGE:
4591                 Enable support for indirect PCI bridges.
4592
4593 - CONFIG_SYS_SRIO:
4594                 Chip has SRIO or not
4595
4596 - CONFIG_SRIO1:
4597                 Board has SRIO 1 port available
4598
4599 - CONFIG_SRIO2:
4600                 Board has SRIO 2 port available
4601
4602 - CONFIG_SRIO_PCIE_BOOT_MASTER
4603                 Board can support master function for Boot from SRIO and PCIE
4604
4605 - CONFIG_SYS_SRIOn_MEM_VIRT:
4606                 Virtual Address of SRIO port 'n' memory region
4607
4608 - CONFIG_SYS_SRIOn_MEM_PHYS:
4609                 Physical Address of SRIO port 'n' memory region
4610
4611 - CONFIG_SYS_SRIOn_MEM_SIZE:
4612                 Size of SRIO port 'n' memory region
4613
4614 - CONFIG_SYS_NAND_BUSWIDTH_16BIT
4615                 Defined to tell the NAND controller that the NAND chip is using
4616                 a 16 bit bus.
4617                 Not all NAND drivers use this symbol.
4618                 Example of drivers that use it:
4619                 - drivers/mtd/nand/ndfc.c
4620                 - drivers/mtd/nand/mxc_nand.c
4621
4622 - CONFIG_SYS_NDFC_EBC0_CFG
4623                 Sets the EBC0_CFG register for the NDFC. If not defined
4624                 a default value will be used.
4625
4626 - CONFIG_SPD_EEPROM
4627                 Get DDR timing information from an I2C EEPROM. Common
4628                 with pluggable memory modules such as SODIMMs
4629
4630   SPD_EEPROM_ADDRESS
4631                 I2C address of the SPD EEPROM
4632
4633 - CONFIG_SYS_SPD_BUS_NUM
4634                 If SPD EEPROM is on an I2C bus other than the first
4635                 one, specify here. Note that the value must resolve
4636                 to something your driver can deal with.
4637
4638 - CONFIG_SYS_DDR_RAW_TIMING
4639                 Get DDR timing information from other than SPD. Common with
4640                 soldered DDR chips onboard without SPD. DDR raw timing
4641                 parameters are extracted from datasheet and hard-coded into
4642                 header files or board specific files.
4643
4644 - CONFIG_FSL_DDR_INTERACTIVE
4645                 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4646
4647 - CONFIG_FSL_DDR_SYNC_REFRESH
4648                 Enable sync of refresh for multiple controllers.
4649
4650 - CONFIG_FSL_DDR_BIST
4651                 Enable built-in memory test for Freescale DDR controllers.
4652
4653 - CONFIG_SYS_83XX_DDR_USES_CS0
4654                 Only for 83xx systems. If specified, then DDR should
4655                 be configured using CS0 and CS1 instead of CS2 and CS3.
4656
4657 - CONFIG_ETHER_ON_FEC[12]
4658                 Define to enable FEC[12] on a 8xx series processor.
4659
4660 - CONFIG_FEC[12]_PHY
4661                 Define to the hardcoded PHY address which corresponds
4662                 to the given FEC; i. e.
4663                         #define CONFIG_FEC1_PHY 4
4664                 means that the PHY with address 4 is connected to FEC1
4665
4666                 When set to -1, means to probe for first available.
4667
4668 - CONFIG_FEC[12]_PHY_NORXERR
4669                 The PHY does not have a RXERR line (RMII only).
4670                 (so program the FEC to ignore it).
4671
4672 - CONFIG_RMII
4673                 Enable RMII mode for all FECs.
4674                 Note that this is a global option, we can't
4675                 have one FEC in standard MII mode and another in RMII mode.
4676
4677 - CONFIG_CRC32_VERIFY
4678                 Add a verify option to the crc32 command.
4679                 The syntax is:
4680
4681                 => crc32 -v <address> <count> <crc32>
4682
4683                 Where address/count indicate a memory area
4684                 and crc32 is the correct crc32 which the
4685                 area should have.
4686
4687 - CONFIG_LOOPW
4688                 Add the "loopw" memory command. This only takes effect if
4689                 the memory commands are activated globally (CONFIG_CMD_MEM).
4690
4691 - CONFIG_MX_CYCLIC
4692                 Add the "mdc" and "mwc" memory commands. These are cyclic
4693                 "md/mw" commands.
4694                 Examples:
4695
4696                 => mdc.b 10 4 500
4697                 This command will print 4 bytes (10,11,12,13) each 500 ms.
4698
4699                 => mwc.l 100 12345678 10
4700                 This command will write 12345678 to address 100 all 10 ms.
4701
4702                 This only takes effect if the memory commands are activated
4703                 globally (CONFIG_CMD_MEM).
4704
4705 - CONFIG_SKIP_LOWLEVEL_INIT
4706                 [ARM, NDS32, MIPS only] If this variable is defined, then certain
4707                 low level initializations (like setting up the memory
4708                 controller) are omitted and/or U-Boot does not
4709                 relocate itself into RAM.
4710
4711                 Normally this variable MUST NOT be defined. The only
4712                 exception is when U-Boot is loaded (to RAM) by some
4713                 other boot loader or by a debugger which performs
4714                 these initializations itself.
4715
4716 - CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4717                 [ARM926EJ-S only] This allows just the call to lowlevel_init()
4718                 to be skipped. The normal CP15 init (such as enabling the
4719                 instruction cache) is still performed.
4720
4721 - CONFIG_SPL_BUILD
4722                 Modifies the behaviour of start.S when compiling a loader
4723                 that is executed before the actual U-Boot. E.g. when
4724                 compiling a NAND SPL.
4725
4726 - CONFIG_TPL_BUILD
4727                 Modifies the behaviour of start.S  when compiling a loader
4728                 that is executed after the SPL and before the actual U-Boot.
4729                 It is loaded by the SPL.
4730
4731 - CONFIG_SYS_MPC85XX_NO_RESETVEC
4732                 Only for 85xx systems. If this variable is specified, the section
4733                 .resetvec is not kept and the section .bootpg is placed in the
4734                 previous 4k of the .text section.
4735
4736 - CONFIG_ARCH_MAP_SYSMEM
4737                 Generally U-Boot (and in particular the md command) uses
4738                 effective address. It is therefore not necessary to regard
4739                 U-Boot address as virtual addresses that need to be translated
4740                 to physical addresses. However, sandbox requires this, since
4741                 it maintains its own little RAM buffer which contains all
4742                 addressable memory. This option causes some memory accesses
4743                 to be mapped through map_sysmem() / unmap_sysmem().
4744
4745 - CONFIG_USE_ARCH_MEMCPY
4746   CONFIG_USE_ARCH_MEMSET
4747                 If these options are used a optimized version of memcpy/memset will
4748                 be used if available. These functions may be faster under some
4749                 conditions but may increase the binary size.
4750
4751 - CONFIG_X86_RESET_VECTOR
4752                 If defined, the x86 reset vector code is included. This is not
4753                 needed when U-Boot is running from Coreboot.
4754
4755 - CONFIG_SYS_MPUCLK
4756                 Defines the MPU clock speed (in MHz).
4757
4758                 NOTE : currently only supported on AM335x platforms.
4759
4760 - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4761                 Enables the RTC32K OSC on AM33xx based plattforms
4762
4763 - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4764                 Option to disable subpage write in NAND driver
4765                 driver that uses this:
4766                 drivers/mtd/nand/davinci_nand.c
4767
4768 Freescale QE/FMAN Firmware Support:
4769 -----------------------------------
4770
4771 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4772 loading of "firmware", which is encoded in the QE firmware binary format.
4773 This firmware often needs to be loaded during U-Boot booting, so macros
4774 are used to identify the storage device (NOR flash, SPI, etc) and the address
4775 within that device.
4776
4777 - CONFIG_SYS_FMAN_FW_ADDR
4778         The address in the storage device where the FMAN microcode is located.  The
4779         meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4780         is also specified.
4781
4782 - CONFIG_SYS_QE_FW_ADDR
4783         The address in the storage device where the QE microcode is located.  The
4784         meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4785         is also specified.
4786
4787 - CONFIG_SYS_QE_FMAN_FW_LENGTH
4788         The maximum possible size of the firmware.  The firmware binary format
4789         has a field that specifies the actual size of the firmware, but it
4790         might not be possible to read any part of the firmware unless some
4791         local storage is allocated to hold the entire firmware first.
4792
4793 - CONFIG_SYS_QE_FMAN_FW_IN_NOR
4794         Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4795         normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4796         virtual address in NOR flash.
4797
4798 - CONFIG_SYS_QE_FMAN_FW_IN_NAND
4799         Specifies that QE/FMAN firmware is located in NAND flash.
4800         CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4801
4802 - CONFIG_SYS_QE_FMAN_FW_IN_MMC
4803         Specifies that QE/FMAN firmware is located on the primary SD/MMC
4804         device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4805
4806 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4807         Specifies that QE/FMAN firmware is located in the remote (master)
4808         memory space.   CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4809         can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4810         window->master inbound window->master LAW->the ucode address in
4811         master's memory space.
4812
4813 Freescale Layerscape Management Complex Firmware Support:
4814 ---------------------------------------------------------
4815 The Freescale Layerscape Management Complex (MC) supports the loading of
4816 "firmware".
4817 This firmware often needs to be loaded during U-Boot booting, so macros
4818 are used to identify the storage device (NOR flash, SPI, etc) and the address
4819 within that device.
4820
4821 - CONFIG_FSL_MC_ENET
4822         Enable the MC driver for Layerscape SoCs.
4823
4824 Freescale Layerscape Debug Server Support:
4825 -------------------------------------------
4826 The Freescale Layerscape Debug Server Support supports the loading of
4827 "Debug Server firmware" and triggering SP boot-rom.
4828 This firmware often needs to be loaded during U-Boot booting.
4829
4830 - CONFIG_SYS_MC_RSV_MEM_ALIGN
4831         Define alignment of reserved memory MC requires
4832
4833 Reproducible builds
4834 -------------------
4835
4836 In order to achieve reproducible builds, timestamps used in the U-Boot build
4837 process have to be set to a fixed value.
4838
4839 This is done using the SOURCE_DATE_EPOCH environment variable.
4840 SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4841 option for U-Boot or an environment variable in U-Boot.
4842
4843 SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4844
4845 Building the Software:
4846 ======================
4847
4848 Building U-Boot has been tested in several native build environments
4849 and in many different cross environments. Of course we cannot support
4850 all possibly existing versions of cross development tools in all
4851 (potentially obsolete) versions. In case of tool chain problems we
4852 recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4853 which is extensively used to build and test U-Boot.
4854
4855 If you are not using a native environment, it is assumed that you
4856 have GNU cross compiling tools available in your path. In this case,
4857 you must set the environment variable CROSS_COMPILE in your shell.
4858 Note that no changes to the Makefile or any other source files are
4859 necessary. For example using the ELDK on a 4xx CPU, please enter:
4860
4861         $ CROSS_COMPILE=ppc_4xx-
4862         $ export CROSS_COMPILE
4863
4864 Note: If you wish to generate Windows versions of the utilities in
4865       the tools directory you can use the MinGW toolchain
4866       (http://www.mingw.org).  Set your HOST tools to the MinGW
4867       toolchain and execute 'make tools'.  For example:
4868
4869        $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4870
4871       Binaries such as tools/mkimage.exe will be created which can
4872       be executed on computers running Windows.
4873
4874 U-Boot is intended to be simple to build. After installing the
4875 sources you must configure U-Boot for one specific board type. This
4876 is done by typing:
4877
4878         make NAME_defconfig
4879
4880 where "NAME_defconfig" is the name of one of the existing configu-
4881 rations; see boards.cfg for supported names.
4882
4883 Note: for some board special configuration names may exist; check if
4884       additional information is available from the board vendor; for
4885       instance, the TQM823L systems are available without (standard)
4886       or with LCD support. You can select such additional "features"
4887       when choosing the configuration, i. e.
4888
4889       make TQM823L_defconfig
4890         - will configure for a plain TQM823L, i. e. no LCD support
4891
4892       make TQM823L_LCD_defconfig
4893         - will configure for a TQM823L with U-Boot console on LCD
4894
4895       etc.
4896
4897
4898 Finally, type "make all", and you should get some working U-Boot
4899 images ready for download to / installation on your system:
4900
4901 - "u-boot.bin" is a raw binary image
4902 - "u-boot" is an image in ELF binary format
4903 - "u-boot.srec" is in Motorola S-Record format
4904
4905 By default the build is performed locally and the objects are saved
4906 in the source directory. One of the two methods can be used to change
4907 this behavior and build U-Boot to some external directory:
4908
4909 1. Add O= to the make command line invocations:
4910
4911         make O=/tmp/build distclean
4912         make O=/tmp/build NAME_defconfig
4913         make O=/tmp/build all
4914
4915 2. Set environment variable KBUILD_OUTPUT to point to the desired location:
4916
4917         export KBUILD_OUTPUT=/tmp/build
4918         make distclean
4919         make NAME_defconfig
4920         make all
4921
4922 Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
4923 variable.
4924
4925
4926 Please be aware that the Makefiles assume you are using GNU make, so
4927 for instance on NetBSD you might need to use "gmake" instead of
4928 native "make".
4929
4930
4931 If the system board that you have is not listed, then you will need
4932 to port U-Boot to your hardware platform. To do this, follow these
4933 steps:
4934
4935 1.  Create a new directory to hold your board specific code. Add any
4936     files you need. In your board directory, you will need at least
4937     the "Makefile" and a "<board>.c".
4938 2.  Create a new configuration file "include/configs/<board>.h" for
4939     your board.
4940 3.  If you're porting U-Boot to a new CPU, then also create a new
4941     directory to hold your CPU specific code. Add any files you need.
4942 4.  Run "make <board>_defconfig" with your new name.
4943 5.  Type "make", and you should get a working "u-boot.srec" file
4944     to be installed on your target system.
4945 6.  Debug and solve any problems that might arise.
4946     [Of course, this last step is much harder than it sounds.]
4947
4948
4949 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4950 ==============================================================
4951
4952 If you have modified U-Boot sources (for instance added a new board
4953 or support for new devices, a new CPU, etc.) you are expected to
4954 provide feedback to the other developers. The feedback normally takes
4955 the form of a "patch", i. e. a context diff against a certain (latest
4956 official or latest in the git repository) version of U-Boot sources.
4957
4958 But before you submit such a patch, please verify that your modifi-
4959 cation did not break existing code. At least make sure that *ALL* of
4960 the supported boards compile WITHOUT ANY compiler warnings. To do so,
4961 just run the buildman script (tools/buildman/buildman), which will
4962 configure and build U-Boot for ALL supported system. Be warned, this
4963 will take a while. Please see the buildman README, or run 'buildman -H'
4964 for documentation.
4965
4966
4967 See also "U-Boot Porting Guide" below.
4968
4969
4970 Monitor Commands - Overview:
4971 ============================
4972
4973 go      - start application at address 'addr'
4974 run     - run commands in an environment variable
4975 bootm   - boot application image from memory
4976 bootp   - boot image via network using BootP/TFTP protocol
4977 bootz   - boot zImage from memory
4978 tftpboot- boot image via network using TFTP protocol
4979                and env variables "ipaddr" and "serverip"
4980                (and eventually "gatewayip")
4981 tftpput - upload a file via network using TFTP protocol
4982 rarpboot- boot image via network using RARP/TFTP protocol
4983 diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4984 loads   - load S-Record file over serial line
4985 loadb   - load binary file over serial line (kermit mode)
4986 md      - memory display
4987 mm      - memory modify (auto-incrementing)
4988 nm      - memory modify (constant address)
4989 mw      - memory write (fill)
4990 cp      - memory copy
4991 cmp     - memory compare
4992 crc32   - checksum calculation
4993 i2c     - I2C sub-system
4994 sspi    - SPI utility commands
4995 base    - print or set address offset
4996 printenv- print environment variables
4997 setenv  - set environment variables
4998 saveenv - save environment variables to persistent storage
4999 protect - enable or disable FLASH write protection
5000 erase   - erase FLASH memory
5001 flinfo  - print FLASH memory information
5002 nand    - NAND memory operations (see doc/README.nand)
5003 bdinfo  - print Board Info structure
5004 iminfo  - print header information for application image
5005 coninfo - print console devices and informations
5006 ide     - IDE sub-system
5007 loop    - infinite loop on address range
5008 loopw   - infinite write loop on address range
5009 mtest   - simple RAM test
5010 icache  - enable or disable instruction cache
5011 dcache  - enable or disable data cache
5012 reset   - Perform RESET of the CPU
5013 echo    - echo args to console
5014 version - print monitor version
5015 help    - print online help
5016 ?       - alias for 'help'
5017
5018
5019 Monitor Commands - Detailed Description:
5020 ========================================
5021
5022 TODO.
5023
5024 For now: just type "help <command>".
5025
5026
5027 Environment Variables:
5028 ======================
5029
5030 U-Boot supports user configuration using Environment Variables which
5031 can be made persistent by saving to Flash memory.
5032
5033 Environment Variables are set using "setenv", printed using
5034 "printenv", and saved to Flash using "saveenv". Using "setenv"
5035 without a value can be used to delete a variable from the
5036 environment. As long as you don't save the environment you are
5037 working with an in-memory copy. In case the Flash area containing the
5038 environment is erased by accident, a default environment is provided.
5039
5040 Some configuration options can be set using Environment Variables.
5041
5042 List of environment variables (most likely not complete):
5043
5044   baudrate      - see CONFIG_BAUDRATE
5045
5046   bootdelay     - see CONFIG_BOOTDELAY
5047
5048   bootcmd       - see CONFIG_BOOTCOMMAND
5049
5050   bootargs      - Boot arguments when booting an RTOS image
5051
5052   bootfile      - Name of the image to load with TFTP
5053
5054   bootm_low     - Memory range available for image processing in the bootm
5055                   command can be restricted. This variable is given as
5056                   a hexadecimal number and defines lowest address allowed
5057                   for use by the bootm command. See also "bootm_size"
5058                   environment variable. Address defined by "bootm_low" is
5059                   also the base of the initial memory mapping for the Linux
5060                   kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5061                   bootm_mapsize.
5062
5063   bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5064                   This variable is given as a hexadecimal number and it
5065                   defines the size of the memory region starting at base
5066                   address bootm_low that is accessible by the Linux kernel
5067                   during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5068                   as the default value if it is defined, and bootm_size is
5069                   used otherwise.
5070
5071   bootm_size    - Memory range available for image processing in the bootm
5072                   command can be restricted. This variable is given as
5073                   a hexadecimal number and defines the size of the region
5074                   allowed for use by the bootm command. See also "bootm_low"
5075                   environment variable.
5076
5077   updatefile    - Location of the software update file on a TFTP server, used
5078                   by the automatic software update feature. Please refer to
5079                   documentation in doc/README.update for more details.
5080
5081   autoload      - if set to "no" (any string beginning with 'n'),
5082                   "bootp" will just load perform a lookup of the
5083                   configuration from the BOOTP server, but not try to
5084                   load any image using TFTP
5085
5086   autostart     - if set to "yes", an image loaded using the "bootp",
5087                   "rarpboot", "tftpboot" or "diskboot" commands will
5088                   be automatically started (by internally calling
5089                   "bootm")
5090
5091                   If set to "no", a standalone image passed to the
5092                   "bootm" command will be copied to the load address
5093                   (and eventually uncompressed), but NOT be started.
5094                   This can be used to load and uncompress arbitrary
5095                   data.
5096
5097   fdt_high      - if set this restricts the maximum address that the
5098                   flattened device tree will be copied into upon boot.
5099                   For example, if you have a system with 1 GB memory
5100                   at physical address 0x10000000, while Linux kernel
5101                   only recognizes the first 704 MB as low memory, you
5102                   may need to set fdt_high as 0x3C000000 to have the
5103                   device tree blob be copied to the maximum address
5104                   of the 704 MB low memory, so that Linux kernel can
5105                   access it during the boot procedure.
5106
5107                   If this is set to the special value 0xFFFFFFFF then
5108                   the fdt will not be copied at all on boot.  For this
5109                   to work it must reside in writable memory, have
5110                   sufficient padding on the end of it for u-boot to
5111                   add the information it needs into it, and the memory
5112                   must be accessible by the kernel.
5113
5114   fdtcontroladdr- if set this is the address of the control flattened
5115                   device tree used by U-Boot when CONFIG_OF_CONTROL is
5116                   defined.
5117
5118   i2cfast       - (PPC405GP|PPC405EP only)
5119                   if set to 'y' configures Linux I2C driver for fast
5120                   mode (400kHZ). This environment variable is used in
5121                   initialization code. So, for changes to be effective
5122                   it must be saved and board must be reset.
5123
5124   initrd_high   - restrict positioning of initrd images:
5125                   If this variable is not set, initrd images will be
5126                   copied to the highest possible address in RAM; this
5127                   is usually what you want since it allows for
5128                   maximum initrd size. If for some reason you want to
5129                   make sure that the initrd image is loaded below the
5130                   CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5131                   variable to a value of "no" or "off" or "0".
5132                   Alternatively, you can set it to a maximum upper
5133                   address to use (U-Boot will still check that it
5134                   does not overwrite the U-Boot stack and data).
5135
5136                   For instance, when you have a system with 16 MB
5137                   RAM, and want to reserve 4 MB from use by Linux,
5138                   you can do this by adding "mem=12M" to the value of
5139                   the "bootargs" variable. However, now you must make
5140                   sure that the initrd image is placed in the first
5141                   12 MB as well - this can be done with
5142
5143                   setenv initrd_high 00c00000
5144
5145                   If you set initrd_high to 0xFFFFFFFF, this is an
5146                   indication to U-Boot that all addresses are legal
5147                   for the Linux kernel, including addresses in flash
5148                   memory. In this case U-Boot will NOT COPY the
5149                   ramdisk at all. This may be useful to reduce the
5150                   boot time on your system, but requires that this
5151                   feature is supported by your Linux kernel.
5152
5153   ipaddr        - IP address; needed for tftpboot command
5154
5155   loadaddr      - Default load address for commands like "bootp",
5156                   "rarpboot", "tftpboot", "loadb" or "diskboot"
5157
5158   loads_echo    - see CONFIG_LOADS_ECHO
5159
5160   serverip      - TFTP server IP address; needed for tftpboot command
5161
5162   bootretry     - see CONFIG_BOOT_RETRY_TIME
5163
5164   bootdelaykey  - see CONFIG_AUTOBOOT_DELAY_STR
5165
5166   bootstopkey   - see CONFIG_AUTOBOOT_STOP_STR
5167
5168   ethprime      - controls which interface is used first.
5169
5170   ethact        - controls which interface is currently active.
5171                   For example you can do the following
5172
5173                   => setenv ethact FEC
5174                   => ping 192.168.0.1 # traffic sent on FEC
5175                   => setenv ethact SCC
5176                   => ping 10.0.0.1 # traffic sent on SCC
5177
5178   ethrotate     - When set to "no" U-Boot does not go through all
5179                   available network interfaces.
5180                   It just stays at the currently selected interface.
5181
5182   netretry      - When set to "no" each network operation will
5183                   either succeed or fail without retrying.
5184                   When set to "once" the network operation will
5185                   fail when all the available network interfaces
5186                   are tried once without success.
5187                   Useful on scripts which control the retry operation
5188                   themselves.
5189
5190   npe_ucode     - set load address for the NPE microcode
5191
5192   silent_linux  - If set then Linux will be told to boot silently, by
5193                   changing the console to be empty. If "yes" it will be
5194                   made silent. If "no" it will not be made silent. If
5195                   unset, then it will be made silent if the U-Boot console
5196                   is silent.
5197
5198   tftpsrcp      - If this is set, the value is used for TFTP's
5199                   UDP source port.
5200
5201   tftpdstp      - If this is set, the value is used for TFTP's UDP
5202                   destination port instead of the Well Know Port 69.
5203
5204   tftpblocksize - Block size to use for TFTP transfers; if not set,
5205                   we use the TFTP server's default block size
5206
5207   tftptimeout   - Retransmission timeout for TFTP packets (in milli-
5208                   seconds, minimum value is 1000 = 1 second). Defines
5209                   when a packet is considered to be lost so it has to
5210                   be retransmitted. The default is 5000 = 5 seconds.
5211                   Lowering this value may make downloads succeed
5212                   faster in networks with high packet loss rates or
5213                   with unreliable TFTP servers.
5214
5215   tftptimeoutcountmax   - maximum count of TFTP timeouts (no
5216                   unit, minimum value = 0). Defines how many timeouts
5217                   can happen during a single file transfer before that
5218                   transfer is aborted. The default is 10, and 0 means
5219                   'no timeouts allowed'. Increasing this value may help
5220                   downloads succeed with high packet loss rates, or with
5221                   unreliable TFTP servers or client hardware.
5222
5223   vlan          - When set to a value < 4095 the traffic over
5224                   Ethernet is encapsulated/received over 802.1q
5225                   VLAN tagged frames.
5226
5227   bootpretryperiod      - Period during which BOOTP/DHCP sends retries.
5228                   Unsigned value, in milliseconds. If not set, the period will
5229                   be either the default (28000), or a value based on
5230                   CONFIG_NET_RETRY_COUNT, if defined. This value has
5231                   precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5232
5233 The following image location variables contain the location of images
5234 used in booting. The "Image" column gives the role of the image and is
5235 not an environment variable name. The other columns are environment
5236 variable names. "File Name" gives the name of the file on a TFTP
5237 server, "RAM Address" gives the location in RAM the image will be
5238 loaded to, and "Flash Location" gives the image's address in NOR
5239 flash or offset in NAND flash.
5240
5241 *Note* - these variables don't have to be defined for all boards, some
5242 boards currently use other variables for these purposes, and some
5243 boards use these variables for other purposes.
5244
5245 Image               File Name        RAM Address       Flash Location
5246 -----               ---------        -----------       --------------
5247 u-boot              u-boot           u-boot_addr_r     u-boot_addr
5248 Linux kernel        bootfile         kernel_addr_r     kernel_addr
5249 device tree blob    fdtfile          fdt_addr_r        fdt_addr
5250 ramdisk             ramdiskfile      ramdisk_addr_r    ramdisk_addr
5251
5252 The following environment variables may be used and automatically
5253 updated by the network boot commands ("bootp" and "rarpboot"),
5254 depending the information provided by your boot server:
5255
5256   bootfile      - see above
5257   dnsip         - IP address of your Domain Name Server
5258   dnsip2        - IP address of your secondary Domain Name Server
5259   gatewayip     - IP address of the Gateway (Router) to use
5260   hostname      - Target hostname
5261   ipaddr        - see above
5262   netmask       - Subnet Mask
5263   rootpath      - Pathname of the root filesystem on the NFS server
5264   serverip      - see above
5265
5266
5267 There are two special Environment Variables:
5268
5269   serial#       - contains hardware identification information such
5270                   as type string and/or serial number
5271   ethaddr       - Ethernet address
5272
5273 These variables can be set only once (usually during manufacturing of
5274 the board). U-Boot refuses to delete or overwrite these variables
5275 once they have been set once.
5276
5277
5278 Further special Environment Variables:
5279
5280   ver           - Contains the U-Boot version string as printed
5281                   with the "version" command. This variable is
5282                   readonly (see CONFIG_VERSION_VARIABLE).
5283
5284
5285 Please note that changes to some configuration parameters may take
5286 only effect after the next boot (yes, that's just like Windoze :-).
5287
5288
5289 Callback functions for environment variables:
5290 ---------------------------------------------
5291
5292 For some environment variables, the behavior of u-boot needs to change
5293 when their values are changed.  This functionality allows functions to
5294 be associated with arbitrary variables.  On creation, overwrite, or
5295 deletion, the callback will provide the opportunity for some side
5296 effect to happen or for the change to be rejected.
5297
5298 The callbacks are named and associated with a function using the
5299 U_BOOT_ENV_CALLBACK macro in your board or driver code.
5300
5301 These callbacks are associated with variables in one of two ways.  The
5302 static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5303 in the board configuration to a string that defines a list of
5304 associations.  The list must be in the following format:
5305
5306         entry = variable_name[:callback_name]
5307         list = entry[,list]
5308
5309 If the callback name is not specified, then the callback is deleted.
5310 Spaces are also allowed anywhere in the list.
5311
5312 Callbacks can also be associated by defining the ".callbacks" variable
5313 with the same list format above.  Any association in ".callbacks" will
5314 override any association in the static list. You can define
5315 CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5316 ".callbacks" environment variable in the default or embedded environment.
5317
5318 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5319 regular expression. This allows multiple variables to be connected to
5320 the same callback without explicitly listing them all out.
5321
5322
5323 Command Line Parsing:
5324 =====================
5325
5326 There are two different command line parsers available with U-Boot:
5327 the old "simple" one, and the much more powerful "hush" shell:
5328
5329 Old, simple command line parser:
5330 --------------------------------
5331
5332 - supports environment variables (through setenv / saveenv commands)
5333 - several commands on one line, separated by ';'
5334 - variable substitution using "... ${name} ..." syntax
5335 - special characters ('$', ';') can be escaped by prefixing with '\',
5336   for example:
5337         setenv bootcmd bootm \${address}
5338 - You can also escape text by enclosing in single apostrophes, for example:
5339         setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5340
5341 Hush shell:
5342 -----------
5343
5344 - similar to Bourne shell, with control structures like
5345   if...then...else...fi, for...do...done; while...do...done,
5346   until...do...done, ...
5347 - supports environment ("global") variables (through setenv / saveenv
5348   commands) and local shell variables (through standard shell syntax
5349   "name=value"); only environment variables can be used with "run"
5350   command
5351
5352 General rules:
5353 --------------
5354
5355 (1) If a command line (or an environment variable executed by a "run"
5356     command) contains several commands separated by semicolon, and
5357     one of these commands fails, then the remaining commands will be
5358     executed anyway.
5359
5360 (2) If you execute several variables with one call to run (i. e.
5361     calling run with a list of variables as arguments), any failing
5362     command will cause "run" to terminate, i. e. the remaining
5363     variables are not executed.
5364
5365 Note for Redundant Ethernet Interfaces:
5366 =======================================
5367
5368 Some boards come with redundant Ethernet interfaces; U-Boot supports
5369 such configurations and is capable of automatic selection of a
5370 "working" interface when needed. MAC assignment works as follows:
5371
5372 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5373 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5374 "eth1addr" (=>eth1), "eth2addr", ...
5375
5376 If the network interface stores some valid MAC address (for instance
5377 in SROM), this is used as default address if there is NO correspon-
5378 ding setting in the environment; if the corresponding environment
5379 variable is set, this overrides the settings in the card; that means:
5380
5381 o If the SROM has a valid MAC address, and there is no address in the
5382   environment, the SROM's address is used.
5383
5384 o If there is no valid address in the SROM, and a definition in the
5385   environment exists, then the value from the environment variable is
5386   used.
5387
5388 o If both the SROM and the environment contain a MAC address, and
5389   both addresses are the same, this MAC address is used.
5390
5391 o If both the SROM and the environment contain a MAC address, and the
5392   addresses differ, the value from the environment is used and a
5393   warning is printed.
5394
5395 o If neither SROM nor the environment contain a MAC address, an error
5396   is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5397   a random, locally-assigned MAC is used.
5398
5399 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5400 will be programmed into hardware as part of the initialization process.  This
5401 may be skipped by setting the appropriate 'ethmacskip' environment variable.
5402 The naming convention is as follows:
5403 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5404
5405 Image Formats:
5406 ==============
5407
5408 U-Boot is capable of booting (and performing other auxiliary operations on)
5409 images in two formats:
5410
5411 New uImage format (FIT)
5412 -----------------------
5413
5414 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5415 to Flattened Device Tree). It allows the use of images with multiple
5416 components (several kernels, ramdisks, etc.), with contents protected by
5417 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5418
5419
5420 Old uImage format
5421 -----------------
5422
5423 Old image format is based on binary files which can be basically anything,
5424 preceded by a special header; see the definitions in include/image.h for
5425 details; basically, the header defines the following image properties:
5426
5427 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5428   4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5429   LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5430   Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5431   INTEGRITY).
5432 * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5433   IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5434   Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5435 * Compression Type (uncompressed, gzip, bzip2)
5436 * Load Address
5437 * Entry Point
5438 * Image Name
5439 * Image Timestamp
5440
5441 The header is marked by a special Magic Number, and both the header
5442 and the data portions of the image are secured against corruption by
5443 CRC32 checksums.
5444
5445
5446 Linux Support:
5447 ==============
5448
5449 Although U-Boot should support any OS or standalone application
5450 easily, the main focus has always been on Linux during the design of
5451 U-Boot.
5452
5453 U-Boot includes many features that so far have been part of some
5454 special "boot loader" code within the Linux kernel. Also, any
5455 "initrd" images to be used are no longer part of one big Linux image;
5456 instead, kernel and "initrd" are separate images. This implementation
5457 serves several purposes:
5458
5459 - the same features can be used for other OS or standalone
5460   applications (for instance: using compressed images to reduce the
5461   Flash memory footprint)
5462
5463 - it becomes much easier to port new Linux kernel versions because
5464   lots of low-level, hardware dependent stuff are done by U-Boot
5465
5466 - the same Linux kernel image can now be used with different "initrd"
5467   images; of course this also means that different kernel images can
5468   be run with the same "initrd". This makes testing easier (you don't
5469   have to build a new "zImage.initrd" Linux image when you just
5470   change a file in your "initrd"). Also, a field-upgrade of the
5471   software is easier now.
5472
5473
5474 Linux HOWTO:
5475 ============
5476
5477 Porting Linux to U-Boot based systems:
5478 ---------------------------------------
5479
5480 U-Boot cannot save you from doing all the necessary modifications to
5481 configure the Linux device drivers for use with your target hardware
5482 (no, we don't intend to provide a full virtual machine interface to
5483 Linux :-).
5484
5485 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5486
5487 Just make sure your machine specific header file (for instance
5488 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
5489 Information structure as we define in include/asm-<arch>/u-boot.h,
5490 and make sure that your definition of IMAP_ADDR uses the same value
5491 as your U-Boot configuration in CONFIG_SYS_IMMR.
5492
5493 Note that U-Boot now has a driver model, a unified model for drivers.
5494 If you are adding a new driver, plumb it into driver model. If there
5495 is no uclass available, you are encouraged to create one. See
5496 doc/driver-model.
5497
5498
5499 Configuring the Linux kernel:
5500 -----------------------------
5501
5502 No specific requirements for U-Boot. Make sure you have some root
5503 device (initial ramdisk, NFS) for your target system.
5504
5505
5506 Building a Linux Image:
5507 -----------------------
5508
5509 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5510 not used. If you use recent kernel source, a new build target
5511 "uImage" will exist which automatically builds an image usable by
5512 U-Boot. Most older kernels also have support for a "pImage" target,
5513 which was introduced for our predecessor project PPCBoot and uses a
5514 100% compatible format.
5515
5516 Example:
5517
5518         make TQM850L_defconfig
5519         make oldconfig
5520         make dep
5521         make uImage
5522
5523 The "uImage" build target uses a special tool (in 'tools/mkimage') to
5524 encapsulate a compressed Linux kernel image with header  information,
5525 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
5526
5527 * build a standard "vmlinux" kernel image (in ELF binary format):
5528
5529 * convert the kernel into a raw binary image:
5530
5531         ${CROSS_COMPILE}-objcopy -O binary \
5532                                  -R .note -R .comment \
5533                                  -S vmlinux linux.bin
5534
5535 * compress the binary image:
5536
5537         gzip -9 linux.bin
5538
5539 * package compressed binary image for U-Boot:
5540
5541         mkimage -A ppc -O linux -T kernel -C gzip \
5542                 -a 0 -e 0 -n "Linux Kernel Image" \
5543                 -d linux.bin.gz uImage
5544
5545
5546 The "mkimage" tool can also be used to create ramdisk images for use
5547 with U-Boot, either separated from the Linux kernel image, or
5548 combined into one file. "mkimage" encapsulates the images with a 64
5549 byte header containing information about target architecture,
5550 operating system, image type, compression method, entry points, time
5551 stamp, CRC32 checksums, etc.
5552
5553 "mkimage" can be called in two ways: to verify existing images and
5554 print the header information, or to build new images.
5555
5556 In the first form (with "-l" option) mkimage lists the information
5557 contained in the header of an existing U-Boot image; this includes
5558 checksum verification:
5559
5560         tools/mkimage -l image
5561           -l ==> list image header information
5562
5563 The second form (with "-d" option) is used to build a U-Boot image
5564 from a "data file" which is used as image payload:
5565
5566         tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5567                       -n name -d data_file image
5568           -A ==> set architecture to 'arch'
5569           -O ==> set operating system to 'os'
5570           -T ==> set image type to 'type'
5571           -C ==> set compression type 'comp'
5572           -a ==> set load address to 'addr' (hex)
5573           -e ==> set entry point to 'ep' (hex)
5574           -n ==> set image name to 'name'
5575           -d ==> use image data from 'datafile'
5576
5577 Right now, all Linux kernels for PowerPC systems use the same load
5578 address (0x00000000), but the entry point address depends on the
5579 kernel version:
5580
5581 - 2.2.x kernels have the entry point at 0x0000000C,
5582 - 2.3.x and later kernels have the entry point at 0x00000000.
5583
5584 So a typical call to build a U-Boot image would read:
5585
5586         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5587         > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5588         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
5589         > examples/uImage.TQM850L
5590         Image Name:   2.4.4 kernel for TQM850L
5591         Created:      Wed Jul 19 02:34:59 2000
5592         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5593         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5594         Load Address: 0x00000000
5595         Entry Point:  0x00000000
5596
5597 To verify the contents of the image (or check for corruption):
5598
5599         -> tools/mkimage -l examples/uImage.TQM850L
5600         Image Name:   2.4.4 kernel for TQM850L
5601         Created:      Wed Jul 19 02:34:59 2000
5602         Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5603         Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5604         Load Address: 0x00000000
5605         Entry Point:  0x00000000
5606
5607 NOTE: for embedded systems where boot time is critical you can trade
5608 speed for memory and install an UNCOMPRESSED image instead: this
5609 needs more space in Flash, but boots much faster since it does not
5610 need to be uncompressed:
5611
5612         -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
5613         -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5614         > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5615         > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
5616         > examples/uImage.TQM850L-uncompressed
5617         Image Name:   2.4.4 kernel for TQM850L
5618         Created:      Wed Jul 19 02:34:59 2000
5619         Image Type:   PowerPC Linux Kernel Image (uncompressed)
5620         Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5621         Load Address: 0x00000000
5622         Entry Point:  0x00000000
5623
5624
5625 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5626 when your kernel is intended to use an initial ramdisk:
5627
5628         -> tools/mkimage -n 'Simple Ramdisk Image' \
5629         > -A ppc -O linux -T ramdisk -C gzip \
5630         > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5631         Image Name:   Simple Ramdisk Image
5632         Created:      Wed Jan 12 14:01:50 2000
5633         Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5634         Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5635         Load Address: 0x00000000
5636         Entry Point:  0x00000000
5637
5638 The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5639 option performs the converse operation of the mkimage's second form (the "-d"
5640 option). Given an image built by mkimage, the dumpimage extracts a "data file"
5641 from the image:
5642
5643         tools/dumpimage -i image -T type -p position data_file
5644           -i ==> extract from the 'image' a specific 'data_file'
5645           -T ==> set image type to 'type'
5646           -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5647
5648
5649 Installing a Linux Image:
5650 -------------------------
5651
5652 To downloading a U-Boot image over the serial (console) interface,
5653 you must convert the image to S-Record format:
5654
5655         objcopy -I binary -O srec examples/image examples/image.srec
5656
5657 The 'objcopy' does not understand the information in the U-Boot
5658 image header, so the resulting S-Record file will be relative to
5659 address 0x00000000. To load it to a given address, you need to
5660 specify the target address as 'offset' parameter with the 'loads'
5661 command.
5662
5663 Example: install the image to address 0x40100000 (which on the
5664 TQM8xxL is in the first Flash bank):
5665
5666         => erase 40100000 401FFFFF
5667
5668         .......... done
5669         Erased 8 sectors
5670
5671         => loads 40100000
5672         ## Ready for S-Record download ...
5673         ~>examples/image.srec
5674         1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5675         ...
5676         15989 15990 15991 15992
5677         [file transfer complete]
5678         [connected]
5679         ## Start Addr = 0x00000000
5680
5681
5682 You can check the success of the download using the 'iminfo' command;
5683 this includes a checksum verification so you can be sure no data
5684 corruption happened:
5685
5686         => imi 40100000
5687
5688         ## Checking Image at 40100000 ...
5689            Image Name:   2.2.13 for initrd on TQM850L
5690            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5691            Data Size:    335725 Bytes = 327 kB = 0 MB
5692            Load Address: 00000000
5693            Entry Point:  0000000c
5694            Verifying Checksum ... OK
5695
5696
5697 Boot Linux:
5698 -----------
5699
5700 The "bootm" command is used to boot an application that is stored in
5701 memory (RAM or Flash). In case of a Linux kernel image, the contents
5702 of the "bootargs" environment variable is passed to the kernel as
5703 parameters. You can check and modify this variable using the
5704 "printenv" and "setenv" commands:
5705
5706
5707         => printenv bootargs
5708         bootargs=root=/dev/ram
5709
5710         => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5711
5712         => printenv bootargs
5713         bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5714
5715         => bootm 40020000
5716         ## Booting Linux kernel at 40020000 ...
5717            Image Name:   2.2.13 for NFS on TQM850L
5718            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5719            Data Size:    381681 Bytes = 372 kB = 0 MB
5720            Load Address: 00000000
5721            Entry Point:  0000000c
5722            Verifying Checksum ... OK
5723            Uncompressing Kernel Image ... OK
5724         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
5725         Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5726         time_init: decrementer frequency = 187500000/60
5727         Calibrating delay loop... 49.77 BogoMIPS
5728         Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5729         ...
5730
5731 If you want to boot a Linux kernel with initial RAM disk, you pass
5732 the memory addresses of both the kernel and the initrd image (PPBCOOT
5733 format!) to the "bootm" command:
5734
5735         => imi 40100000 40200000
5736
5737         ## Checking Image at 40100000 ...
5738            Image Name:   2.2.13 for initrd on TQM850L
5739            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5740            Data Size:    335725 Bytes = 327 kB = 0 MB
5741            Load Address: 00000000
5742            Entry Point:  0000000c
5743            Verifying Checksum ... OK
5744
5745         ## Checking Image at 40200000 ...
5746            Image Name:   Simple Ramdisk Image
5747            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5748            Data Size:    566530 Bytes = 553 kB = 0 MB
5749            Load Address: 00000000
5750            Entry Point:  00000000
5751            Verifying Checksum ... OK
5752
5753         => bootm 40100000 40200000
5754         ## Booting Linux kernel at 40100000 ...
5755            Image Name:   2.2.13 for initrd on TQM850L
5756            Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5757            Data Size:    335725 Bytes = 327 kB = 0 MB
5758            Load Address: 00000000
5759            Entry Point:  0000000c
5760            Verifying Checksum ... OK
5761            Uncompressing Kernel Image ... OK
5762         ## Loading RAMDisk Image at 40200000 ...
5763            Image Name:   Simple Ramdisk Image
5764            Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5765            Data Size:    566530 Bytes = 553 kB = 0 MB
5766            Load Address: 00000000
5767            Entry Point:  00000000
5768            Verifying Checksum ... OK
5769            Loading Ramdisk ... OK
5770         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
5771         Boot arguments: root=/dev/ram
5772         time_init: decrementer frequency = 187500000/60
5773         Calibrating delay loop... 49.77 BogoMIPS
5774         ...
5775         RAMDISK: Compressed image found at block 0
5776         VFS: Mounted root (ext2 filesystem).
5777
5778         bash#
5779
5780 Boot Linux and pass a flat device tree:
5781 -----------
5782
5783 First, U-Boot must be compiled with the appropriate defines. See the section
5784 titled "Linux Kernel Interface" above for a more in depth explanation. The
5785 following is an example of how to start a kernel and pass an updated
5786 flat device tree:
5787
5788 => print oftaddr
5789 oftaddr=0x300000
5790 => print oft
5791 oft=oftrees/mpc8540ads.dtb
5792 => tftp $oftaddr $oft
5793 Speed: 1000, full duplex
5794 Using TSEC0 device
5795 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5796 Filename 'oftrees/mpc8540ads.dtb'.
5797 Load address: 0x300000
5798 Loading: #
5799 done
5800 Bytes transferred = 4106 (100a hex)
5801 => tftp $loadaddr $bootfile
5802 Speed: 1000, full duplex
5803 Using TSEC0 device
5804 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5805 Filename 'uImage'.
5806 Load address: 0x200000
5807 Loading:############
5808 done
5809 Bytes transferred = 1029407 (fb51f hex)
5810 => print loadaddr
5811 loadaddr=200000
5812 => print oftaddr
5813 oftaddr=0x300000
5814 => bootm $loadaddr - $oftaddr
5815 ## Booting image at 00200000 ...
5816    Image Name:   Linux-2.6.17-dirty
5817    Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5818    Data Size:    1029343 Bytes = 1005.2 kB
5819    Load Address: 00000000
5820    Entry Point:  00000000
5821    Verifying Checksum ... OK
5822    Uncompressing Kernel Image ... OK
5823 Booting using flat device tree at 0x300000
5824 Using MPC85xx ADS machine description
5825 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5826 [snip]
5827
5828
5829 More About U-Boot Image Types:
5830 ------------------------------
5831
5832 U-Boot supports the following image types:
5833
5834    "Standalone Programs" are directly runnable in the environment
5835         provided by U-Boot; it is expected that (if they behave
5836         well) you can continue to work in U-Boot after return from
5837         the Standalone Program.
5838    "OS Kernel Images" are usually images of some Embedded OS which
5839         will take over control completely. Usually these programs
5840         will install their own set of exception handlers, device
5841         drivers, set up the MMU, etc. - this means, that you cannot
5842         expect to re-enter U-Boot except by resetting the CPU.
5843    "RAMDisk Images" are more or less just data blocks, and their
5844         parameters (address, size) are passed to an OS kernel that is
5845         being started.
5846    "Multi-File Images" contain several images, typically an OS
5847         (Linux) kernel image and one or more data images like
5848         RAMDisks. This construct is useful for instance when you want
5849         to boot over the network using BOOTP etc., where the boot
5850         server provides just a single image file, but you want to get
5851         for instance an OS kernel and a RAMDisk image.
5852
5853         "Multi-File Images" start with a list of image sizes, each
5854         image size (in bytes) specified by an "uint32_t" in network
5855         byte order. This list is terminated by an "(uint32_t)0".
5856         Immediately after the terminating 0 follow the images, one by
5857         one, all aligned on "uint32_t" boundaries (size rounded up to
5858         a multiple of 4 bytes).
5859
5860    "Firmware Images" are binary images containing firmware (like
5861         U-Boot or FPGA images) which usually will be programmed to
5862         flash memory.
5863
5864    "Script files" are command sequences that will be executed by
5865         U-Boot's command interpreter; this feature is especially
5866         useful when you configure U-Boot to use a real shell (hush)
5867         as command interpreter.
5868
5869 Booting the Linux zImage:
5870 -------------------------
5871
5872 On some platforms, it's possible to boot Linux zImage. This is done
5873 using the "bootz" command. The syntax of "bootz" command is the same
5874 as the syntax of "bootm" command.
5875
5876 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5877 kernel with raw initrd images. The syntax is slightly different, the
5878 address of the initrd must be augmented by it's size, in the following
5879 format: "<initrd addres>:<initrd size>".
5880
5881
5882 Standalone HOWTO:
5883 =================
5884
5885 One of the features of U-Boot is that you can dynamically load and
5886 run "standalone" applications, which can use some resources of
5887 U-Boot like console I/O functions or interrupt services.
5888
5889 Two simple examples are included with the sources:
5890
5891 "Hello World" Demo:
5892 -------------------
5893
5894 'examples/hello_world.c' contains a small "Hello World" Demo
5895 application; it is automatically compiled when you build U-Boot.
5896 It's configured to run at address 0x00040004, so you can play with it
5897 like that:
5898
5899         => loads
5900         ## Ready for S-Record download ...
5901         ~>examples/hello_world.srec
5902         1 2 3 4 5 6 7 8 9 10 11 ...
5903         [file transfer complete]
5904         [connected]
5905         ## Start Addr = 0x00040004
5906
5907         => go 40004 Hello World! This is a test.
5908         ## Starting application at 0x00040004 ...
5909         Hello World
5910         argc = 7
5911         argv[0] = "40004"
5912         argv[1] = "Hello"
5913         argv[2] = "World!"
5914         argv[3] = "This"
5915         argv[4] = "is"
5916         argv[5] = "a"
5917         argv[6] = "test."
5918         argv[7] = "<NULL>"
5919         Hit any key to exit ...
5920
5921         ## Application terminated, rc = 0x0
5922
5923 Another example, which demonstrates how to register a CPM interrupt
5924 handler with the U-Boot code, can be found in 'examples/timer.c'.
5925 Here, a CPM timer is set up to generate an interrupt every second.
5926 The interrupt service routine is trivial, just printing a '.'
5927 character, but this is just a demo program. The application can be
5928 controlled by the following keys:
5929
5930         ? - print current values og the CPM Timer registers
5931         b - enable interrupts and start timer
5932         e - stop timer and disable interrupts
5933         q - quit application
5934
5935         => loads
5936         ## Ready for S-Record download ...
5937         ~>examples/timer.srec
5938         1 2 3 4 5 6 7 8 9 10 11 ...
5939         [file transfer complete]
5940         [connected]
5941         ## Start Addr = 0x00040004
5942
5943         => go 40004
5944         ## Starting application at 0x00040004 ...
5945         TIMERS=0xfff00980
5946         Using timer 1
5947           tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5948
5949 Hit 'b':
5950         [q, b, e, ?] Set interval 1000000 us
5951         Enabling timer
5952 Hit '?':
5953         [q, b, e, ?] ........
5954         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5955 Hit '?':
5956         [q, b, e, ?] .
5957         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5958 Hit '?':
5959         [q, b, e, ?] .
5960         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5961 Hit '?':
5962         [q, b, e, ?] .
5963         tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5964 Hit 'e':
5965         [q, b, e, ?] ...Stopping timer
5966 Hit 'q':
5967         [q, b, e, ?] ## Application terminated, rc = 0x0
5968
5969
5970 Minicom warning:
5971 ================
5972
5973 Over time, many people have reported problems when trying to use the
5974 "minicom" terminal emulation program for serial download. I (wd)
5975 consider minicom to be broken, and recommend not to use it. Under
5976 Unix, I recommend to use C-Kermit for general purpose use (and
5977 especially for kermit binary protocol download ("loadb" command), and
5978 use "cu" for S-Record download ("loads" command).  See
5979 http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5980 for help with kermit.
5981
5982
5983 Nevertheless, if you absolutely want to use it try adding this
5984 configuration to your "File transfer protocols" section:
5985
5986            Name    Program                      Name U/D FullScr IO-Red. Multi
5987         X  kermit  /usr/bin/kermit -i -l %l -s   Y    U    Y       N      N
5988         Y  kermit  /usr/bin/kermit -i -l %l -r   N    D    Y       N      N
5989
5990
5991 NetBSD Notes:
5992 =============
5993
5994 Starting at version 0.9.2, U-Boot supports NetBSD both as host
5995 (build U-Boot) and target system (boots NetBSD/mpc8xx).
5996
5997 Building requires a cross environment; it is known to work on
5998 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5999 need gmake since the Makefiles are not compatible with BSD make).
6000 Note that the cross-powerpc package does not install include files;
6001 attempting to build U-Boot will fail because <machine/ansi.h> is
6002 missing.  This file has to be installed and patched manually:
6003
6004         # cd /usr/pkg/cross/powerpc-netbsd/include
6005         # mkdir powerpc
6006         # ln -s powerpc machine
6007         # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6008         # ${EDIT} powerpc/ansi.h        ## must remove __va_list, _BSD_VA_LIST
6009
6010 Native builds *don't* work due to incompatibilities between native
6011 and U-Boot include files.
6012
6013 Booting assumes that (the first part of) the image booted is a
6014 stage-2 loader which in turn loads and then invokes the kernel
6015 proper. Loader sources will eventually appear in the NetBSD source
6016 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
6017 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6018
6019
6020 Implementation Internals:
6021 =========================
6022
6023 The following is not intended to be a complete description of every
6024 implementation detail. However, it should help to understand the
6025 inner workings of U-Boot and make it easier to port it to custom
6026 hardware.
6027
6028
6029 Initial Stack, Global Data:
6030 ---------------------------
6031
6032 The implementation of U-Boot is complicated by the fact that U-Boot
6033 starts running out of ROM (flash memory), usually without access to
6034 system RAM (because the memory controller is not initialized yet).
6035 This means that we don't have writable Data or BSS segments, and BSS
6036 is not initialized as zero. To be able to get a C environment working
6037 at all, we have to allocate at least a minimal stack. Implementation
6038 options for this are defined and restricted by the CPU used: Some CPU
6039 models provide on-chip memory (like the IMMR area on MPC8xx and
6040 MPC826x processors), on others (parts of) the data cache can be
6041 locked as (mis-) used as memory, etc.
6042
6043         Chris Hallinan posted a good summary of these issues to the
6044         U-Boot mailing list:
6045
6046         Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6047         From: "Chris Hallinan" <clh@net1plus.com>
6048         Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6049         ...
6050
6051         Correct me if I'm wrong, folks, but the way I understand it
6052         is this: Using DCACHE as initial RAM for Stack, etc, does not
6053         require any physical RAM backing up the cache. The cleverness
6054         is that the cache is being used as a temporary supply of
6055         necessary storage before the SDRAM controller is setup. It's
6056         beyond the scope of this list to explain the details, but you
6057         can see how this works by studying the cache architecture and
6058         operation in the architecture and processor-specific manuals.
6059
6060         OCM is On Chip Memory, which I believe the 405GP has 4K. It
6061         is another option for the system designer to use as an
6062         initial stack/RAM area prior to SDRAM being available. Either
6063         option should work for you. Using CS 4 should be fine if your
6064         board designers haven't used it for something that would
6065         cause you grief during the initial boot! It is frequently not
6066         used.
6067
6068         CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
6069         with your processor/board/system design. The default value
6070         you will find in any recent u-boot distribution in
6071         walnut.h should work for you. I'd set it to a value larger
6072         than your SDRAM module. If you have a 64MB SDRAM module, set
6073         it above 400_0000. Just make sure your board has no resources
6074         that are supposed to respond to that address! That code in
6075         start.S has been around a while and should work as is when
6076         you get the config right.
6077
6078         -Chris Hallinan
6079         DS4.COM, Inc.
6080
6081 It is essential to remember this, since it has some impact on the C
6082 code for the initialization procedures:
6083
6084 * Initialized global data (data segment) is read-only. Do not attempt
6085   to write it.
6086
6087 * Do not use any uninitialized global data (or implicitly initialized
6088   as zero data - BSS segment) at all - this is undefined, initiali-
6089   zation is performed later (when relocating to RAM).
6090
6091 * Stack space is very limited. Avoid big data buffers or things like
6092   that.
6093
6094 Having only the stack as writable memory limits means we cannot use
6095 normal global data to share information between the code. But it
6096 turned out that the implementation of U-Boot can be greatly
6097 simplified by making a global data structure (gd_t) available to all
6098 functions. We could pass a pointer to this data as argument to _all_
6099 functions, but this would bloat the code. Instead we use a feature of
6100 the GCC compiler (Global Register Variables) to share the data: we
6101 place a pointer (gd) to the global data into a register which we
6102 reserve for this purpose.
6103
6104 When choosing a register for such a purpose we are restricted by the
6105 relevant  (E)ABI  specifications for the current architecture, and by
6106 GCC's implementation.
6107
6108 For PowerPC, the following registers have specific use:
6109         R1:     stack pointer
6110         R2:     reserved for system use
6111         R3-R4:  parameter passing and return values
6112         R5-R10: parameter passing
6113         R13:    small data area pointer
6114         R30:    GOT pointer
6115         R31:    frame pointer
6116
6117         (U-Boot also uses R12 as internal GOT pointer. r12
6118         is a volatile register so r12 needs to be reset when
6119         going back and forth between asm and C)
6120
6121     ==> U-Boot will use R2 to hold a pointer to the global data
6122
6123     Note: on PPC, we could use a static initializer (since the
6124     address of the global data structure is known at compile time),
6125     but it turned out that reserving a register results in somewhat
6126     smaller code - although the code savings are not that big (on
6127     average for all boards 752 bytes for the whole U-Boot image,
6128     624 text + 127 data).
6129
6130 On Blackfin, the normal C ABI (except for P3) is followed as documented here:
6131         http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6132
6133     ==> U-Boot will use P3 to hold a pointer to the global data
6134
6135 On ARM, the following registers are used:
6136
6137         R0:     function argument word/integer result
6138         R1-R3:  function argument word
6139         R9:     platform specific
6140         R10:    stack limit (used only if stack checking is enabled)
6141         R11:    argument (frame) pointer
6142         R12:    temporary workspace
6143         R13:    stack pointer
6144         R14:    link register
6145         R15:    program counter
6146
6147     ==> U-Boot will use R9 to hold a pointer to the global data
6148
6149     Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6150
6151 On Nios II, the ABI is documented here:
6152         http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6153
6154     ==> U-Boot will use gp to hold a pointer to the global data
6155
6156     Note: on Nios II, we give "-G0" option to gcc and don't use gp
6157     to access small data sections, so gp is free.
6158
6159 On NDS32, the following registers are used:
6160
6161         R0-R1:  argument/return
6162         R2-R5:  argument
6163         R15:    temporary register for assembler
6164         R16:    trampoline register
6165         R28:    frame pointer (FP)
6166         R29:    global pointer (GP)
6167         R30:    link register (LP)
6168         R31:    stack pointer (SP)
6169         PC:     program counter (PC)
6170
6171     ==> U-Boot will use R10 to hold a pointer to the global data
6172
6173 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6174 or current versions of GCC may "optimize" the code too much.
6175
6176 Memory Management:
6177 ------------------
6178
6179 U-Boot runs in system state and uses physical addresses, i.e. the
6180 MMU is not used either for address mapping nor for memory protection.
6181
6182 The available memory is mapped to fixed addresses using the memory
6183 controller. In this process, a contiguous block is formed for each
6184 memory type (Flash, SDRAM, SRAM), even when it consists of several
6185 physical memory banks.
6186
6187 U-Boot is installed in the first 128 kB of the first Flash bank (on
6188 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6189 booting and sizing and initializing DRAM, the code relocates itself
6190 to the upper end of DRAM. Immediately below the U-Boot code some
6191 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6192 configuration setting]. Below that, a structure with global Board
6193 Info data is placed, followed by the stack (growing downward).
6194
6195 Additionally, some exception handler code is copied to the low 8 kB
6196 of DRAM (0x00000000 ... 0x00001FFF).
6197
6198 So a typical memory configuration with 16 MB of DRAM could look like
6199 this:
6200
6201         0x0000 0000     Exception Vector code
6202               :
6203         0x0000 1FFF
6204         0x0000 2000     Free for Application Use
6205               :
6206               :
6207
6208               :
6209               :
6210         0x00FB FF20     Monitor Stack (Growing downward)
6211         0x00FB FFAC     Board Info Data and permanent copy of global data
6212         0x00FC 0000     Malloc Arena
6213               :
6214         0x00FD FFFF
6215         0x00FE 0000     RAM Copy of Monitor Code
6216         ...             eventually: LCD or video framebuffer
6217         ...             eventually: pRAM (Protected RAM - unchanged by reset)
6218         0x00FF FFFF     [End of RAM]
6219
6220
6221 System Initialization:
6222 ----------------------
6223
6224 In the reset configuration, U-Boot starts at the reset entry point
6225 (on most PowerPC systems at address 0x00000100). Because of the reset
6226 configuration for CS0# this is a mirror of the on board Flash memory.
6227 To be able to re-map memory U-Boot then jumps to its link address.
6228 To be able to implement the initialization code in C, a (small!)
6229 initial stack is set up in the internal Dual Ported RAM (in case CPUs
6230 which provide such a feature like MPC8xx or MPC8260), or in a locked
6231 part of the data cache. After that, U-Boot initializes the CPU core,
6232 the caches and the SIU.
6233
6234 Next, all (potentially) available memory banks are mapped using a
6235 preliminary mapping. For example, we put them on 512 MB boundaries
6236 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6237 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6238 programmed for SDRAM access. Using the temporary configuration, a
6239 simple memory test is run that determines the size of the SDRAM
6240 banks.
6241
6242 When there is more than one SDRAM bank, and the banks are of
6243 different size, the largest is mapped first. For equal size, the first
6244 bank (CS2#) is mapped first. The first mapping is always for address
6245 0x00000000, with any additional banks following immediately to create
6246 contiguous memory starting from 0.
6247
6248 Then, the monitor installs itself at the upper end of the SDRAM area
6249 and allocates memory for use by malloc() and for the global Board
6250 Info data; also, the exception vector code is copied to the low RAM
6251 pages, and the final stack is set up.
6252
6253 Only after this relocation will you have a "normal" C environment;
6254 until that you are restricted in several ways, mostly because you are
6255 running from ROM, and because the code will have to be relocated to a
6256 new address in RAM.
6257
6258
6259 U-Boot Porting Guide:
6260 ----------------------
6261
6262 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6263 list, October 2002]
6264
6265
6266 int main(int argc, char *argv[])
6267 {
6268         sighandler_t no_more_time;
6269
6270         signal(SIGALRM, no_more_time);
6271         alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6272
6273         if (available_money > available_manpower) {
6274                 Pay consultant to port U-Boot;
6275                 return 0;
6276         }
6277
6278         Download latest U-Boot source;
6279
6280         Subscribe to u-boot mailing list;
6281
6282         if (clueless)
6283                 email("Hi, I am new to U-Boot, how do I get started?");
6284
6285         while (learning) {
6286                 Read the README file in the top level directory;
6287                 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6288                 Read applicable doc/*.README;
6289                 Read the source, Luke;
6290                 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
6291         }
6292
6293         if (available_money > toLocalCurrency ($2500))
6294                 Buy a BDI3000;
6295         else
6296                 Add a lot of aggravation and time;
6297
6298         if (a similar board exists) {   /* hopefully... */
6299                 cp -a board/<similar> board/<myboard>
6300                 cp include/configs/<similar>.h include/configs/<myboard>.h
6301         } else {
6302                 Create your own board support subdirectory;
6303                 Create your own board include/configs/<myboard>.h file;
6304         }
6305         Edit new board/<myboard> files
6306         Edit new include/configs/<myboard>.h
6307
6308         while (!accepted) {
6309                 while (!running) {
6310                         do {
6311                                 Add / modify source code;
6312                         } until (compiles);
6313                         Debug;
6314                         if (clueless)
6315                                 email("Hi, I am having problems...");
6316                 }
6317                 Send patch file to the U-Boot email list;
6318                 if (reasonable critiques)
6319                         Incorporate improvements from email list code review;
6320                 else
6321                         Defend code as written;
6322         }
6323
6324         return 0;
6325 }
6326
6327 void no_more_time (int sig)
6328 {
6329       hire_a_guru();
6330 }
6331
6332
6333 Coding Standards:
6334 -----------------
6335
6336 All contributions to U-Boot should conform to the Linux kernel
6337 coding style; see the file "Documentation/CodingStyle" and the script
6338 "scripts/Lindent" in your Linux kernel source directory.
6339
6340 Source files originating from a different project (for example the
6341 MTD subsystem) are generally exempt from these guidelines and are not
6342 reformatted to ease subsequent migration to newer versions of those
6343 sources.
6344
6345 Please note that U-Boot is implemented in C (and to some small parts in
6346 Assembler); no C++ is used, so please do not use C++ style comments (//)
6347 in your code.
6348
6349 Please also stick to the following formatting rules:
6350 - remove any trailing white space
6351 - use TAB characters for indentation and vertical alignment, not spaces
6352 - make sure NOT to use DOS '\r\n' line feeds
6353 - do not add more than 2 consecutive empty lines to source files
6354 - do not add trailing empty lines to source files
6355
6356 Submissions which do not conform to the standards may be returned
6357 with a request to reformat the changes.
6358
6359
6360 Submitting Patches:
6361 -------------------
6362
6363 Since the number of patches for U-Boot is growing, we need to
6364 establish some rules. Submissions which do not conform to these rules
6365 may be rejected, even when they contain important and valuable stuff.
6366
6367 Please see http://www.denx.de/wiki/U-Boot/Patches for details.
6368
6369 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6370 see http://lists.denx.de/mailman/listinfo/u-boot
6371
6372 When you send a patch, please include the following information with
6373 it:
6374
6375 * For bug fixes: a description of the bug and how your patch fixes
6376   this bug. Please try to include a way of demonstrating that the
6377   patch actually fixes something.
6378
6379 * For new features: a description of the feature and your
6380   implementation.
6381
6382 * A CHANGELOG entry as plaintext (separate from the patch)
6383
6384 * For major contributions, add a MAINTAINERS file with your
6385   information and associated file and directory references.
6386
6387 * When you add support for a new board, don't forget to add a
6388   maintainer e-mail address to the boards.cfg file, too.
6389
6390 * If your patch adds new configuration options, don't forget to
6391   document these in the README file.
6392
6393 * The patch itself. If you are using git (which is *strongly*
6394   recommended) you can easily generate the patch using the
6395   "git format-patch". If you then use "git send-email" to send it to
6396   the U-Boot mailing list, you will avoid most of the common problems
6397   with some other mail clients.
6398
6399   If you cannot use git, use "diff -purN OLD NEW". If your version of
6400   diff does not support these options, then get the latest version of
6401   GNU diff.
6402
6403   The current directory when running this command shall be the parent
6404   directory of the U-Boot source tree (i. e. please make sure that
6405   your patch includes sufficient directory information for the
6406   affected files).
6407
6408   We prefer patches as plain text. MIME attachments are discouraged,
6409   and compressed attachments must not be used.
6410
6411 * If one logical set of modifications affects or creates several
6412   files, all these changes shall be submitted in a SINGLE patch file.
6413
6414 * Changesets that contain different, unrelated modifications shall be
6415   submitted as SEPARATE patches, one patch per changeset.
6416
6417
6418 Notes:
6419
6420 * Before sending the patch, run the buildman script on your patched
6421   source tree and make sure that no errors or warnings are reported
6422   for any of the boards.
6423
6424 * Keep your modifications to the necessary minimum: A patch
6425   containing several unrelated changes or arbitrary reformats will be
6426   returned with a request to re-formatting / split it.
6427
6428 * If you modify existing code, make sure that your new code does not
6429   add to the memory footprint of the code ;-) Small is beautiful!
6430   When adding new features, these should compile conditionally only
6431   (using #ifdef), and the resulting code with the new feature
6432   disabled must not need more memory than the old code without your
6433   modification.
6434
6435 * Remember that there is a size limit of 100 kB per message on the
6436   u-boot mailing list. Bigger patches will be moderated. If they are
6437   reasonable and not too big, they will be acknowledged. But patches
6438   bigger than the size limit should be avoided.