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