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