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