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