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