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