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