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