2 # (C) Copyright 2000 - 2008
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 # See file CREDITS for list of people who contributed to this
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.
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.
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,
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
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.
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.
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.
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
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-users@lists.sourceforge.net>. There is also an archive of
64 previous traffic on the mailing list - please search the archive
65 before asking FAQ's. Please see
66 http://lists.sourceforge.net/lists/listinfo/u-boot-users/
69 Where to get source code:
70 =========================
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
76 The "snapshot" links on this page allow you to download tarballs of
77 any version you might be interested in. Ofifcial releases are also
78 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
81 Pre-build (and tested) images are available from
82 ftp://ftp.denx.de/pub/u-boot/images/
88 - start from 8xxrom sources
89 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
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
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/UBoot
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:
111 This is the README file for the U-Boot project.
113 File names etc. shall be based on the string "u-boot". Examples:
115 include/asm-ppc/u-boot.h
117 #include <asm/u-boot.h>
119 Variable names, preprocessor constants etc. shall be either based on
120 the string "u_boot" or on "U_BOOT". Example:
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
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".
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".
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 - i386 Files specific to i386 CPUs
155 - ixp Files specific to Intel XScale IXP CPUs
156 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
157 - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
158 - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
159 - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
160 - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
161 - mips Files specific to MIPS CPUs
162 - mpc5xx Files specific to Freescale MPC5xx CPUs
163 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
164 - mpc8xx Files specific to Freescale MPC8xx CPUs
165 - mpc8220 Files specific to Freescale MPC8220 CPUs
166 - mpc824x Files specific to Freescale MPC824x CPUs
167 - mpc8260 Files specific to Freescale MPC8260 CPUs
168 - mpc85xx Files specific to Freescale MPC85xx CPUs
169 - nios Files specific to Altera NIOS CPUs
170 - nios2 Files specific to Altera Nios-II CPUs
171 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
172 - pxa Files specific to Intel XScale PXA CPUs
173 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
174 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
175 - disk Code for disk drive partition handling
176 - doc Documentation (don't expect too much)
177 - drivers Commonly used device drivers
178 - dtt Digital Thermometer and Thermostat drivers
179 - examples Example code for standalone applications, etc.
180 - include Header Files
181 - lib_arm Files generic to ARM architecture
182 - lib_avr32 Files generic to AVR32 architecture
183 - lib_generic Files generic to all architectures
184 - lib_i386 Files generic to i386 architecture
185 - lib_m68k Files generic to m68k architecture
186 - lib_mips Files generic to MIPS architecture
187 - lib_nios Files generic to NIOS architecture
188 - lib_ppc Files generic to PowerPC architecture
189 - libfdt Library files to support flattened device trees
190 - net Networking code
191 - post Power On Self Test
192 - rtc Real Time Clock drivers
193 - tools Tools to build S-Record or U-Boot images, etc.
195 Software Configuration:
196 =======================
198 Configuration is usually done using C preprocessor defines; the
199 rationale behind that is to avoid dead code whenever possible.
201 There are two classes of configuration variables:
203 * Configuration _OPTIONS_:
204 These are selectable by the user and have names beginning with
207 * Configuration _SETTINGS_:
208 These depend on the hardware etc. and should not be meddled with if
209 you don't know what you're doing; they have names beginning with
212 Later we will add a configuration tool - probably similar to or even
213 identical to what's used for the Linux kernel. Right now, we have to
214 do the configuration by hand, which means creating some symbolic
215 links and editing some configuration files. We use the TQM8xxL boards
219 Selection of Processor Architecture and Board Type:
220 ---------------------------------------------------
222 For all supported boards there are ready-to-use default
223 configurations available; just type "make <board_name>_config".
225 Example: For a TQM823L module type:
230 For the Cogent platform, you need to specify the cpu type as well;
231 e.g. "make cogent_mpc8xx_config". And also configure the cogent
232 directory according to the instructions in cogent/README.
235 Configuration Options:
236 ----------------------
238 Configuration depends on the combination of board and CPU type; all
239 such information is kept in a configuration file
240 "include/configs/<board_name>.h".
242 Example: For a TQM823L module, all configuration settings are in
243 "include/configs/TQM823L.h".
246 Many of the options are named exactly as the corresponding Linux
247 kernel configuration options. The intention is to make it easier to
248 build a config tool - later.
251 The following options need to be configured:
253 - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
255 - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
257 - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
258 Define exactly one, e.g. CONFIG_ATSTK1002
260 - CPU Module Type: (if CONFIG_COGENT is defined)
261 Define exactly one of
263 --- FIXME --- not tested yet:
264 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
265 CONFIG_CMA287_23, CONFIG_CMA287_50
267 - Motherboard Type: (if CONFIG_COGENT is defined)
268 Define exactly one of
269 CONFIG_CMA101, CONFIG_CMA102
271 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
272 Define one or more of
275 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
276 Define one or more of
277 CONFIG_LCD_HEARTBEAT - update a character position on
278 the lcd display every second with
281 - Board flavour: (if CONFIG_MPC8260ADS is defined)
284 CFG_8260ADS - original MPC8260ADS
285 CFG_8266ADS - MPC8266ADS
286 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
287 CFG_8272ADS - MPC8272ADS
289 - MPC824X Family Member (if CONFIG_MPC824X is defined)
290 Define exactly one of
291 CONFIG_MPC8240, CONFIG_MPC8245
293 - 8xx CPU Options: (if using an MPC8xx cpu)
294 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
295 get_gclk_freq() cannot work
296 e.g. if there is no 32KHz
297 reference PIT/RTC clock
298 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
301 - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
304 CONFIG_8xx_CPUCLK_DEFAULT
305 See doc/README.MPC866
309 Define this to measure the actual CPU clock instead
310 of relying on the correctness of the configured
311 values. Mostly useful for board bringup to make sure
312 the PLL is locked at the intended frequency. Note
313 that this requires a (stable) reference clock (32 kHz
314 RTC clock or CFG_8XX_XIN)
316 - Intel Monahans options:
317 CFG_MONAHANS_RUN_MODE_OSC_RATIO
319 Defines the Monahans run mode to oscillator
320 ratio. Valid values are 8, 16, 24, 31. The core
321 frequency is this value multiplied by 13 MHz.
323 CFG_MONAHANS_TURBO_RUN_MODE_RATIO
325 Defines the Monahans turbo mode to oscillator
326 ratio. Valid values are 1 (default if undefined) and
327 2. The core frequency as calculated above is multiplied
330 - Linux Kernel Interface:
333 U-Boot stores all clock information in Hz
334 internally. For binary compatibility with older Linux
335 kernels (which expect the clocks passed in the
336 bd_info data to be in MHz) the environment variable
337 "clocks_in_mhz" can be defined so that U-Boot
338 converts clock data to MHZ before passing it to the
340 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
341 "clocks_in_mhz=1" is automatically included in the
344 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
346 When transfering memsize parameter to linux, some versions
347 expect it to be in bytes, others in MB.
348 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
350 CONFIG_OF_LIBFDT / CONFIG_OF_FLAT_TREE
352 New kernel versions are expecting firmware settings to be
353 passed using flattened device trees (based on open firmware
357 * New libfdt-based support
358 * Adds the "fdt" command
359 * The bootm command automatically updates the fdt
362 * Deprecated, see CONFIG_OF_LIBFDT
363 * Original ft_build.c-based support
364 * Automatically modifies the dft as part of the bootm command
365 * The environment variable "disable_of", when set,
366 disables this functionality.
368 OF_CPU - The proper name of the cpus node.
369 OF_SOC - The proper name of the soc node.
370 OF_TBCLK - The timebase frequency.
371 OF_STDOUT_PATH - The path to the console device
373 boards with QUICC Engines require OF_QE to set UCC mac addresses
377 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
378 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
379 will have a copy of the bd_t. Space should be
380 pre-allocated in the dts for the bd_t.
382 CONFIG_OF_HAS_UBOOT_ENV
384 * CONFIG_OF_LIBFDT - enables the "fdt env" command
385 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
386 will have a copy of u-boot's environment variables
388 CONFIG_OF_BOARD_SETUP
390 Board code has addition modification that it wants to make
391 to the flat device tree before handing it off to the kernel
395 This define fills in the correct boot cpu in the boot
396 param header, the default value is zero if undefined.
401 Define this if you want support for Amba PrimeCell PL010 UARTs.
405 Define this if you want support for Amba PrimeCell PL011 UARTs.
409 If you have Amba PrimeCell PL011 UARTs, set this variable to
410 the clock speed of the UARTs.
414 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
415 define this to a list of base addresses for each (supported)
416 port. See e.g. include/configs/versatile.h
420 Depending on board, define exactly one serial port
421 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
422 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
423 console by defining CONFIG_8xx_CONS_NONE
425 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
426 port routines must be defined elsewhere
427 (i.e. serial_init(), serial_getc(), ...)
430 Enables console device for a color framebuffer. Needs following
431 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
432 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
434 VIDEO_HW_RECTFILL graphic chip supports
437 VIDEO_HW_BITBLT graphic chip supports
438 bit-blit (cf. smiLynxEM)
439 VIDEO_VISIBLE_COLS visible pixel columns
441 VIDEO_VISIBLE_ROWS visible pixel rows
442 VIDEO_PIXEL_SIZE bytes per pixel
443 VIDEO_DATA_FORMAT graphic data format
444 (0-5, cf. cfb_console.c)
445 VIDEO_FB_ADRS framebuffer address
446 VIDEO_KBD_INIT_FCT keyboard int fct
447 (i.e. i8042_kbd_init())
448 VIDEO_TSTC_FCT test char fct
450 VIDEO_GETC_FCT get char fct
452 CONFIG_CONSOLE_CURSOR cursor drawing on/off
453 (requires blink timer
455 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
456 CONFIG_CONSOLE_TIME display time/date info in
458 (requires CONFIG_CMD_DATE)
459 CONFIG_VIDEO_LOGO display Linux logo in
461 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
462 linux_logo.h for logo.
463 Requires CONFIG_VIDEO_LOGO
464 CONFIG_CONSOLE_EXTRA_INFO
465 addional board info beside
468 When CONFIG_CFB_CONSOLE is defined, video console is
469 default i/o. Serial console can be forced with
470 environment 'console=serial'.
472 When CONFIG_SILENT_CONSOLE is defined, all console
473 messages (by U-Boot and Linux!) can be silenced with
474 the "silent" environment variable. See
475 doc/README.silent for more information.
478 CONFIG_BAUDRATE - in bps
479 Select one of the baudrates listed in
480 CFG_BAUDRATE_TABLE, see below.
481 CFG_BRGCLK_PRESCALE, baudrate prescale
483 - Interrupt driven serial port input:
484 CONFIG_SERIAL_SOFTWARE_FIFO
487 Use an interrupt handler for receiving data on the
488 serial port. It also enables using hardware handshake
489 (RTS/CTS) and UART's built-in FIFO. Set the number of
490 bytes the interrupt driven input buffer should have.
492 Leave undefined to disable this feature, including
493 disable the buffer and hardware handshake.
495 - Console UART Number:
499 If defined internal UART1 (and not UART0) is used
500 as default U-Boot console.
502 - Boot Delay: CONFIG_BOOTDELAY - in seconds
503 Delay before automatically booting the default image;
504 set to -1 to disable autoboot.
506 See doc/README.autoboot for these options that
507 work with CONFIG_BOOTDELAY. None are required.
508 CONFIG_BOOT_RETRY_TIME
509 CONFIG_BOOT_RETRY_MIN
510 CONFIG_AUTOBOOT_KEYED
511 CONFIG_AUTOBOOT_PROMPT
512 CONFIG_AUTOBOOT_DELAY_STR
513 CONFIG_AUTOBOOT_STOP_STR
514 CONFIG_AUTOBOOT_DELAY_STR2
515 CONFIG_AUTOBOOT_STOP_STR2
516 CONFIG_ZERO_BOOTDELAY_CHECK
517 CONFIG_RESET_TO_RETRY
521 Only needed when CONFIG_BOOTDELAY is enabled;
522 define a command string that is automatically executed
523 when no character is read on the console interface
524 within "Boot Delay" after reset.
527 This can be used to pass arguments to the bootm
528 command. The value of CONFIG_BOOTARGS goes into the
529 environment value "bootargs".
531 CONFIG_RAMBOOT and CONFIG_NFSBOOT
532 The value of these goes into the environment as
533 "ramboot" and "nfsboot" respectively, and can be used
534 as a convenience, when switching between booting from
540 When this option is #defined, the existence of the
541 environment variable "preboot" will be checked
542 immediately before starting the CONFIG_BOOTDELAY
543 countdown and/or running the auto-boot command resp.
544 entering interactive mode.
546 This feature is especially useful when "preboot" is
547 automatically generated or modified. For an example
548 see the LWMON board specific code: here "preboot" is
549 modified when the user holds down a certain
550 combination of keys on the (special) keyboard when
553 - Serial Download Echo Mode:
555 If defined to 1, all characters received during a
556 serial download (using the "loads" command) are
557 echoed back. This might be needed by some terminal
558 emulations (like "cu"), but may as well just take
559 time on others. This setting #define's the initial
560 value of the "loads_echo" environment variable.
562 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
564 Select one of the baudrates listed in
565 CFG_BAUDRATE_TABLE, see below.
568 Monitor commands can be included or excluded
569 from the build by using the #include files
570 "config_cmd_all.h" and #undef'ing unwanted
571 commands, or using "config_cmd_default.h"
572 and augmenting with additional #define's
575 The default command configuration includes all commands
576 except those marked below with a "*".
578 CONFIG_CMD_ASKENV * ask for env variable
579 CONFIG_CMD_AUTOSCRIPT Autoscript Support
580 CONFIG_CMD_BDI bdinfo
581 CONFIG_CMD_BEDBUG * Include BedBug Debugger
582 CONFIG_CMD_BMP * BMP support
583 CONFIG_CMD_BSP * Board specific commands
584 CONFIG_CMD_BOOTD bootd
585 CONFIG_CMD_CACHE * icache, dcache
586 CONFIG_CMD_CONSOLE coninfo
587 CONFIG_CMD_DATE * support for RTC, date/time...
588 CONFIG_CMD_DHCP * DHCP support
589 CONFIG_CMD_DIAG * Diagnostics
590 CONFIG_CMD_DOC * Disk-On-Chip Support
591 CONFIG_CMD_DTT * Digital Therm and Thermostat
592 CONFIG_CMD_ECHO echo arguments
593 CONFIG_CMD_EEPROM * EEPROM read/write support
594 CONFIG_CMD_ELF * bootelf, bootvx
595 CONFIG_CMD_ENV saveenv
596 CONFIG_CMD_FDC * Floppy Disk Support
597 CONFIG_CMD_FAT * FAT partition support
598 CONFIG_CMD_FDOS * Dos diskette Support
599 CONFIG_CMD_FLASH flinfo, erase, protect
600 CONFIG_CMD_FPGA FPGA device initialization support
601 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
602 CONFIG_CMD_I2C * I2C serial bus support
603 CONFIG_CMD_IDE * IDE harddisk support
604 CONFIG_CMD_IMI iminfo
605 CONFIG_CMD_IMLS List all found images
606 CONFIG_CMD_IMMAP * IMMR dump support
607 CONFIG_CMD_IRQ * irqinfo
608 CONFIG_CMD_ITEST Integer/string test of 2 values
609 CONFIG_CMD_JFFS2 * JFFS2 Support
610 CONFIG_CMD_KGDB * kgdb
611 CONFIG_CMD_LOADB loadb
612 CONFIG_CMD_LOADS loads
613 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
615 CONFIG_CMD_MISC Misc functions like sleep etc
616 CONFIG_CMD_MMC * MMC memory mapped support
617 CONFIG_CMD_MII * MII utility commands
618 CONFIG_CMD_NAND * NAND support
619 CONFIG_CMD_NET bootp, tftpboot, rarpboot
620 CONFIG_CMD_PCI * pciinfo
621 CONFIG_CMD_PCMCIA * PCMCIA support
622 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
624 CONFIG_CMD_PORTIO * Port I/O
625 CONFIG_CMD_REGINFO * Register dump
626 CONFIG_CMD_RUN run command in env variable
627 CONFIG_CMD_SAVES * save S record dump
628 CONFIG_CMD_SCSI * SCSI Support
629 CONFIG_CMD_SDRAM * print SDRAM configuration information
630 (requires CONFIG_CMD_I2C)
631 CONFIG_CMD_SETGETDCR Support for DCR Register access
633 CONFIG_CMD_SPI * SPI serial bus support
634 CONFIG_CMD_USB * USB support
635 CONFIG_CMD_VFD * VFD support (TRAB)
636 CONFIG_CMD_BSP * Board SPecific functions
637 CONFIG_CMD_CDP * Cisco Discover Protocol support
638 CONFIG_CMD_FSL * Microblaze FSL support
641 EXAMPLE: If you want all functions except of network
642 support you can write:
644 #include "config_cmd_all.h"
645 #undef CONFIG_CMD_NET
648 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
650 Note: Don't enable the "icache" and "dcache" commands
651 (configuration option CONFIG_CMD_CACHE) unless you know
652 what you (and your U-Boot users) are doing. Data
653 cache cannot be enabled on systems like the 8xx or
654 8260 (where accesses to the IMMR region must be
655 uncached), and it cannot be disabled on all other
656 systems where we (mis-) use the data cache to hold an
657 initial stack and some data.
660 XXX - this list needs to get updated!
664 If this variable is defined, it enables watchdog
665 support. There must be support in the platform specific
666 code for a watchdog. For the 8xx and 8260 CPUs, the
667 SIU Watchdog feature is enabled in the SYPCR
671 CONFIG_VERSION_VARIABLE
672 If this variable is defined, an environment variable
673 named "ver" is created by U-Boot showing the U-Boot
674 version as printed by the "version" command.
675 This variable is readonly.
679 When CONFIG_CMD_DATE is selected, the type of the RTC
680 has to be selected, too. Define exactly one of the
683 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
684 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
685 CONFIG_RTC_MC146818 - use MC146818 RTC
686 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
687 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
688 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
689 CONFIG_RTC_DS164x - use Dallas DS164x RTC
690 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
691 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
693 Note that if the RTC uses I2C, then the I2C interface
694 must also be configured. See I2C Support, below.
698 When CONFIG_TIMESTAMP is selected, the timestamp
699 (date and time) of an image is printed by image
700 commands like bootm or iminfo. This option is
701 automatically enabled when you select CONFIG_CMD_DATE .
704 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
705 and/or CONFIG_ISO_PARTITION
707 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
708 CONFIG_CMD_SCSI) you must configure support for at
709 least one partition type as well.
712 CONFIG_IDE_RESET_ROUTINE - this is defined in several
713 board configurations files but used nowhere!
715 CONFIG_IDE_RESET - is this is defined, IDE Reset will
716 be performed by calling the function
717 ide_set_reset(int reset)
718 which has to be defined in a board specific file
723 Set this to enable ATAPI support.
728 Set this to enable support for disks larger than 137GB
729 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
730 Whithout these , LBA48 support uses 32bit variables and will 'only'
731 support disks up to 2.1TB.
734 When enabled, makes the IDE subsystem use 64bit sector addresses.
738 At the moment only there is only support for the
739 SYM53C8XX SCSI controller; define
740 CONFIG_SCSI_SYM53C8XX to enable it.
742 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
743 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
744 CFG_SCSI_MAX_LUN] can be adjusted to define the
745 maximum numbers of LUNs, SCSI ID's and target
747 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
749 - NETWORK Support (PCI):
751 Support for Intel 8254x gigabit chips.
754 Support for Intel 82557/82559/82559ER chips.
755 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
756 write routine for first time initialisation.
759 Support for Digital 2114x chips.
760 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
761 modem chip initialisation (KS8761/QS6611).
764 Support for National dp83815 chips.
767 Support for National dp8382[01] gigabit chips.
769 - NETWORK Support (other):
771 CONFIG_DRIVER_LAN91C96
772 Support for SMSC's LAN91C96 chips.
775 Define this to hold the physical address
776 of the LAN91C96's I/O space
778 CONFIG_LAN91C96_USE_32_BIT
779 Define this to enable 32 bit addressing
781 CONFIG_DRIVER_SMC91111
782 Support for SMSC's LAN91C111 chip
785 Define this to hold the physical address
786 of the device (I/O space)
788 CONFIG_SMC_USE_32_BIT
789 Define this if data bus is 32 bits
791 CONFIG_SMC_USE_IOFUNCS
792 Define this to use i/o functions instead of macros
793 (some hardware wont work with macros)
796 At the moment only the UHCI host controller is
797 supported (PIP405, MIP405, MPC5200); define
798 CONFIG_USB_UHCI to enable it.
799 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
800 and define CONFIG_USB_STORAGE to enable the USB
803 Supported are USB Keyboards and USB Floppy drives
805 MPC5200 USB requires additional defines:
807 for 528 MHz Clock: 0x0001bbbb
809 for differential drivers: 0x00001000
810 for single ended drivers: 0x00005000
812 May be defined to allow interrupt polling
813 instead of using asynchronous interrupts
816 Define the below if you wish to use the USB console.
817 Once firmware is rebuilt from a serial console issue the
818 command "setenv stdin usbtty; setenv stdout usbtty" and
819 attach your usb cable. The Unix command "dmesg" should print
820 it has found a new device. The environment variable usbtty
821 can be set to gserial or cdc_acm to enable your device to
822 appear to a USB host as a Linux gserial device or a
823 Common Device Class Abstract Control Model serial device.
824 If you select usbtty = gserial you should be able to enumerate
826 # modprobe usbserial vendor=0xVendorID product=0xProductID
827 else if using cdc_acm, simply setting the environment
828 variable usbtty to be cdc_acm should suffice. The following
829 might be defined in YourBoardName.h
832 Define this to build a UDC device
835 Define this to have a tty type of device available to
836 talk to the UDC device
838 CFG_CONSOLE_IS_IN_ENV
839 Define this if you want stdin, stdout &/or stderr to
843 CFG_USB_EXTC_CLK 0xBLAH
844 Derive USB clock from external clock "blah"
845 - CFG_USB_EXTC_CLK 0x02
847 CFG_USB_BRG_CLK 0xBLAH
848 Derive USB clock from brgclk
849 - CFG_USB_BRG_CLK 0x04
851 If you have a USB-IF assigned VendorID then you may wish to
852 define your own vendor specific values either in BoardName.h
853 or directly in usbd_vendor_info.h. If you don't define
854 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
855 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
856 should pretend to be a Linux device to it's target host.
858 CONFIG_USBD_MANUFACTURER
859 Define this string as the name of your company for
860 - CONFIG_USBD_MANUFACTURER "my company"
862 CONFIG_USBD_PRODUCT_NAME
863 Define this string as the name of your product
864 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
867 Define this as your assigned Vendor ID from the USB
868 Implementors Forum. This *must* be a genuine Vendor ID
869 to avoid polluting the USB namespace.
870 - CONFIG_USBD_VENDORID 0xFFFF
872 CONFIG_USBD_PRODUCTID
873 Define this as the unique Product ID
875 - CONFIG_USBD_PRODUCTID 0xFFFF
879 The MMC controller on the Intel PXA is supported. To
880 enable this define CONFIG_MMC. The MMC can be
881 accessed from the boot prompt by mapping the device
882 to physical memory similar to flash. Command line is
883 enabled with CONFIG_CMD_MMC. The MMC driver also works with
884 the FAT fs. This is enabled with CONFIG_CMD_FAT.
886 - Journaling Flash filesystem support:
887 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
888 CONFIG_JFFS2_NAND_DEV
889 Define these for a default partition on a NAND device
891 CFG_JFFS2_FIRST_SECTOR,
892 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
893 Define these for a default partition on a NOR device
896 Define this to create an own partition. You have to provide a
897 function struct part_info* jffs2_part_info(int part_num)
899 If you define only one JFFS2 partition you may also want to
900 #define CFG_JFFS_SINGLE_PART 1
901 to disable the command chpart. This is the default when you
902 have not defined a custom partition
907 Define this to enable standard (PC-Style) keyboard
911 Standard PC keyboard driver with US (is default) and
912 GERMAN key layout (switch via environment 'keymap=de') support.
913 Export function i8042_kbd_init, i8042_tstc and i8042_getc
914 for cfb_console. Supports cursor blinking.
919 Define this to enable video support (for output to
924 Enable Chips & Technologies 69000 Video chip
926 CONFIG_VIDEO_SMI_LYNXEM
927 Enable Silicon Motion SMI 712/710/810 Video chip. The
928 video output is selected via environment 'videoout'
929 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
932 For the CT69000 and SMI_LYNXEM drivers, videomode is
933 selected via environment 'videomode'. Two diferent ways
935 - "videomode=num" 'num' is a standard LiLo mode numbers.
936 Following standard modes are supported (* is default):
938 Colors 640x480 800x600 1024x768 1152x864 1280x1024
939 -------------+---------------------------------------------
940 8 bits | 0x301* 0x303 0x305 0x161 0x307
941 15 bits | 0x310 0x313 0x316 0x162 0x319
942 16 bits | 0x311 0x314 0x317 0x163 0x31A
943 24 bits | 0x312 0x315 0x318 ? 0x31B
944 -------------+---------------------------------------------
945 (i.e. setenv videomode 317; saveenv; reset;)
947 - "videomode=bootargs" all the video parameters are parsed
948 from the bootargs. (See drivers/video/videomodes.c)
951 CONFIG_VIDEO_SED13806
952 Enable Epson SED13806 driver. This driver supports 8bpp
953 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
954 or CONFIG_VIDEO_SED13806_16BPP
959 Define this to enable a custom keyboard support.
960 This simply calls drv_keyboard_init() which must be
961 defined in your board-specific files.
962 The only board using this so far is RBC823.
964 - LCD Support: CONFIG_LCD
966 Define this to enable LCD support (for output to LCD
967 display); also select one of the supported displays
968 by defining one of these:
970 CONFIG_NEC_NL6448AC33:
972 NEC NL6448AC33-18. Active, color, single scan.
974 CONFIG_NEC_NL6448BC20
976 NEC NL6448BC20-08. 6.5", 640x480.
977 Active, color, single scan.
979 CONFIG_NEC_NL6448BC33_54
981 NEC NL6448BC33-54. 10.4", 640x480.
982 Active, color, single scan.
986 Sharp 320x240. Active, color, single scan.
987 It isn't 16x9, and I am not sure what it is.
989 CONFIG_SHARP_LQ64D341
991 Sharp LQ64D341 display, 640x480.
992 Active, color, single scan.
996 HLD1045 display, 640x480.
997 Active, color, single scan.
1001 Optrex CBL50840-2 NF-FW 99 22 M5
1003 Hitachi LMG6912RPFC-00T
1007 320x240. Black & white.
1009 Normally display is black on white background; define
1010 CFG_WHITE_ON_BLACK to get it inverted.
1012 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1014 If this option is set, the environment is checked for
1015 a variable "splashimage". If found, the usual display
1016 of logo, copyright and system information on the LCD
1017 is suppressed and the BMP image at the address
1018 specified in "splashimage" is loaded instead. The
1019 console is redirected to the "nulldev", too. This
1020 allows for a "silent" boot where a splash screen is
1021 loaded very quickly after power-on.
1023 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1025 If this option is set, additionally to standard BMP
1026 images, gzipped BMP images can be displayed via the
1027 splashscreen support or the bmp command.
1029 - Compression support:
1032 If this option is set, support for bzip2 compressed
1033 images is included. If not, only uncompressed and gzip
1034 compressed images are supported.
1036 NOTE: the bzip2 algorithm requires a lot of RAM, so
1037 the malloc area (as defined by CFG_MALLOC_LEN) should
1043 The address of PHY on MII bus.
1045 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1047 The clock frequency of the MII bus
1051 If this option is set, support for speed/duplex
1052 detection of Gigabit PHY is included.
1054 CONFIG_PHY_RESET_DELAY
1056 Some PHY like Intel LXT971A need extra delay after
1057 reset before any MII register access is possible.
1058 For such PHY, set this option to the usec delay
1059 required. (minimum 300usec for LXT971A)
1061 CONFIG_PHY_CMD_DELAY (ppc4xx)
1063 Some PHY like Intel LXT971A need extra delay after
1064 command issued before MII status register can be read
1071 Define a default value for ethernet address to use
1072 for the respective ethernet interface, in case this
1073 is not determined automatically.
1078 Define a default value for the IP address to use for
1079 the default ethernet interface, in case this is not
1080 determined through e.g. bootp.
1082 - Server IP address:
1085 Defines a default value for theIP address of a TFTP
1086 server to contact when using the "tftboot" command.
1088 - Multicast TFTP Mode:
1091 Defines whether you want to support multicast TFTP as per
1092 rfc-2090; for example to work with atftp. Lets lots of targets
1093 tftp down the same boot image concurrently. Note: the ethernet
1094 driver in use must provide a function: mcast() to join/leave a
1097 CONFIG_BOOTP_RANDOM_DELAY
1098 - BOOTP Recovery Mode:
1099 CONFIG_BOOTP_RANDOM_DELAY
1101 If you have many targets in a network that try to
1102 boot using BOOTP, you may want to avoid that all
1103 systems send out BOOTP requests at precisely the same
1104 moment (which would happen for instance at recovery
1105 from a power failure, when all systems will try to
1106 boot, thus flooding the BOOTP server. Defining
1107 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1108 inserted before sending out BOOTP requests. The
1109 following delays are inserted then:
1111 1st BOOTP request: delay 0 ... 1 sec
1112 2nd BOOTP request: delay 0 ... 2 sec
1113 3rd BOOTP request: delay 0 ... 4 sec
1115 BOOTP requests: delay 0 ... 8 sec
1117 - DHCP Advanced Options:
1118 You can fine tune the DHCP functionality by defining
1119 CONFIG_BOOTP_* symbols:
1121 CONFIG_BOOTP_SUBNETMASK
1122 CONFIG_BOOTP_GATEWAY
1123 CONFIG_BOOTP_HOSTNAME
1124 CONFIG_BOOTP_NISDOMAIN
1125 CONFIG_BOOTP_BOOTPATH
1126 CONFIG_BOOTP_BOOTFILESIZE
1129 CONFIG_BOOTP_SEND_HOSTNAME
1130 CONFIG_BOOTP_NTPSERVER
1131 CONFIG_BOOTP_TIMEOFFSET
1132 CONFIG_BOOTP_VENDOREX
1134 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1135 environment variable, not the BOOTP server.
1137 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1138 serverip from a DHCP server, it is possible that more
1139 than one DNS serverip is offered to the client.
1140 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1141 serverip will be stored in the additional environment
1142 variable "dnsip2". The first DNS serverip is always
1143 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1146 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1147 to do a dynamic update of a DNS server. To do this, they
1148 need the hostname of the DHCP requester.
1149 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1150 of the "hostname" environment variable is passed as
1151 option 12 to the DHCP server.
1154 CONFIG_CDP_DEVICE_ID
1156 The device id used in CDP trigger frames.
1158 CONFIG_CDP_DEVICE_ID_PREFIX
1160 A two character string which is prefixed to the MAC address
1165 A printf format string which contains the ascii name of
1166 the port. Normally is set to "eth%d" which sets
1167 eth0 for the first ethernet, eth1 for the second etc.
1169 CONFIG_CDP_CAPABILITIES
1171 A 32bit integer which indicates the device capabilities;
1172 0x00000010 for a normal host which does not forwards.
1176 An ascii string containing the version of the software.
1180 An ascii string containing the name of the platform.
1184 A 32bit integer sent on the trigger.
1186 CONFIG_CDP_POWER_CONSUMPTION
1188 A 16bit integer containing the power consumption of the
1189 device in .1 of milliwatts.
1191 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1193 A byte containing the id of the VLAN.
1195 - Status LED: CONFIG_STATUS_LED
1197 Several configurations allow to display the current
1198 status using a LED. For instance, the LED will blink
1199 fast while running U-Boot code, stop blinking as
1200 soon as a reply to a BOOTP request was received, and
1201 start blinking slow once the Linux kernel is running
1202 (supported by a status LED driver in the Linux
1203 kernel). Defining CONFIG_STATUS_LED enables this
1206 - CAN Support: CONFIG_CAN_DRIVER
1208 Defining CONFIG_CAN_DRIVER enables CAN driver support
1209 on those systems that support this (optional)
1210 feature, like the TQM8xxL modules.
1212 - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1214 These enable I2C serial bus commands. Defining either of
1215 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1216 include the appropriate I2C driver for the selected cpu.
1218 This will allow you to use i2c commands at the u-boot
1219 command line (as long as you set CONFIG_CMD_I2C in
1220 CONFIG_COMMANDS) and communicate with i2c based realtime
1221 clock chips. See common/cmd_i2c.c for a description of the
1222 command line interface.
1224 CONFIG_I2C_CMD_TREE is a recommended option that places
1225 all I2C commands under a single 'i2c' root command. The
1226 older 'imm', 'imd', 'iprobe' etc. commands are considered
1227 deprecated and may disappear in the future.
1229 CONFIG_HARD_I2C selects a hardware I2C controller.
1231 CONFIG_SOFT_I2C configures u-boot to use a software (aka
1232 bit-banging) driver instead of CPM or similar hardware
1235 There are several other quantities that must also be
1236 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1238 In both cases you will need to define CFG_I2C_SPEED
1239 to be the frequency (in Hz) at which you wish your i2c bus
1240 to run and CFG_I2C_SLAVE to be the address of this node (ie
1241 the cpu's i2c node address).
1243 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1244 sets the cpu up as a master node and so its address should
1245 therefore be cleared to 0 (See, eg, MPC823e User's Manual
1246 p.16-473). So, set CFG_I2C_SLAVE to 0.
1248 That's all that's required for CONFIG_HARD_I2C.
1250 If you use the software i2c interface (CONFIG_SOFT_I2C)
1251 then the following macros need to be defined (examples are
1252 from include/configs/lwmon.h):
1256 (Optional). Any commands necessary to enable the I2C
1257 controller or configure ports.
1259 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
1263 (Only for MPC8260 CPU). The I/O port to use (the code
1264 assumes both bits are on the same port). Valid values
1265 are 0..3 for ports A..D.
1269 The code necessary to make the I2C data line active
1270 (driven). If the data line is open collector, this
1273 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1277 The code necessary to make the I2C data line tri-stated
1278 (inactive). If the data line is open collector, this
1281 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1285 Code that returns TRUE if the I2C data line is high,
1288 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1292 If <bit> is TRUE, sets the I2C data line high. If it
1293 is FALSE, it clears it (low).
1295 eg: #define I2C_SDA(bit) \
1296 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
1297 else immr->im_cpm.cp_pbdat &= ~PB_SDA
1301 If <bit> is TRUE, sets the I2C clock line high. If it
1302 is FALSE, it clears it (low).
1304 eg: #define I2C_SCL(bit) \
1305 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
1306 else immr->im_cpm.cp_pbdat &= ~PB_SCL
1310 This delay is invoked four times per clock cycle so this
1311 controls the rate of data transfer. The data rate thus
1312 is 1 / (I2C_DELAY * 4). Often defined to be something
1315 #define I2C_DELAY udelay(2)
1319 When a board is reset during an i2c bus transfer
1320 chips might think that the current transfer is still
1321 in progress. On some boards it is possible to access
1322 the i2c SCLK line directly, either by using the
1323 processor pin as a GPIO or by having a second pin
1324 connected to the bus. If this option is defined a
1325 custom i2c_init_board() routine in boards/xxx/board.c
1326 is run early in the boot sequence.
1328 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1330 This option enables configuration of bi_iic_fast[] flags
1331 in u-boot bd_info structure based on u-boot environment
1332 variable "i2cfast". (see also i2cfast)
1334 CONFIG_I2C_MULTI_BUS
1336 This option allows the use of multiple I2C buses, each of which
1337 must have a controller. At any point in time, only one bus is
1338 active. To switch to a different bus, use the 'i2c dev' command.
1339 Note that bus numbering is zero-based.
1343 This option specifies a list of I2C devices that will be skipped
1344 when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1345 command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1346 pairs. Otherwise, specify a 1D array of device addresses
1349 #undef CONFIG_I2C_MULTI_BUS
1350 #define CFG_I2C_NOPROBES {0x50,0x68}
1352 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1354 #define CONFIG_I2C_MULTI_BUS
1355 #define CFG_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1357 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1361 If defined, then this indicates the I2C bus number for DDR SPD.
1362 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1366 If defined, then this indicates the I2C bus number for the RTC.
1367 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1371 If defined, then this indicates the I2C bus number for the DTT.
1372 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1376 Define this option if you want to use Freescale's I2C driver in
1377 drivers/i2c/fsl_i2c.c.
1380 - SPI Support: CONFIG_SPI
1382 Enables SPI driver (so far only tested with
1383 SPI EEPROM, also an instance works with Crystal A/D and
1384 D/As on the SACSng board)
1388 Enables extended (16-bit) SPI EEPROM addressing.
1389 (symmetrical to CONFIG_I2C_X)
1393 Enables a software (bit-bang) SPI driver rather than
1394 using hardware support. This is a general purpose
1395 driver that only requires three general I/O port pins
1396 (two outputs, one input) to function. If this is
1397 defined, the board configuration must define several
1398 SPI configuration items (port pins to use, etc). For
1399 an example, see include/configs/sacsng.h.
1403 Enables a hardware SPI driver for general-purpose reads
1404 and writes. As with CONFIG_SOFT_SPI, the board configuration
1405 must define a list of chip-select function pointers.
1406 Currently supported on some MPC8xxx processors. For an
1407 example, see include/configs/mpc8349emds.h.
1409 - FPGA Support: CONFIG_FPGA
1411 Enables FPGA subsystem.
1413 CONFIG_FPGA_<vendor>
1415 Enables support for specific chip vendors.
1418 CONFIG_FPGA_<family>
1420 Enables support for FPGA family.
1421 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1425 Specify the number of FPGA devices to support.
1427 CFG_FPGA_PROG_FEEDBACK
1429 Enable printing of hash marks during FPGA configuration.
1433 Enable checks on FPGA configuration interface busy
1434 status by the configuration function. This option
1435 will require a board or device specific function to
1440 If defined, a function that provides delays in the FPGA
1441 configuration driver.
1443 CFG_FPGA_CHECK_CTRLC
1444 Allow Control-C to interrupt FPGA configuration
1446 CFG_FPGA_CHECK_ERROR
1448 Check for configuration errors during FPGA bitfile
1449 loading. For example, abort during Virtex II
1450 configuration if the INIT_B line goes low (which
1451 indicated a CRC error).
1455 Maximum time to wait for the INIT_B line to deassert
1456 after PROB_B has been deasserted during a Virtex II
1457 FPGA configuration sequence. The default time is 500
1462 Maximum time to wait for BUSY to deassert during
1463 Virtex II FPGA configuration. The default is 5 mS.
1465 CFG_FPGA_WAIT_CONFIG
1467 Time to wait after FPGA configuration. The default is
1470 - Configuration Management:
1473 If defined, this string will be added to the U-Boot
1474 version information (U_BOOT_VERSION)
1476 - Vendor Parameter Protection:
1478 U-Boot considers the values of the environment
1479 variables "serial#" (Board Serial Number) and
1480 "ethaddr" (Ethernet Address) to be parameters that
1481 are set once by the board vendor / manufacturer, and
1482 protects these variables from casual modification by
1483 the user. Once set, these variables are read-only,
1484 and write or delete attempts are rejected. You can
1485 change this behviour:
1487 If CONFIG_ENV_OVERWRITE is #defined in your config
1488 file, the write protection for vendor parameters is
1489 completely disabled. Anybody can change or delete
1492 Alternatively, if you #define _both_ CONFIG_ETHADDR
1493 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1494 ethernet address is installed in the environment,
1495 which can be changed exactly ONCE by the user. [The
1496 serial# is unaffected by this, i. e. it remains
1502 Define this variable to enable the reservation of
1503 "protected RAM", i. e. RAM which is not overwritten
1504 by U-Boot. Define CONFIG_PRAM to hold the number of
1505 kB you want to reserve for pRAM. You can overwrite
1506 this default value by defining an environment
1507 variable "pram" to the number of kB you want to
1508 reserve. Note that the board info structure will
1509 still show the full amount of RAM. If pRAM is
1510 reserved, a new environment variable "mem" will
1511 automatically be defined to hold the amount of
1512 remaining RAM in a form that can be passed as boot
1513 argument to Linux, for instance like that:
1515 setenv bootargs ... mem=\${mem}
1518 This way you can tell Linux not to use this memory,
1519 either, which results in a memory region that will
1520 not be affected by reboots.
1522 *WARNING* If your board configuration uses automatic
1523 detection of the RAM size, you must make sure that
1524 this memory test is non-destructive. So far, the
1525 following board configurations are known to be
1528 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1529 HERMES, IP860, RPXlite, LWMON, LANTEC,
1530 PCU_E, FLAGADM, TQM8260
1535 Define this variable to stop the system in case of a
1536 fatal error, so that you have to reset it manually.
1537 This is probably NOT a good idea for an embedded
1538 system where you want to system to reboot
1539 automatically as fast as possible, but it may be
1540 useful during development since you can try to debug
1541 the conditions that lead to the situation.
1543 CONFIG_NET_RETRY_COUNT
1545 This variable defines the number of retries for
1546 network operations like ARP, RARP, TFTP, or BOOTP
1547 before giving up the operation. If not defined, a
1548 default value of 5 is used.
1552 Timeout waiting for an ARP reply in milliseconds.
1554 - Command Interpreter:
1555 CONFIG_AUTO_COMPLETE
1557 Enable auto completion of commands using TAB.
1559 Note that this feature has NOT been implemented yet
1560 for the "hush" shell.
1565 Define this variable to enable the "hush" shell (from
1566 Busybox) as command line interpreter, thus enabling
1567 powerful command line syntax like
1568 if...then...else...fi conditionals or `&&' and '||'
1569 constructs ("shell scripts").
1571 If undefined, you get the old, much simpler behaviour
1572 with a somewhat smaller memory footprint.
1577 This defines the secondary prompt string, which is
1578 printed when the command interpreter needs more input
1579 to complete a command. Usually "> ".
1583 In the current implementation, the local variables
1584 space and global environment variables space are
1585 separated. Local variables are those you define by
1586 simply typing `name=value'. To access a local
1587 variable later on, you have write `$name' or
1588 `${name}'; to execute the contents of a variable
1589 directly type `$name' at the command prompt.
1591 Global environment variables are those you use
1592 setenv/printenv to work with. To run a command stored
1593 in such a variable, you need to use the run command,
1594 and you must not use the '$' sign to access them.
1596 To store commands and special characters in a
1597 variable, please use double quotation marks
1598 surrounding the whole text of the variable, instead
1599 of the backslashes before semicolons and special
1602 - Commandline Editing and History:
1603 CONFIG_CMDLINE_EDITING
1605 Enable editiong and History functions for interactive
1606 commandline input operations
1608 - Default Environment:
1609 CONFIG_EXTRA_ENV_SETTINGS
1611 Define this to contain any number of null terminated
1612 strings (variable = value pairs) that will be part of
1613 the default environment compiled into the boot image.
1615 For example, place something like this in your
1616 board's config file:
1618 #define CONFIG_EXTRA_ENV_SETTINGS \
1622 Warning: This method is based on knowledge about the
1623 internal format how the environment is stored by the
1624 U-Boot code. This is NOT an official, exported
1625 interface! Although it is unlikely that this format
1626 will change soon, there is no guarantee either.
1627 You better know what you are doing here.
1629 Note: overly (ab)use of the default environment is
1630 discouraged. Make sure to check other ways to preset
1631 the environment like the autoscript function or the
1634 - DataFlash Support:
1635 CONFIG_HAS_DATAFLASH
1637 Defining this option enables DataFlash features and
1638 allows to read/write in Dataflash via the standard
1641 - SystemACE Support:
1644 Adding this option adds support for Xilinx SystemACE
1645 chips attached via some sort of local bus. The address
1646 of the chip must alsh be defined in the
1647 CFG_SYSTEMACE_BASE macro. For example:
1649 #define CONFIG_SYSTEMACE
1650 #define CFG_SYSTEMACE_BASE 0xf0000000
1652 When SystemACE support is added, the "ace" device type
1653 becomes available to the fat commands, i.e. fatls.
1655 - TFTP Fixed UDP Port:
1658 If this is defined, the environment variable tftpsrcp
1659 is used to supply the TFTP UDP source port value.
1660 If tftpsrcp isn't defined, the normal pseudo-random port
1661 number generator is used.
1663 Also, the environment variable tftpdstp is used to supply
1664 the TFTP UDP destination port value. If tftpdstp isn't
1665 defined, the normal port 69 is used.
1667 The purpose for tftpsrcp is to allow a TFTP server to
1668 blindly start the TFTP transfer using the pre-configured
1669 target IP address and UDP port. This has the effect of
1670 "punching through" the (Windows XP) firewall, allowing
1671 the remainder of the TFTP transfer to proceed normally.
1672 A better solution is to properly configure the firewall,
1673 but sometimes that is not allowed.
1675 - Show boot progress:
1676 CONFIG_SHOW_BOOT_PROGRESS
1678 Defining this option allows to add some board-
1679 specific code (calling a user-provided function
1680 "show_boot_progress(int)") that enables you to show
1681 the system's boot progress on some display (for
1682 example, some LED's) on your board. At the moment,
1683 the following checkpoints are implemented:
1685 Legacy uImage format:
1688 1 common/cmd_bootm.c before attempting to boot an image
1689 -1 common/cmd_bootm.c Image header has bad magic number
1690 2 common/cmd_bootm.c Image header has correct magic number
1691 -2 common/cmd_bootm.c Image header has bad checksum
1692 3 common/cmd_bootm.c Image header has correct checksum
1693 -3 common/cmd_bootm.c Image data has bad checksum
1694 4 common/cmd_bootm.c Image data has correct checksum
1695 -4 common/cmd_bootm.c Image is for unsupported architecture
1696 5 common/cmd_bootm.c Architecture check OK
1697 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1698 6 common/cmd_bootm.c Image Type check OK
1699 -6 common/cmd_bootm.c gunzip uncompression error
1700 -7 common/cmd_bootm.c Unimplemented compression type
1701 7 common/cmd_bootm.c Uncompression OK
1702 8 common/cmd_bootm.c No uncompress/copy overwrite error
1703 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1705 9 common/image.c Start initial ramdisk verification
1706 -10 common/image.c Ramdisk header has bad magic number
1707 -11 common/image.c Ramdisk header has bad checksum
1708 10 common/image.c Ramdisk header is OK
1709 -12 common/image.c Ramdisk data has bad checksum
1710 11 common/image.c Ramdisk data has correct checksum
1711 12 common/image.c Ramdisk verification complete, start loading
1712 -13 common/image.c Wrong Image Type (not PPC Linux Ramdisk)
1713 13 common/image.c Start multifile image verification
1714 14 common/image.c No initial ramdisk, no multifile, continue.
1716 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
1718 -30 lib_ppc/board.c Fatal error, hang the system
1719 -31 post/post.c POST test failed, detected by post_output_backlog()
1720 -32 post/post.c POST test failed, detected by post_run_single()
1722 34 common/cmd_doc.c before loading a Image from a DOC device
1723 -35 common/cmd_doc.c Bad usage of "doc" command
1724 35 common/cmd_doc.c correct usage of "doc" command
1725 -36 common/cmd_doc.c No boot device
1726 36 common/cmd_doc.c correct boot device
1727 -37 common/cmd_doc.c Unknown Chip ID on boot device
1728 37 common/cmd_doc.c correct chip ID found, device available
1729 -38 common/cmd_doc.c Read Error on boot device
1730 38 common/cmd_doc.c reading Image header from DOC device OK
1731 -39 common/cmd_doc.c Image header has bad magic number
1732 39 common/cmd_doc.c Image header has correct magic number
1733 -40 common/cmd_doc.c Error reading Image from DOC device
1734 40 common/cmd_doc.c Image header has correct magic number
1735 41 common/cmd_ide.c before loading a Image from a IDE device
1736 -42 common/cmd_ide.c Bad usage of "ide" command
1737 42 common/cmd_ide.c correct usage of "ide" command
1738 -43 common/cmd_ide.c No boot device
1739 43 common/cmd_ide.c boot device found
1740 -44 common/cmd_ide.c Device not available
1741 44 common/cmd_ide.c Device available
1742 -45 common/cmd_ide.c wrong partition selected
1743 45 common/cmd_ide.c partition selected
1744 -46 common/cmd_ide.c Unknown partition table
1745 46 common/cmd_ide.c valid partition table found
1746 -47 common/cmd_ide.c Invalid partition type
1747 47 common/cmd_ide.c correct partition type
1748 -48 common/cmd_ide.c Error reading Image Header on boot device
1749 48 common/cmd_ide.c reading Image Header from IDE device OK
1750 -49 common/cmd_ide.c Image header has bad magic number
1751 49 common/cmd_ide.c Image header has correct magic number
1752 -50 common/cmd_ide.c Image header has bad checksum
1753 50 common/cmd_ide.c Image header has correct checksum
1754 -51 common/cmd_ide.c Error reading Image from IDE device
1755 51 common/cmd_ide.c reading Image from IDE device OK
1756 52 common/cmd_nand.c before loading a Image from a NAND device
1757 -53 common/cmd_nand.c Bad usage of "nand" command
1758 53 common/cmd_nand.c correct usage of "nand" command
1759 -54 common/cmd_nand.c No boot device
1760 54 common/cmd_nand.c boot device found
1761 -55 common/cmd_nand.c Unknown Chip ID on boot device
1762 55 common/cmd_nand.c correct chip ID found, device available
1763 -56 common/cmd_nand.c Error reading Image Header on boot device
1764 56 common/cmd_nand.c reading Image Header from NAND device OK
1765 -57 common/cmd_nand.c Image header has bad magic number
1766 57 common/cmd_nand.c Image header has correct magic number
1767 -58 common/cmd_nand.c Error reading Image from NAND device
1768 58 common/cmd_nand.c reading Image from NAND device OK
1770 -60 common/env_common.c Environment has a bad CRC, using default
1772 64 net/eth.c starting with Ethernetconfiguration.
1773 -64 net/eth.c no Ethernet found.
1774 65 net/eth.c Ethernet found.
1776 -80 common/cmd_net.c usage wrong
1777 80 common/cmd_net.c before calling NetLoop()
1778 -81 common/cmd_net.c some error in NetLoop() occured
1779 81 common/cmd_net.c NetLoop() back without error
1780 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1781 82 common/cmd_net.c trying automatic boot
1782 83 common/cmd_net.c running autoscript
1783 -83 common/cmd_net.c some error in automatic boot or autoscript
1784 84 common/cmd_net.c end without errors
1789 100 common/cmd_bootm.c Kernel FIT Image has correct format
1790 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1791 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1792 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1793 102 common/cmd_bootm.c Kernel unit name specified
1794 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1795 103 common/cmd_bootm.c Found configuration node
1796 104 common/cmd_bootm.c Got kernel subimage node offset
1797 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1798 105 common/cmd_bootm.c Kernel subimage hash verification OK
1799 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1800 106 common/cmd_bootm.c Architecture check OK
1801 -106 common/cmd_bootm.c Kernel subimage has wrong typea
1802 107 common/cmd_bootm.c Kernel subimge type OK
1803 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1804 108 common/cmd_bootm.c Got kernel subimage data/size
1805 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1806 -109 common/cmd_bootm.c Can't get kernel subimage type
1807 -110 common/cmd_bootm.c Can't get kernel subimage comp
1808 -111 common/cmd_bootm.c Can't get kernel subimage os
1809 -112 common/cmd_bootm.c Can't get kernel subimage load address
1810 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1812 120 common/image.c Start initial ramdisk verification
1813 -120 common/image.c Ramdisk FIT image has incorrect format
1814 121 common/image.c Ramdisk FIT image has correct format
1815 122 common/image.c No Ramdisk subimage unit name, using configuration
1816 -122 common/image.c Can't get configuration for ramdisk subimage
1817 123 common/image.c Ramdisk unit name specified
1818 -124 common/image.c Can't get ramdisk subimage node offset
1819 125 common/image.c Got ramdisk subimage node offset
1820 -125 common/image.c Ramdisk subimage hash verification failed
1821 126 common/image.c Ramdisk subimage hash verification OK
1822 -126 common/image.c Ramdisk subimage for unsupported architecture
1823 127 common/image.c Architecture check OK
1824 -127 common/image.c Can't get ramdisk subimage data/size
1825 128 common/image.c Got ramdisk subimage data/size
1826 129 common/image.c Can't get ramdisk load address
1827 -129 common/image.c Got ramdisk load address
1829 -130 common/cmd_doc.c Icorrect FIT image format
1830 131 common/cmd_doc.c FIT image format OK
1832 -140 common/cmd_ide.c Icorrect FIT image format
1833 141 common/cmd_ide.c FIT image format OK
1835 -150 common/cmd_nand.c Icorrect FIT image format
1836 151 common/cmd_nand.c FIT image format OK
1842 [so far only for SMDK2400 and TRAB boards]
1844 - Modem support endable:
1845 CONFIG_MODEM_SUPPORT
1847 - RTS/CTS Flow control enable:
1850 - Modem debug support:
1851 CONFIG_MODEM_SUPPORT_DEBUG
1853 Enables debugging stuff (char screen[1024], dbg())
1854 for modem support. Useful only with BDI2000.
1856 - Interrupt support (PPC):
1858 There are common interrupt_init() and timer_interrupt()
1859 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1860 for cpu specific initialization. interrupt_init_cpu()
1861 should set decrementer_count to appropriate value. If
1862 cpu resets decrementer automatically after interrupt
1863 (ppc4xx) it should set decrementer_count to zero.
1864 timer_interrupt() calls timer_interrupt_cpu() for cpu
1865 specific handling. If board has watchdog / status_led
1866 / other_activity_monitor it works automatically from
1867 general timer_interrupt().
1871 In the target system modem support is enabled when a
1872 specific key (key combination) is pressed during
1873 power-on. Otherwise U-Boot will boot normally
1874 (autoboot). The key_pressed() fuction is called from
1875 board_init(). Currently key_pressed() is a dummy
1876 function, returning 1 and thus enabling modem
1879 If there are no modem init strings in the
1880 environment, U-Boot proceed to autoboot; the
1881 previous output (banner, info printfs) will be
1884 See also: doc/README.Modem
1887 Configuration Settings:
1888 -----------------------
1890 - CFG_LONGHELP: Defined when you want long help messages included;
1891 undefine this when you're short of memory.
1893 - CFG_PROMPT: This is what U-Boot prints on the console to
1894 prompt for user input.
1896 - CFG_CBSIZE: Buffer size for input from the Console
1898 - CFG_PBSIZE: Buffer size for Console output
1900 - CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1902 - CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1903 the application (usually a Linux kernel) when it is
1906 - CFG_BAUDRATE_TABLE:
1907 List of legal baudrate settings for this board.
1909 - CFG_CONSOLE_INFO_QUIET
1910 Suppress display of console information at boot.
1912 - CFG_CONSOLE_IS_IN_ENV
1913 If the board specific function
1914 extern int overwrite_console (void);
1915 returns 1, the stdin, stderr and stdout are switched to the
1916 serial port, else the settings in the environment are used.
1918 - CFG_CONSOLE_OVERWRITE_ROUTINE
1919 Enable the call to overwrite_console().
1921 - CFG_CONSOLE_ENV_OVERWRITE
1922 Enable overwrite of previous console environment settings.
1924 - CFG_MEMTEST_START, CFG_MEMTEST_END:
1925 Begin and End addresses of the area used by the
1929 Enable an alternate, more extensive memory test.
1931 - CFG_MEMTEST_SCRATCH:
1932 Scratch address used by the alternate memory test
1933 You only need to set this if address zero isn't writeable
1935 - CFG_TFTP_LOADADDR:
1936 Default load address for network file downloads
1938 - CFG_LOADS_BAUD_CHANGE:
1939 Enable temporary baudrate change while serial download
1942 Physical start address of SDRAM. _Must_ be 0 here.
1945 Physical start address of Motherboard I/O (if using a
1949 Physical start address of Flash memory.
1952 Physical start address of boot monitor code (set by
1953 make config files to be same as the text base address
1954 (TEXT_BASE) used when linking) - same as
1955 CFG_FLASH_BASE when booting from flash.
1958 Size of memory reserved for monitor code, used to
1959 determine _at_compile_time_ (!) if the environment is
1960 embedded within the U-Boot image, or in a separate
1964 Size of DRAM reserved for malloc() use.
1967 Normally compressed uImages are limited to an
1968 uncompressed size of 8 MBytes. If this is not enough,
1969 you can define CFG_BOOTM_LEN in your board config file
1970 to adjust this setting to your needs.
1973 Maximum size of memory mapped by the startup code of
1974 the Linux kernel; all data that must be processed by
1975 the Linux kernel (bd_info, boot arguments, eventually
1976 initrd image) must be put below this limit.
1978 - CFG_MAX_FLASH_BANKS:
1979 Max number of Flash memory banks
1981 - CFG_MAX_FLASH_SECT:
1982 Max number of sectors on a Flash chip
1984 - CFG_FLASH_ERASE_TOUT:
1985 Timeout for Flash erase operations (in ms)
1987 - CFG_FLASH_WRITE_TOUT:
1988 Timeout for Flash write operations (in ms)
1990 - CFG_FLASH_LOCK_TOUT
1991 Timeout for Flash set sector lock bit operation (in ms)
1993 - CFG_FLASH_UNLOCK_TOUT
1994 Timeout for Flash clear lock bits operation (in ms)
1996 - CFG_FLASH_PROTECTION
1997 If defined, hardware flash sectors protection is used
1998 instead of U-Boot software protection.
2000 - CFG_DIRECT_FLASH_TFTP:
2002 Enable TFTP transfers directly to flash memory;
2003 without this option such a download has to be
2004 performed in two steps: (1) download to RAM, and (2)
2005 copy from RAM to flash.
2007 The two-step approach is usually more reliable, since
2008 you can check if the download worked before you erase
2009 the flash, but in some situations (when sytem RAM is
2010 too limited to allow for a tempory copy of the
2011 downloaded image) this option may be very useful.
2014 Define if the flash driver uses extra elements in the
2015 common flash structure for storing flash geometry.
2017 - CFG_FLASH_CFI_DRIVER
2018 This option also enables the building of the cfi_flash driver
2019 in the drivers directory
2021 - CFG_FLASH_USE_BUFFER_WRITE
2022 Use buffered writes to flash.
2024 - CONFIG_FLASH_SPANSION_S29WS_N
2025 s29ws-n MirrorBit flash has non-standard addresses for buffered
2028 - CFG_FLASH_QUIET_TEST
2029 If this option is defined, the common CFI flash doesn't
2030 print it's warning upon not recognized FLASH banks. This
2031 is useful, if some of the configured banks are only
2032 optionally available.
2034 - CONFIG_FLASH_SHOW_PROGRESS
2035 If defined (must be an integer), print out countdown
2036 digits and dots. Recommended value: 45 (9..1) for 80
2037 column displays, 15 (3..1) for 40 column displays.
2039 - CFG_RX_ETH_BUFFER:
2040 Defines the number of ethernet receive buffers. On some
2041 ethernet controllers it is recommended to set this value
2042 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2043 buffers can be full shortly after enabling the interface
2044 on high ethernet traffic.
2045 Defaults to 4 if not defined.
2047 The following definitions that deal with the placement and management
2048 of environment data (variable area); in general, we support the
2049 following configurations:
2051 - CFG_ENV_IS_IN_FLASH:
2053 Define this if the environment is in flash memory.
2055 a) The environment occupies one whole flash sector, which is
2056 "embedded" in the text segment with the U-Boot code. This
2057 happens usually with "bottom boot sector" or "top boot
2058 sector" type flash chips, which have several smaller
2059 sectors at the start or the end. For instance, such a
2060 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2061 such a case you would place the environment in one of the
2062 4 kB sectors - with U-Boot code before and after it. With
2063 "top boot sector" type flash chips, you would put the
2064 environment in one of the last sectors, leaving a gap
2065 between U-Boot and the environment.
2069 Offset of environment data (variable area) to the
2070 beginning of flash memory; for instance, with bottom boot
2071 type flash chips the second sector can be used: the offset
2072 for this sector is given here.
2074 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
2078 This is just another way to specify the start address of
2079 the flash sector containing the environment (instead of
2082 - CFG_ENV_SECT_SIZE:
2084 Size of the sector containing the environment.
2087 b) Sometimes flash chips have few, equal sized, BIG sectors.
2088 In such a case you don't want to spend a whole sector for
2093 If you use this in combination with CFG_ENV_IS_IN_FLASH
2094 and CFG_ENV_SECT_SIZE, you can specify to use only a part
2095 of this flash sector for the environment. This saves
2096 memory for the RAM copy of the environment.
2098 It may also save flash memory if you decide to use this
2099 when your environment is "embedded" within U-Boot code,
2100 since then the remainder of the flash sector could be used
2101 for U-Boot code. It should be pointed out that this is
2102 STRONGLY DISCOURAGED from a robustness point of view:
2103 updating the environment in flash makes it always
2104 necessary to erase the WHOLE sector. If something goes
2105 wrong before the contents has been restored from a copy in
2106 RAM, your target system will be dead.
2108 - CFG_ENV_ADDR_REDUND
2111 These settings describe a second storage area used to hold
2112 a redundand copy of the environment data, so that there is
2113 a valid backup copy in case there is a power failure during
2114 a "saveenv" operation.
2116 BE CAREFUL! Any changes to the flash layout, and some changes to the
2117 source code will make it necessary to adapt <board>/u-boot.lds*
2121 - CFG_ENV_IS_IN_NVRAM:
2123 Define this if you have some non-volatile memory device
2124 (NVRAM, battery buffered SRAM) which you want to use for the
2130 These two #defines are used to determin the memory area you
2131 want to use for environment. It is assumed that this memory
2132 can just be read and written to, without any special
2135 BE CAREFUL! The first access to the environment happens quite early
2136 in U-Boot initalization (when we try to get the setting of for the
2137 console baudrate). You *MUST* have mappend your NVRAM area then, or
2140 Please note that even with NVRAM we still use a copy of the
2141 environment in RAM: we could work on NVRAM directly, but we want to
2142 keep settings there always unmodified except somebody uses "saveenv"
2143 to save the current settings.
2146 - CFG_ENV_IS_IN_EEPROM:
2148 Use this if you have an EEPROM or similar serial access
2149 device and a driver for it.
2154 These two #defines specify the offset and size of the
2155 environment area within the total memory of your EEPROM.
2157 - CFG_I2C_EEPROM_ADDR:
2158 If defined, specified the chip address of the EEPROM device.
2159 The default address is zero.
2161 - CFG_EEPROM_PAGE_WRITE_BITS:
2162 If defined, the number of bits used to address bytes in a
2163 single page in the EEPROM device. A 64 byte page, for example
2164 would require six bits.
2166 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2167 If defined, the number of milliseconds to delay between
2168 page writes. The default is zero milliseconds.
2170 - CFG_I2C_EEPROM_ADDR_LEN:
2171 The length in bytes of the EEPROM memory array address. Note
2172 that this is NOT the chip address length!
2174 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
2175 EEPROM chips that implement "address overflow" are ones
2176 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2177 address and the extra bits end up in the "chip address" bit
2178 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2181 Note that we consider the length of the address field to
2182 still be one byte because the extra address bits are hidden
2183 in the chip address.
2186 The size in bytes of the EEPROM device.
2189 - CFG_ENV_IS_IN_DATAFLASH:
2191 Define this if you have a DataFlash memory device which you
2192 want to use for the environment.
2198 These three #defines specify the offset and size of the
2199 environment area within the total memory of your DataFlash placed
2200 at the specified address.
2202 - CFG_ENV_IS_IN_NAND:
2204 Define this if you have a NAND device which you want to use
2205 for the environment.
2210 These two #defines specify the offset and size of the environment
2211 area within the first NAND device.
2213 - CFG_ENV_OFFSET_REDUND
2215 This setting describes a second storage area of CFG_ENV_SIZE
2216 size used to hold a redundant copy of the environment data,
2217 so that there is a valid backup copy in case there is a
2218 power failure during a "saveenv" operation.
2220 Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2221 to a block boundary, and CFG_ENV_SIZE must be a multiple of
2222 the NAND devices block size.
2224 - CFG_SPI_INIT_OFFSET
2226 Defines offset to the initial SPI buffer area in DPRAM. The
2227 area is used at an early stage (ROM part) if the environment
2228 is configured to reside in the SPI EEPROM: We need a 520 byte
2229 scratch DPRAM area. It is used between the two initialization
2230 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2231 to be a good choice since it makes it far enough from the
2232 start of the data area as well as from the stack pointer.
2234 Please note that the environment is read-only until the monitor
2235 has been relocated to RAM and a RAM copy of the environment has been
2236 created; also, when using EEPROM you will have to use getenv_r()
2237 until then to read environment variables.
2239 The environment is protected by a CRC32 checksum. Before the monitor
2240 is relocated into RAM, as a result of a bad CRC you will be working
2241 with the compiled-in default environment - *silently*!!! [This is
2242 necessary, because the first environment variable we need is the
2243 "baudrate" setting for the console - if we have a bad CRC, we don't
2244 have any device yet where we could complain.]
2246 Note: once the monitor has been relocated, then it will complain if
2247 the default environment is used; a new CRC is computed as soon as you
2248 use the "saveenv" command to store a valid environment.
2250 - CFG_FAULT_ECHO_LINK_DOWN:
2251 Echo the inverted Ethernet link state to the fault LED.
2253 Note: If this option is active, then CFG_FAULT_MII_ADDR
2254 also needs to be defined.
2256 - CFG_FAULT_MII_ADDR:
2257 MII address of the PHY to check for the Ethernet link state.
2259 - CFG_64BIT_VSPRINTF:
2260 Makes vsprintf (and all *printf functions) support printing
2261 of 64bit values by using the L quantifier
2263 - CFG_64BIT_STRTOUL:
2264 Adds simple_strtoull that returns a 64bit value
2266 Low Level (hardware related) configuration options:
2267 ---------------------------------------------------
2269 - CFG_CACHELINE_SIZE:
2270 Cache Line Size of the CPU.
2273 Default address of the IMMR after system reset.
2275 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2276 and RPXsuper) to be able to adjust the position of
2277 the IMMR register after a reset.
2279 - Floppy Disk Support:
2280 CFG_FDC_DRIVE_NUMBER
2282 the default drive number (default value 0)
2286 defines the spacing between fdc chipset registers
2291 defines the offset of register from address. It
2292 depends on which part of the data bus is connected to
2293 the fdc chipset. (default value 0)
2295 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
2296 CFG_FDC_DRIVE_NUMBER are undefined, they take their
2299 if CFG_FDC_HW_INIT is defined, then the function
2300 fdc_hw_init() is called at the beginning of the FDC
2301 setup. fdc_hw_init() must be provided by the board
2302 source code. It is used to make hardware dependant
2305 - CFG_IMMR: Physical address of the Internal Memory.
2306 DO NOT CHANGE unless you know exactly what you're
2307 doing! (11-4) [MPC8xx/82xx systems only]
2309 - CFG_INIT_RAM_ADDR:
2311 Start address of memory area that can be used for
2312 initial data and stack; please note that this must be
2313 writable memory that is working WITHOUT special
2314 initialization, i. e. you CANNOT use normal RAM which
2315 will become available only after programming the
2316 memory controller and running certain initialization
2319 U-Boot uses the following memory types:
2320 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2321 - MPC824X: data cache
2322 - PPC4xx: data cache
2324 - CFG_GBL_DATA_OFFSET:
2326 Offset of the initial data structure in the memory
2327 area defined by CFG_INIT_RAM_ADDR. Usually
2328 CFG_GBL_DATA_OFFSET is chosen such that the initial
2329 data is located at the end of the available space
2330 (sometimes written as (CFG_INIT_RAM_END -
2331 CFG_INIT_DATA_SIZE), and the initial stack is just
2332 below that area (growing from (CFG_INIT_RAM_ADDR +
2333 CFG_GBL_DATA_OFFSET) downward.
2336 On the MPC824X (or other systems that use the data
2337 cache for initial memory) the address chosen for
2338 CFG_INIT_RAM_ADDR is basically arbitrary - it must
2339 point to an otherwise UNUSED address space between
2340 the top of RAM and the start of the PCI space.
2342 - CFG_SIUMCR: SIU Module Configuration (11-6)
2344 - CFG_SYPCR: System Protection Control (11-9)
2346 - CFG_TBSCR: Time Base Status and Control (11-26)
2348 - CFG_PISCR: Periodic Interrupt Status and Control (11-31)
2350 - CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
2352 - CFG_SCCR: System Clock and reset Control Register (15-27)
2354 - CFG_OR_TIMING_SDRAM:
2358 periodic timer for refresh
2360 - CFG_DER: Debug Event Register (37-47)
2362 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2363 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2364 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2366 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2368 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2369 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2370 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2371 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2373 - CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2374 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2375 Machine Mode Register and Memory Periodic Timer
2376 Prescaler definitions (SDRAM timing)
2378 - CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2379 enable I2C microcode relocation patch (MPC8xx);
2380 define relocation offset in DPRAM [DSP2]
2382 - CFG_SMC_UCODE_PATCH, CFG_SMC_DPMEM_OFFSET [0x1FC0]:
2383 enable SMC microcode relocation patch (MPC8xx);
2384 define relocation offset in DPRAM [SMC1]
2386 - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2387 enable SPI microcode relocation patch (MPC8xx);
2388 define relocation offset in DPRAM [SCC4]
2391 Use OSCM clock mode on MBX8xx board. Be careful,
2392 wrong setting might damage your board. Read
2393 doc/README.MBX before setting this variable!
2395 - CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2396 Offset of the bootmode word in DPRAM used by post
2397 (Power On Self Tests). This definition overrides
2398 #define'd default value in commproc.h resp.
2401 - CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2402 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2403 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2404 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2405 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2406 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2407 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
2408 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2409 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2412 Get DDR timing information from an I2C EEPROM. Common
2413 with pluggable memory modules such as SODIMMs
2416 I2C address of the SPD EEPROM
2419 If SPD EEPROM is on an I2C bus other than the first
2420 one, specify here. Note that the value must resolve
2421 to something your driver can deal with.
2423 - CFG_83XX_DDR_USES_CS0
2424 Only for 83xx systems. If specified, then DDR should
2425 be configured using CS0 and CS1 instead of CS2 and CS3.
2427 - CFG_83XX_DDR_USES_CS0
2428 Only for 83xx systems. If specified, then DDR should
2429 be configured using CS0 and CS1 instead of CS2 and CS3.
2431 - CONFIG_ETHER_ON_FEC[12]
2432 Define to enable FEC[12] on a 8xx series processor.
2434 - CONFIG_FEC[12]_PHY
2435 Define to the hardcoded PHY address which corresponds
2436 to the given FEC; i. e.
2437 #define CONFIG_FEC1_PHY 4
2438 means that the PHY with address 4 is connected to FEC1
2440 When set to -1, means to probe for first available.
2442 - CONFIG_FEC[12]_PHY_NORXERR
2443 The PHY does not have a RXERR line (RMII only).
2444 (so program the FEC to ignore it).
2447 Enable RMII mode for all FECs.
2448 Note that this is a global option, we can't
2449 have one FEC in standard MII mode and another in RMII mode.
2451 - CONFIG_CRC32_VERIFY
2452 Add a verify option to the crc32 command.
2455 => crc32 -v <address> <count> <crc32>
2457 Where address/count indicate a memory area
2458 and crc32 is the correct crc32 which the
2462 Add the "loopw" memory command. This only takes effect if
2463 the memory commands are activated globally (CONFIG_CMD_MEM).
2466 Add the "mdc" and "mwc" memory commands. These are cyclic
2471 This command will print 4 bytes (10,11,12,13) each 500 ms.
2473 => mwc.l 100 12345678 10
2474 This command will write 12345678 to address 100 all 10 ms.
2476 This only takes effect if the memory commands are activated
2477 globally (CONFIG_CMD_MEM).
2479 - CONFIG_SKIP_LOWLEVEL_INIT
2480 - CONFIG_SKIP_RELOCATE_UBOOT
2482 [ARM only] If these variables are defined, then
2483 certain low level initializations (like setting up
2484 the memory controller) are omitted and/or U-Boot does
2485 not relocate itself into RAM.
2486 Normally these variables MUST NOT be defined. The
2487 only exception is when U-Boot is loaded (to RAM) by
2488 some other boot loader or by a debugger which
2489 performs these intializations itself.
2492 Building the Software:
2493 ======================
2495 Building U-Boot has been tested in several native build environments
2496 and in many different cross environments. Of course we cannot support
2497 all possibly existing versions of cross development tools in all
2498 (potentially obsolete) versions. In case of tool chain problems we
2499 recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2500 which is extensively used to build and test U-Boot.
2502 If you are not using a native environment, it is assumed that you
2503 have GNU cross compiling tools available in your path. In this case,
2504 you must set the environment variable CROSS_COMPILE in your shell.
2505 Note that no changes to the Makefile or any other source files are
2506 necessary. For example using the ELDK on a 4xx CPU, please enter:
2508 $ CROSS_COMPILE=ppc_4xx-
2509 $ export CROSS_COMPILE
2511 U-Boot is intended to be simple to build. After installing the
2512 sources you must configure U-Boot for one specific board type. This
2517 where "NAME_config" is the name of one of the existing configu-
2518 rations; see the main Makefile for supported names.
2520 Note: for some board special configuration names may exist; check if
2521 additional information is available from the board vendor; for
2522 instance, the TQM823L systems are available without (standard)
2523 or with LCD support. You can select such additional "features"
2524 when chosing the configuration, i. e.
2527 - will configure for a plain TQM823L, i. e. no LCD support
2529 make TQM823L_LCD_config
2530 - will configure for a TQM823L with U-Boot console on LCD
2535 Finally, type "make all", and you should get some working U-Boot
2536 images ready for download to / installation on your system:
2538 - "u-boot.bin" is a raw binary image
2539 - "u-boot" is an image in ELF binary format
2540 - "u-boot.srec" is in Motorola S-Record format
2542 By default the build is performed locally and the objects are saved
2543 in the source directory. One of the two methods can be used to change
2544 this behavior and build U-Boot to some external directory:
2546 1. Add O= to the make command line invocations:
2548 make O=/tmp/build distclean
2549 make O=/tmp/build NAME_config
2550 make O=/tmp/build all
2552 2. Set environment variable BUILD_DIR to point to the desired location:
2554 export BUILD_DIR=/tmp/build
2559 Note that the command line "O=" setting overrides the BUILD_DIR environment
2563 Please be aware that the Makefiles assume you are using GNU make, so
2564 for instance on NetBSD you might need to use "gmake" instead of
2568 If the system board that you have is not listed, then you will need
2569 to port U-Boot to your hardware platform. To do this, follow these
2572 1. Add a new configuration option for your board to the toplevel
2573 "Makefile" and to the "MAKEALL" script, using the existing
2574 entries as examples. Note that here and at many other places
2575 boards and other names are listed in alphabetical sort order. Please
2577 2. Create a new directory to hold your board specific code. Add any
2578 files you need. In your board directory, you will need at least
2579 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
2580 3. Create a new configuration file "include/configs/<board>.h" for
2582 3. If you're porting U-Boot to a new CPU, then also create a new
2583 directory to hold your CPU specific code. Add any files you need.
2584 4. Run "make <board>_config" with your new name.
2585 5. Type "make", and you should get a working "u-boot.srec" file
2586 to be installed on your target system.
2587 6. Debug and solve any problems that might arise.
2588 [Of course, this last step is much harder than it sounds.]
2591 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2592 ==============================================================
2594 If you have modified U-Boot sources (for instance added a new board
2595 or support for new devices, a new CPU, etc.) you are expected to
2596 provide feedback to the other developers. The feedback normally takes
2597 the form of a "patch", i. e. a context diff against a certain (latest
2598 official or latest in the git repository) version of U-Boot sources.
2600 But before you submit such a patch, please verify that your modifi-
2601 cation did not break existing code. At least make sure that *ALL* of
2602 the supported boards compile WITHOUT ANY compiler warnings. To do so,
2603 just run the "MAKEALL" script, which will configure and build U-Boot
2604 for ALL supported system. Be warned, this will take a while. You can
2605 select which (cross) compiler to use by passing a `CROSS_COMPILE'
2606 environment variable to the script, i. e. to use the ELDK cross tools
2609 CROSS_COMPILE=ppc_8xx- MAKEALL
2611 or to build on a native PowerPC system you can type
2613 CROSS_COMPILE=' ' MAKEALL
2615 When using the MAKEALL script, the default behaviour is to build
2616 U-Boot in the source directory. This location can be changed by
2617 setting the BUILD_DIR environment variable. Also, for each target
2618 built, the MAKEALL script saves two log files (<target>.ERR and
2619 <target>.MAKEALL) in the <source dir>/LOG directory. This default
2620 location can be changed by setting the MAKEALL_LOGDIR environment
2621 variable. For example:
2623 export BUILD_DIR=/tmp/build
2624 export MAKEALL_LOGDIR=/tmp/log
2625 CROSS_COMPILE=ppc_8xx- MAKEALL
2627 With the above settings build objects are saved in the /tmp/build,
2628 log files are saved in the /tmp/log and the source tree remains clean
2629 during the whole build process.
2632 See also "U-Boot Porting Guide" below.
2635 Monitor Commands - Overview:
2636 ============================
2638 go - start application at address 'addr'
2639 run - run commands in an environment variable
2640 bootm - boot application image from memory
2641 bootp - boot image via network using BootP/TFTP protocol
2642 tftpboot- boot image via network using TFTP protocol
2643 and env variables "ipaddr" and "serverip"
2644 (and eventually "gatewayip")
2645 rarpboot- boot image via network using RARP/TFTP protocol
2646 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2647 loads - load S-Record file over serial line
2648 loadb - load binary file over serial line (kermit mode)
2650 mm - memory modify (auto-incrementing)
2651 nm - memory modify (constant address)
2652 mw - memory write (fill)
2654 cmp - memory compare
2655 crc32 - checksum calculation
2656 imd - i2c memory display
2657 imm - i2c memory modify (auto-incrementing)
2658 inm - i2c memory modify (constant address)
2659 imw - i2c memory write (fill)
2660 icrc32 - i2c checksum calculation
2661 iprobe - probe to discover valid I2C chip addresses
2662 iloop - infinite loop on address range
2663 isdram - print SDRAM configuration information
2664 sspi - SPI utility commands
2665 base - print or set address offset
2666 printenv- print environment variables
2667 setenv - set environment variables
2668 saveenv - save environment variables to persistent storage
2669 protect - enable or disable FLASH write protection
2670 erase - erase FLASH memory
2671 flinfo - print FLASH memory information
2672 bdinfo - print Board Info structure
2673 iminfo - print header information for application image
2674 coninfo - print console devices and informations
2675 ide - IDE sub-system
2676 loop - infinite loop on address range
2677 loopw - infinite write loop on address range
2678 mtest - simple RAM test
2679 icache - enable or disable instruction cache
2680 dcache - enable or disable data cache
2681 reset - Perform RESET of the CPU
2682 echo - echo args to console
2683 version - print monitor version
2684 help - print online help
2685 ? - alias for 'help'
2688 Monitor Commands - Detailed Description:
2689 ========================================
2693 For now: just type "help <command>".
2696 Environment Variables:
2697 ======================
2699 U-Boot supports user configuration using Environment Variables which
2700 can be made persistent by saving to Flash memory.
2702 Environment Variables are set using "setenv", printed using
2703 "printenv", and saved to Flash using "saveenv". Using "setenv"
2704 without a value can be used to delete a variable from the
2705 environment. As long as you don't save the environment you are
2706 working with an in-memory copy. In case the Flash area containing the
2707 environment is erased by accident, a default environment is provided.
2709 Some configuration options can be set using Environment Variables:
2711 baudrate - see CONFIG_BAUDRATE
2713 bootdelay - see CONFIG_BOOTDELAY
2715 bootcmd - see CONFIG_BOOTCOMMAND
2717 bootargs - Boot arguments when booting an RTOS image
2719 bootfile - Name of the image to load with TFTP
2721 autoload - if set to "no" (any string beginning with 'n'),
2722 "bootp" will just load perform a lookup of the
2723 configuration from the BOOTP server, but not try to
2724 load any image using TFTP
2726 autoscript - if set to "yes" commands like "loadb", "loady",
2727 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
2728 to automatically run script images (by internally
2729 calling "autoscript").
2731 autoscript_uname - if script image is in a format (FIT) this
2732 variable is used to get script subimage unit name.
2734 autostart - if set to "yes", an image loaded using the "bootp",
2735 "rarpboot", "tftpboot" or "diskboot" commands will
2736 be automatically started (by internally calling
2739 If set to "no", a standalone image passed to the
2740 "bootm" command will be copied to the load address
2741 (and eventually uncompressed), but NOT be started.
2742 This can be used to load and uncompress arbitrary
2745 i2cfast - (PPC405GP|PPC405EP only)
2746 if set to 'y' configures Linux I2C driver for fast
2747 mode (400kHZ). This environment variable is used in
2748 initialization code. So, for changes to be effective
2749 it must be saved and board must be reset.
2751 initrd_high - restrict positioning of initrd images:
2752 If this variable is not set, initrd images will be
2753 copied to the highest possible address in RAM; this
2754 is usually what you want since it allows for
2755 maximum initrd size. If for some reason you want to
2756 make sure that the initrd image is loaded below the
2757 CFG_BOOTMAPSZ limit, you can set this environment
2758 variable to a value of "no" or "off" or "0".
2759 Alternatively, you can set it to a maximum upper
2760 address to use (U-Boot will still check that it
2761 does not overwrite the U-Boot stack and data).
2763 For instance, when you have a system with 16 MB
2764 RAM, and want to reserve 4 MB from use by Linux,
2765 you can do this by adding "mem=12M" to the value of
2766 the "bootargs" variable. However, now you must make
2767 sure that the initrd image is placed in the first
2768 12 MB as well - this can be done with
2770 setenv initrd_high 00c00000
2772 If you set initrd_high to 0xFFFFFFFF, this is an
2773 indication to U-Boot that all addresses are legal
2774 for the Linux kernel, including addresses in flash
2775 memory. In this case U-Boot will NOT COPY the
2776 ramdisk at all. This may be useful to reduce the
2777 boot time on your system, but requires that this
2778 feature is supported by your Linux kernel.
2780 ipaddr - IP address; needed for tftpboot command
2782 loadaddr - Default load address for commands like "bootp",
2783 "rarpboot", "tftpboot", "loadb" or "diskboot"
2785 loads_echo - see CONFIG_LOADS_ECHO
2787 serverip - TFTP server IP address; needed for tftpboot command
2789 bootretry - see CONFIG_BOOT_RETRY_TIME
2791 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
2793 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
2795 ethprime - When CONFIG_NET_MULTI is enabled controls which
2796 interface is used first.
2798 ethact - When CONFIG_NET_MULTI is enabled controls which
2799 interface is currently active. For example you
2800 can do the following
2802 => setenv ethact FEC ETHERNET
2803 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2804 => setenv ethact SCC ETHERNET
2805 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2807 ethrotate - When set to "no" U-Boot does not go through all
2808 available network interfaces.
2809 It just stays at the currently selected interface.
2811 netretry - When set to "no" each network operation will
2812 either succeed or fail without retrying.
2813 When set to "once" the network operation will
2814 fail when all the available network interfaces
2815 are tried once without success.
2816 Useful on scripts which control the retry operation
2819 npe_ucode - see CONFIG_IXP4XX_NPE_EXT_UCOD
2820 if set load address for the npe microcode
2822 tftpsrcport - If this is set, the value is used for TFTP's
2825 tftpdstport - If this is set, the value is used for TFTP's UDP
2826 destination port instead of the Well Know Port 69.
2828 vlan - When set to a value < 4095 the traffic over
2829 ethernet is encapsulated/received over 802.1q
2832 The following environment variables may be used and automatically
2833 updated by the network boot commands ("bootp" and "rarpboot"),
2834 depending the information provided by your boot server:
2836 bootfile - see above
2837 dnsip - IP address of your Domain Name Server
2838 dnsip2 - IP address of your secondary Domain Name Server
2839 gatewayip - IP address of the Gateway (Router) to use
2840 hostname - Target hostname
2842 netmask - Subnet Mask
2843 rootpath - Pathname of the root filesystem on the NFS server
2844 serverip - see above
2847 There are two special Environment Variables:
2849 serial# - contains hardware identification information such
2850 as type string and/or serial number
2851 ethaddr - Ethernet address
2853 These variables can be set only once (usually during manufacturing of
2854 the board). U-Boot refuses to delete or overwrite these variables
2855 once they have been set once.
2858 Further special Environment Variables:
2860 ver - Contains the U-Boot version string as printed
2861 with the "version" command. This variable is
2862 readonly (see CONFIG_VERSION_VARIABLE).
2865 Please note that changes to some configuration parameters may take
2866 only effect after the next boot (yes, that's just like Windoze :-).
2869 Command Line Parsing:
2870 =====================
2872 There are two different command line parsers available with U-Boot:
2873 the old "simple" one, and the much more powerful "hush" shell:
2875 Old, simple command line parser:
2876 --------------------------------
2878 - supports environment variables (through setenv / saveenv commands)
2879 - several commands on one line, separated by ';'
2880 - variable substitution using "... ${name} ..." syntax
2881 - special characters ('$', ';') can be escaped by prefixing with '\',
2883 setenv bootcmd bootm \${address}
2884 - You can also escape text by enclosing in single apostrophes, for example:
2885 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2890 - similar to Bourne shell, with control structures like
2891 if...then...else...fi, for...do...done; while...do...done,
2892 until...do...done, ...
2893 - supports environment ("global") variables (through setenv / saveenv
2894 commands) and local shell variables (through standard shell syntax
2895 "name=value"); only environment variables can be used with "run"
2901 (1) If a command line (or an environment variable executed by a "run"
2902 command) contains several commands separated by semicolon, and
2903 one of these commands fails, then the remaining commands will be
2906 (2) If you execute several variables with one call to run (i. e.
2907 calling run with a list af variables as arguments), any failing
2908 command will cause "run" to terminate, i. e. the remaining
2909 variables are not executed.
2911 Note for Redundant Ethernet Interfaces:
2912 =======================================
2914 Some boards come with redundant ethernet interfaces; U-Boot supports
2915 such configurations and is capable of automatic selection of a
2916 "working" interface when needed. MAC assignment works as follows:
2918 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2919 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2920 "eth1addr" (=>eth1), "eth2addr", ...
2922 If the network interface stores some valid MAC address (for instance
2923 in SROM), this is used as default address if there is NO correspon-
2924 ding setting in the environment; if the corresponding environment
2925 variable is set, this overrides the settings in the card; that means:
2927 o If the SROM has a valid MAC address, and there is no address in the
2928 environment, the SROM's address is used.
2930 o If there is no valid address in the SROM, and a definition in the
2931 environment exists, then the value from the environment variable is
2934 o If both the SROM and the environment contain a MAC address, and
2935 both addresses are the same, this MAC address is used.
2937 o If both the SROM and the environment contain a MAC address, and the
2938 addresses differ, the value from the environment is used and a
2941 o If neither SROM nor the environment contain a MAC address, an error
2948 U-Boot is capable of booting (and performing other auxiliary operations on)
2949 images in two formats:
2951 New uImage format (FIT)
2952 -----------------------
2954 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
2955 to Flattened Device Tree). It allows the use of images with multiple
2956 components (several kernels, ramdisks, etc.), with contents protected by
2957 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
2963 Old image format is based on binary files which can be basically anything,
2964 preceded by a special header; see the definitions in include/image.h for
2965 details; basically, the header defines the following image properties:
2967 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2968 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2969 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2970 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2971 * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
2972 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2973 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
2974 * Compression Type (uncompressed, gzip, bzip2)
2980 The header is marked by a special Magic Number, and both the header
2981 and the data portions of the image are secured against corruption by
2988 Although U-Boot should support any OS or standalone application
2989 easily, the main focus has always been on Linux during the design of
2992 U-Boot includes many features that so far have been part of some
2993 special "boot loader" code within the Linux kernel. Also, any
2994 "initrd" images to be used are no longer part of one big Linux image;
2995 instead, kernel and "initrd" are separate images. This implementation
2996 serves several purposes:
2998 - the same features can be used for other OS or standalone
2999 applications (for instance: using compressed images to reduce the
3000 Flash memory footprint)
3002 - it becomes much easier to port new Linux kernel versions because
3003 lots of low-level, hardware dependent stuff are done by U-Boot
3005 - the same Linux kernel image can now be used with different "initrd"
3006 images; of course this also means that different kernel images can
3007 be run with the same "initrd". This makes testing easier (you don't
3008 have to build a new "zImage.initrd" Linux image when you just
3009 change a file in your "initrd"). Also, a field-upgrade of the
3010 software is easier now.
3016 Porting Linux to U-Boot based systems:
3017 ---------------------------------------
3019 U-Boot cannot save you from doing all the necessary modifications to
3020 configure the Linux device drivers for use with your target hardware
3021 (no, we don't intend to provide a full virtual machine interface to
3024 But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
3026 Just make sure your machine specific header file (for instance
3027 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
3028 Information structure as we define in include/u-boot.h, and make
3029 sure that your definition of IMAP_ADDR uses the same value as your
3030 U-Boot configuration in CFG_IMMR.
3033 Configuring the Linux kernel:
3034 -----------------------------
3036 No specific requirements for U-Boot. Make sure you have some root
3037 device (initial ramdisk, NFS) for your target system.
3040 Building a Linux Image:
3041 -----------------------
3043 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3044 not used. If you use recent kernel source, a new build target
3045 "uImage" will exist which automatically builds an image usable by
3046 U-Boot. Most older kernels also have support for a "pImage" target,
3047 which was introduced for our predecessor project PPCBoot and uses a
3048 100% compatible format.
3057 The "uImage" build target uses a special tool (in 'tools/mkimage') to
3058 encapsulate a compressed Linux kernel image with header information,
3059 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
3061 * build a standard "vmlinux" kernel image (in ELF binary format):
3063 * convert the kernel into a raw binary image:
3065 ${CROSS_COMPILE}-objcopy -O binary \
3066 -R .note -R .comment \
3067 -S vmlinux linux.bin
3069 * compress the binary image:
3073 * package compressed binary image for U-Boot:
3075 mkimage -A ppc -O linux -T kernel -C gzip \
3076 -a 0 -e 0 -n "Linux Kernel Image" \
3077 -d linux.bin.gz uImage
3080 The "mkimage" tool can also be used to create ramdisk images for use
3081 with U-Boot, either separated from the Linux kernel image, or
3082 combined into one file. "mkimage" encapsulates the images with a 64
3083 byte header containing information about target architecture,
3084 operating system, image type, compression method, entry points, time
3085 stamp, CRC32 checksums, etc.
3087 "mkimage" can be called in two ways: to verify existing images and
3088 print the header information, or to build new images.
3090 In the first form (with "-l" option) mkimage lists the information
3091 contained in the header of an existing U-Boot image; this includes
3092 checksum verification:
3094 tools/mkimage -l image
3095 -l ==> list image header information
3097 The second form (with "-d" option) is used to build a U-Boot image
3098 from a "data file" which is used as image payload:
3100 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3101 -n name -d data_file image
3102 -A ==> set architecture to 'arch'
3103 -O ==> set operating system to 'os'
3104 -T ==> set image type to 'type'
3105 -C ==> set compression type 'comp'
3106 -a ==> set load address to 'addr' (hex)
3107 -e ==> set entry point to 'ep' (hex)
3108 -n ==> set image name to 'name'
3109 -d ==> use image data from 'datafile'
3111 Right now, all Linux kernels for PowerPC systems use the same load
3112 address (0x00000000), but the entry point address depends on the
3115 - 2.2.x kernels have the entry point at 0x0000000C,
3116 - 2.3.x and later kernels have the entry point at 0x00000000.
3118 So a typical call to build a U-Boot image would read:
3120 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3121 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3122 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3123 > examples/uImage.TQM850L
3124 Image Name: 2.4.4 kernel for TQM850L
3125 Created: Wed Jul 19 02:34:59 2000
3126 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3127 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3128 Load Address: 0x00000000
3129 Entry Point: 0x00000000
3131 To verify the contents of the image (or check for corruption):
3133 -> tools/mkimage -l examples/uImage.TQM850L
3134 Image Name: 2.4.4 kernel for TQM850L
3135 Created: Wed Jul 19 02:34:59 2000
3136 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3137 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3138 Load Address: 0x00000000
3139 Entry Point: 0x00000000
3141 NOTE: for embedded systems where boot time is critical you can trade
3142 speed for memory and install an UNCOMPRESSED image instead: this
3143 needs more space in Flash, but boots much faster since it does not
3144 need to be uncompressed:
3146 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3147 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3148 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3149 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3150 > examples/uImage.TQM850L-uncompressed
3151 Image Name: 2.4.4 kernel for TQM850L
3152 Created: Wed Jul 19 02:34:59 2000
3153 Image Type: PowerPC Linux Kernel Image (uncompressed)
3154 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3155 Load Address: 0x00000000
3156 Entry Point: 0x00000000
3159 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3160 when your kernel is intended to use an initial ramdisk:
3162 -> tools/mkimage -n 'Simple Ramdisk Image' \
3163 > -A ppc -O linux -T ramdisk -C gzip \
3164 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3165 Image Name: Simple Ramdisk Image
3166 Created: Wed Jan 12 14:01:50 2000
3167 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3168 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3169 Load Address: 0x00000000
3170 Entry Point: 0x00000000
3173 Installing a Linux Image:
3174 -------------------------
3176 To downloading a U-Boot image over the serial (console) interface,
3177 you must convert the image to S-Record format:
3179 objcopy -I binary -O srec examples/image examples/image.srec
3181 The 'objcopy' does not understand the information in the U-Boot
3182 image header, so the resulting S-Record file will be relative to
3183 address 0x00000000. To load it to a given address, you need to
3184 specify the target address as 'offset' parameter with the 'loads'
3187 Example: install the image to address 0x40100000 (which on the
3188 TQM8xxL is in the first Flash bank):
3190 => erase 40100000 401FFFFF
3196 ## Ready for S-Record download ...
3197 ~>examples/image.srec
3198 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3200 15989 15990 15991 15992
3201 [file transfer complete]
3203 ## Start Addr = 0x00000000
3206 You can check the success of the download using the 'iminfo' command;
3207 this includes a checksum verification so you can be sure no data
3208 corruption happened:
3212 ## Checking Image at 40100000 ...
3213 Image Name: 2.2.13 for initrd on TQM850L
3214 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3215 Data Size: 335725 Bytes = 327 kB = 0 MB
3216 Load Address: 00000000
3217 Entry Point: 0000000c
3218 Verifying Checksum ... OK
3224 The "bootm" command is used to boot an application that is stored in
3225 memory (RAM or Flash). In case of a Linux kernel image, the contents
3226 of the "bootargs" environment variable is passed to the kernel as
3227 parameters. You can check and modify this variable using the
3228 "printenv" and "setenv" commands:
3231 => printenv bootargs
3232 bootargs=root=/dev/ram
3234 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3236 => printenv bootargs
3237 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3240 ## Booting Linux kernel at 40020000 ...
3241 Image Name: 2.2.13 for NFS on TQM850L
3242 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3243 Data Size: 381681 Bytes = 372 kB = 0 MB
3244 Load Address: 00000000
3245 Entry Point: 0000000c
3246 Verifying Checksum ... OK
3247 Uncompressing Kernel Image ... OK
3248 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
3249 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3250 time_init: decrementer frequency = 187500000/60
3251 Calibrating delay loop... 49.77 BogoMIPS
3252 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3255 If you want to boot a Linux kernel with initial ram disk, you pass
3256 the memory addresses of both the kernel and the initrd image (PPBCOOT
3257 format!) to the "bootm" command:
3259 => imi 40100000 40200000
3261 ## Checking Image at 40100000 ...
3262 Image Name: 2.2.13 for initrd on TQM850L
3263 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3264 Data Size: 335725 Bytes = 327 kB = 0 MB
3265 Load Address: 00000000
3266 Entry Point: 0000000c
3267 Verifying Checksum ... OK
3269 ## Checking Image at 40200000 ...
3270 Image Name: Simple Ramdisk Image
3271 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3272 Data Size: 566530 Bytes = 553 kB = 0 MB
3273 Load Address: 00000000
3274 Entry Point: 00000000
3275 Verifying Checksum ... OK
3277 => bootm 40100000 40200000
3278 ## Booting Linux kernel at 40100000 ...
3279 Image Name: 2.2.13 for initrd on TQM850L
3280 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3281 Data Size: 335725 Bytes = 327 kB = 0 MB
3282 Load Address: 00000000
3283 Entry Point: 0000000c
3284 Verifying Checksum ... OK
3285 Uncompressing Kernel Image ... OK
3286 ## Loading RAMDisk Image at 40200000 ...
3287 Image Name: Simple Ramdisk Image
3288 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3289 Data Size: 566530 Bytes = 553 kB = 0 MB
3290 Load Address: 00000000
3291 Entry Point: 00000000
3292 Verifying Checksum ... OK
3293 Loading Ramdisk ... OK
3294 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
3295 Boot arguments: root=/dev/ram
3296 time_init: decrementer frequency = 187500000/60
3297 Calibrating delay loop... 49.77 BogoMIPS
3299 RAMDISK: Compressed image found at block 0
3300 VFS: Mounted root (ext2 filesystem).
3304 Boot Linux and pass a flat device tree:
3307 First, U-Boot must be compiled with the appropriate defines. See the section
3308 titled "Linux Kernel Interface" above for a more in depth explanation. The
3309 following is an example of how to start a kernel and pass an updated
3315 oft=oftrees/mpc8540ads.dtb
3316 => tftp $oftaddr $oft
3317 Speed: 1000, full duplex
3319 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3320 Filename 'oftrees/mpc8540ads.dtb'.
3321 Load address: 0x300000
3324 Bytes transferred = 4106 (100a hex)
3325 => tftp $loadaddr $bootfile
3326 Speed: 1000, full duplex
3328 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3330 Load address: 0x200000
3331 Loading:############
3333 Bytes transferred = 1029407 (fb51f hex)
3338 => bootm $loadaddr - $oftaddr
3339 ## Booting image at 00200000 ...
3340 Image Name: Linux-2.6.17-dirty
3341 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3342 Data Size: 1029343 Bytes = 1005.2 kB
3343 Load Address: 00000000
3344 Entry Point: 00000000
3345 Verifying Checksum ... OK
3346 Uncompressing Kernel Image ... OK
3347 Booting using flat device tree at 0x300000
3348 Using MPC85xx ADS machine description
3349 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3353 More About U-Boot Image Types:
3354 ------------------------------
3356 U-Boot supports the following image types:
3358 "Standalone Programs" are directly runnable in the environment
3359 provided by U-Boot; it is expected that (if they behave
3360 well) you can continue to work in U-Boot after return from
3361 the Standalone Program.
3362 "OS Kernel Images" are usually images of some Embedded OS which
3363 will take over control completely. Usually these programs
3364 will install their own set of exception handlers, device
3365 drivers, set up the MMU, etc. - this means, that you cannot
3366 expect to re-enter U-Boot except by resetting the CPU.
3367 "RAMDisk Images" are more or less just data blocks, and their
3368 parameters (address, size) are passed to an OS kernel that is
3370 "Multi-File Images" contain several images, typically an OS
3371 (Linux) kernel image and one or more data images like
3372 RAMDisks. This construct is useful for instance when you want
3373 to boot over the network using BOOTP etc., where the boot
3374 server provides just a single image file, but you want to get
3375 for instance an OS kernel and a RAMDisk image.
3377 "Multi-File Images" start with a list of image sizes, each
3378 image size (in bytes) specified by an "uint32_t" in network
3379 byte order. This list is terminated by an "(uint32_t)0".
3380 Immediately after the terminating 0 follow the images, one by
3381 one, all aligned on "uint32_t" boundaries (size rounded up to
3382 a multiple of 4 bytes).
3384 "Firmware Images" are binary images containing firmware (like
3385 U-Boot or FPGA images) which usually will be programmed to
3388 "Script files" are command sequences that will be executed by
3389 U-Boot's command interpreter; this feature is especially
3390 useful when you configure U-Boot to use a real shell (hush)
3391 as command interpreter.
3397 One of the features of U-Boot is that you can dynamically load and
3398 run "standalone" applications, which can use some resources of
3399 U-Boot like console I/O functions or interrupt services.
3401 Two simple examples are included with the sources:
3406 'examples/hello_world.c' contains a small "Hello World" Demo
3407 application; it is automatically compiled when you build U-Boot.
3408 It's configured to run at address 0x00040004, so you can play with it
3412 ## Ready for S-Record download ...
3413 ~>examples/hello_world.srec
3414 1 2 3 4 5 6 7 8 9 10 11 ...
3415 [file transfer complete]
3417 ## Start Addr = 0x00040004
3419 => go 40004 Hello World! This is a test.
3420 ## Starting application at 0x00040004 ...
3431 Hit any key to exit ...
3433 ## Application terminated, rc = 0x0
3435 Another example, which demonstrates how to register a CPM interrupt
3436 handler with the U-Boot code, can be found in 'examples/timer.c'.
3437 Here, a CPM timer is set up to generate an interrupt every second.
3438 The interrupt service routine is trivial, just printing a '.'
3439 character, but this is just a demo program. The application can be
3440 controlled by the following keys:
3442 ? - print current values og the CPM Timer registers
3443 b - enable interrupts and start timer
3444 e - stop timer and disable interrupts
3445 q - quit application
3448 ## Ready for S-Record download ...
3449 ~>examples/timer.srec
3450 1 2 3 4 5 6 7 8 9 10 11 ...
3451 [file transfer complete]
3453 ## Start Addr = 0x00040004
3456 ## Starting application at 0x00040004 ...
3459 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3462 [q, b, e, ?] Set interval 1000000 us
3465 [q, b, e, ?] ........
3466 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3469 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3472 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3475 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3477 [q, b, e, ?] ...Stopping timer
3479 [q, b, e, ?] ## Application terminated, rc = 0x0
3485 Over time, many people have reported problems when trying to use the
3486 "minicom" terminal emulation program for serial download. I (wd)
3487 consider minicom to be broken, and recommend not to use it. Under
3488 Unix, I recommend to use C-Kermit for general purpose use (and
3489 especially for kermit binary protocol download ("loadb" command), and
3490 use "cu" for S-Record download ("loads" command).
3492 Nevertheless, if you absolutely want to use it try adding this
3493 configuration to your "File transfer protocols" section:
3495 Name Program Name U/D FullScr IO-Red. Multi
3496 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3497 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
3503 Starting at version 0.9.2, U-Boot supports NetBSD both as host
3504 (build U-Boot) and target system (boots NetBSD/mpc8xx).
3506 Building requires a cross environment; it is known to work on
3507 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3508 need gmake since the Makefiles are not compatible with BSD make).
3509 Note that the cross-powerpc package does not install include files;
3510 attempting to build U-Boot will fail because <machine/ansi.h> is
3511 missing. This file has to be installed and patched manually:
3513 # cd /usr/pkg/cross/powerpc-netbsd/include
3515 # ln -s powerpc machine
3516 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3517 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
3519 Native builds *don't* work due to incompatibilities between native
3520 and U-Boot include files.
3522 Booting assumes that (the first part of) the image booted is a
3523 stage-2 loader which in turn loads and then invokes the kernel
3524 proper. Loader sources will eventually appear in the NetBSD source
3525 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
3526 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3529 Implementation Internals:
3530 =========================
3532 The following is not intended to be a complete description of every
3533 implementation detail. However, it should help to understand the
3534 inner workings of U-Boot and make it easier to port it to custom
3538 Initial Stack, Global Data:
3539 ---------------------------
3541 The implementation of U-Boot is complicated by the fact that U-Boot
3542 starts running out of ROM (flash memory), usually without access to
3543 system RAM (because the memory controller is not initialized yet).
3544 This means that we don't have writable Data or BSS segments, and BSS
3545 is not initialized as zero. To be able to get a C environment working
3546 at all, we have to allocate at least a minimal stack. Implementation
3547 options for this are defined and restricted by the CPU used: Some CPU
3548 models provide on-chip memory (like the IMMR area on MPC8xx and
3549 MPC826x processors), on others (parts of) the data cache can be
3550 locked as (mis-) used as memory, etc.
3552 Chris Hallinan posted a good summary of these issues to the
3553 u-boot-users mailing list:
3555 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3556 From: "Chris Hallinan" <clh@net1plus.com>
3557 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3560 Correct me if I'm wrong, folks, but the way I understand it
3561 is this: Using DCACHE as initial RAM for Stack, etc, does not
3562 require any physical RAM backing up the cache. The cleverness
3563 is that the cache is being used as a temporary supply of
3564 necessary storage before the SDRAM controller is setup. It's
3565 beyond the scope of this list to expain the details, but you
3566 can see how this works by studying the cache architecture and
3567 operation in the architecture and processor-specific manuals.
3569 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3570 is another option for the system designer to use as an
3571 initial stack/ram area prior to SDRAM being available. Either
3572 option should work for you. Using CS 4 should be fine if your
3573 board designers haven't used it for something that would
3574 cause you grief during the initial boot! It is frequently not
3577 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3578 with your processor/board/system design. The default value
3579 you will find in any recent u-boot distribution in
3580 walnut.h should work for you. I'd set it to a value larger
3581 than your SDRAM module. If you have a 64MB SDRAM module, set
3582 it above 400_0000. Just make sure your board has no resources
3583 that are supposed to respond to that address! That code in
3584 start.S has been around a while and should work as is when
3585 you get the config right.
3590 It is essential to remember this, since it has some impact on the C
3591 code for the initialization procedures:
3593 * Initialized global data (data segment) is read-only. Do not attempt
3596 * Do not use any unitialized global data (or implicitely initialized
3597 as zero data - BSS segment) at all - this is undefined, initiali-
3598 zation is performed later (when relocating to RAM).
3600 * Stack space is very limited. Avoid big data buffers or things like
3603 Having only the stack as writable memory limits means we cannot use
3604 normal global data to share information beween the code. But it
3605 turned out that the implementation of U-Boot can be greatly
3606 simplified by making a global data structure (gd_t) available to all
3607 functions. We could pass a pointer to this data as argument to _all_
3608 functions, but this would bloat the code. Instead we use a feature of
3609 the GCC compiler (Global Register Variables) to share the data: we
3610 place a pointer (gd) to the global data into a register which we
3611 reserve for this purpose.
3613 When choosing a register for such a purpose we are restricted by the
3614 relevant (E)ABI specifications for the current architecture, and by
3615 GCC's implementation.
3617 For PowerPC, the following registers have specific use:
3619 R2: reserved for system use
3620 R3-R4: parameter passing and return values
3621 R5-R10: parameter passing
3622 R13: small data area pointer
3626 (U-Boot also uses R14 as internal GOT pointer.)
3628 ==> U-Boot will use R2 to hold a pointer to the global data
3630 Note: on PPC, we could use a static initializer (since the
3631 address of the global data structure is known at compile time),
3632 but it turned out that reserving a register results in somewhat
3633 smaller code - although the code savings are not that big (on
3634 average for all boards 752 bytes for the whole U-Boot image,
3635 624 text + 127 data).
3637 On Blackfin, the normal C ABI (except for P5) is followed as documented here:
3638 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3640 ==> U-Boot will use P5 to hold a pointer to the global data
3642 On ARM, the following registers are used:
3644 R0: function argument word/integer result
3645 R1-R3: function argument word
3647 R10: stack limit (used only if stack checking if enabled)
3648 R11: argument (frame) pointer
3649 R12: temporary workspace
3652 R15: program counter
3654 ==> U-Boot will use R8 to hold a pointer to the global data
3656 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3657 or current versions of GCC may "optimize" the code too much.
3662 U-Boot runs in system state and uses physical addresses, i.e. the
3663 MMU is not used either for address mapping nor for memory protection.
3665 The available memory is mapped to fixed addresses using the memory
3666 controller. In this process, a contiguous block is formed for each
3667 memory type (Flash, SDRAM, SRAM), even when it consists of several
3668 physical memory banks.
3670 U-Boot is installed in the first 128 kB of the first Flash bank (on
3671 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3672 booting and sizing and initializing DRAM, the code relocates itself
3673 to the upper end of DRAM. Immediately below the U-Boot code some
3674 memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3675 configuration setting]. Below that, a structure with global Board
3676 Info data is placed, followed by the stack (growing downward).
3678 Additionally, some exception handler code is copied to the low 8 kB
3679 of DRAM (0x00000000 ... 0x00001FFF).
3681 So a typical memory configuration with 16 MB of DRAM could look like
3684 0x0000 0000 Exception Vector code
3687 0x0000 2000 Free for Application Use
3693 0x00FB FF20 Monitor Stack (Growing downward)
3694 0x00FB FFAC Board Info Data and permanent copy of global data
3695 0x00FC 0000 Malloc Arena
3698 0x00FE 0000 RAM Copy of Monitor Code
3699 ... eventually: LCD or video framebuffer
3700 ... eventually: pRAM (Protected RAM - unchanged by reset)
3701 0x00FF FFFF [End of RAM]
3704 System Initialization:
3705 ----------------------
3707 In the reset configuration, U-Boot starts at the reset entry point
3708 (on most PowerPC systens at address 0x00000100). Because of the reset
3709 configuration for CS0# this is a mirror of the onboard Flash memory.
3710 To be able to re-map memory U-Boot then jumps to its link address.
3711 To be able to implement the initialization code in C, a (small!)
3712 initial stack is set up in the internal Dual Ported RAM (in case CPUs
3713 which provide such a feature like MPC8xx or MPC8260), or in a locked
3714 part of the data cache. After that, U-Boot initializes the CPU core,
3715 the caches and the SIU.
3717 Next, all (potentially) available memory banks are mapped using a
3718 preliminary mapping. For example, we put them on 512 MB boundaries
3719 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3720 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3721 programmed for SDRAM access. Using the temporary configuration, a
3722 simple memory test is run that determines the size of the SDRAM
3725 When there is more than one SDRAM bank, and the banks are of
3726 different size, the largest is mapped first. For equal size, the first
3727 bank (CS2#) is mapped first. The first mapping is always for address
3728 0x00000000, with any additional banks following immediately to create
3729 contiguous memory starting from 0.
3731 Then, the monitor installs itself at the upper end of the SDRAM area
3732 and allocates memory for use by malloc() and for the global Board
3733 Info data; also, the exception vector code is copied to the low RAM
3734 pages, and the final stack is set up.
3736 Only after this relocation will you have a "normal" C environment;
3737 until that you are restricted in several ways, mostly because you are
3738 running from ROM, and because the code will have to be relocated to a
3742 U-Boot Porting Guide:
3743 ----------------------
3745 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3749 int main (int argc, char *argv[])
3751 sighandler_t no_more_time;
3753 signal (SIGALRM, no_more_time);
3754 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3756 if (available_money > available_manpower) {
3757 pay consultant to port U-Boot;
3761 Download latest U-Boot source;
3763 Subscribe to u-boot-users mailing list;
3766 email ("Hi, I am new to U-Boot, how do I get started?");
3770 Read the README file in the top level directory;
3771 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3772 Read the source, Luke;
3775 if (available_money > toLocalCurrency ($2500)) {
3778 Add a lot of aggravation and time;
3781 Create your own board support subdirectory;
3783 Create your own board config file;
3787 Add / modify source code;
3791 email ("Hi, I am having problems...");
3793 Send patch file to Wolfgang;
3798 void no_more_time (int sig)
3807 All contributions to U-Boot should conform to the Linux kernel
3808 coding style; see the file "Documentation/CodingStyle" and the script
3809 "scripts/Lindent" in your Linux kernel source directory. In sources
3810 originating from U-Boot a style corresponding to "Lindent -pcs" (adding
3811 spaces before parameters to function calls) is actually used.
3813 Source files originating from a different project (for example the
3814 MTD subsystem) are generally exempt from these guidelines and are not
3815 reformated to ease subsequent migration to newer versions of those
3818 Please note that U-Boot is implemented in C (and to some small parts in
3819 Assembler); no C++ is used, so please do not use C++ style comments (//)
3822 Please also stick to the following formatting rules:
3823 - remove any trailing white space
3824 - use TAB characters for indentation, not spaces
3825 - make sure NOT to use DOS '\r\n' line feeds
3826 - do not add more than 2 empty lines to source files
3827 - do not add trailing empty lines to source files
3829 Submissions which do not conform to the standards may be returned
3830 with a request to reformat the changes.
3836 Since the number of patches for U-Boot is growing, we need to
3837 establish some rules. Submissions which do not conform to these rules
3838 may be rejected, even when they contain important and valuable stuff.
3840 Patches shall be sent to the u-boot-users mailing list.
3842 Please see http://www.denx.de/wiki/UBoot/Patches for details.
3844 When you send a patch, please include the following information with
3847 * For bug fixes: a description of the bug and how your patch fixes
3848 this bug. Please try to include a way of demonstrating that the
3849 patch actually fixes something.
3851 * For new features: a description of the feature and your
3854 * A CHANGELOG entry as plaintext (separate from the patch)
3856 * For major contributions, your entry to the CREDITS file
3858 * When you add support for a new board, don't forget to add this
3859 board to the MAKEALL script, too.
3861 * If your patch adds new configuration options, don't forget to
3862 document these in the README file.
3864 * The patch itself. If you are using git (which is *strongly*
3865 recommended) you can easily generate the patch using the
3866 "git-format-patch". If you then use "git-send-email" to send it to
3867 the U-Boot mailing list, you will avoid most of the common problems
3868 with some other mail clients.
3870 If you cannot use git, use "diff -purN OLD NEW". If your version of
3871 diff does not support these options, then get the latest version of
3874 The current directory when running this command shall be the parent
3875 directory of the U-Boot source tree (i. e. please make sure that
3876 your patch includes sufficient directory information for the
3879 We prefer patches as plain text. MIME attachments are discouraged,
3880 and compressed attachments must not be used.
3882 * If one logical set of modifications affects or creates several
3883 files, all these changes shall be submitted in a SINGLE patch file.
3885 * Changesets that contain different, unrelated modifications shall be
3886 submitted as SEPARATE patches, one patch per changeset.
3891 * Before sending the patch, run the MAKEALL script on your patched
3892 source tree and make sure that no errors or warnings are reported
3893 for any of the boards.
3895 * Keep your modifications to the necessary minimum: A patch
3896 containing several unrelated changes or arbitrary reformats will be
3897 returned with a request to re-formatting / split it.
3899 * If you modify existing code, make sure that your new code does not
3900 add to the memory footprint of the code ;-) Small is beautiful!
3901 When adding new features, these should compile conditionally only
3902 (using #ifdef), and the resulting code with the new feature
3903 disabled must not need more memory than the old code without your
3906 * Remember that there is a size limit of 40 kB per message on the
3907 u-boot-users mailing list. Bigger patches will be moderated. If
3908 they are reasonable and not bigger than 100 kB, they will be
3909 acknowledged. Even bigger patches should be avoided.
projects / u-boot / blob