2 # (C) Copyright 2000 - 2004
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 and ARM processors, which can be
29 installed in a boot ROM and used to initialize and test the hardware
30 or to download and run application code.
32 The development of U-Boot is closely related to Linux: some parts of
33 the source code originate in the Linux source tree, we have some
34 header files in common, and special provision has been made to
35 support booting of Linux images.
37 Some attention has been paid to make this software easily
38 configurable and extendable. For instance, all monitor commands are
39 implemented with the same call interface, so that it's very easy to
40 add new commands. Also, instead of permanently adding rarely used
41 code (for instance hardware test utilities) to the monitor, you can
42 load and run it dynamically.
48 In general, all boards for which a configuration option exists in the
49 Makefile have been tested to some extent and can be considered
50 "working". In fact, many of them are used in production systems.
52 In case of problems see the CHANGELOG and CREDITS files to find out
53 who contributed the specific port.
59 In case you have questions about, problems with or contributions for
60 U-Boot you should send a message to the U-Boot mailing list at
61 <u-boot-users@lists.sourceforge.net>. There is also an archive of
62 previous traffic on the mailing list - please search the archive
63 before asking FAQ's. Please see
64 http://lists.sourceforge.net/lists/listinfo/u-boot-users/
70 - start from 8xxrom sources
71 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
73 - make it easier to add custom boards
74 - make it possible to add other [PowerPC] CPUs
75 - extend functions, especially:
76 * Provide extended interface to Linux boot loader
79 * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
80 - create ARMBoot project (http://sourceforge.net/projects/armboot)
81 - add other CPU families (starting with ARM)
82 - create U-Boot project (http://sourceforge.net/projects/u-boot)
88 The "official" name of this project is "Das U-Boot". The spelling
89 "U-Boot" shall be used in all written text (documentation, comments
90 in source files etc.). Example:
92 This is the README file for the U-Boot project.
94 File names etc. shall be based on the string "u-boot". Examples:
96 include/asm-ppc/u-boot.h
98 #include <asm/u-boot.h>
100 Variable names, preprocessor constants etc. shall be either based on
101 the string "u_boot" or on "U_BOOT". Example:
103 U_BOOT_VERSION u_boot_logo
104 IH_OS_U_BOOT u_boot_hush_start
110 U-Boot uses a 3 level version number containing a version, a
111 sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
112 sub-version "34", and patchlevel "4".
114 The patchlevel is used to indicate certain stages of development
115 between released versions, i. e. officially released versions of
116 U-Boot will always have a patchlevel of "0".
122 - board Board dependent files
123 - common Misc architecture independent functions
124 - cpu CPU specific files
125 - 74xx_7xx Files specific to Motorola MPC74xx and 7xx CPUs
126 - arm720t Files specific to ARM 720 CPUs
127 - arm920t Files specific to ARM 920 CPUs
128 - arm925t Files specific to ARM 925 CPUs
129 - arm926ejs Files specific to ARM 926 CPUs
130 - at91rm9200 Files specific to Atmel AT91RM9200 CPUs
131 - i386 Files specific to i386 CPUs
132 - ixp Files specific to Intel XScale IXP CPUs
133 - mcf52x2 Files specific to Motorola ColdFire MCF52x2 CPUs
134 - mips Files specific to MIPS CPUs
135 - mpc5xx Files specific to Motorola MPC5xx CPUs
136 - mpc5xxx Files specific to Motorola MPC5xxx CPUs
137 - mpc8xx Files specific to Motorola MPC8xx CPUs
138 - mpc824x Files specific to Motorola MPC824x CPUs
139 - mpc8260 Files specific to Motorola MPC8260 CPUs
140 - mpc85xx Files specific to Motorola MPC85xx CPUs
141 - nios Files specific to Altera NIOS CPUs
142 - ppc4xx Files specific to IBM PowerPC 4xx CPUs
143 - pxa Files specific to Intel XScale PXA CPUs
144 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
145 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
146 - disk Code for disk drive partition handling
147 - doc Documentation (don't expect too much)
148 - drivers Commonly used device drivers
149 - dtt Digital Thermometer and Thermostat drivers
150 - examples Example code for standalone applications, etc.
151 - include Header Files
152 - lib_arm Files generic to ARM architecture
153 - lib_generic Files generic to all architectures
154 - lib_i386 Files generic to i386 architecture
155 - lib_m68k Files generic to m68k architecture
156 - lib_mips Files generic to MIPS architecture
157 - lib_nios Files generic to NIOS architecture
158 - lib_ppc Files generic to PowerPC architecture
159 - net Networking code
160 - post Power On Self Test
161 - rtc Real Time Clock drivers
162 - tools Tools to build S-Record or U-Boot images, etc.
164 Software Configuration:
165 =======================
167 Configuration is usually done using C preprocessor defines; the
168 rationale behind that is to avoid dead code whenever possible.
170 There are two classes of configuration variables:
172 * Configuration _OPTIONS_:
173 These are selectable by the user and have names beginning with
176 * Configuration _SETTINGS_:
177 These depend on the hardware etc. and should not be meddled with if
178 you don't know what you're doing; they have names beginning with
181 Later we will add a configuration tool - probably similar to or even
182 identical to what's used for the Linux kernel. Right now, we have to
183 do the configuration by hand, which means creating some symbolic
184 links and editing some configuration files. We use the TQM8xxL boards
188 Selection of Processor Architecture and Board Type:
189 ---------------------------------------------------
191 For all supported boards there are ready-to-use default
192 configurations available; just type "make <board_name>_config".
194 Example: For a TQM823L module type:
199 For the Cogent platform, you need to specify the cpu type as well;
200 e.g. "make cogent_mpc8xx_config". And also configure the cogent
201 directory according to the instructions in cogent/README.
204 Configuration Options:
205 ----------------------
207 Configuration depends on the combination of board and CPU type; all
208 such information is kept in a configuration file
209 "include/configs/<board_name>.h".
211 Example: For a TQM823L module, all configuration settings are in
212 "include/configs/TQM823L.h".
215 Many of the options are named exactly as the corresponding Linux
216 kernel configuration options. The intention is to make it easier to
217 build a config tool - later.
220 The following options need to be configured:
222 - CPU Type: Define exactly one of
226 CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860
228 or CONFIG_MPC824X, CONFIG_MPC8260
243 MicroBlaze based CPUs:
244 ----------------------
248 - Board Type: Define exactly one of
250 PowerPC based boards:
251 ---------------------
253 CONFIG_ADCIOP CONFIG_GEN860T CONFIG_PCI405
254 CONFIG_ADS860 CONFIG_GENIETV CONFIG_PCIPPC2
255 CONFIG_AMX860 CONFIG_GTH CONFIG_PCIPPC6
256 CONFIG_AR405 CONFIG_gw8260 CONFIG_pcu_e
257 CONFIG_BAB7xx CONFIG_hermes CONFIG_PIP405
258 CONFIG_c2mon CONFIG_hymod CONFIG_PM826
259 CONFIG_CANBT CONFIG_IAD210 CONFIG_ppmc8260
260 CONFIG_CCM CONFIG_ICU862 CONFIG_QS823
261 CONFIG_CMI CONFIG_IP860 CONFIG_QS850
262 CONFIG_cogent_mpc8260 CONFIG_IPHASE4539 CONFIG_QS860T
263 CONFIG_cogent_mpc8xx CONFIG_IVML24 CONFIG_RBC823
264 CONFIG_CPCI405 CONFIG_IVML24_128 CONFIG_RPXClassic
265 CONFIG_CPCI4052 CONFIG_IVML24_256 CONFIG_RPXlite
266 CONFIG_CPCIISER4 CONFIG_IVMS8 CONFIG_RPXsuper
267 CONFIG_CPU86 CONFIG_IVMS8_128 CONFIG_rsdproto
268 CONFIG_CRAYL1 CONFIG_IVMS8_256 CONFIG_sacsng
269 CONFIG_CSB272 CONFIG_JSE CONFIG_Sandpoint8240
270 CONFIG_CU824 CONFIG_LANTEC CONFIG_Sandpoint8245
271 CONFIG_DASA_SIM CONFIG_lwmon CONFIG_sbc8260
272 CONFIG_DB64360 CONFIG_MBX CONFIG_sbc8560
273 CONFIG_DB64460 CONFIG_MBX860T CONFIG_SM850
274 CONFIG_DU405 CONFIG_MHPC CONFIG_SPD823TS
275 CONFIG_DUET_ADS CONFIG_MIP405 CONFIG_STXGP3
276 CONFIG_EBONY CONFIG_MOUSSE CONFIG_SXNI855T
277 CONFIG_ELPPC CONFIG_MPC8260ADS CONFIG_TQM823L
278 CONFIG_ELPT860 CONFIG_MPC8540ADS CONFIG_TQM8260
279 CONFIG_ep8260 CONFIG_MPC8560ADS CONFIG_TQM850L
280 CONFIG_ERIC CONFIG_MUSENKI CONFIG_TQM855L
281 CONFIG_ESTEEM192E CONFIG_MVS1 CONFIG_TQM860L
282 CONFIG_ETX094 CONFIG_NETPHONE CONFIG_TTTech
283 CONFIG_EVB64260 CONFIG_NETTA CONFIG_UTX8245
284 CONFIG_FADS823 CONFIG_NETVIA CONFIG_V37
285 CONFIG_FADS850SAR CONFIG_NX823 CONFIG_W7OLMC
286 CONFIG_FADS860T CONFIG_OCRTC CONFIG_W7OLMG
287 CONFIG_FLAGADM CONFIG_ORSG CONFIG_WALNUT405
288 CONFIG_FPS850L CONFIG_OXC CONFIG_ZPC1900
289 CONFIG_FPS860L CONFIG_ZUMA
294 CONFIG_AT91RM9200DK, CONFIG_CERF250, CONFIG_DNP1110,
295 CONFIG_EP7312, CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE,
296 CONFIG_IMPA7, CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610,
297 CONFIG_LART, CONFIG_LPD7A400 CONFIG_LUBBOCK,
298 CONFIG_OSK_OMAP5912, CONFIG_SHANNON, CONFIG_P2_OMAP730,
299 CONFIG_SMDK2400, CONFIG_SMDK2410, CONFIG_TRAB,
302 MicroBlaze based boards:
303 ------------------------
308 - CPU Module Type: (if CONFIG_COGENT is defined)
309 Define exactly one of
311 --- FIXME --- not tested yet:
312 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
313 CONFIG_CMA287_23, CONFIG_CMA287_50
315 - Motherboard Type: (if CONFIG_COGENT is defined)
316 Define exactly one of
317 CONFIG_CMA101, CONFIG_CMA102
319 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
320 Define one or more of
323 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
324 Define one or more of
325 CONFIG_LCD_HEARTBEAT - update a character position on
326 the lcd display every second with
329 - Board flavour: (if CONFIG_MPC8260ADS is defined)
332 CFG_8260ADS - original MPC8260ADS
333 CFG_8266ADS - MPC8266ADS
334 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
335 CFG_8272ADS - MPC8272ADS
337 - MPC824X Family Member (if CONFIG_MPC824X is defined)
338 Define exactly one of
339 CONFIG_MPC8240, CONFIG_MPC8245
341 - 8xx CPU Options: (if using an MPC8xx cpu)
342 Define one or more of
343 CONFIG_8xx_GCLK_FREQ - if get_gclk_freq() cannot work
344 e.g. if there is no 32KHz
345 reference PIT/RTC clock
347 - 859/866 CPU options: (if using a MPC859 or MPC866 CPU):
351 CFG_866_CPUCLK_DEFAULT
352 See doc/README.MPC866
356 Define this to measure the actual CPU clock instead
357 of relying on the correctness of the configured
358 values. Mostly useful for board bringup to make sure
359 the PLL is locked at the intended frequency. Note
360 that this requires a (stable) reference clock (32 kHz
363 - Linux Kernel Interface:
366 U-Boot stores all clock information in Hz
367 internally. For binary compatibility with older Linux
368 kernels (which expect the clocks passed in the
369 bd_info data to be in MHz) the environment variable
370 "clocks_in_mhz" can be defined so that U-Boot
371 converts clock data to MHZ before passing it to the
373 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
374 "clocks_in_mhz=1" is automatically included in the
377 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
379 When transfering memsize parameter to linux, some versions
380 expect it to be in bytes, others in MB.
381 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
384 Depending on board, define exactly one serial port
385 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
386 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
387 console by defining CONFIG_8xx_CONS_NONE
389 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
390 port routines must be defined elsewhere
391 (i.e. serial_init(), serial_getc(), ...)
394 Enables console device for a color framebuffer. Needs following
395 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
396 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
398 VIDEO_HW_RECTFILL graphic chip supports
401 VIDEO_HW_BITBLT graphic chip supports
402 bit-blit (cf. smiLynxEM)
403 VIDEO_VISIBLE_COLS visible pixel columns
405 VIDEO_VISIBLE_ROWS visible pixel rows
406 VIDEO_PIXEL_SIZE bytes per pixel
407 VIDEO_DATA_FORMAT graphic data format
408 (0-5, cf. cfb_console.c)
409 VIDEO_FB_ADRS framebuffer address
410 VIDEO_KBD_INIT_FCT keyboard int fct
411 (i.e. i8042_kbd_init())
412 VIDEO_TSTC_FCT test char fct
414 VIDEO_GETC_FCT get char fct
416 CONFIG_CONSOLE_CURSOR cursor drawing on/off
417 (requires blink timer
419 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
420 CONFIG_CONSOLE_TIME display time/date info in
422 (requires CFG_CMD_DATE)
423 CONFIG_VIDEO_LOGO display Linux logo in
425 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
426 linux_logo.h for logo.
427 Requires CONFIG_VIDEO_LOGO
428 CONFIG_CONSOLE_EXTRA_INFO
429 addional board info beside
432 When CONFIG_CFB_CONSOLE is defined, video console is
433 default i/o. Serial console can be forced with
434 environment 'console=serial'.
436 When CONFIG_SILENT_CONSOLE is defined, all console
437 messages (by U-Boot and Linux!) can be silenced with
438 the "silent" environment variable. See
439 doc/README.silent for more information.
442 CONFIG_BAUDRATE - in bps
443 Select one of the baudrates listed in
444 CFG_BAUDRATE_TABLE, see below.
445 CFG_BRGCLK_PRESCALE, baudrate prescale
447 - Interrupt driven serial port input:
448 CONFIG_SERIAL_SOFTWARE_FIFO
451 Use an interrupt handler for receiving data on the
452 serial port. It also enables using hardware handshake
453 (RTS/CTS) and UART's built-in FIFO. Set the number of
454 bytes the interrupt driven input buffer should have.
456 Leave undefined to disable this feature, including
457 disable the buffer and hardware handshake.
459 - Console UART Number:
463 If defined internal UART1 (and not UART0) is used
464 as default U-Boot console.
466 - Boot Delay: CONFIG_BOOTDELAY - in seconds
467 Delay before automatically booting the default image;
468 set to -1 to disable autoboot.
470 See doc/README.autoboot for these options that
471 work with CONFIG_BOOTDELAY. None are required.
472 CONFIG_BOOT_RETRY_TIME
473 CONFIG_BOOT_RETRY_MIN
474 CONFIG_AUTOBOOT_KEYED
475 CONFIG_AUTOBOOT_PROMPT
476 CONFIG_AUTOBOOT_DELAY_STR
477 CONFIG_AUTOBOOT_STOP_STR
478 CONFIG_AUTOBOOT_DELAY_STR2
479 CONFIG_AUTOBOOT_STOP_STR2
480 CONFIG_ZERO_BOOTDELAY_CHECK
481 CONFIG_RESET_TO_RETRY
485 Only needed when CONFIG_BOOTDELAY is enabled;
486 define a command string that is automatically executed
487 when no character is read on the console interface
488 within "Boot Delay" after reset.
491 This can be used to pass arguments to the bootm
492 command. The value of CONFIG_BOOTARGS goes into the
493 environment value "bootargs".
495 CONFIG_RAMBOOT and CONFIG_NFSBOOT
496 The value of these goes into the environment as
497 "ramboot" and "nfsboot" respectively, and can be used
498 as a convenience, when switching between booting from
504 When this option is #defined, the existence of the
505 environment variable "preboot" will be checked
506 immediately before starting the CONFIG_BOOTDELAY
507 countdown and/or running the auto-boot command resp.
508 entering interactive mode.
510 This feature is especially useful when "preboot" is
511 automatically generated or modified. For an example
512 see the LWMON board specific code: here "preboot" is
513 modified when the user holds down a certain
514 combination of keys on the (special) keyboard when
517 - Serial Download Echo Mode:
519 If defined to 1, all characters received during a
520 serial download (using the "loads" command) are
521 echoed back. This might be needed by some terminal
522 emulations (like "cu"), but may as well just take
523 time on others. This setting #define's the initial
524 value of the "loads_echo" environment variable.
526 - Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
528 Select one of the baudrates listed in
529 CFG_BAUDRATE_TABLE, see below.
533 Most monitor functions can be selected (or
534 de-selected) by adjusting the definition of
535 CONFIG_COMMANDS; to select individual functions,
536 #define CONFIG_COMMANDS by "OR"ing any of the
539 #define enables commands:
540 -------------------------
541 CFG_CMD_ASKENV * ask for env variable
542 CFG_CMD_AUTOSCRIPT Autoscript Support
544 CFG_CMD_BEDBUG Include BedBug Debugger
545 CFG_CMD_BMP * BMP support
547 CFG_CMD_CACHE icache, dcache
548 CFG_CMD_CONSOLE coninfo
549 CFG_CMD_DATE * support for RTC, date/time...
550 CFG_CMD_DHCP DHCP support
551 CFG_CMD_DIAG * Diagnostics
552 CFG_CMD_DOC * Disk-On-Chip Support
553 CFG_CMD_DTT Digital Therm and Thermostat
554 CFG_CMD_ECHO * echo arguments
555 CFG_CMD_EEPROM * EEPROM read/write support
556 CFG_CMD_ELF bootelf, bootvx
558 CFG_CMD_FDC * Floppy Disk Support
559 CFG_CMD_FAT FAT partition support
560 CFG_CMD_FDOS * Dos diskette Support
561 CFG_CMD_FLASH flinfo, erase, protect
562 CFG_CMD_FPGA FPGA device initialization support
563 CFG_CMD_HWFLOW * RTS/CTS hw flow control
564 CFG_CMD_I2C * I2C serial bus support
565 CFG_CMD_IDE * IDE harddisk support
567 CFG_CMD_IMLS List all found images
568 CFG_CMD_IMMAP * IMMR dump support
569 CFG_CMD_IRQ * irqinfo
570 CFG_CMD_ITEST * Integer/string test of 2 values
571 CFG_CMD_JFFS2 * JFFS2 Support
575 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
577 CFG_CMD_MISC Misc functions like sleep etc
578 CFG_CMD_MMC MMC memory mapped support
579 CFG_CMD_MII MII utility commands
580 CFG_CMD_NAND * NAND support
581 CFG_CMD_NET bootp, tftpboot, rarpboot
582 CFG_CMD_PCI * pciinfo
583 CFG_CMD_PCMCIA * PCMCIA support
584 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
585 CFG_CMD_PORTIO * Port I/O
586 CFG_CMD_REGINFO * Register dump
587 CFG_CMD_RUN run command in env variable
588 CFG_CMD_SAVES save S record dump
589 CFG_CMD_SCSI * SCSI Support
590 CFG_CMD_SDRAM * print SDRAM configuration information
591 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
592 CFG_CMD_SPI * SPI serial bus support
593 CFG_CMD_USB * USB support
594 CFG_CMD_VFD * VFD support (TRAB)
595 CFG_CMD_BSP * Board SPecific functions
596 CFG_CMD_CDP * Cisco Discover Protocol support
597 -----------------------------------------------
600 CONFIG_CMD_DFL Default configuration; at the moment
601 this is includes all commands, except
602 the ones marked with "*" in the list
605 If you don't define CONFIG_COMMANDS it defaults to
606 CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
607 override the default settings in the respective
610 EXAMPLE: If you want all functions except of network
611 support you can write:
613 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
616 Note: Don't enable the "icache" and "dcache" commands
617 (configuration option CFG_CMD_CACHE) unless you know
618 what you (and your U-Boot users) are doing. Data
619 cache cannot be enabled on systems like the 8xx or
620 8260 (where accesses to the IMMR region must be
621 uncached), and it cannot be disabled on all other
622 systems where we (mis-) use the data cache to hold an
623 initial stack and some data.
626 XXX - this list needs to get updated!
630 If this variable is defined, it enables watchdog
631 support. There must be support in the platform specific
632 code for a watchdog. For the 8xx and 8260 CPUs, the
633 SIU Watchdog feature is enabled in the SYPCR
637 CONFIG_VERSION_VARIABLE
638 If this variable is defined, an environment variable
639 named "ver" is created by U-Boot showing the U-Boot
640 version as printed by the "version" command.
641 This variable is readonly.
645 When CFG_CMD_DATE is selected, the type of the RTC
646 has to be selected, too. Define exactly one of the
649 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
650 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
651 CONFIG_RTC_MC146818 - use MC146818 RTC
652 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
653 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
654 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
655 CONFIG_RTC_DS164x - use Dallas DS164x RTC
656 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
658 Note that if the RTC uses I2C, then the I2C interface
659 must also be configured. See I2C Support, below.
663 When CONFIG_TIMESTAMP is selected, the timestamp
664 (date and time) of an image is printed by image
665 commands like bootm or iminfo. This option is
666 automatically enabled when you select CFG_CMD_DATE .
669 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
670 and/or CONFIG_ISO_PARTITION
672 If IDE or SCSI support is enabled (CFG_CMD_IDE or
673 CFG_CMD_SCSI) you must configure support for at least
674 one partition type as well.
677 CONFIG_IDE_RESET_ROUTINE - this is defined in several
678 board configurations files but used nowhere!
680 CONFIG_IDE_RESET - is this is defined, IDE Reset will
681 be performed by calling the function
682 ide_set_reset(int reset)
683 which has to be defined in a board specific file
688 Set this to enable ATAPI support.
693 Set this to enable support for disks larger than 137GB
694 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
695 Whithout these , LBA48 support uses 32bit variables and will 'only'
696 support disks up to 2.1TB.
699 When enabled, makes the IDE subsystem use 64bit sector addresses.
703 At the moment only there is only support for the
704 SYM53C8XX SCSI controller; define
705 CONFIG_SCSI_SYM53C8XX to enable it.
707 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
708 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
709 CFG_SCSI_MAX_LUN] can be adjusted to define the
710 maximum numbers of LUNs, SCSI ID's and target
712 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
714 - NETWORK Support (PCI):
716 Support for Intel 8254x gigabit chips.
719 Support for Intel 82557/82559/82559ER chips.
720 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
721 write routine for first time initialisation.
724 Support for Digital 2114x chips.
725 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
726 modem chip initialisation (KS8761/QS6611).
729 Support for National dp83815 chips.
732 Support for National dp8382[01] gigabit chips.
734 - NETWORK Support (other):
736 CONFIG_DRIVER_LAN91C96
737 Support for SMSC's LAN91C96 chips.
740 Define this to hold the physical address
741 of the LAN91C96's I/O space
743 CONFIG_LAN91C96_USE_32_BIT
744 Define this to enable 32 bit addressing
746 CONFIG_DRIVER_SMC91111
747 Support for SMSC's LAN91C111 chip
750 Define this to hold the physical address
751 of the device (I/O space)
753 CONFIG_SMC_USE_32_BIT
754 Define this if data bus is 32 bits
756 CONFIG_SMC_USE_IOFUNCS
757 Define this to use i/o functions instead of macros
758 (some hardware wont work with macros)
761 At the moment only the UHCI host controller is
762 supported (PIP405, MIP405, MPC5200); define
763 CONFIG_USB_UHCI to enable it.
764 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
765 end define CONFIG_USB_STORAGE to enable the USB
768 Supported are USB Keyboards and USB Floppy drives
770 MPC5200 USB requires additional defines:
772 for 528 MHz Clock: 0x0001bbbb
774 for differential drivers: 0x00001000
775 for single ended drivers: 0x00005000
779 The MMC controller on the Intel PXA is supported. To
780 enable this define CONFIG_MMC. The MMC can be
781 accessed from the boot prompt by mapping the device
782 to physical memory similar to flash. Command line is
783 enabled with CFG_CMD_MMC. The MMC driver also works with
784 the FAT fs. This is enabled with CFG_CMD_FAT.
789 Define this to enable standard (PC-Style) keyboard
793 Standard PC keyboard driver with US (is default) and
794 GERMAN key layout (switch via environment 'keymap=de') support.
795 Export function i8042_kbd_init, i8042_tstc and i8042_getc
796 for cfb_console. Supports cursor blinking.
801 Define this to enable video support (for output to
806 Enable Chips & Technologies 69000 Video chip
808 CONFIG_VIDEO_SMI_LYNXEM
809 Enable Silicon Motion SMI 712/710/810 Video chip. The
810 video output is selected via environment 'videoout'
811 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
814 For the CT69000 and SMI_LYNXEM drivers, videomode is
815 selected via environment 'videomode'. Two diferent ways
817 - "videomode=num" 'num' is a standard LiLo mode numbers.
818 Following standard modes are supported (* is default):
820 Colors 640x480 800x600 1024x768 1152x864 1280x1024
821 -------------+---------------------------------------------
822 8 bits | 0x301* 0x303 0x305 0x161 0x307
823 15 bits | 0x310 0x313 0x316 0x162 0x319
824 16 bits | 0x311 0x314 0x317 0x163 0x31A
825 24 bits | 0x312 0x315 0x318 ? 0x31B
826 -------------+---------------------------------------------
827 (i.e. setenv videomode 317; saveenv; reset;)
829 - "videomode=bootargs" all the video parameters are parsed
830 from the bootargs. (See drivers/videomodes.c)
833 CONFIG_VIDEO_SED13806
834 Enable Epson SED13806 driver. This driver supports 8bpp
835 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
836 or CONFIG_VIDEO_SED13806_16BPP
841 Define this to enable a custom keyboard support.
842 This simply calls drv_keyboard_init() which must be
843 defined in your board-specific files.
844 The only board using this so far is RBC823.
846 - LCD Support: CONFIG_LCD
848 Define this to enable LCD support (for output to LCD
849 display); also select one of the supported displays
850 by defining one of these:
852 CONFIG_NEC_NL6448AC33:
854 NEC NL6448AC33-18. Active, color, single scan.
856 CONFIG_NEC_NL6448BC20
858 NEC NL6448BC20-08. 6.5", 640x480.
859 Active, color, single scan.
861 CONFIG_NEC_NL6448BC33_54
863 NEC NL6448BC33-54. 10.4", 640x480.
864 Active, color, single scan.
868 Sharp 320x240. Active, color, single scan.
869 It isn't 16x9, and I am not sure what it is.
871 CONFIG_SHARP_LQ64D341
873 Sharp LQ64D341 display, 640x480.
874 Active, color, single scan.
878 HLD1045 display, 640x480.
879 Active, color, single scan.
883 Optrex CBL50840-2 NF-FW 99 22 M5
885 Hitachi LMG6912RPFC-00T
889 320x240. Black & white.
891 Normally display is black on white background; define
892 CFG_WHITE_ON_BLACK to get it inverted.
894 - Splash Screen Support: CONFIG_SPLASH_SCREEN
896 If this option is set, the environment is checked for
897 a variable "splashimage". If found, the usual display
898 of logo, copyright and system information on the LCD
899 is suppressed and the BMP image at the address
900 specified in "splashimage" is loaded instead. The
901 console is redirected to the "nulldev", too. This
902 allows for a "silent" boot where a splash screen is
903 loaded very quickly after power-on.
905 - Compression support:
908 If this option is set, support for bzip2 compressed
909 images is included. If not, only uncompressed and gzip
910 compressed images are supported.
912 NOTE: the bzip2 algorithm requires a lot of RAM, so
913 the malloc area (as defined by CFG_MALLOC_LEN) should
919 The address of PHY on MII bus.
921 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
923 The clock frequency of the MII bus
927 If this option is set, support for speed/duplex
928 detection of Gigabit PHY is included.
930 CONFIG_PHY_RESET_DELAY
932 Some PHY like Intel LXT971A need extra delay after
933 reset before any MII register access is possible.
934 For such PHY, set this option to the usec delay
935 required. (minimum 300usec for LXT971A)
937 CONFIG_PHY_CMD_DELAY (ppc4xx)
939 Some PHY like Intel LXT971A need extra delay after
940 command issued before MII status register can be read
947 Define a default value for ethernet address to use
948 for the respective ethernet interface, in case this
949 is not determined automatically.
954 Define a default value for the IP address to use for
955 the default ethernet interface, in case this is not
956 determined through e.g. bootp.
961 Defines a default value for theIP address of a TFTP
962 server to contact when using the "tftboot" command.
964 - BOOTP Recovery Mode:
965 CONFIG_BOOTP_RANDOM_DELAY
967 If you have many targets in a network that try to
968 boot using BOOTP, you may want to avoid that all
969 systems send out BOOTP requests at precisely the same
970 moment (which would happen for instance at recovery
971 from a power failure, when all systems will try to
972 boot, thus flooding the BOOTP server. Defining
973 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
974 inserted before sending out BOOTP requests. The
975 following delays are insterted then:
977 1st BOOTP request: delay 0 ... 1 sec
978 2nd BOOTP request: delay 0 ... 2 sec
979 3rd BOOTP request: delay 0 ... 4 sec
981 BOOTP requests: delay 0 ... 8 sec
983 - DHCP Advanced Options:
986 You can fine tune the DHCP functionality by adding
987 these flags to the CONFIG_BOOTP_MASK define:
989 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
990 serverip from a DHCP server, it is possible that more
991 than one DNS serverip is offered to the client.
992 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
993 serverip will be stored in the additional environment
994 variable "dnsip2". The first DNS serverip is always
995 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
996 is added to the CONFIG_BOOTP_MASK.
998 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
999 to do a dynamic update of a DNS server. To do this, they
1000 need the hostname of the DHCP requester.
1001 If CONFIG_BOOP_SEND_HOSTNAME is added to the
1002 CONFIG_BOOTP_MASK, the content of the "hostname"
1003 environment variable is passed as option 12 to
1007 CONFIG_CDP_DEVICE_ID
1009 The device id used in CDP trigger frames.
1011 CONFIG_CDP_DEVICE_ID_PREFIX
1013 A two character string which is prefixed to the MAC address
1018 A printf format string which contains the ascii name of
1019 the port. Normally is set to "eth%d" which sets
1020 eth0 for the first ethernet, eth1 for the second etc.
1022 CONFIG_CDP_CAPABILITIES
1024 A 32bit integer which indicates the device capabilities;
1025 0x00000010 for a normal host which does not forwards.
1029 An ascii string containing the version of the software.
1033 An ascii string containing the name of the platform.
1037 A 32bit integer sent on the trigger.
1039 CONFIG_CDP_POWER_CONSUMPTION
1041 A 16bit integer containing the power consumption of the
1042 device in .1 of milliwatts.
1044 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1046 A byte containing the id of the VLAN.
1048 - Status LED: CONFIG_STATUS_LED
1050 Several configurations allow to display the current
1051 status using a LED. For instance, the LED will blink
1052 fast while running U-Boot code, stop blinking as
1053 soon as a reply to a BOOTP request was received, and
1054 start blinking slow once the Linux kernel is running
1055 (supported by a status LED driver in the Linux
1056 kernel). Defining CONFIG_STATUS_LED enables this
1059 - CAN Support: CONFIG_CAN_DRIVER
1061 Defining CONFIG_CAN_DRIVER enables CAN driver support
1062 on those systems that support this (optional)
1063 feature, like the TQM8xxL modules.
1065 - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1067 These enable I2C serial bus commands. Defining either of
1068 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1069 include the appropriate I2C driver for the selected cpu.
1071 This will allow you to use i2c commands at the u-boot
1072 command line (as long as you set CFG_CMD_I2C in
1073 CONFIG_COMMANDS) and communicate with i2c based realtime
1074 clock chips. See common/cmd_i2c.c for a description of the
1075 command line interface.
1077 CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1079 CONFIG_SOFT_I2C configures u-boot to use a software (aka
1080 bit-banging) driver instead of CPM or similar hardware
1083 There are several other quantities that must also be
1084 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1086 In both cases you will need to define CFG_I2C_SPEED
1087 to be the frequency (in Hz) at which you wish your i2c bus
1088 to run and CFG_I2C_SLAVE to be the address of this node (ie
1089 the cpu's i2c node address).
1091 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1092 sets the cpu up as a master node and so its address should
1093 therefore be cleared to 0 (See, eg, MPC823e User's Manual
1094 p.16-473). So, set CFG_I2C_SLAVE to 0.
1096 That's all that's required for CONFIG_HARD_I2C.
1098 If you use the software i2c interface (CONFIG_SOFT_I2C)
1099 then the following macros need to be defined (examples are
1100 from include/configs/lwmon.h):
1104 (Optional). Any commands necessary to enable the I2C
1105 controller or configure ports.
1107 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
1111 (Only for MPC8260 CPU). The I/O port to use (the code
1112 assumes both bits are on the same port). Valid values
1113 are 0..3 for ports A..D.
1117 The code necessary to make the I2C data line active
1118 (driven). If the data line is open collector, this
1121 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1125 The code necessary to make the I2C data line tri-stated
1126 (inactive). If the data line is open collector, this
1129 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1133 Code that returns TRUE if the I2C data line is high,
1136 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1140 If <bit> is TRUE, sets the I2C data line high. If it
1141 is FALSE, it clears it (low).
1143 eg: #define I2C_SDA(bit) \
1144 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
1145 else immr->im_cpm.cp_pbdat &= ~PB_SDA
1149 If <bit> is TRUE, sets the I2C clock line high. If it
1150 is FALSE, it clears it (low).
1152 eg: #define I2C_SCL(bit) \
1153 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
1154 else immr->im_cpm.cp_pbdat &= ~PB_SCL
1158 This delay is invoked four times per clock cycle so this
1159 controls the rate of data transfer. The data rate thus
1160 is 1 / (I2C_DELAY * 4). Often defined to be something
1163 #define I2C_DELAY udelay(2)
1167 When a board is reset during an i2c bus transfer
1168 chips might think that the current transfer is still
1169 in progress. On some boards it is possible to access
1170 the i2c SCLK line directly, either by using the
1171 processor pin as a GPIO or by having a second pin
1172 connected to the bus. If this option is defined a
1173 custom i2c_init_board() routine in boards/xxx/board.c
1174 is run early in the boot sequence.
1176 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1178 This option enables configuration of bi_iic_fast[] flags
1179 in u-boot bd_info structure based on u-boot environment
1180 variable "i2cfast". (see also i2cfast)
1182 - SPI Support: CONFIG_SPI
1184 Enables SPI driver (so far only tested with
1185 SPI EEPROM, also an instance works with Crystal A/D and
1186 D/As on the SACSng board)
1190 Enables extended (16-bit) SPI EEPROM addressing.
1191 (symmetrical to CONFIG_I2C_X)
1195 Enables a software (bit-bang) SPI driver rather than
1196 using hardware support. This is a general purpose
1197 driver that only requires three general I/O port pins
1198 (two outputs, one input) to function. If this is
1199 defined, the board configuration must define several
1200 SPI configuration items (port pins to use, etc). For
1201 an example, see include/configs/sacsng.h.
1203 - FPGA Support: CONFIG_FPGA_COUNT
1205 Specify the number of FPGA devices to support.
1209 Used to specify the types of FPGA devices. For example,
1210 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
1212 CFG_FPGA_PROG_FEEDBACK
1214 Enable printing of hash marks during FPGA configuration.
1218 Enable checks on FPGA configuration interface busy
1219 status by the configuration function. This option
1220 will require a board or device specific function to
1225 If defined, a function that provides delays in the FPGA
1226 configuration driver.
1228 CFG_FPGA_CHECK_CTRLC
1229 Allow Control-C to interrupt FPGA configuration
1231 CFG_FPGA_CHECK_ERROR
1233 Check for configuration errors during FPGA bitfile
1234 loading. For example, abort during Virtex II
1235 configuration if the INIT_B line goes low (which
1236 indicated a CRC error).
1240 Maximum time to wait for the INIT_B line to deassert
1241 after PROB_B has been deasserted during a Virtex II
1242 FPGA configuration sequence. The default time is 500
1247 Maximum time to wait for BUSY to deassert during
1248 Virtex II FPGA configuration. The default is 5 mS.
1250 CFG_FPGA_WAIT_CONFIG
1252 Time to wait after FPGA configuration. The default is
1255 - Configuration Management:
1258 If defined, this string will be added to the U-Boot
1259 version information (U_BOOT_VERSION)
1261 - Vendor Parameter Protection:
1263 U-Boot considers the values of the environment
1264 variables "serial#" (Board Serial Number) and
1265 "ethaddr" (Ethernet Address) to be parameters that
1266 are set once by the board vendor / manufacturer, and
1267 protects these variables from casual modification by
1268 the user. Once set, these variables are read-only,
1269 and write or delete attempts are rejected. You can
1270 change this behviour:
1272 If CONFIG_ENV_OVERWRITE is #defined in your config
1273 file, the write protection for vendor parameters is
1274 completely disabled. Anybody can change or delete
1277 Alternatively, if you #define _both_ CONFIG_ETHADDR
1278 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1279 ethernet address is installed in the environment,
1280 which can be changed exactly ONCE by the user. [The
1281 serial# is unaffected by this, i. e. it remains
1287 Define this variable to enable the reservation of
1288 "protected RAM", i. e. RAM which is not overwritten
1289 by U-Boot. Define CONFIG_PRAM to hold the number of
1290 kB you want to reserve for pRAM. You can overwrite
1291 this default value by defining an environment
1292 variable "pram" to the number of kB you want to
1293 reserve. Note that the board info structure will
1294 still show the full amount of RAM. If pRAM is
1295 reserved, a new environment variable "mem" will
1296 automatically be defined to hold the amount of
1297 remaining RAM in a form that can be passed as boot
1298 argument to Linux, for instance like that:
1300 setenv bootargs ... mem=\$(mem)
1303 This way you can tell Linux not to use this memory,
1304 either, which results in a memory region that will
1305 not be affected by reboots.
1307 *WARNING* If your board configuration uses automatic
1308 detection of the RAM size, you must make sure that
1309 this memory test is non-destructive. So far, the
1310 following board configurations are known to be
1313 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1314 HERMES, IP860, RPXlite, LWMON, LANTEC,
1315 PCU_E, FLAGADM, TQM8260
1320 Define this variable to stop the system in case of a
1321 fatal error, so that you have to reset it manually.
1322 This is probably NOT a good idea for an embedded
1323 system where you want to system to reboot
1324 automatically as fast as possible, but it may be
1325 useful during development since you can try to debug
1326 the conditions that lead to the situation.
1328 CONFIG_NET_RETRY_COUNT
1330 This variable defines the number of retries for
1331 network operations like ARP, RARP, TFTP, or BOOTP
1332 before giving up the operation. If not defined, a
1333 default value of 5 is used.
1335 - Command Interpreter:
1338 Enable auto completion of commands using TAB.
1342 Define this variable to enable the "hush" shell (from
1343 Busybox) as command line interpreter, thus enabling
1344 powerful command line syntax like
1345 if...then...else...fi conditionals or `&&' and '||'
1346 constructs ("shell scripts").
1348 If undefined, you get the old, much simpler behaviour
1349 with a somewhat smaller memory footprint.
1354 This defines the secondary prompt string, which is
1355 printed when the command interpreter needs more input
1356 to complete a command. Usually "> ".
1360 In the current implementation, the local variables
1361 space and global environment variables space are
1362 separated. Local variables are those you define by
1363 simply typing `name=value'. To access a local
1364 variable later on, you have write `$name' or
1365 `${name}'; to execute the contents of a variable
1366 directly type `$name' at the command prompt.
1368 Global environment variables are those you use
1369 setenv/printenv to work with. To run a command stored
1370 in such a variable, you need to use the run command,
1371 and you must not use the '$' sign to access them.
1373 To store commands and special characters in a
1374 variable, please use double quotation marks
1375 surrounding the whole text of the variable, instead
1376 of the backslashes before semicolons and special
1379 - Default Environment:
1380 CONFIG_EXTRA_ENV_SETTINGS
1382 Define this to contain any number of null terminated
1383 strings (variable = value pairs) that will be part of
1384 the default environment compiled into the boot image.
1386 For example, place something like this in your
1387 board's config file:
1389 #define CONFIG_EXTRA_ENV_SETTINGS \
1393 Warning: This method is based on knowledge about the
1394 internal format how the environment is stored by the
1395 U-Boot code. This is NOT an official, exported
1396 interface! Although it is unlikely that this format
1397 will change soon, there is no guarantee either.
1398 You better know what you are doing here.
1400 Note: overly (ab)use of the default environment is
1401 discouraged. Make sure to check other ways to preset
1402 the environment like the autoscript function or the
1405 - DataFlash Support:
1406 CONFIG_HAS_DATAFLASH
1408 Defining this option enables DataFlash features and
1409 allows to read/write in Dataflash via the standard
1412 - SystemACE Support:
1415 Adding this option adds support for Xilinx SystemACE
1416 chips attached via some sort of local bus. The address
1417 of the chip must alsh be defined in the
1418 CFG_SYSTEMACE_BASE macro. For example:
1420 #define CONFIG_SYSTEMACE
1421 #define CFG_SYSTEMACE_BASE 0xf0000000
1423 When SystemACE support is added, the "ace" device type
1424 becomes available to the fat commands, i.e. fatls.
1426 - Show boot progress:
1427 CONFIG_SHOW_BOOT_PROGRESS
1429 Defining this option allows to add some board-
1430 specific code (calling a user-provided function
1431 "show_boot_progress(int)") that enables you to show
1432 the system's boot progress on some display (for
1433 example, some LED's) on your board. At the moment,
1434 the following checkpoints are implemented:
1437 1 common/cmd_bootm.c before attempting to boot an image
1438 -1 common/cmd_bootm.c Image header has bad magic number
1439 2 common/cmd_bootm.c Image header has correct magic number
1440 -2 common/cmd_bootm.c Image header has bad checksum
1441 3 common/cmd_bootm.c Image header has correct checksum
1442 -3 common/cmd_bootm.c Image data has bad checksum
1443 4 common/cmd_bootm.c Image data has correct checksum
1444 -4 common/cmd_bootm.c Image is for unsupported architecture
1445 5 common/cmd_bootm.c Architecture check OK
1446 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1447 6 common/cmd_bootm.c Image Type check OK
1448 -6 common/cmd_bootm.c gunzip uncompression error
1449 -7 common/cmd_bootm.c Unimplemented compression type
1450 7 common/cmd_bootm.c Uncompression OK
1451 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1452 8 common/cmd_bootm.c Image Type check OK
1453 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1454 9 common/cmd_bootm.c Start initial ramdisk verification
1455 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1456 -11 common/cmd_bootm.c Ramdisk header has bad checksum
1457 10 common/cmd_bootm.c Ramdisk header is OK
1458 -12 common/cmd_bootm.c Ramdisk data has bad checksum
1459 11 common/cmd_bootm.c Ramdisk data has correct checksum
1460 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1461 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1462 13 common/cmd_bootm.c Start multifile image verification
1463 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1464 15 common/cmd_bootm.c All preparation done, transferring control to OS
1466 -30 lib_ppc/board.c Fatal error, hang the system
1467 -31 post/post.c POST test failed, detected by post_output_backlog()
1468 -32 post/post.c POST test failed, detected by post_run_single()
1470 -1 common/cmd_doc.c Bad usage of "doc" command
1471 -1 common/cmd_doc.c No boot device
1472 -1 common/cmd_doc.c Unknown Chip ID on boot device
1473 -1 common/cmd_doc.c Read Error on boot device
1474 -1 common/cmd_doc.c Image header has bad magic number
1476 -1 common/cmd_ide.c Bad usage of "ide" command
1477 -1 common/cmd_ide.c No boot device
1478 -1 common/cmd_ide.c Unknown boot device
1479 -1 common/cmd_ide.c Unknown partition table
1480 -1 common/cmd_ide.c Invalid partition type
1481 -1 common/cmd_ide.c Read Error on boot device
1482 -1 common/cmd_ide.c Image header has bad magic number
1484 -1 common/cmd_nand.c Bad usage of "nand" command
1485 -1 common/cmd_nand.c No boot device
1486 -1 common/cmd_nand.c Unknown Chip ID on boot device
1487 -1 common/cmd_nand.c Read Error on boot device
1488 -1 common/cmd_nand.c Image header has bad magic number
1490 -1 common/env_common.c Environment has a bad CRC, using default
1496 [so far only for SMDK2400 and TRAB boards]
1498 - Modem support endable:
1499 CONFIG_MODEM_SUPPORT
1501 - RTS/CTS Flow control enable:
1504 - Modem debug support:
1505 CONFIG_MODEM_SUPPORT_DEBUG
1507 Enables debugging stuff (char screen[1024], dbg())
1508 for modem support. Useful only with BDI2000.
1510 - Interrupt support (PPC):
1512 There are common interrupt_init() and timer_interrupt()
1513 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1514 for cpu specific initialization. interrupt_init_cpu()
1515 should set decrementer_count to appropriate value. If
1516 cpu resets decrementer automatically after interrupt
1517 (ppc4xx) it should set decrementer_count to zero.
1518 timer_interrupt() calls timer_interrupt_cpu() for cpu
1519 specific handling. If board has watchdog / status_led
1520 / other_activity_monitor it works automatically from
1521 general timer_interrupt().
1525 In the target system modem support is enabled when a
1526 specific key (key combination) is pressed during
1527 power-on. Otherwise U-Boot will boot normally
1528 (autoboot). The key_pressed() fuction is called from
1529 board_init(). Currently key_pressed() is a dummy
1530 function, returning 1 and thus enabling modem
1533 If there are no modem init strings in the
1534 environment, U-Boot proceed to autoboot; the
1535 previous output (banner, info printfs) will be
1538 See also: doc/README.Modem
1541 Configuration Settings:
1542 -----------------------
1544 - CFG_LONGHELP: Defined when you want long help messages included;
1545 undefine this when you're short of memory.
1547 - CFG_PROMPT: This is what U-Boot prints on the console to
1548 prompt for user input.
1550 - CFG_CBSIZE: Buffer size for input from the Console
1552 - CFG_PBSIZE: Buffer size for Console output
1554 - CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1556 - CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1557 the application (usually a Linux kernel) when it is
1560 - CFG_BAUDRATE_TABLE:
1561 List of legal baudrate settings for this board.
1563 - CFG_CONSOLE_INFO_QUIET
1564 Suppress display of console information at boot.
1566 - CFG_CONSOLE_IS_IN_ENV
1567 If the board specific function
1568 extern int overwrite_console (void);
1569 returns 1, the stdin, stderr and stdout are switched to the
1570 serial port, else the settings in the environment are used.
1572 - CFG_CONSOLE_OVERWRITE_ROUTINE
1573 Enable the call to overwrite_console().
1575 - CFG_CONSOLE_ENV_OVERWRITE
1576 Enable overwrite of previous console environment settings.
1578 - CFG_MEMTEST_START, CFG_MEMTEST_END:
1579 Begin and End addresses of the area used by the
1583 Enable an alternate, more extensive memory test.
1585 - CFG_MEMTEST_SCRATCH:
1586 Scratch address used by the alternate memory test
1587 You only need to set this if address zero isn't writeable
1589 - CFG_TFTP_LOADADDR:
1590 Default load address for network file downloads
1592 - CFG_LOADS_BAUD_CHANGE:
1593 Enable temporary baudrate change while serial download
1596 Physical start address of SDRAM. _Must_ be 0 here.
1599 Physical start address of Motherboard I/O (if using a
1603 Physical start address of Flash memory.
1606 Physical start address of boot monitor code (set by
1607 make config files to be same as the text base address
1608 (TEXT_BASE) used when linking) - same as
1609 CFG_FLASH_BASE when booting from flash.
1612 Size of memory reserved for monitor code, used to
1613 determine _at_compile_time_ (!) if the environment is
1614 embedded within the U-Boot image, or in a separate
1618 Size of DRAM reserved for malloc() use.
1621 Maximum size of memory mapped by the startup code of
1622 the Linux kernel; all data that must be processed by
1623 the Linux kernel (bd_info, boot arguments, eventually
1624 initrd image) must be put below this limit.
1626 - CFG_MAX_FLASH_BANKS:
1627 Max number of Flash memory banks
1629 - CFG_MAX_FLASH_SECT:
1630 Max number of sectors on a Flash chip
1632 - CFG_FLASH_ERASE_TOUT:
1633 Timeout for Flash erase operations (in ms)
1635 - CFG_FLASH_WRITE_TOUT:
1636 Timeout for Flash write operations (in ms)
1638 - CFG_FLASH_LOCK_TOUT
1639 Timeout for Flash set sector lock bit operation (in ms)
1641 - CFG_FLASH_UNLOCK_TOUT
1642 Timeout for Flash clear lock bits operation (in ms)
1644 - CFG_FLASH_PROTECTION
1645 If defined, hardware flash sectors protection is used
1646 instead of U-Boot software protection.
1648 - CFG_DIRECT_FLASH_TFTP:
1650 Enable TFTP transfers directly to flash memory;
1651 without this option such a download has to be
1652 performed in two steps: (1) download to RAM, and (2)
1653 copy from RAM to flash.
1655 The two-step approach is usually more reliable, since
1656 you can check if the download worked before you erase
1657 the flash, but in some situations (when sytem RAM is
1658 too limited to allow for a tempory copy of the
1659 downloaded image) this option may be very useful.
1662 Define if the flash driver uses extra elements in the
1663 common flash structure for storing flash geometry.
1665 - CFG_FLASH_CFI_DRIVER
1666 This option also enables the building of the cfi_flash driver
1667 in the drivers directory
1669 - CFG_RX_ETH_BUFFER:
1670 Defines the number of ethernet receive buffers. On some
1671 ethernet controllers it is recommended to set this value
1672 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1673 buffers can be full shortly after enabling the interface
1674 on high ethernet traffic.
1675 Defaults to 4 if not defined.
1677 The following definitions that deal with the placement and management
1678 of environment data (variable area); in general, we support the
1679 following configurations:
1681 - CFG_ENV_IS_IN_FLASH:
1683 Define this if the environment is in flash memory.
1685 a) The environment occupies one whole flash sector, which is
1686 "embedded" in the text segment with the U-Boot code. This
1687 happens usually with "bottom boot sector" or "top boot
1688 sector" type flash chips, which have several smaller
1689 sectors at the start or the end. For instance, such a
1690 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1691 such a case you would place the environment in one of the
1692 4 kB sectors - with U-Boot code before and after it. With
1693 "top boot sector" type flash chips, you would put the
1694 environment in one of the last sectors, leaving a gap
1695 between U-Boot and the environment.
1699 Offset of environment data (variable area) to the
1700 beginning of flash memory; for instance, with bottom boot
1701 type flash chips the second sector can be used: the offset
1702 for this sector is given here.
1704 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1708 This is just another way to specify the start address of
1709 the flash sector containing the environment (instead of
1712 - CFG_ENV_SECT_SIZE:
1714 Size of the sector containing the environment.
1717 b) Sometimes flash chips have few, equal sized, BIG sectors.
1718 In such a case you don't want to spend a whole sector for
1723 If you use this in combination with CFG_ENV_IS_IN_FLASH
1724 and CFG_ENV_SECT_SIZE, you can specify to use only a part
1725 of this flash sector for the environment. This saves
1726 memory for the RAM copy of the environment.
1728 It may also save flash memory if you decide to use this
1729 when your environment is "embedded" within U-Boot code,
1730 since then the remainder of the flash sector could be used
1731 for U-Boot code. It should be pointed out that this is
1732 STRONGLY DISCOURAGED from a robustness point of view:
1733 updating the environment in flash makes it always
1734 necessary to erase the WHOLE sector. If something goes
1735 wrong before the contents has been restored from a copy in
1736 RAM, your target system will be dead.
1738 - CFG_ENV_ADDR_REDUND
1741 These settings describe a second storage area used to hold
1742 a redundand copy of the environment data, so that there is
1743 a valid backup copy in case there is a power failure during
1744 a "saveenv" operation.
1746 BE CAREFUL! Any changes to the flash layout, and some changes to the
1747 source code will make it necessary to adapt <board>/u-boot.lds*
1751 - CFG_ENV_IS_IN_NVRAM:
1753 Define this if you have some non-volatile memory device
1754 (NVRAM, battery buffered SRAM) which you want to use for the
1760 These two #defines are used to determin the memory area you
1761 want to use for environment. It is assumed that this memory
1762 can just be read and written to, without any special
1765 BE CAREFUL! The first access to the environment happens quite early
1766 in U-Boot initalization (when we try to get the setting of for the
1767 console baudrate). You *MUST* have mappend your NVRAM area then, or
1770 Please note that even with NVRAM we still use a copy of the
1771 environment in RAM: we could work on NVRAM directly, but we want to
1772 keep settings there always unmodified except somebody uses "saveenv"
1773 to save the current settings.
1776 - CFG_ENV_IS_IN_EEPROM:
1778 Use this if you have an EEPROM or similar serial access
1779 device and a driver for it.
1784 These two #defines specify the offset and size of the
1785 environment area within the total memory of your EEPROM.
1787 - CFG_I2C_EEPROM_ADDR:
1788 If defined, specified the chip address of the EEPROM device.
1789 The default address is zero.
1791 - CFG_EEPROM_PAGE_WRITE_BITS:
1792 If defined, the number of bits used to address bytes in a
1793 single page in the EEPROM device. A 64 byte page, for example
1794 would require six bits.
1796 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1797 If defined, the number of milliseconds to delay between
1798 page writes. The default is zero milliseconds.
1800 - CFG_I2C_EEPROM_ADDR_LEN:
1801 The length in bytes of the EEPROM memory array address. Note
1802 that this is NOT the chip address length!
1804 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
1805 EEPROM chips that implement "address overflow" are ones
1806 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
1807 address and the extra bits end up in the "chip address" bit
1808 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
1811 Note that we consider the length of the address field to
1812 still be one byte because the extra address bits are hidden
1813 in the chip address.
1816 The size in bytes of the EEPROM device.
1819 - CFG_ENV_IS_IN_DATAFLASH:
1821 Define this if you have a DataFlash memory device which you
1822 want to use for the environment.
1828 These three #defines specify the offset and size of the
1829 environment area within the total memory of your DataFlash placed
1830 at the specified address.
1832 - CFG_ENV_IS_IN_NAND:
1834 Define this if you have a NAND device which you want to use
1835 for the environment.
1840 These two #defines specify the offset and size of the environment
1841 area within the first NAND device.
1843 - CFG_SPI_INIT_OFFSET
1845 Defines offset to the initial SPI buffer area in DPRAM. The
1846 area is used at an early stage (ROM part) if the environment
1847 is configured to reside in the SPI EEPROM: We need a 520 byte
1848 scratch DPRAM area. It is used between the two initialization
1849 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1850 to be a good choice since it makes it far enough from the
1851 start of the data area as well as from the stack pointer.
1853 Please note that the environment is read-only as long as the monitor
1854 has been relocated to RAM and a RAM copy of the environment has been
1855 created; also, when using EEPROM you will have to use getenv_r()
1856 until then to read environment variables.
1858 The environment is protected by a CRC32 checksum. Before the monitor
1859 is relocated into RAM, as a result of a bad CRC you will be working
1860 with the compiled-in default environment - *silently*!!! [This is
1861 necessary, because the first environment variable we need is the
1862 "baudrate" setting for the console - if we have a bad CRC, we don't
1863 have any device yet where we could complain.]
1865 Note: once the monitor has been relocated, then it will complain if
1866 the default environment is used; a new CRC is computed as soon as you
1867 use the "saveenv" command to store a valid environment.
1869 - CFG_FAULT_ECHO_LINK_DOWN:
1870 Echo the inverted Ethernet link state to the fault LED.
1872 Note: If this option is active, then CFG_FAULT_MII_ADDR
1873 also needs to be defined.
1875 - CFG_FAULT_MII_ADDR:
1876 MII address of the PHY to check for the Ethernet link state.
1878 - CFG_64BIT_VSPRINTF:
1879 Makes vsprintf (and all *printf functions) support printing
1880 of 64bit values by using the L quantifier
1882 - CFG_64BIT_STRTOUL:
1883 Adds simple_strtoull that returns a 64bit value
1885 Low Level (hardware related) configuration options:
1886 ---------------------------------------------------
1888 - CFG_CACHELINE_SIZE:
1889 Cache Line Size of the CPU.
1892 Default address of the IMMR after system reset.
1894 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
1895 and RPXsuper) to be able to adjust the position of
1896 the IMMR register after a reset.
1898 - Floppy Disk Support:
1899 CFG_FDC_DRIVE_NUMBER
1901 the default drive number (default value 0)
1905 defines the spacing between fdc chipset registers
1910 defines the offset of register from address. It
1911 depends on which part of the data bus is connected to
1912 the fdc chipset. (default value 0)
1914 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
1915 CFG_FDC_DRIVE_NUMBER are undefined, they take their
1918 if CFG_FDC_HW_INIT is defined, then the function
1919 fdc_hw_init() is called at the beginning of the FDC
1920 setup. fdc_hw_init() must be provided by the board
1921 source code. It is used to make hardware dependant
1924 - CFG_IMMR: Physical address of the Internal Memory Mapped
1925 Register; DO NOT CHANGE! (11-4)
1926 [MPC8xx systems only]
1928 - CFG_INIT_RAM_ADDR:
1930 Start address of memory area that can be used for
1931 initial data and stack; please note that this must be
1932 writable memory that is working WITHOUT special
1933 initialization, i. e. you CANNOT use normal RAM which
1934 will become available only after programming the
1935 memory controller and running certain initialization
1938 U-Boot uses the following memory types:
1939 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
1940 - MPC824X: data cache
1941 - PPC4xx: data cache
1943 - CFG_GBL_DATA_OFFSET:
1945 Offset of the initial data structure in the memory
1946 area defined by CFG_INIT_RAM_ADDR. Usually
1947 CFG_GBL_DATA_OFFSET is chosen such that the initial
1948 data is located at the end of the available space
1949 (sometimes written as (CFG_INIT_RAM_END -
1950 CFG_INIT_DATA_SIZE), and the initial stack is just
1951 below that area (growing from (CFG_INIT_RAM_ADDR +
1952 CFG_GBL_DATA_OFFSET) downward.
1955 On the MPC824X (or other systems that use the data
1956 cache for initial memory) the address chosen for
1957 CFG_INIT_RAM_ADDR is basically arbitrary - it must
1958 point to an otherwise UNUSED address space between
1959 the top of RAM and the start of the PCI space.
1961 - CFG_SIUMCR: SIU Module Configuration (11-6)
1963 - CFG_SYPCR: System Protection Control (11-9)
1965 - CFG_TBSCR: Time Base Status and Control (11-26)
1967 - CFG_PISCR: Periodic Interrupt Status and Control (11-31)
1969 - CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
1971 - CFG_SCCR: System Clock and reset Control Register (15-27)
1973 - CFG_OR_TIMING_SDRAM:
1977 periodic timer for refresh
1979 - CFG_DER: Debug Event Register (37-47)
1981 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
1982 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
1983 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
1985 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
1987 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
1988 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
1989 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
1990 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
1992 - CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
1993 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
1994 Machine Mode Register and Memory Periodic Timer
1995 Prescaler definitions (SDRAM timing)
1997 - CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
1998 enable I2C microcode relocation patch (MPC8xx);
1999 define relocation offset in DPRAM [DSP2]
2001 - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2002 enable SPI microcode relocation patch (MPC8xx);
2003 define relocation offset in DPRAM [SCC4]
2006 Use OSCM clock mode on MBX8xx board. Be careful,
2007 wrong setting might damage your board. Read
2008 doc/README.MBX before setting this variable!
2010 - CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2011 Offset of the bootmode word in DPRAM used by post
2012 (Power On Self Tests). This definition overrides
2013 #define'd default value in commproc.h resp.
2016 - CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2017 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2018 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2019 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2020 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2021 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2022 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
2023 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2024 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2026 - CONFIG_ETHER_ON_FEC[12]
2027 Define to enable FEC[12] on a 8xx series processor.
2029 - CONFIG_FEC[12]_PHY
2030 Define to the hardcoded PHY address which corresponds
2031 to the given FEC; i. e.
2032 #define CONFIG_FEC1_PHY 4
2033 means that the PHY with address 4 is connected to FEC1
2035 When set to -1, means to probe for first available.
2037 - CONFIG_FEC[12]_PHY_NORXERR
2038 The PHY does not have a RXERR line (RMII only).
2039 (so program the FEC to ignore it).
2042 Enable RMII mode for all FECs.
2043 Note that this is a global option, we can't
2044 have one FEC in standard MII mode and another in RMII mode.
2046 - CONFIG_CRC32_VERIFY
2047 Add a verify option to the crc32 command.
2050 => crc32 -v <address> <count> <crc32>
2052 Where address/count indicate a memory area
2053 and crc32 is the correct crc32 which the
2057 Add the "loopw" memory command. This only takes effect if
2058 the memory commands are activated globally (CFG_CMD_MEM).
2060 Building the Software:
2061 ======================
2063 Building U-Boot has been tested in native PPC environments (on a
2064 PowerBook G3 running LinuxPPC 2000) and in cross environments
2065 (running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2068 If you are not using a native PPC environment, it is assumed that you
2069 have the GNU cross compiling tools available in your path and named
2070 with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2071 you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2072 the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2075 CROSS_COMPILE = ppc_4xx-
2078 U-Boot is intended to be simple to build. After installing the
2079 sources you must configure U-Boot for one specific board type. This
2084 where "NAME_config" is the name of one of the existing
2085 configurations; the following names are supported:
2087 ADCIOP_config FPS860L_config omap730p2_config
2088 ADS860_config GEN860T_config pcu_e_config
2089 AR405_config GENIETV_config PIP405_config
2090 at91rm9200dk_config GTH_config QS823_config
2091 CANBT_config hermes_config QS850_config
2092 cmi_mpc5xx_config hymod_config QS860T_config
2093 cogent_common_config IP860_config RPXlite_config
2094 cogent_mpc8260_config IVML24_config RPXlite_DW_config
2095 cogent_mpc8xx_config IVMS8_config RPXsuper_config
2096 CPCI405_config JSE_config rsdproto_config
2097 CPCIISER4_config LANTEC_config Sandpoint8240_config
2098 csb272_config lwmon_config sbc8260_config
2099 CU824_config MBX860T_config sbc8560_33_config
2100 DUET_ADS_config MBX_config sbc8560_66_config
2101 EBONY_config MPC8260ADS_config SM850_config
2102 ELPT860_config MPC8540ADS_config SPD823TS_config
2103 ESTEEM192E_config MPC8560ADS_config stxgp3_config
2104 ETX094_config NETVIA_config SXNI855T_config
2105 FADS823_config omap1510inn_config TQM823L_config
2106 FADS850SAR_config omap1610h2_config TQM850L_config
2107 FADS860T_config omap1610inn_config TQM855L_config
2108 FPS850L_config omap5912osk_config TQM860L_config
2112 Note: for some board special configuration names may exist; check if
2113 additional information is available from the board vendor; for
2114 instance, the TQM823L systems are available without (standard)
2115 or with LCD support. You can select such additional "features"
2116 when chosing the configuration, i. e.
2119 - will configure for a plain TQM823L, i. e. no LCD support
2121 make TQM823L_LCD_config
2122 - will configure for a TQM823L with U-Boot console on LCD
2127 Finally, type "make all", and you should get some working U-Boot
2128 images ready for download to / installation on your system:
2130 - "u-boot.bin" is a raw binary image
2131 - "u-boot" is an image in ELF binary format
2132 - "u-boot.srec" is in Motorola S-Record format
2135 Please be aware that the Makefiles assume you are using GNU make, so
2136 for instance on NetBSD you might need to use "gmake" instead of
2140 If the system board that you have is not listed, then you will need
2141 to port U-Boot to your hardware platform. To do this, follow these
2144 1. Add a new configuration option for your board to the toplevel
2145 "Makefile" and to the "MAKEALL" script, using the existing
2146 entries as examples. Note that here and at many other places
2147 boards and other names are listed in alphabetical sort order. Please
2149 2. Create a new directory to hold your board specific code. Add any
2150 files you need. In your board directory, you will need at least
2151 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
2152 3. Create a new configuration file "include/configs/<board>.h" for
2154 3. If you're porting U-Boot to a new CPU, then also create a new
2155 directory to hold your CPU specific code. Add any files you need.
2156 4. Run "make <board>_config" with your new name.
2157 5. Type "make", and you should get a working "u-boot.srec" file
2158 to be installed on your target system.
2159 6. Debug and solve any problems that might arise.
2160 [Of course, this last step is much harder than it sounds.]
2163 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2164 ==============================================================
2166 If you have modified U-Boot sources (for instance added a new board
2167 or support for new devices, a new CPU, etc.) you are expected to
2168 provide feedback to the other developers. The feedback normally takes
2169 the form of a "patch", i. e. a context diff against a certain (latest
2170 official or latest in CVS) version of U-Boot sources.
2172 But before you submit such a patch, please verify that your modifi-
2173 cation did not break existing code. At least make sure that *ALL* of
2174 the supported boards compile WITHOUT ANY compiler warnings. To do so,
2175 just run the "MAKEALL" script, which will configure and build U-Boot
2176 for ALL supported system. Be warned, this will take a while. You can
2177 select which (cross) compiler to use by passing a `CROSS_COMPILE'
2178 environment variable to the script, i. e. to use the cross tools from
2179 MontaVista's Hard Hat Linux you can type
2181 CROSS_COMPILE=ppc_8xx- MAKEALL
2183 or to build on a native PowerPC system you can type
2185 CROSS_COMPILE=' ' MAKEALL
2187 See also "U-Boot Porting Guide" below.
2190 Monitor Commands - Overview:
2191 ============================
2193 go - start application at address 'addr'
2194 run - run commands in an environment variable
2195 bootm - boot application image from memory
2196 bootp - boot image via network using BootP/TFTP protocol
2197 tftpboot- boot image via network using TFTP protocol
2198 and env variables "ipaddr" and "serverip"
2199 (and eventually "gatewayip")
2200 rarpboot- boot image via network using RARP/TFTP protocol
2201 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2202 loads - load S-Record file over serial line
2203 loadb - load binary file over serial line (kermit mode)
2205 mm - memory modify (auto-incrementing)
2206 nm - memory modify (constant address)
2207 mw - memory write (fill)
2209 cmp - memory compare
2210 crc32 - checksum calculation
2211 imd - i2c memory display
2212 imm - i2c memory modify (auto-incrementing)
2213 inm - i2c memory modify (constant address)
2214 imw - i2c memory write (fill)
2215 icrc32 - i2c checksum calculation
2216 iprobe - probe to discover valid I2C chip addresses
2217 iloop - infinite loop on address range
2218 isdram - print SDRAM configuration information
2219 sspi - SPI utility commands
2220 base - print or set address offset
2221 printenv- print environment variables
2222 setenv - set environment variables
2223 saveenv - save environment variables to persistent storage
2224 protect - enable or disable FLASH write protection
2225 erase - erase FLASH memory
2226 flinfo - print FLASH memory information
2227 bdinfo - print Board Info structure
2228 iminfo - print header information for application image
2229 coninfo - print console devices and informations
2230 ide - IDE sub-system
2231 loop - infinite loop on address range
2232 loopw - infinite write loop on address range
2233 mtest - simple RAM test
2234 icache - enable or disable instruction cache
2235 dcache - enable or disable data cache
2236 reset - Perform RESET of the CPU
2237 echo - echo args to console
2238 version - print monitor version
2239 help - print online help
2240 ? - alias for 'help'
2243 Monitor Commands - Detailed Description:
2244 ========================================
2248 For now: just type "help <command>".
2251 Environment Variables:
2252 ======================
2254 U-Boot supports user configuration using Environment Variables which
2255 can be made persistent by saving to Flash memory.
2257 Environment Variables are set using "setenv", printed using
2258 "printenv", and saved to Flash using "saveenv". Using "setenv"
2259 without a value can be used to delete a variable from the
2260 environment. As long as you don't save the environment you are
2261 working with an in-memory copy. In case the Flash area containing the
2262 environment is erased by accident, a default environment is provided.
2264 Some configuration options can be set using Environment Variables:
2266 baudrate - see CONFIG_BAUDRATE
2268 bootdelay - see CONFIG_BOOTDELAY
2270 bootcmd - see CONFIG_BOOTCOMMAND
2272 bootargs - Boot arguments when booting an RTOS image
2274 bootfile - Name of the image to load with TFTP
2276 autoload - if set to "no" (any string beginning with 'n'),
2277 "bootp" will just load perform a lookup of the
2278 configuration from the BOOTP server, but not try to
2279 load any image using TFTP
2281 autostart - if set to "yes", an image loaded using the "bootp",
2282 "rarpboot", "tftpboot" or "diskboot" commands will
2283 be automatically started (by internally calling
2286 If set to "no", a standalone image passed to the
2287 "bootm" command will be copied to the load address
2288 (and eventually uncompressed), but NOT be started.
2289 This can be used to load and uncompress arbitrary
2292 i2cfast - (PPC405GP|PPC405EP only)
2293 if set to 'y' configures Linux I2C driver for fast
2294 mode (400kHZ). This environment variable is used in
2295 initialization code. So, for changes to be effective
2296 it must be saved and board must be reset.
2298 initrd_high - restrict positioning of initrd images:
2299 If this variable is not set, initrd images will be
2300 copied to the highest possible address in RAM; this
2301 is usually what you want since it allows for
2302 maximum initrd size. If for some reason you want to
2303 make sure that the initrd image is loaded below the
2304 CFG_BOOTMAPSZ limit, you can set this environment
2305 variable to a value of "no" or "off" or "0".
2306 Alternatively, you can set it to a maximum upper
2307 address to use (U-Boot will still check that it
2308 does not overwrite the U-Boot stack and data).
2310 For instance, when you have a system with 16 MB
2311 RAM, and want to reserve 4 MB from use by Linux,
2312 you can do this by adding "mem=12M" to the value of
2313 the "bootargs" variable. However, now you must make
2314 sure that the initrd image is placed in the first
2315 12 MB as well - this can be done with
2317 setenv initrd_high 00c00000
2319 If you set initrd_high to 0xFFFFFFFF, this is an
2320 indication to U-Boot that all addresses are legal
2321 for the Linux kernel, including addresses in flash
2322 memory. In this case U-Boot will NOT COPY the
2323 ramdisk at all. This may be useful to reduce the
2324 boot time on your system, but requires that this
2325 feature is supported by your Linux kernel.
2327 ipaddr - IP address; needed for tftpboot command
2329 loadaddr - Default load address for commands like "bootp",
2330 "rarpboot", "tftpboot", "loadb" or "diskboot"
2332 loads_echo - see CONFIG_LOADS_ECHO
2334 serverip - TFTP server IP address; needed for tftpboot command
2336 bootretry - see CONFIG_BOOT_RETRY_TIME
2338 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
2340 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
2342 ethprime - When CONFIG_NET_MULTI is enabled controls which
2343 interface is used first.
2345 ethact - When CONFIG_NET_MULTI is enabled controls which
2346 interface is currently active. For example you
2347 can do the following
2349 => setenv ethact FEC ETHERNET
2350 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2351 => setenv ethact SCC ETHERNET
2352 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2354 netretry - When set to "no" each network operation will
2355 either succeed or fail without retrying.
2356 When set to "once" the network operation will
2357 fail when all the available network interfaces
2358 are tried once without success.
2359 Useful on scripts which control the retry operation
2362 vlan - When set to a value < 4095 the traffic over
2363 ethernet is encapsulated/received over 802.1q
2366 The following environment variables may be used and automatically
2367 updated by the network boot commands ("bootp" and "rarpboot"),
2368 depending the information provided by your boot server:
2370 bootfile - see above
2371 dnsip - IP address of your Domain Name Server
2372 dnsip2 - IP address of your secondary Domain Name Server
2373 gatewayip - IP address of the Gateway (Router) to use
2374 hostname - Target hostname
2376 netmask - Subnet Mask
2377 rootpath - Pathname of the root filesystem on the NFS server
2378 serverip - see above
2381 There are two special Environment Variables:
2383 serial# - contains hardware identification information such
2384 as type string and/or serial number
2385 ethaddr - Ethernet address
2387 These variables can be set only once (usually during manufacturing of
2388 the board). U-Boot refuses to delete or overwrite these variables
2389 once they have been set once.
2392 Further special Environment Variables:
2394 ver - Contains the U-Boot version string as printed
2395 with the "version" command. This variable is
2396 readonly (see CONFIG_VERSION_VARIABLE).
2399 Please note that changes to some configuration parameters may take
2400 only effect after the next boot (yes, that's just like Windoze :-).
2403 Command Line Parsing:
2404 =====================
2406 There are two different command line parsers available with U-Boot:
2407 the old "simple" one, and the much more powerful "hush" shell:
2409 Old, simple command line parser:
2410 --------------------------------
2412 - supports environment variables (through setenv / saveenv commands)
2413 - several commands on one line, separated by ';'
2414 - variable substitution using "... $(name) ..." syntax
2415 - special characters ('$', ';') can be escaped by prefixing with '\',
2417 setenv bootcmd bootm \$(address)
2418 - You can also escape text by enclosing in single apostrophes, for example:
2419 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2424 - similar to Bourne shell, with control structures like
2425 if...then...else...fi, for...do...done; while...do...done,
2426 until...do...done, ...
2427 - supports environment ("global") variables (through setenv / saveenv
2428 commands) and local shell variables (through standard shell syntax
2429 "name=value"); only environment variables can be used with "run"
2435 (1) If a command line (or an environment variable executed by a "run"
2436 command) contains several commands separated by semicolon, and
2437 one of these commands fails, then the remaining commands will be
2440 (2) If you execute several variables with one call to run (i. e.
2441 calling run with a list af variables as arguments), any failing
2442 command will cause "run" to terminate, i. e. the remaining
2443 variables are not executed.
2445 Note for Redundant Ethernet Interfaces:
2446 =======================================
2448 Some boards come with redundant ethernet interfaces; U-Boot supports
2449 such configurations and is capable of automatic selection of a
2450 "working" interface when needed. MAC assignment works as follows:
2452 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2453 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2454 "eth1addr" (=>eth1), "eth2addr", ...
2456 If the network interface stores some valid MAC address (for instance
2457 in SROM), this is used as default address if there is NO correspon-
2458 ding setting in the environment; if the corresponding environment
2459 variable is set, this overrides the settings in the card; that means:
2461 o If the SROM has a valid MAC address, and there is no address in the
2462 environment, the SROM's address is used.
2464 o If there is no valid address in the SROM, and a definition in the
2465 environment exists, then the value from the environment variable is
2468 o If both the SROM and the environment contain a MAC address, and
2469 both addresses are the same, this MAC address is used.
2471 o If both the SROM and the environment contain a MAC address, and the
2472 addresses differ, the value from the environment is used and a
2475 o If neither SROM nor the environment contain a MAC address, an error
2482 The "boot" commands of this monitor operate on "image" files which
2483 can be basicly anything, preceeded by a special header; see the
2484 definitions in include/image.h for details; basicly, the header
2485 defines the following image properties:
2487 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2488 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2489 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2490 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2491 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2492 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2493 Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2494 * Compression Type (uncompressed, gzip, bzip2)
2500 The header is marked by a special Magic Number, and both the header
2501 and the data portions of the image are secured against corruption by
2508 Although U-Boot should support any OS or standalone application
2509 easily, the main focus has always been on Linux during the design of
2512 U-Boot includes many features that so far have been part of some
2513 special "boot loader" code within the Linux kernel. Also, any
2514 "initrd" images to be used are no longer part of one big Linux image;
2515 instead, kernel and "initrd" are separate images. This implementation
2516 serves several purposes:
2518 - the same features can be used for other OS or standalone
2519 applications (for instance: using compressed images to reduce the
2520 Flash memory footprint)
2522 - it becomes much easier to port new Linux kernel versions because
2523 lots of low-level, hardware dependent stuff are done by U-Boot
2525 - the same Linux kernel image can now be used with different "initrd"
2526 images; of course this also means that different kernel images can
2527 be run with the same "initrd". This makes testing easier (you don't
2528 have to build a new "zImage.initrd" Linux image when you just
2529 change a file in your "initrd"). Also, a field-upgrade of the
2530 software is easier now.
2536 Porting Linux to U-Boot based systems:
2537 ---------------------------------------
2539 U-Boot cannot save you from doing all the necessary modifications to
2540 configure the Linux device drivers for use with your target hardware
2541 (no, we don't intend to provide a full virtual machine interface to
2544 But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2546 Just make sure your machine specific header file (for instance
2547 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2548 Information structure as we define in include/u-boot.h, and make
2549 sure that your definition of IMAP_ADDR uses the same value as your
2550 U-Boot configuration in CFG_IMMR.
2553 Configuring the Linux kernel:
2554 -----------------------------
2556 No specific requirements for U-Boot. Make sure you have some root
2557 device (initial ramdisk, NFS) for your target system.
2560 Building a Linux Image:
2561 -----------------------
2563 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2564 not used. If you use recent kernel source, a new build target
2565 "uImage" will exist which automatically builds an image usable by
2566 U-Boot. Most older kernels also have support for a "pImage" target,
2567 which was introduced for our predecessor project PPCBoot and uses a
2568 100% compatible format.
2577 The "uImage" build target uses a special tool (in 'tools/mkimage') to
2578 encapsulate a compressed Linux kernel image with header information,
2579 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2581 * build a standard "vmlinux" kernel image (in ELF binary format):
2583 * convert the kernel into a raw binary image:
2585 ${CROSS_COMPILE}-objcopy -O binary \
2586 -R .note -R .comment \
2587 -S vmlinux linux.bin
2589 * compress the binary image:
2593 * package compressed binary image for U-Boot:
2595 mkimage -A ppc -O linux -T kernel -C gzip \
2596 -a 0 -e 0 -n "Linux Kernel Image" \
2597 -d linux.bin.gz uImage
2600 The "mkimage" tool can also be used to create ramdisk images for use
2601 with U-Boot, either separated from the Linux kernel image, or
2602 combined into one file. "mkimage" encapsulates the images with a 64
2603 byte header containing information about target architecture,
2604 operating system, image type, compression method, entry points, time
2605 stamp, CRC32 checksums, etc.
2607 "mkimage" can be called in two ways: to verify existing images and
2608 print the header information, or to build new images.
2610 In the first form (with "-l" option) mkimage lists the information
2611 contained in the header of an existing U-Boot image; this includes
2612 checksum verification:
2614 tools/mkimage -l image
2615 -l ==> list image header information
2617 The second form (with "-d" option) is used to build a U-Boot image
2618 from a "data file" which is used as image payload:
2620 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2621 -n name -d data_file image
2622 -A ==> set architecture to 'arch'
2623 -O ==> set operating system to 'os'
2624 -T ==> set image type to 'type'
2625 -C ==> set compression type 'comp'
2626 -a ==> set load address to 'addr' (hex)
2627 -e ==> set entry point to 'ep' (hex)
2628 -n ==> set image name to 'name'
2629 -d ==> use image data from 'datafile'
2631 Right now, all Linux kernels for PowerPC systems use the same load
2632 address (0x00000000), but the entry point address depends on the
2635 - 2.2.x kernels have the entry point at 0x0000000C,
2636 - 2.3.x and later kernels have the entry point at 0x00000000.
2638 So a typical call to build a U-Boot image would read:
2640 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2641 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2642 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2643 > examples/uImage.TQM850L
2644 Image Name: 2.4.4 kernel for TQM850L
2645 Created: Wed Jul 19 02:34:59 2000
2646 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2647 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2648 Load Address: 0x00000000
2649 Entry Point: 0x00000000
2651 To verify the contents of the image (or check for corruption):
2653 -> tools/mkimage -l examples/uImage.TQM850L
2654 Image Name: 2.4.4 kernel for TQM850L
2655 Created: Wed Jul 19 02:34:59 2000
2656 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2657 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2658 Load Address: 0x00000000
2659 Entry Point: 0x00000000
2661 NOTE: for embedded systems where boot time is critical you can trade
2662 speed for memory and install an UNCOMPRESSED image instead: this
2663 needs more space in Flash, but boots much faster since it does not
2664 need to be uncompressed:
2666 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2667 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2668 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2669 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2670 > examples/uImage.TQM850L-uncompressed
2671 Image Name: 2.4.4 kernel for TQM850L
2672 Created: Wed Jul 19 02:34:59 2000
2673 Image Type: PowerPC Linux Kernel Image (uncompressed)
2674 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2675 Load Address: 0x00000000
2676 Entry Point: 0x00000000
2679 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2680 when your kernel is intended to use an initial ramdisk:
2682 -> tools/mkimage -n 'Simple Ramdisk Image' \
2683 > -A ppc -O linux -T ramdisk -C gzip \
2684 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2685 Image Name: Simple Ramdisk Image
2686 Created: Wed Jan 12 14:01:50 2000
2687 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2688 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2689 Load Address: 0x00000000
2690 Entry Point: 0x00000000
2693 Installing a Linux Image:
2694 -------------------------
2696 To downloading a U-Boot image over the serial (console) interface,
2697 you must convert the image to S-Record format:
2699 objcopy -I binary -O srec examples/image examples/image.srec
2701 The 'objcopy' does not understand the information in the U-Boot
2702 image header, so the resulting S-Record file will be relative to
2703 address 0x00000000. To load it to a given address, you need to
2704 specify the target address as 'offset' parameter with the 'loads'
2707 Example: install the image to address 0x40100000 (which on the
2708 TQM8xxL is in the first Flash bank):
2710 => erase 40100000 401FFFFF
2716 ## Ready for S-Record download ...
2717 ~>examples/image.srec
2718 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2720 15989 15990 15991 15992
2721 [file transfer complete]
2723 ## Start Addr = 0x00000000
2726 You can check the success of the download using the 'iminfo' command;
2727 this includes a checksum verification so you can be sure no data
2728 corruption happened:
2732 ## Checking Image at 40100000 ...
2733 Image Name: 2.2.13 for initrd on TQM850L
2734 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2735 Data Size: 335725 Bytes = 327 kB = 0 MB
2736 Load Address: 00000000
2737 Entry Point: 0000000c
2738 Verifying Checksum ... OK
2744 The "bootm" command is used to boot an application that is stored in
2745 memory (RAM or Flash). In case of a Linux kernel image, the contents
2746 of the "bootargs" environment variable is passed to the kernel as
2747 parameters. You can check and modify this variable using the
2748 "printenv" and "setenv" commands:
2751 => printenv bootargs
2752 bootargs=root=/dev/ram
2754 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2756 => printenv bootargs
2757 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2760 ## Booting Linux kernel at 40020000 ...
2761 Image Name: 2.2.13 for NFS on TQM850L
2762 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2763 Data Size: 381681 Bytes = 372 kB = 0 MB
2764 Load Address: 00000000
2765 Entry Point: 0000000c
2766 Verifying Checksum ... OK
2767 Uncompressing Kernel Image ... OK
2768 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
2769 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2770 time_init: decrementer frequency = 187500000/60
2771 Calibrating delay loop... 49.77 BogoMIPS
2772 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2775 If you want to boot a Linux kernel with initial ram disk, you pass
2776 the memory addresses of both the kernel and the initrd image (PPBCOOT
2777 format!) to the "bootm" command:
2779 => imi 40100000 40200000
2781 ## Checking Image at 40100000 ...
2782 Image Name: 2.2.13 for initrd on TQM850L
2783 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2784 Data Size: 335725 Bytes = 327 kB = 0 MB
2785 Load Address: 00000000
2786 Entry Point: 0000000c
2787 Verifying Checksum ... OK
2789 ## Checking Image at 40200000 ...
2790 Image Name: Simple Ramdisk Image
2791 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2792 Data Size: 566530 Bytes = 553 kB = 0 MB
2793 Load Address: 00000000
2794 Entry Point: 00000000
2795 Verifying Checksum ... OK
2797 => bootm 40100000 40200000
2798 ## Booting Linux kernel at 40100000 ...
2799 Image Name: 2.2.13 for initrd on TQM850L
2800 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2801 Data Size: 335725 Bytes = 327 kB = 0 MB
2802 Load Address: 00000000
2803 Entry Point: 0000000c
2804 Verifying Checksum ... OK
2805 Uncompressing Kernel Image ... OK
2806 ## Loading RAMDisk Image at 40200000 ...
2807 Image Name: Simple Ramdisk Image
2808 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2809 Data Size: 566530 Bytes = 553 kB = 0 MB
2810 Load Address: 00000000
2811 Entry Point: 00000000
2812 Verifying Checksum ... OK
2813 Loading Ramdisk ... OK
2814 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
2815 Boot arguments: root=/dev/ram
2816 time_init: decrementer frequency = 187500000/60
2817 Calibrating delay loop... 49.77 BogoMIPS
2819 RAMDISK: Compressed image found at block 0
2820 VFS: Mounted root (ext2 filesystem).
2824 More About U-Boot Image Types:
2825 ------------------------------
2827 U-Boot supports the following image types:
2829 "Standalone Programs" are directly runnable in the environment
2830 provided by U-Boot; it is expected that (if they behave
2831 well) you can continue to work in U-Boot after return from
2832 the Standalone Program.
2833 "OS Kernel Images" are usually images of some Embedded OS which
2834 will take over control completely. Usually these programs
2835 will install their own set of exception handlers, device
2836 drivers, set up the MMU, etc. - this means, that you cannot
2837 expect to re-enter U-Boot except by resetting the CPU.
2838 "RAMDisk Images" are more or less just data blocks, and their
2839 parameters (address, size) are passed to an OS kernel that is
2841 "Multi-File Images" contain several images, typically an OS
2842 (Linux) kernel image and one or more data images like
2843 RAMDisks. This construct is useful for instance when you want
2844 to boot over the network using BOOTP etc., where the boot
2845 server provides just a single image file, but you want to get
2846 for instance an OS kernel and a RAMDisk image.
2848 "Multi-File Images" start with a list of image sizes, each
2849 image size (in bytes) specified by an "uint32_t" in network
2850 byte order. This list is terminated by an "(uint32_t)0".
2851 Immediately after the terminating 0 follow the images, one by
2852 one, all aligned on "uint32_t" boundaries (size rounded up to
2853 a multiple of 4 bytes).
2855 "Firmware Images" are binary images containing firmware (like
2856 U-Boot or FPGA images) which usually will be programmed to
2859 "Script files" are command sequences that will be executed by
2860 U-Boot's command interpreter; this feature is especially
2861 useful when you configure U-Boot to use a real shell (hush)
2862 as command interpreter.
2868 One of the features of U-Boot is that you can dynamically load and
2869 run "standalone" applications, which can use some resources of
2870 U-Boot like console I/O functions or interrupt services.
2872 Two simple examples are included with the sources:
2877 'examples/hello_world.c' contains a small "Hello World" Demo
2878 application; it is automatically compiled when you build U-Boot.
2879 It's configured to run at address 0x00040004, so you can play with it
2883 ## Ready for S-Record download ...
2884 ~>examples/hello_world.srec
2885 1 2 3 4 5 6 7 8 9 10 11 ...
2886 [file transfer complete]
2888 ## Start Addr = 0x00040004
2890 => go 40004 Hello World! This is a test.
2891 ## Starting application at 0x00040004 ...
2902 Hit any key to exit ...
2904 ## Application terminated, rc = 0x0
2906 Another example, which demonstrates how to register a CPM interrupt
2907 handler with the U-Boot code, can be found in 'examples/timer.c'.
2908 Here, a CPM timer is set up to generate an interrupt every second.
2909 The interrupt service routine is trivial, just printing a '.'
2910 character, but this is just a demo program. The application can be
2911 controlled by the following keys:
2913 ? - print current values og the CPM Timer registers
2914 b - enable interrupts and start timer
2915 e - stop timer and disable interrupts
2916 q - quit application
2919 ## Ready for S-Record download ...
2920 ~>examples/timer.srec
2921 1 2 3 4 5 6 7 8 9 10 11 ...
2922 [file transfer complete]
2924 ## Start Addr = 0x00040004
2927 ## Starting application at 0x00040004 ...
2930 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
2933 [q, b, e, ?] Set interval 1000000 us
2936 [q, b, e, ?] ........
2937 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
2940 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
2943 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
2946 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
2948 [q, b, e, ?] ...Stopping timer
2950 [q, b, e, ?] ## Application terminated, rc = 0x0
2956 Over time, many people have reported problems when trying to use the
2957 "minicom" terminal emulation program for serial download. I (wd)
2958 consider minicom to be broken, and recommend not to use it. Under
2959 Unix, I recommend to use C-Kermit for general purpose use (and
2960 especially for kermit binary protocol download ("loadb" command), and
2961 use "cu" for S-Record download ("loads" command).
2963 Nevertheless, if you absolutely want to use it try adding this
2964 configuration to your "File transfer protocols" section:
2966 Name Program Name U/D FullScr IO-Red. Multi
2967 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
2968 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
2974 Starting at version 0.9.2, U-Boot supports NetBSD both as host
2975 (build U-Boot) and target system (boots NetBSD/mpc8xx).
2977 Building requires a cross environment; it is known to work on
2978 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
2979 need gmake since the Makefiles are not compatible with BSD make).
2980 Note that the cross-powerpc package does not install include files;
2981 attempting to build U-Boot will fail because <machine/ansi.h> is
2982 missing. This file has to be installed and patched manually:
2984 # cd /usr/pkg/cross/powerpc-netbsd/include
2986 # ln -s powerpc machine
2987 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
2988 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
2990 Native builds *don't* work due to incompatibilities between native
2991 and U-Boot include files.
2993 Booting assumes that (the first part of) the image booted is a
2994 stage-2 loader which in turn loads and then invokes the kernel
2995 proper. Loader sources will eventually appear in the NetBSD source
2996 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2997 meantime, send mail to bruno@exet-ag.de and/or wd@denx.de for
3001 Implementation Internals:
3002 =========================
3004 The following is not intended to be a complete description of every
3005 implementation detail. However, it should help to understand the
3006 inner workings of U-Boot and make it easier to port it to custom
3010 Initial Stack, Global Data:
3011 ---------------------------
3013 The implementation of U-Boot is complicated by the fact that U-Boot
3014 starts running out of ROM (flash memory), usually without access to
3015 system RAM (because the memory controller is not initialized yet).
3016 This means that we don't have writable Data or BSS segments, and BSS
3017 is not initialized as zero. To be able to get a C environment working
3018 at all, we have to allocate at least a minimal stack. Implementation
3019 options for this are defined and restricted by the CPU used: Some CPU
3020 models provide on-chip memory (like the IMMR area on MPC8xx and
3021 MPC826x processors), on others (parts of) the data cache can be
3022 locked as (mis-) used as memory, etc.
3024 Chris Hallinan posted a good summary of these issues to the
3025 u-boot-users mailing list:
3027 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3028 From: "Chris Hallinan" <clh@net1plus.com>
3029 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3032 Correct me if I'm wrong, folks, but the way I understand it
3033 is this: Using DCACHE as initial RAM for Stack, etc, does not
3034 require any physical RAM backing up the cache. The cleverness
3035 is that the cache is being used as a temporary supply of
3036 necessary storage before the SDRAM controller is setup. It's
3037 beyond the scope of this list to expain the details, but you
3038 can see how this works by studying the cache architecture and
3039 operation in the architecture and processor-specific manuals.
3041 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3042 is another option for the system designer to use as an
3043 initial stack/ram area prior to SDRAM being available. Either
3044 option should work for you. Using CS 4 should be fine if your
3045 board designers haven't used it for something that would
3046 cause you grief during the initial boot! It is frequently not
3049 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3050 with your processor/board/system design. The default value
3051 you will find in any recent u-boot distribution in
3052 Walnut405.h should work for you. I'd set it to a value larger
3053 than your SDRAM module. If you have a 64MB SDRAM module, set
3054 it above 400_0000. Just make sure your board has no resources
3055 that are supposed to respond to that address! That code in
3056 start.S has been around a while and should work as is when
3057 you get the config right.
3062 It is essential to remember this, since it has some impact on the C
3063 code for the initialization procedures:
3065 * Initialized global data (data segment) is read-only. Do not attempt
3068 * Do not use any unitialized global data (or implicitely initialized
3069 as zero data - BSS segment) at all - this is undefined, initiali-
3070 zation is performed later (when relocating to RAM).
3072 * Stack space is very limited. Avoid big data buffers or things like
3075 Having only the stack as writable memory limits means we cannot use
3076 normal global data to share information beween the code. But it
3077 turned out that the implementation of U-Boot can be greatly
3078 simplified by making a global data structure (gd_t) available to all
3079 functions. We could pass a pointer to this data as argument to _all_
3080 functions, but this would bloat the code. Instead we use a feature of
3081 the GCC compiler (Global Register Variables) to share the data: we
3082 place a pointer (gd) to the global data into a register which we
3083 reserve for this purpose.
3085 When choosing a register for such a purpose we are restricted by the
3086 relevant (E)ABI specifications for the current architecture, and by
3087 GCC's implementation.
3089 For PowerPC, the following registers have specific use:
3092 R3-R4: parameter passing and return values
3093 R5-R10: parameter passing
3094 R13: small data area pointer
3098 (U-Boot also uses R14 as internal GOT pointer.)
3100 ==> U-Boot will use R29 to hold a pointer to the global data
3102 Note: on PPC, we could use a static initializer (since the
3103 address of the global data structure is known at compile time),
3104 but it turned out that reserving a register results in somewhat
3105 smaller code - although the code savings are not that big (on
3106 average for all boards 752 bytes for the whole U-Boot image,
3107 624 text + 127 data).
3109 On ARM, the following registers are used:
3111 R0: function argument word/integer result
3112 R1-R3: function argument word
3114 R10: stack limit (used only if stack checking if enabled)
3115 R11: argument (frame) pointer
3116 R12: temporary workspace
3119 R15: program counter
3121 ==> U-Boot will use R8 to hold a pointer to the global data
3127 U-Boot runs in system state and uses physical addresses, i.e. the
3128 MMU is not used either for address mapping nor for memory protection.
3130 The available memory is mapped to fixed addresses using the memory
3131 controller. In this process, a contiguous block is formed for each
3132 memory type (Flash, SDRAM, SRAM), even when it consists of several
3133 physical memory banks.
3135 U-Boot is installed in the first 128 kB of the first Flash bank (on
3136 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3137 booting and sizing and initializing DRAM, the code relocates itself
3138 to the upper end of DRAM. Immediately below the U-Boot code some
3139 memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3140 configuration setting]. Below that, a structure with global Board
3141 Info data is placed, followed by the stack (growing downward).
3143 Additionally, some exception handler code is copied to the low 8 kB
3144 of DRAM (0x00000000 ... 0x00001FFF).
3146 So a typical memory configuration with 16 MB of DRAM could look like
3149 0x0000 0000 Exception Vector code
3152 0x0000 2000 Free for Application Use
3158 0x00FB FF20 Monitor Stack (Growing downward)
3159 0x00FB FFAC Board Info Data and permanent copy of global data
3160 0x00FC 0000 Malloc Arena
3163 0x00FE 0000 RAM Copy of Monitor Code
3164 ... eventually: LCD or video framebuffer
3165 ... eventually: pRAM (Protected RAM - unchanged by reset)
3166 0x00FF FFFF [End of RAM]
3169 System Initialization:
3170 ----------------------
3172 In the reset configuration, U-Boot starts at the reset entry point
3173 (on most PowerPC systens at address 0x00000100). Because of the reset
3174 configuration for CS0# this is a mirror of the onboard Flash memory.
3175 To be able to re-map memory U-Boot then jumps to its link address.
3176 To be able to implement the initialization code in C, a (small!)
3177 initial stack is set up in the internal Dual Ported RAM (in case CPUs
3178 which provide such a feature like MPC8xx or MPC8260), or in a locked
3179 part of the data cache. After that, U-Boot initializes the CPU core,
3180 the caches and the SIU.
3182 Next, all (potentially) available memory banks are mapped using a
3183 preliminary mapping. For example, we put them on 512 MB boundaries
3184 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3185 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3186 programmed for SDRAM access. Using the temporary configuration, a
3187 simple memory test is run that determines the size of the SDRAM
3190 When there is more than one SDRAM bank, and the banks are of
3191 different size, the largest is mapped first. For equal size, the first
3192 bank (CS2#) is mapped first. The first mapping is always for address
3193 0x00000000, with any additional banks following immediately to create
3194 contiguous memory starting from 0.
3196 Then, the monitor installs itself at the upper end of the SDRAM area
3197 and allocates memory for use by malloc() and for the global Board
3198 Info data; also, the exception vector code is copied to the low RAM
3199 pages, and the final stack is set up.
3201 Only after this relocation will you have a "normal" C environment;
3202 until that you are restricted in several ways, mostly because you are
3203 running from ROM, and because the code will have to be relocated to a
3207 U-Boot Porting Guide:
3208 ----------------------
3210 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3214 int main (int argc, char *argv[])
3216 sighandler_t no_more_time;
3218 signal (SIGALRM, no_more_time);
3219 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3221 if (available_money > available_manpower) {
3222 pay consultant to port U-Boot;
3226 Download latest U-Boot source;
3228 Subscribe to u-boot-users mailing list;
3231 email ("Hi, I am new to U-Boot, how do I get started?");
3235 Read the README file in the top level directory;
3236 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3237 Read the source, Luke;
3240 if (available_money > toLocalCurrency ($2500)) {
3243 Add a lot of aggravation and time;
3246 Create your own board support subdirectory;
3248 Create your own board config file;
3252 Add / modify source code;
3256 email ("Hi, I am having problems...");
3258 Send patch file to Wolfgang;
3263 void no_more_time (int sig)
3272 All contributions to U-Boot should conform to the Linux kernel
3273 coding style; see the file "Documentation/CodingStyle" in your Linux
3274 kernel source directory.
3276 Please note that U-Boot is implemented in C (and to some small parts
3277 in Assembler); no C++ is used, so please do not use C++ style
3278 comments (//) in your code.
3280 Please also stick to the following formatting rules:
3281 - remove any trailing white space
3282 - use TAB characters for indentation, not spaces
3283 - make sure NOT to use DOS '\r\n' line feeds
3284 - do not add more than 2 empty lines to source files
3285 - do not add trailing empty lines to source files
3287 Submissions which do not conform to the standards may be returned
3288 with a request to reformat the changes.
3294 Since the number of patches for U-Boot is growing, we need to
3295 establish some rules. Submissions which do not conform to these rules
3296 may be rejected, even when they contain important and valuable stuff.
3299 When you send a patch, please include the following information with
3302 * For bug fixes: a description of the bug and how your patch fixes
3303 this bug. Please try to include a way of demonstrating that the
3304 patch actually fixes something.
3306 * For new features: a description of the feature and your
3309 * A CHANGELOG entry as plaintext (separate from the patch)
3311 * For major contributions, your entry to the CREDITS file
3313 * When you add support for a new board, don't forget to add this
3314 board to the MAKEALL script, too.
3316 * If your patch adds new configuration options, don't forget to
3317 document these in the README file.
3319 * The patch itself. If you are accessing the CVS repository use "cvs
3320 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3321 version of diff does not support these options, then get the latest
3322 version of GNU diff.
3324 The current directory when running this command shall be the top
3325 level directory of the U-Boot source tree, or it's parent directory
3326 (i. e. please make sure that your patch includes sufficient
3327 directory information for the affected files).
3329 We accept patches as plain text, MIME attachments or as uuencoded
3332 * If one logical set of modifications affects or creates several
3333 files, all these changes shall be submitted in a SINGLE patch file.
3335 * Changesets that contain different, unrelated modifications shall be
3336 submitted as SEPARATE patches, one patch per changeset.
3341 * Before sending the patch, run the MAKEALL script on your patched
3342 source tree and make sure that no errors or warnings are reported
3343 for any of the boards.
3345 * Keep your modifications to the necessary minimum: A patch
3346 containing several unrelated changes or arbitrary reformats will be
3347 returned with a request to re-formatting / split it.
3349 * If you modify existing code, make sure that your new code does not
3350 add to the memory footprint of the code ;-) Small is beautiful!
3351 When adding new features, these should compile conditionally only
3352 (using #ifdef), and the resulting code with the new feature
3353 disabled must not need more memory than the old code without your
projects / karo-tx-uboot.git / blob