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