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