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