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