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