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