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