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