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