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