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