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