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 - disk Code for disk drive partition handling
126 - doc Documentation (don't expect too much)
127 - drivers Commonly used device drivers
128 - dtt Digital Thermometer and Thermostat drivers
129 - examples Example code for standalone applications, etc.
130 - include Header Files
131 - disk Harddisk interface code
132 - net Networking code
133 - ppc Files generic to PowerPC architecture
134 - post Power On Self Test
135 - post/arch Symlink to architecture specific Power On Self Test
136 - post/arch-ppc PowerPC architecture specific Power On Self Test
137 - post/cpu/mpc8260 MPC8260 CPU specific Power On Self Test
138 - post/cpu/mpc8xx MPC8xx CPU specific Power On Self Test
139 - rtc Real Time Clock drivers
140 - tools Tools to build S-Record or U-Boot images, etc.
142 - cpu/74xx_7xx Files specific to Motorola MPC74xx and 7xx CPUs
143 - cpu/arm925t Files specific to ARM 925 CPUs
144 - cpu/arm926ejs Files specific to ARM 926 CPUs
145 - cpu/mpc5xx Files specific to Motorola MPC5xx CPUs
146 - cpu/mpc8xx Files specific to Motorola MPC8xx CPUs
147 - cpu/mpc824x Files specific to Motorola MPC824x CPUs
148 - cpu/mpc8260 Files specific to Motorola MPC8260 CPU
149 - cpu/mpc85xx Files specific to Motorola MPC85xx CPUs
150 - cpu/ppc4xx Files specific to IBM 4xx CPUs
153 - board/LEOX/ Files specific to boards manufactured by The LEOX team
154 - board/LEOX/elpt860 Files specific to ELPT860 boards
156 Files specific to RPXClassic boards
157 - board/RPXlite Files specific to RPXlite boards
158 - board/at91rm9200dk Files specific to AT91RM9200DK boards
159 - board/c2mon Files specific to c2mon boards
160 - board/cmi Files specific to cmi boards
161 - board/cogent Files specific to Cogent boards
162 (need further configuration)
163 Files specific to CPCIISER4 boards
164 - board/cpu86 Files specific to CPU86 boards
165 - board/cray/ Files specific to boards manufactured by Cray
166 - board/cray/L1 Files specific to L1 boards
167 - board/cu824 Files specific to CU824 boards
168 - board/ebony Files specific to IBM Ebony board
169 - board/eric Files specific to ERIC boards
170 - board/esd/ Files specific to boards manufactured by ESD
171 - board/esd/adciop Files specific to ADCIOP boards
172 - board/esd/ar405 Files specific to AR405 boards
173 - board/esd/canbt Files specific to CANBT boards
174 - board/esd/cpci405 Files specific to CPCI405 boards
175 - board/esd/cpciiser4 Files specific to CPCIISER4 boards
176 - board/esd/common Common files for ESD boards
177 - board/esd/dasa_sim Files specific to DASA_SIM boards
178 - board/esd/du405 Files specific to DU405 boards
179 - board/esd/ocrtc Files specific to OCRTC boards
180 - board/esd/pci405 Files specific to PCI405 boards
182 Files specific to ESTEEM192E boards
183 - board/etx094 Files specific to ETX_094 boards
185 Files specific to EVB64260 boards
186 - board/fads Files specific to FADS boards
187 - board/flagadm Files specific to FLAGADM boards
188 - board/gen860t Files specific to GEN860T and GEN860T_SC boards
189 - board/genietv Files specific to GENIETV boards
190 - board/gth Files specific to GTH boards
191 - board/hermes Files specific to HERMES boards
192 - board/hymod Files specific to HYMOD boards
193 - board/icu862 Files specific to ICU862 boards
194 - board/ip860 Files specific to IP860 boards
196 Files specific to Interphase4539 boards
197 - board/ivm Files specific to IVMS8/IVML24 boards
198 - board/lantec Files specific to LANTEC boards
199 - board/lwmon Files specific to LWMON boards
200 - board/Marvell Files specific to Marvell development boards
201 - board/Marvell/db64360 Files specific to db64360 board
202 - board/Marvell/db64460 Files specific to db64460 board
203 - board/mbx8xx Files specific to MBX boards
205 Files specific to MPC826xADS and PQ2FADS-ZU/VR boards
207 Files specific to MPC8540ADS boards
209 Files specific to MPC8560ADS boards
210 - board/mpl/ Files specific to boards manufactured by MPL
211 - board/mpl/common Common files for MPL boards
212 - board/mpl/pip405 Files specific to PIP405 boards
213 - board/mpl/mip405 Files specific to MIP405 boards
214 - board/mpl/vcma9 Files specific to VCMA9 boards
215 - board/musenki Files specific to MUSEKNI boards
216 - board/mvs1 Files specific to MVS1 boards
217 - board/nx823 Files specific to NX823 boards
218 - board/oxc Files specific to OXC boards
220 Files specific to OMAP 1510 Innovator boards
222 Files specific to OMAP 1610 Innovator boards
223 - board/pcippc2 Files specific to PCIPPC2/PCIPPC6 boards
224 - board/pm826 Files specific to PM826 boards
226 Files specific to PPMC8260 boards
227 - board/snmc/qs850 Files specific to QS850/823 boards
228 - board/snmc/qs860t Files specific to QS860T boards
230 Files specific to RPXsuper boards
232 Files specific to RSDproto boards
234 Files specific to Sandpoint boards
235 - board/sbc8260 Files specific to SBC8260 boards
236 - board/sacsng Files specific to SACSng boards
237 - board/siemens Files specific to boards manufactured by Siemens AG
238 - board/siemens/CCM Files specific to CCM boards
239 - board/siemens/IAD210 Files specific to IAD210 boards
240 - board/siemens/SCM Files specific to SCM boards
241 - board/siemens/pcu_e Files specific to PCU_E boards
242 - board/sixnet Files specific to SIXNET boards
243 - board/spd8xx Files specific to SPD8xxTS boards
244 - board/tqm8260 Files specific to TQM8260 boards
245 - board/tqm8xx Files specific to TQM8xxL boards
246 - board/w7o Files specific to W7O boards
248 Files specific to Walnut405 boards
249 - board/westel/ Files specific to boards manufactured by Westel Wireless
250 - board/westel/amx860 Files specific to AMX860 boards
251 - board/utx8245 Files specific to UTX8245 boards
252 - board/zpc1900 Files specific to Zephyr Engineering ZPC.1900 board
254 Software Configuration:
255 =======================
257 Configuration is usually done using C preprocessor defines; the
258 rationale behind that is to avoid dead code whenever possible.
260 There are two classes of configuration variables:
262 * Configuration _OPTIONS_:
263 These are selectable by the user and have names beginning with
266 * Configuration _SETTINGS_:
267 These depend on the hardware etc. and should not be meddled with if
268 you don't know what you're doing; they have names beginning with
271 Later we will add a configuration tool - probably similar to or even
272 identical to what's used for the Linux kernel. Right now, we have to
273 do the configuration by hand, which means creating some symbolic
274 links and editing some configuration files. We use the TQM8xxL boards
278 Selection of Processor Architecture and Board Type:
279 ---------------------------------------------------
281 For all supported boards there are ready-to-use default
282 configurations available; just type "make <board_name>_config".
284 Example: For a TQM823L module type:
289 For the Cogent platform, you need to specify the cpu type as well;
290 e.g. "make cogent_mpc8xx_config". And also configure the cogent
291 directory according to the instructions in cogent/README.
294 Configuration Options:
295 ----------------------
297 Configuration depends on the combination of board and CPU type; all
298 such information is kept in a configuration file
299 "include/configs/<board_name>.h".
301 Example: For a TQM823L module, all configuration settings are in
302 "include/configs/TQM823L.h".
305 Many of the options are named exactly as the corresponding Linux
306 kernel configuration options. The intention is to make it easier to
307 build a config tool - later.
310 The following options need to be configured:
312 - CPU Type: Define exactly one of
316 CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860
318 or CONFIG_MPC824X, CONFIG_MPC8260
334 - Board Type: Define exactly one of
336 PowerPC based boards:
337 ---------------------
339 CONFIG_ADCIOP, CONFIG_ICU862 CONFIG_RPXsuper,
340 CONFIG_ADS860, CONFIG_IP860, CONFIG_SM850,
341 CONFIG_AMX860, CONFIG_IPHASE4539, CONFIG_SPD823TS,
342 CONFIG_AR405, CONFIG_IVML24, CONFIG_SXNI855T,
343 CONFIG_BAB7xx, CONFIG_IVML24_128, CONFIG_Sandpoint8240,
344 CONFIG_CANBT, CONFIG_IVML24_256, CONFIG_Sandpoint8245,
345 CONFIG_CCM, CONFIG_IVMS8, CONFIG_TQM823L,
346 CONFIG_CPCI405, CONFIG_IVMS8_128, CONFIG_TQM850L,
347 CONFIG_CPCI4052, CONFIG_IVMS8_256, CONFIG_TQM855L,
348 CONFIG_CPCIISER4, CONFIG_LANTEC, CONFIG_TQM860L,
349 CONFIG_CPU86, CONFIG_MBX, CONFIG_TQM8260,
350 CONFIG_CRAYL1, CONFIG_MBX860T, CONFIG_TTTech,
351 CONFIG_CU824, CONFIG_MHPC, CONFIG_UTX8245,
352 CONFIG_DASA_SIM, CONFIG_MIP405, CONFIG_W7OLMC,
353 CONFIG_DU405, CONFIG_MOUSSE, CONFIG_W7OLMG,
354 CONFIG_ELPPC, CONFIG_MPC8260ADS, CONFIG_WALNUT405,
355 CONFIG_ERIC, CONFIG_MUSENKI, CONFIG_ZUMA,
356 CONFIG_ESTEEM192E, CONFIG_MVS1, CONFIG_c2mon,
357 CONFIG_ETX094, CONFIG_NX823, CONFIG_cogent_mpc8260,
358 CONFIG_EVB64260, CONFIG_OCRTC, CONFIG_cogent_mpc8xx,
359 CONFIG_FADS823, CONFIG_ORSG, CONFIG_ep8260,
360 CONFIG_FADS850SAR, CONFIG_OXC, CONFIG_gw8260,
361 CONFIG_FADS860T, CONFIG_PCI405, CONFIG_hermes,
362 CONFIG_FLAGADM, CONFIG_PCIPPC2, CONFIG_hymod,
363 CONFIG_FPS850L, CONFIG_PCIPPC6, CONFIG_lwmon,
364 CONFIG_GEN860T, CONFIG_PIP405, CONFIG_pcu_e,
365 CONFIG_GENIETV, CONFIG_PM826, CONFIG_ppmc8260,
366 CONFIG_GTH, CONFIG_RPXClassic, CONFIG_rsdproto,
367 CONFIG_IAD210, CONFIG_RPXlite, CONFIG_sbc8260,
368 CONFIG_EBONY, CONFIG_sacsng, CONFIG_FPS860L,
369 CONFIG_V37, CONFIG_ELPT860, CONFIG_CMI,
370 CONFIG_NETVIA, CONFIG_RBC823, CONFIG_ZPC1900,
371 CONFIG_MPC8540ADS, CONFIG_MPC8560ADS, CONFIG_QS850,
372 CONFIG_QS823, CONFIG_QS860T, CONFIG_DB64360,
373 CONFIG_DB64460, CONFIG_DUET_ADS
378 CONFIG_HHP_CRADLE, CONFIG_DNP1110, CONFIG_EP7312,
379 CONFIG_IMPA7, CONFIG_LART, CONFIG_LUBBOCK,
380 CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610
381 CONFIG_SHANNON, CONFIG_SMDK2400, CONFIG_SMDK2410,
382 CONFIG_TRAB, CONFIG_VCMA9, CONFIG_AT91RM9200DK
385 - CPU Module Type: (if CONFIG_COGENT is defined)
386 Define exactly one of
388 --- FIXME --- not tested yet:
389 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
390 CONFIG_CMA287_23, CONFIG_CMA287_50
392 - Motherboard Type: (if CONFIG_COGENT is defined)
393 Define exactly one of
394 CONFIG_CMA101, CONFIG_CMA102
396 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
397 Define one or more of
400 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
401 Define one or more of
402 CONFIG_LCD_HEARTBEAT - update a character position on
403 the lcd display every second with
406 - Board flavour: (if CONFIG_MPC8260ADS is defined)
409 CFG_8260ADS - original MPC8260ADS
410 CFG_8266ADS - MPC8266ADS
411 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
414 - MPC824X Family Member (if CONFIG_MPC824X is defined)
415 Define exactly one of
416 CONFIG_MPC8240, CONFIG_MPC8245
418 - 8xx CPU Options: (if using an MPC8xx cpu)
419 Define one or more of
420 CONFIG_8xx_GCLK_FREQ - if get_gclk_freq() cannot work
421 e.g. if there is no 32KHz
422 reference PIT/RTC clock
424 - 859/866 CPU options: (if using a MPC859 or MPC866 CPU):
428 CFG_866_CPUCLK_DEFAULT
429 See doc/README.MPC866
433 Define this to measure the actual CPU clock instead
434 of relying on the correctness of the configured
435 values. Mostly useful for board bringup to make sure
436 the PLL is locked at the intended frequency. Note
437 that this requires a (stable) reference clock (32 kHz
440 - Linux Kernel Interface:
443 U-Boot stores all clock information in Hz
444 internally. For binary compatibility with older Linux
445 kernels (which expect the clocks passed in the
446 bd_info data to be in MHz) the environment variable
447 "clocks_in_mhz" can be defined so that U-Boot
448 converts clock data to MHZ before passing it to the
450 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
451 "clocks_in_mhz=1" is automatically included in the
454 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
456 When transfering memsize parameter to linux, some versions
457 expect it to be in bytes, others in MB.
458 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
461 Depending on board, define exactly one serial port
462 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
463 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
464 console by defining CONFIG_8xx_CONS_NONE
466 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
467 port routines must be defined elsewhere
468 (i.e. serial_init(), serial_getc(), ...)
471 Enables console device for a color framebuffer. Needs following
472 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
473 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
475 VIDEO_HW_RECTFILL graphic chip supports
478 VIDEO_HW_BITBLT graphic chip supports
479 bit-blit (cf. smiLynxEM)
480 VIDEO_VISIBLE_COLS visible pixel columns
482 VIDEO_VISIBLE_ROWS visible pixel rows
483 VIDEO_PIXEL_SIZE bytes per pixel
484 VIDEO_DATA_FORMAT graphic data format
485 (0-5, cf. cfb_console.c)
486 VIDEO_FB_ADRS framebuffer address
487 VIDEO_KBD_INIT_FCT keyboard int fct
488 (i.e. i8042_kbd_init())
489 VIDEO_TSTC_FCT test char fct
491 VIDEO_GETC_FCT get char fct
493 CONFIG_CONSOLE_CURSOR cursor drawing on/off
494 (requires blink timer
496 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
497 CONFIG_CONSOLE_TIME display time/date info in
499 (requires CFG_CMD_DATE)
500 CONFIG_VIDEO_LOGO display Linux logo in
502 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
503 linux_logo.h for logo.
504 Requires CONFIG_VIDEO_LOGO
505 CONFIG_CONSOLE_EXTRA_INFO
506 addional board info beside
509 When CONFIG_CFB_CONSOLE is defined, video console is
510 default i/o. Serial console can be forced with
511 environment 'console=serial'.
513 When CONFIG_SILENT_CONSOLE is defined, all console
514 messages (by U-Boot and Linux!) can be silenced with
515 the "silent" environment variable. See
516 doc/README.silent for more information.
519 CONFIG_BAUDRATE - in bps
520 Select one of the baudrates listed in
521 CFG_BAUDRATE_TABLE, see below.
522 CFG_BRGCLK_PRESCALE, baudrate prescale
524 - Interrupt driven serial port input:
525 CONFIG_SERIAL_SOFTWARE_FIFO
528 Use an interrupt handler for receiving data on the
529 serial port. It also enables using hardware handshake
530 (RTS/CTS) and UART's built-in FIFO. Set the number of
531 bytes the interrupt driven input buffer should have.
533 Set to 0 to disable this feature (this is the default).
534 This will also disable hardware handshake.
536 - Console UART Number:
540 If defined internal UART1 (and not UART0) is used
541 as default U-Boot console.
543 - Boot Delay: CONFIG_BOOTDELAY - in seconds
544 Delay before automatically booting the default image;
545 set to -1 to disable autoboot.
547 See doc/README.autoboot for these options that
548 work with CONFIG_BOOTDELAY. None are required.
549 CONFIG_BOOT_RETRY_TIME
550 CONFIG_BOOT_RETRY_MIN
551 CONFIG_AUTOBOOT_KEYED
552 CONFIG_AUTOBOOT_PROMPT
553 CONFIG_AUTOBOOT_DELAY_STR
554 CONFIG_AUTOBOOT_STOP_STR
555 CONFIG_AUTOBOOT_DELAY_STR2
556 CONFIG_AUTOBOOT_STOP_STR2
557 CONFIG_ZERO_BOOTDELAY_CHECK
558 CONFIG_RESET_TO_RETRY
562 Only needed when CONFIG_BOOTDELAY is enabled;
563 define a command string that is automatically executed
564 when no character is read on the console interface
565 within "Boot Delay" after reset.
568 This can be used to pass arguments to the bootm
569 command. The value of CONFIG_BOOTARGS goes into the
570 environment value "bootargs".
572 CONFIG_RAMBOOT and CONFIG_NFSBOOT
573 The value of these goes into the environment as
574 "ramboot" and "nfsboot" respectively, and can be used
575 as a convenience, when switching between booting from
581 When this option is #defined, the existence of the
582 environment variable "preboot" will be checked
583 immediately before starting the CONFIG_BOOTDELAY
584 countdown and/or running the auto-boot command resp.
585 entering interactive mode.
587 This feature is especially useful when "preboot" is
588 automatically generated or modified. For an example
589 see the LWMON board specific code: here "preboot" is
590 modified when the user holds down a certain
591 combination of keys on the (special) keyboard when
594 - Serial Download Echo Mode:
596 If defined to 1, all characters received during a
597 serial download (using the "loads" command) are
598 echoed back. This might be needed by some terminal
599 emulations (like "cu"), but may as well just take
600 time on others. This setting #define's the initial
601 value of the "loads_echo" environment variable.
603 - Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
605 Select one of the baudrates listed in
606 CFG_BAUDRATE_TABLE, see below.
610 Most monitor functions can be selected (or
611 de-selected) by adjusting the definition of
612 CONFIG_COMMANDS; to select individual functions,
613 #define CONFIG_COMMANDS by "OR"ing any of the
616 #define enables commands:
617 -------------------------
618 CFG_CMD_ASKENV * ask for env variable
619 CFG_CMD_AUTOSCRIPT Autoscript Support
621 CFG_CMD_BEDBUG Include BedBug Debugger
622 CFG_CMD_BMP * BMP support
624 CFG_CMD_CACHE icache, dcache
625 CFG_CMD_CONSOLE coninfo
626 CFG_CMD_DATE * support for RTC, date/time...
627 CFG_CMD_DHCP DHCP support
628 CFG_CMD_DIAG * Diagnostics
629 CFG_CMD_DOC * Disk-On-Chip Support
630 CFG_CMD_DTT Digital Therm and Thermostat
631 CFG_CMD_ECHO * echo arguments
632 CFG_CMD_EEPROM * EEPROM read/write support
633 CFG_CMD_ELF bootelf, bootvx
635 CFG_CMD_FDC * Floppy Disk Support
636 CFG_CMD_FAT FAT partition support
637 CFG_CMD_FDOS * Dos diskette Support
638 CFG_CMD_FLASH flinfo, erase, protect
639 CFG_CMD_FPGA FPGA device initialization support
640 CFG_CMD_HWFLOW * RTS/CTS hw flow control
641 CFG_CMD_I2C * I2C serial bus support
642 CFG_CMD_IDE * IDE harddisk support
644 CFG_CMD_IMLS List all found images
645 CFG_CMD_IMMAP * IMMR dump support
646 CFG_CMD_IRQ * irqinfo
647 CFG_CMD_JFFS2 * JFFS2 Support
651 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
653 CFG_CMD_MISC Misc functions like sleep etc
654 CFG_CMD_MMC MMC memory mapped support
655 CFG_CMD_MII MII utility commands
656 CFG_CMD_NAND * NAND support
657 CFG_CMD_NET bootp, tftpboot, rarpboot
658 CFG_CMD_PCI * pciinfo
659 CFG_CMD_PCMCIA * PCMCIA support
660 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
661 CFG_CMD_PORTIO * Port I/O
662 CFG_CMD_REGINFO * Register dump
663 CFG_CMD_RUN run command in env variable
664 CFG_CMD_SAVES save S record dump
665 CFG_CMD_SCSI * SCSI Support
666 CFG_CMD_SDRAM * print SDRAM configuration information
667 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
668 CFG_CMD_SPI * SPI serial bus support
669 CFG_CMD_USB * USB support
670 CFG_CMD_VFD * VFD support (TRAB)
671 CFG_CMD_BSP * Board SPecific functions
672 -----------------------------------------------
675 CFG_CMD_DFL Default configuration; at the moment
676 this is includes all commands, except
677 the ones marked with "*" in the list
680 If you don't define CONFIG_COMMANDS it defaults to
681 CFG_CMD_DFL in include/cmd_confdefs.h. A board can
682 override the default settings in the respective
685 EXAMPLE: If you want all functions except of network
686 support you can write:
688 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
691 Note: Don't enable the "icache" and "dcache" commands
692 (configuration option CFG_CMD_CACHE) unless you know
693 what you (and your U-Boot users) are doing. Data
694 cache cannot be enabled on systems like the 8xx or
695 8260 (where accesses to the IMMR region must be
696 uncached), and it cannot be disabled on all other
697 systems where we (mis-) use the data cache to hold an
698 initial stack and some data.
701 XXX - this list needs to get updated!
705 If this variable is defined, it enables watchdog
706 support. There must be support in the platform specific
707 code for a watchdog. For the 8xx and 8260 CPUs, the
708 SIU Watchdog feature is enabled in the SYPCR
712 CONFIG_VERSION_VARIABLE
713 If this variable is defined, an environment variable
714 named "ver" is created by U-Boot showing the U-Boot
715 version as printed by the "version" command.
716 This variable is readonly.
720 When CFG_CMD_DATE is selected, the type of the RTC
721 has to be selected, too. Define exactly one of the
724 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
725 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
726 CONFIG_RTC_MC146818 - use MC146818 RTC
727 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
728 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
729 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
730 CONFIG_RTC_DS164x - use Dallas DS164x RTC
732 Note that if the RTC uses I2C, then the I2C interface
733 must also be configured. See I2C Support, below.
737 When CONFIG_TIMESTAMP is selected, the timestamp
738 (date and time) of an image is printed by image
739 commands like bootm or iminfo. This option is
740 automatically enabled when you select CFG_CMD_DATE .
743 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
744 and/or CONFIG_ISO_PARTITION
746 If IDE or SCSI support is enabled (CFG_CMD_IDE or
747 CFG_CMD_SCSI) you must configure support for at least
748 one partition type as well.
751 CONFIG_IDE_RESET_ROUTINE
753 Set this to define that instead of a reset Pin, the
754 routine ide_set_reset(int idereset) will be used.
759 Set this to enable ATAPI support.
762 At the moment only there is only support for the
763 SYM53C8XX SCSI controller; define
764 CONFIG_SCSI_SYM53C8XX to enable it.
766 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
767 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
768 CFG_SCSI_MAX_LUN] can be adjusted to define the
769 maximum numbers of LUNs, SCSI ID's and target
771 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
773 - NETWORK Support (PCI):
775 Support for Intel 8254x gigabit chips.
778 Support for Intel 82557/82559/82559ER chips.
779 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
780 write routine for first time initialisation.
783 Support for Digital 2114x chips.
784 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
785 modem chip initialisation (KS8761/QS6611).
788 Support for National dp83815 chips.
791 Support for National dp8382[01] gigabit chips.
793 - NETWORK Support (other):
795 CONFIG_DRIVER_LAN91C96
796 Support for SMSC's LAN91C96 chips.
799 Define this to hold the physical address
800 of the LAN91C96's I/O space
802 CONFIG_LAN91C96_USE_32_BIT
803 Define this to enable 32 bit addressing
806 At the moment only the UHCI host controller is
807 supported (PIP405, MIP405); define
808 CONFIG_USB_UHCI to enable it.
809 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
810 end define CONFIG_USB_STORAGE to enable the USB
813 Supported are USB Keyboards and USB Floppy drives
817 The MMC controller on the Intel PXA is supported. To
818 enable this define CONFIG_MMC. The MMC can be
819 accessed from the boot prompt by mapping the device
820 to physical memory similar to flash. Command line is
821 enabled with CFG_CMD_MMC. The MMC driver also works with
822 the FAT fs. This is enabled with CFG_CMD_FAT.
827 Define this to enable standard (PC-Style) keyboard
831 Standard PC keyboard driver with US (is default) and
832 GERMAN key layout (switch via environment 'keymap=de') support.
833 Export function i8042_kbd_init, i8042_tstc and i8042_getc
834 for cfb_console. Supports cursor blinking.
839 Define this to enable video support (for output to
844 Enable Chips & Technologies 69000 Video chip
846 CONFIG_VIDEO_SMI_LYNXEM
847 Enable Silicon Motion SMI 712/710/810 Video chip
848 Videomode are selected via environment 'videomode' with
849 standard LiLo mode numbers.
850 Following modes are supported (* is default):
852 800x600 1024x768 1280x1024
853 256 (8bit) 303* 305 307
854 65536 (16bit) 314 317 31a
855 16,7 Mill (24bit) 315 318 31b
856 (i.e. setenv videomode 317; saveenv; reset;)
858 CONFIG_VIDEO_SED13806
859 Enable Epson SED13806 driver. This driver supports 8bpp
860 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
861 or CONFIG_VIDEO_SED13806_16BPP
866 Define this to enable a custom keyboard support.
867 This simply calls drv_keyboard_init() which must be
868 defined in your board-specific files.
869 The only board using this so far is RBC823.
871 - LCD Support: CONFIG_LCD
873 Define this to enable LCD support (for output to LCD
874 display); also select one of the supported displays
875 by defining one of these:
877 CONFIG_NEC_NL6448AC33:
879 NEC NL6448AC33-18. Active, color, single scan.
881 CONFIG_NEC_NL6448BC20
883 NEC NL6448BC20-08. 6.5", 640x480.
884 Active, color, single scan.
886 CONFIG_NEC_NL6448BC33_54
888 NEC NL6448BC33-54. 10.4", 640x480.
889 Active, color, single scan.
893 Sharp 320x240. Active, color, single scan.
894 It isn't 16x9, and I am not sure what it is.
896 CONFIG_SHARP_LQ64D341
898 Sharp LQ64D341 display, 640x480.
899 Active, color, single scan.
903 HLD1045 display, 640x480.
904 Active, color, single scan.
908 Optrex CBL50840-2 NF-FW 99 22 M5
910 Hitachi LMG6912RPFC-00T
914 320x240. Black & white.
916 Normally display is black on white background; define
917 CFG_WHITE_ON_BLACK to get it inverted.
919 - Splash Screen Support: CONFIG_SPLASH_SCREEN
921 If this option is set, the environment is checked for
922 a variable "splashimage". If found, the usual display
923 of logo, copyright and system information on the LCD
924 is supressed and the BMP image at the address
925 specified in "splashimage" is loaded instead. The
926 console is redirected to the "nulldev", too. This
927 allows for a "silent" boot where a splash screen is
928 loaded very quickly after power-on.
930 - Compression support:
933 If this option is set, support for bzip2 compressed
934 images is included. If not, only uncompressed and gzip
935 compressed images are supported.
937 NOTE: the bzip2 algorithm requires a lot of RAM, so
938 the malloc area (as defined by CFG_MALLOC_LEN) should
946 Define a default value for ethernet address to use
947 for the respective ethernet interface, in case this
948 is not determined automatically.
953 Define a default value for the IP address to use for
954 the default ethernet interface, in case this is not
955 determined through e.g. bootp.
960 Defines a default value for theIP address of a TFTP
961 server to contact when using the "tftboot" command.
963 - BOOTP Recovery Mode:
964 CONFIG_BOOTP_RANDOM_DELAY
966 If you have many targets in a network that try to
967 boot using BOOTP, you may want to avoid that all
968 systems send out BOOTP requests at precisely the same
969 moment (which would happen for instance at recovery
970 from a power failure, when all systems will try to
971 boot, thus flooding the BOOTP server. Defining
972 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
973 inserted before sending out BOOTP requests. The
974 following delays are insterted then:
976 1st BOOTP request: delay 0 ... 1 sec
977 2nd BOOTP request: delay 0 ... 2 sec
978 3rd BOOTP request: delay 0 ... 4 sec
980 BOOTP requests: delay 0 ... 8 sec
982 - DHCP Advanced Options:
985 You can fine tune the DHCP functionality by adding
986 these flags to the CONFIG_BOOTP_MASK define:
988 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
989 serverip from a DHCP server, it is possible that more
990 than one DNS serverip is offered to the client.
991 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
992 serverip will be stored in the additional environment
993 variable "dnsip2". The first DNS serverip is always
994 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
995 is added to the CONFIG_BOOTP_MASK.
997 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
998 to do a dynamic update of a DNS server. To do this, they
999 need the hostname of the DHCP requester.
1000 If CONFIG_BOOP_SEND_HOSTNAME is added to the
1001 CONFIG_BOOTP_MASK, the content of the "hostname"
1002 environment variable is passed as option 12 to
1005 - Status LED: CONFIG_STATUS_LED
1007 Several configurations allow to display the current
1008 status using a LED. For instance, the LED will blink
1009 fast while running U-Boot code, stop blinking as
1010 soon as a reply to a BOOTP request was received, and
1011 start blinking slow once the Linux kernel is running
1012 (supported by a status LED driver in the Linux
1013 kernel). Defining CONFIG_STATUS_LED enables this
1016 - CAN Support: CONFIG_CAN_DRIVER
1018 Defining CONFIG_CAN_DRIVER enables CAN driver support
1019 on those systems that support this (optional)
1020 feature, like the TQM8xxL modules.
1022 - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1024 These enable I2C serial bus commands. Defining either of
1025 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1026 include the appropriate I2C driver for the selected cpu.
1028 This will allow you to use i2c commands at the u-boot
1029 command line (as long as you set CFG_CMD_I2C in
1030 CONFIG_COMMANDS) and communicate with i2c based realtime
1031 clock chips. See common/cmd_i2c.c for a description of the
1032 command line interface.
1034 CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1036 CONFIG_SOFT_I2C configures u-boot to use a software (aka
1037 bit-banging) driver instead of CPM or similar hardware
1040 There are several other quantities that must also be
1041 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1043 In both cases you will need to define CFG_I2C_SPEED
1044 to be the frequency (in Hz) at which you wish your i2c bus
1045 to run and CFG_I2C_SLAVE to be the address of this node (ie
1046 the cpu's i2c node address).
1048 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1049 sets the cpu up as a master node and so its address should
1050 therefore be cleared to 0 (See, eg, MPC823e User's Manual
1051 p.16-473). So, set CFG_I2C_SLAVE to 0.
1053 That's all that's required for CONFIG_HARD_I2C.
1055 If you use the software i2c interface (CONFIG_SOFT_I2C)
1056 then the following macros need to be defined (examples are
1057 from include/configs/lwmon.h):
1061 (Optional). Any commands necessary to enable the I2C
1062 controller or configure ports.
1064 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
1068 (Only for MPC8260 CPU). The I/O port to use (the code
1069 assumes both bits are on the same port). Valid values
1070 are 0..3 for ports A..D.
1074 The code necessary to make the I2C data line active
1075 (driven). If the data line is open collector, this
1078 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1082 The code necessary to make the I2C data line tri-stated
1083 (inactive). If the data line is open collector, this
1086 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1090 Code that returns TRUE if the I2C data line is high,
1093 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1097 If <bit> is TRUE, sets the I2C data line high. If it
1098 is FALSE, it clears it (low).
1100 eg: #define I2C_SDA(bit) \
1101 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
1102 else immr->im_cpm.cp_pbdat &= ~PB_SDA
1106 If <bit> is TRUE, sets the I2C clock line high. If it
1107 is FALSE, it clears it (low).
1109 eg: #define I2C_SCL(bit) \
1110 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
1111 else immr->im_cpm.cp_pbdat &= ~PB_SCL
1115 This delay is invoked four times per clock cycle so this
1116 controls the rate of data transfer. The data rate thus
1117 is 1 / (I2C_DELAY * 4). Often defined to be something
1120 #define I2C_DELAY udelay(2)
1124 When a board is reset during an i2c bus transfer
1125 chips might think that the current transfer is still
1126 in progress. On some boards it is possible to access
1127 the i2c SCLK line directly, either by using the
1128 processor pin as a GPIO or by having a second pin
1129 connected to the bus. If this option is defined a
1130 custom i2c_init_board() routine in boards/xxx/board.c
1131 is run early in the boot sequence.
1133 - SPI Support: CONFIG_SPI
1135 Enables SPI driver (so far only tested with
1136 SPI EEPROM, also an instance works with Crystal A/D and
1137 D/As on the SACSng board)
1141 Enables extended (16-bit) SPI EEPROM addressing.
1142 (symmetrical to CONFIG_I2C_X)
1146 Enables a software (bit-bang) SPI driver rather than
1147 using hardware support. This is a general purpose
1148 driver that only requires three general I/O port pins
1149 (two outputs, one input) to function. If this is
1150 defined, the board configuration must define several
1151 SPI configuration items (port pins to use, etc). For
1152 an example, see include/configs/sacsng.h.
1154 - FPGA Support: CONFIG_FPGA_COUNT
1156 Specify the number of FPGA devices to support.
1160 Used to specify the types of FPGA devices. For
1162 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
1164 CFG_FPGA_PROG_FEEDBACK
1166 Enable printing of hash marks during FPGA
1171 Enable checks on FPGA configuration interface busy
1172 status by the configuration function. This option
1173 will require a board or device specific function to
1178 If defined, a function that provides delays in the
1179 FPGA configuration driver.
1181 CFG_FPGA_CHECK_CTRLC
1183 Allow Control-C to interrupt FPGA configuration
1185 CFG_FPGA_CHECK_ERROR
1187 Check for configuration errors during FPGA bitfile
1188 loading. For example, abort during Virtex II
1189 configuration if the INIT_B line goes low (which
1190 indicated a CRC error).
1194 Maximum time to wait for the INIT_B line to deassert
1195 after PROB_B has been deasserted during a Virtex II
1196 FPGA configuration sequence. The default time is 500 mS.
1200 Maximum time to wait for BUSY to deassert during
1201 Virtex II FPGA configuration. The default is 5 mS.
1203 CFG_FPGA_WAIT_CONFIG
1205 Time to wait after FPGA configuration. The default is
1208 - FPGA Support: CONFIG_FPGA_COUNT
1210 Specify the number of FPGA devices to support.
1214 Used to specify the types of FPGA devices. For example,
1215 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
1217 CFG_FPGA_PROG_FEEDBACK
1219 Enable printing of hash marks during FPGA configuration.
1223 Enable checks on FPGA configuration interface busy
1224 status by the configuration function. This option
1225 will require a board or device specific function to
1230 If defined, a function that provides delays in the FPGA
1231 configuration driver.
1233 CFG_FPGA_CHECK_CTRLC
1234 Allow Control-C to interrupt FPGA configuration
1236 CFG_FPGA_CHECK_ERROR
1238 Check for configuration errors during FPGA bitfile
1239 loading. For example, abort during Virtex II
1240 configuration if the INIT_B line goes low (which
1241 indicated a CRC error).
1245 Maximum time to wait for the INIT_B line to deassert
1246 after PROB_B has been deasserted during a Virtex II
1247 FPGA configuration sequence. The default time is 500
1252 Maximum time to wait for BUSY to deassert during
1253 Virtex II FPGA configuration. The default is 5 mS.
1255 CFG_FPGA_WAIT_CONFIG
1257 Time to wait after FPGA configuration. The default is
1260 - Configuration Management:
1263 If defined, this string will be added to the U-Boot
1264 version information (U_BOOT_VERSION)
1266 - Vendor Parameter Protection:
1268 U-Boot considers the values of the environment
1269 variables "serial#" (Board Serial Number) and
1270 "ethaddr" (Ethernet Address) to be parameters that
1271 are set once by the board vendor / manufacturer, and
1272 protects these variables from casual modification by
1273 the user. Once set, these variables are read-only,
1274 and write or delete attempts are rejected. You can
1275 change this behviour:
1277 If CONFIG_ENV_OVERWRITE is #defined in your config
1278 file, the write protection for vendor parameters is
1279 completely disabled. Anybody can change or delete
1282 Alternatively, if you #define _both_ CONFIG_ETHADDR
1283 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1284 ethernet address is installed in the environment,
1285 which can be changed exactly ONCE by the user. [The
1286 serial# is unaffected by this, i. e. it remains
1292 Define this variable to enable the reservation of
1293 "protected RAM", i. e. RAM which is not overwritten
1294 by U-Boot. Define CONFIG_PRAM to hold the number of
1295 kB you want to reserve for pRAM. You can overwrite
1296 this default value by defining an environment
1297 variable "pram" to the number of kB you want to
1298 reserve. Note that the board info structure will
1299 still show the full amount of RAM. If pRAM is
1300 reserved, a new environment variable "mem" will
1301 automatically be defined to hold the amount of
1302 remaining RAM in a form that can be passed as boot
1303 argument to Linux, for instance like that:
1305 setenv bootargs ... mem=\$(mem)
1308 This way you can tell Linux not to use this memory,
1309 either, which results in a memory region that will
1310 not be affected by reboots.
1312 *WARNING* If your board configuration uses automatic
1313 detection of the RAM size, you must make sure that
1314 this memory test is non-destructive. So far, the
1315 following board configurations are known to be
1318 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1319 HERMES, IP860, RPXlite, LWMON, LANTEC,
1320 PCU_E, FLAGADM, TQM8260
1325 Define this variable to stop the system in case of a
1326 fatal error, so that you have to reset it manually.
1327 This is probably NOT a good idea for an embedded
1328 system where you want to system to reboot
1329 automatically as fast as possible, but it may be
1330 useful during development since you can try to debug
1331 the conditions that lead to the situation.
1333 CONFIG_NET_RETRY_COUNT
1335 This variable defines the number of retries for
1336 network operations like ARP, RARP, TFTP, or BOOTP
1337 before giving up the operation. If not defined, a
1338 default value of 5 is used.
1340 - Command Interpreter:
1343 Define this variable to enable the "hush" shell (from
1344 Busybox) as command line interpreter, thus enabling
1345 powerful command line syntax like
1346 if...then...else...fi conditionals or `&&' and '||'
1347 constructs ("shell scripts").
1349 If undefined, you get the old, much simpler behaviour
1350 with a somewhat smaller memory footprint.
1355 This defines the secondary prompt string, which is
1356 printed when the command interpreter needs more input
1357 to complete a command. Usually "> ".
1361 In the current implementation, the local variables
1362 space and global environment variables space are
1363 separated. Local variables are those you define by
1364 simply typing `name=value'. To access a local
1365 variable later on, you have write `$name' or
1366 `${name}'; to execute the contents of a variable
1367 directly type `$name' at the command prompt.
1369 Global environment variables are those you use
1370 setenv/printenv to work with. To run a command stored
1371 in such a variable, you need to use the run command,
1372 and you must not use the '$' sign to access them.
1374 To store commands and special characters in a
1375 variable, please use double quotation marks
1376 surrounding the whole text of the variable, instead
1377 of the backslashes before semicolons and special
1380 - Default Environment:
1381 CONFIG_EXTRA_ENV_SETTINGS
1383 Define this to contain any number of null terminated
1384 strings (variable = value pairs) that will be part of
1385 the default environment compiled into the boot image.
1387 For example, place something like this in your
1388 board's config file:
1390 #define CONFIG_EXTRA_ENV_SETTINGS \
1394 Warning: This method is based on knowledge about the
1395 internal format how the environment is stored by the
1396 U-Boot code. This is NOT an official, exported
1397 interface! Although it is unlikely that this format
1398 will change soon, there is no guarantee either.
1399 You better know what you are doing here.
1401 Note: overly (ab)use of the default environment is
1402 discouraged. Make sure to check other ways to preset
1403 the environment like the autoscript function or the
1406 - DataFlash Support:
1407 CONFIG_HAS_DATAFLASH
1409 Defining this option enables DataFlash features and
1410 allows to read/write in Dataflash via the standard
1413 - SystemACE Support:
1416 Adding this option adds support for Xilinx SystemACE
1417 chips attached via some sort of local bus. The address
1418 of the chip must alsh be defined in the
1419 CFG_SYSTEMACE_BASE macro. For example:
1421 #define CONFIG_SYSTEMACE
1422 #define CFG_SYSTEMACE_BASE 0xf0000000
1424 When SystemACE support is added, the "ace" device type
1425 becomes available to the fat commands, i.e. fatls.
1427 - Show boot progress:
1428 CONFIG_SHOW_BOOT_PROGRESS
1430 Defining this option allows to add some board-
1431 specific code (calling a user-provided function
1432 "show_boot_progress(int)") that enables you to show
1433 the system's boot progress on some display (for
1434 example, some LED's) on your board. At the moment,
1435 the following checkpoints are implemented:
1438 1 common/cmd_bootm.c before attempting to boot an image
1439 -1 common/cmd_bootm.c Image header has bad magic number
1440 2 common/cmd_bootm.c Image header has correct magic number
1441 -2 common/cmd_bootm.c Image header has bad checksum
1442 3 common/cmd_bootm.c Image header has correct checksum
1443 -3 common/cmd_bootm.c Image data has bad checksum
1444 4 common/cmd_bootm.c Image data has correct checksum
1445 -4 common/cmd_bootm.c Image is for unsupported architecture
1446 5 common/cmd_bootm.c Architecture check OK
1447 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1448 6 common/cmd_bootm.c Image Type check OK
1449 -6 common/cmd_bootm.c gunzip uncompression error
1450 -7 common/cmd_bootm.c Unimplemented compression type
1451 7 common/cmd_bootm.c Uncompression OK
1452 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1453 8 common/cmd_bootm.c Image Type check OK
1454 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1455 9 common/cmd_bootm.c Start initial ramdisk verification
1456 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1457 -11 common/cmd_bootm.c Ramdisk header has bad checksum
1458 10 common/cmd_bootm.c Ramdisk header is OK
1459 -12 common/cmd_bootm.c Ramdisk data has bad checksum
1460 11 common/cmd_bootm.c Ramdisk data has correct checksum
1461 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1462 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1463 13 common/cmd_bootm.c Start multifile image verification
1464 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1465 15 common/cmd_bootm.c All preparation done, transferring control to OS
1467 -1 common/cmd_doc.c Bad usage of "doc" command
1468 -1 common/cmd_doc.c No boot device
1469 -1 common/cmd_doc.c Unknown Chip ID on boot device
1470 -1 common/cmd_doc.c Read Error on boot device
1471 -1 common/cmd_doc.c Image header has bad magic number
1473 -1 common/cmd_ide.c Bad usage of "ide" command
1474 -1 common/cmd_ide.c No boot device
1475 -1 common/cmd_ide.c Unknown boot device
1476 -1 common/cmd_ide.c Unknown partition table
1477 -1 common/cmd_ide.c Invalid partition type
1478 -1 common/cmd_ide.c Read Error on boot device
1479 -1 common/cmd_ide.c Image header has bad magic number
1481 -1 common/cmd_nand.c Bad usage of "nand" command
1482 -1 common/cmd_nand.c No boot device
1483 -1 common/cmd_nand.c Unknown Chip ID on boot device
1484 -1 common/cmd_nand.c Read Error on boot device
1485 -1 common/cmd_nand.c Image header has bad magic number
1487 -1 common/env_common.c Environment has a bad CRC, using default
1493 [so far only for SMDK2400 and TRAB boards]
1495 - Modem support endable:
1496 CONFIG_MODEM_SUPPORT
1498 - RTS/CTS Flow control enable:
1501 - Modem debug support:
1502 CONFIG_MODEM_SUPPORT_DEBUG
1504 Enables debugging stuff (char screen[1024], dbg())
1505 for modem support. Useful only with BDI2000.
1507 - Interrupt support (PPC):
1509 There are common interrupt_init() and timer_interrupt()
1510 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1511 for cpu specific initialization. interrupt_init_cpu()
1512 should set decrementer_count to appropriate value. If
1513 cpu resets decrementer automatically after interrupt
1514 (ppc4xx) it should set decrementer_count to zero.
1515 timer_interrupt() calls timer_interrupt_cpu() for cpu
1516 specific handling. If board has watchdog / status_led
1517 / other_activity_monitor it works automatically from
1518 general timer_interrupt().
1522 In the target system modem support is enabled when a
1523 specific key (key combination) is pressed during
1524 power-on. Otherwise U-Boot will boot normally
1525 (autoboot). The key_pressed() fuction is called from
1526 board_init(). Currently key_pressed() is a dummy
1527 function, returning 1 and thus enabling modem
1530 If there are no modem init strings in the
1531 environment, U-Boot proceed to autoboot; the
1532 previous output (banner, info printfs) will be
1535 See also: doc/README.Modem
1538 Configuration Settings:
1539 -----------------------
1541 - CFG_LONGHELP: Defined when you want long help messages included;
1542 undefine this when you're short of memory.
1544 - CFG_PROMPT: This is what U-Boot prints on the console to
1545 prompt for user input.
1547 - CFG_CBSIZE: Buffer size for input from the Console
1549 - CFG_PBSIZE: Buffer size for Console output
1551 - CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1553 - CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1554 the application (usually a Linux kernel) when it is
1557 - CFG_BAUDRATE_TABLE:
1558 List of legal baudrate settings for this board.
1560 - CFG_CONSOLE_INFO_QUIET
1561 Suppress display of console information at boot.
1563 - CFG_CONSOLE_IS_IN_ENV
1564 If the board specific function
1565 extern int overwrite_console (void);
1566 returns 1, the stdin, stderr and stdout are switched to the
1567 serial port, else the settings in the environment are used.
1569 - CFG_CONSOLE_OVERWRITE_ROUTINE
1570 Enable the call to overwrite_console().
1572 - CFG_CONSOLE_ENV_OVERWRITE
1573 Enable overwrite of previous console environment settings.
1575 - CFG_MEMTEST_START, CFG_MEMTEST_END:
1576 Begin and End addresses of the area used by the
1580 Enable an alternate, more extensive memory test.
1582 - CFG_MEMTEST_SCRATCH:
1583 Scratch address used by the alternate memory test
1584 You only need to set this if address zero isn't writeable
1586 - CFG_TFTP_LOADADDR:
1587 Default load address for network file downloads
1589 - CFG_LOADS_BAUD_CHANGE:
1590 Enable temporary baudrate change while serial download
1593 Physical start address of SDRAM. _Must_ be 0 here.
1596 Physical start address of Motherboard I/O (if using a
1600 Physical start address of Flash memory.
1603 Physical start address of boot monitor code (set by
1604 make config files to be same as the text base address
1605 (TEXT_BASE) used when linking) - same as
1606 CFG_FLASH_BASE when booting from flash.
1609 Size of memory reserved for monitor code, used to
1610 determine _at_compile_time_ (!) if the environment is
1611 embedded within the U-Boot image, or in a separate
1615 Size of DRAM reserved for malloc() use.
1618 Maximum size of memory mapped by the startup code of
1619 the Linux kernel; all data that must be processed by
1620 the Linux kernel (bd_info, boot arguments, eventually
1621 initrd image) must be put below this limit.
1623 - CFG_MAX_FLASH_BANKS:
1624 Max number of Flash memory banks
1626 - CFG_MAX_FLASH_SECT:
1627 Max number of sectors on a Flash chip
1629 - CFG_FLASH_ERASE_TOUT:
1630 Timeout for Flash erase operations (in ms)
1632 - CFG_FLASH_WRITE_TOUT:
1633 Timeout for Flash write operations (in ms)
1635 - CFG_FLASH_LOCK_TOUT
1636 Timeout for Flash set sector lock bit operation (in ms)
1638 - CFG_FLASH_UNLOCK_TOUT
1639 Timeout for Flash clear lock bits operation (in ms)
1641 - CFG_FLASH_PROTECTION
1642 If defined, hardware flash sectors protection is used
1643 instead of U-Boot software protection.
1645 - CFG_DIRECT_FLASH_TFTP:
1647 Enable TFTP transfers directly to flash memory;
1648 without this option such a download has to be
1649 performed in two steps: (1) download to RAM, and (2)
1650 copy from RAM to flash.
1652 The two-step approach is usually more reliable, since
1653 you can check if the download worked before you erase
1654 the flash, but in some situations (when sytem RAM is
1655 too limited to allow for a tempory copy of the
1656 downloaded image) this option may be very useful.
1659 Define if the flash driver uses extra elements in the
1660 common flash structure for storing flash geometry.
1662 - CFG_FLASH_CFI_DRIVER
1663 This option also enables the building of the cfi_flash driver
1664 in the drivers directory
1666 - CFG_RX_ETH_BUFFER:
1667 Defines the number of ethernet receive buffers. On some
1668 ethernet controllers it is recommended to set this value
1669 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1670 buffers can be full shortly after enabling the interface
1671 on high ethernet traffic.
1672 Defaults to 4 if not defined.
1674 The following definitions that deal with the placement and management
1675 of environment data (variable area); in general, we support the
1676 following configurations:
1678 - CFG_ENV_IS_IN_FLASH:
1680 Define this if the environment is in flash memory.
1682 a) The environment occupies one whole flash sector, which is
1683 "embedded" in the text segment with the U-Boot code. This
1684 happens usually with "bottom boot sector" or "top boot
1685 sector" type flash chips, which have several smaller
1686 sectors at the start or the end. For instance, such a
1687 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1688 such a case you would place the environment in one of the
1689 4 kB sectors - with U-Boot code before and after it. With
1690 "top boot sector" type flash chips, you would put the
1691 environment in one of the last sectors, leaving a gap
1692 between U-Boot and the environment.
1696 Offset of environment data (variable area) to the
1697 beginning of flash memory; for instance, with bottom boot
1698 type flash chips the second sector can be used: the offset
1699 for this sector is given here.
1701 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1705 This is just another way to specify the start address of
1706 the flash sector containing the environment (instead of
1709 - CFG_ENV_SECT_SIZE:
1711 Size of the sector containing the environment.
1714 b) Sometimes flash chips have few, equal sized, BIG sectors.
1715 In such a case you don't want to spend a whole sector for
1720 If you use this in combination with CFG_ENV_IS_IN_FLASH
1721 and CFG_ENV_SECT_SIZE, you can specify to use only a part
1722 of this flash sector for the environment. This saves
1723 memory for the RAM copy of the environment.
1725 It may also save flash memory if you decide to use this
1726 when your environment is "embedded" within U-Boot code,
1727 since then the remainder of the flash sector could be used
1728 for U-Boot code. It should be pointed out that this is
1729 STRONGLY DISCOURAGED from a robustness point of view:
1730 updating the environment in flash makes it always
1731 necessary to erase the WHOLE sector. If something goes
1732 wrong before the contents has been restored from a copy in
1733 RAM, your target system will be dead.
1735 - CFG_ENV_ADDR_REDUND
1738 These settings describe a second storage area used to hold
1739 a redundand copy of the environment data, so that there is
1740 a valid backup copy in case there is a power failure during
1741 a "saveenv" operation.
1743 BE CAREFUL! Any changes to the flash layout, and some changes to the
1744 source code will make it necessary to adapt <board>/u-boot.lds*
1748 - CFG_ENV_IS_IN_NVRAM:
1750 Define this if you have some non-volatile memory device
1751 (NVRAM, battery buffered SRAM) which you want to use for the
1757 These two #defines are used to determin the memory area you
1758 want to use for environment. It is assumed that this memory
1759 can just be read and written to, without any special
1762 BE CAREFUL! The first access to the environment happens quite early
1763 in U-Boot initalization (when we try to get the setting of for the
1764 console baudrate). You *MUST* have mappend your NVRAM area then, or
1767 Please note that even with NVRAM we still use a copy of the
1768 environment in RAM: we could work on NVRAM directly, but we want to
1769 keep settings there always unmodified except somebody uses "saveenv"
1770 to save the current settings.
1773 - CFG_ENV_IS_IN_EEPROM:
1775 Use this if you have an EEPROM or similar serial access
1776 device and a driver for it.
1781 These two #defines specify the offset and size of the
1782 environment area within the total memory of your EEPROM.
1784 - CFG_I2C_EEPROM_ADDR:
1785 If defined, specified the chip address of the EEPROM device.
1786 The default address is zero.
1788 - CFG_EEPROM_PAGE_WRITE_BITS:
1789 If defined, the number of bits used to address bytes in a
1790 single page in the EEPROM device. A 64 byte page, for example
1791 would require six bits.
1793 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1794 If defined, the number of milliseconds to delay between
1795 page writes. The default is zero milliseconds.
1797 - CFG_I2C_EEPROM_ADDR_LEN:
1798 The length in bytes of the EEPROM memory array address. Note
1799 that this is NOT the chip address length!
1802 The size in bytes of the EEPROM device.
1805 - CFG_ENV_IS_IN_DATAFLASH:
1807 Define this if you have a DataFlash memory device which you
1808 want to use for the environment.
1814 These three #defines specify the offset and size of the
1815 environment area within the total memory of your DataFlash placed
1816 at the specified address.
1819 - CFG_SPI_INIT_OFFSET
1821 Defines offset to the initial SPI buffer area in DPRAM. The
1822 area is used at an early stage (ROM part) if the environment
1823 is configured to reside in the SPI EEPROM: We need a 520 byte
1824 scratch DPRAM area. It is used between the two initialization
1825 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1826 to be a good choice since it makes it far enough from the
1827 start of the data area as well as from the stack pointer.
1829 Please note that the environment is read-only as long as the monitor
1830 has been relocated to RAM and a RAM copy of the environment has been
1831 created; also, when using EEPROM you will have to use getenv_r()
1832 until then to read environment variables.
1834 The environment is protected by a CRC32 checksum. Before the monitor
1835 is relocated into RAM, as a result of a bad CRC you will be working
1836 with the compiled-in default environment - *silently*!!! [This is
1837 necessary, because the first environment variable we need is the
1838 "baudrate" setting for the console - if we have a bad CRC, we don't
1839 have any device yet where we could complain.]
1841 Note: once the monitor has been relocated, then it will complain if
1842 the default environment is used; a new CRC is computed as soon as you
1843 use the "saveenv" command to store a valid environment.
1845 - CFG_FAULT_ECHO_LINK_DOWN:
1846 Echo the inverted Ethernet link state to the fault LED.
1848 Note: If this option is active, then CFG_FAULT_MII_ADDR
1849 also needs to be defined.
1851 - CFG_FAULT_MII_ADDR:
1852 MII address of the PHY to check for the Ethernet link state.
1854 Low Level (hardware related) configuration options:
1855 ---------------------------------------------------
1857 - CFG_CACHELINE_SIZE:
1858 Cache Line Size of the CPU.
1861 Default address of the IMMR after system reset.
1863 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
1864 and RPXsuper) to be able to adjust the position of
1865 the IMMR register after a reset.
1867 - Floppy Disk Support:
1868 CFG_FDC_DRIVE_NUMBER
1870 the default drive number (default value 0)
1874 defines the spacing between fdc chipset registers
1879 defines the offset of register from address. It
1880 depends on which part of the data bus is connected to
1881 the fdc chipset. (default value 0)
1883 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
1884 CFG_FDC_DRIVE_NUMBER are undefined, they take their
1887 if CFG_FDC_HW_INIT is defined, then the function
1888 fdc_hw_init() is called at the beginning of the FDC
1889 setup. fdc_hw_init() must be provided by the board
1890 source code. It is used to make hardware dependant
1893 - CFG_IMMR: Physical address of the Internal Memory Mapped
1894 Register; DO NOT CHANGE! (11-4)
1895 [MPC8xx systems only]
1897 - CFG_INIT_RAM_ADDR:
1899 Start address of memory area that can be used for
1900 initial data and stack; please note that this must be
1901 writable memory that is working WITHOUT special
1902 initialization, i. e. you CANNOT use normal RAM which
1903 will become available only after programming the
1904 memory controller and running certain initialization
1907 U-Boot uses the following memory types:
1908 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
1909 - MPC824X: data cache
1910 - PPC4xx: data cache
1912 - CFG_GBL_DATA_OFFSET:
1914 Offset of the initial data structure in the memory
1915 area defined by CFG_INIT_RAM_ADDR. Usually
1916 CFG_GBL_DATA_OFFSET is chosen such that the initial
1917 data is located at the end of the available space
1918 (sometimes written as (CFG_INIT_RAM_END -
1919 CFG_INIT_DATA_SIZE), and the initial stack is just
1920 below that area (growing from (CFG_INIT_RAM_ADDR +
1921 CFG_GBL_DATA_OFFSET) downward.
1924 On the MPC824X (or other systems that use the data
1925 cache for initial memory) the address chosen for
1926 CFG_INIT_RAM_ADDR is basically arbitrary - it must
1927 point to an otherwise UNUSED address space between
1928 the top of RAM and the start of the PCI space.
1930 - CFG_SIUMCR: SIU Module Configuration (11-6)
1932 - CFG_SYPCR: System Protection Control (11-9)
1934 - CFG_TBSCR: Time Base Status and Control (11-26)
1936 - CFG_PISCR: Periodic Interrupt Status and Control (11-31)
1938 - CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
1940 - CFG_SCCR: System Clock and reset Control Register (15-27)
1942 - CFG_OR_TIMING_SDRAM:
1946 periodic timer for refresh
1948 - CFG_DER: Debug Event Register (37-47)
1950 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
1951 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
1952 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
1954 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
1956 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
1957 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
1958 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
1959 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
1961 - CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
1962 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
1963 Machine Mode Register and Memory Periodic Timer
1964 Prescaler definitions (SDRAM timing)
1966 - CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
1967 enable I2C microcode relocation patch (MPC8xx);
1968 define relocation offset in DPRAM [DSP2]
1970 - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
1971 enable SPI microcode relocation patch (MPC8xx);
1972 define relocation offset in DPRAM [SCC4]
1975 Use OSCM clock mode on MBX8xx board. Be careful,
1976 wrong setting might damage your board. Read
1977 doc/README.MBX before setting this variable!
1979 - CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
1980 Offset of the bootmode word in DPRAM used by post
1981 (Power On Self Tests). This definition overrides
1982 #define'd default value in commproc.h resp.
1985 - CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
1986 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
1987 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
1988 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
1989 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
1990 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
1991 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
1992 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
1993 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
1995 Building the Software:
1996 ======================
1998 Building U-Boot has been tested in native PPC environments (on a
1999 PowerBook G3 running LinuxPPC 2000) and in cross environments
2000 (running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2003 If you are not using a native PPC environment, it is assumed that you
2004 have the GNU cross compiling tools available in your path and named
2005 with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2006 you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2007 the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2010 CROSS_COMPILE = ppc_4xx-
2013 U-Boot is intended to be simple to build. After installing the
2014 sources you must configure U-Boot for one specific board type. This
2019 where "NAME_config" is the name of one of the existing
2020 configurations; the following names are supported:
2022 ADCIOP_config GTH_config TQM850L_config
2023 ADS860_config IP860_config TQM855L_config
2024 AR405_config IVML24_config TQM860L_config
2025 CANBT_config IVMS8_config WALNUT405_config
2026 CPCI405_config LANTEC_config cogent_common_config
2027 CPCIISER4_config MBX_config cogent_mpc8260_config
2028 CU824_config MBX860T_config cogent_mpc8xx_config
2029 ESTEEM192E_config RPXlite_config hermes_config
2030 ETX094_config RPXsuper_config hymod_config
2031 FADS823_config SM850_config lwmon_config
2032 FADS850SAR_config SPD823TS_config pcu_e_config
2033 FADS860T_config SXNI855T_config rsdproto_config
2034 FPS850L_config Sandpoint8240_config sbc8260_config
2035 GENIETV_config TQM823L_config PIP405_config
2036 GEN860T_config EBONY_config FPS860L_config
2037 ELPT860_config cmi_mpc5xx_config NETVIA_config
2038 at91rm9200dk_config omap1510inn_config MPC8260ADS_config
2039 omap1610inn_config ZPC1900_config MPC8540ADS_config
2040 MPC8560ADS_config QS850_config QS823_config
2041 QS860T_config DUET_ADS_config
2043 Note: for some board special configuration names may exist; check if
2044 additional information is available from the board vendor; for
2045 instance, the TQM8xxL systems run normally at 50 MHz and use a
2046 SCC for 10baseT ethernet; there are also systems with 80 MHz
2047 CPU clock, and an optional Fast Ethernet module is available
2048 for CPU's with FEC. You can select such additional "features"
2049 when chosing the configuration, i. e.
2052 - will configure for a plain TQM860L, i. e. 50MHz, no FEC
2054 make TQM860L_FEC_config
2055 - will configure for a TQM860L at 50MHz with FEC for ethernet
2057 make TQM860L_80MHz_config
2058 - will configure for a TQM860L at 80 MHz, with normal 10baseT
2061 make TQM860L_FEC_80MHz_config
2062 - will configure for a TQM860L at 80 MHz with FEC for ethernet
2064 make TQM823L_LCD_config
2065 - will configure for a TQM823L with U-Boot console on LCD
2067 make TQM823L_LCD_80MHz_config
2068 - will configure for a TQM823L at 80 MHz with U-Boot console on LCD
2073 Finally, type "make all", and you should get some working U-Boot
2074 images ready for download to / installation on your system:
2076 - "u-boot.bin" is a raw binary image
2077 - "u-boot" is an image in ELF binary format
2078 - "u-boot.srec" is in Motorola S-Record format
2081 Please be aware that the Makefiles assume you are using GNU make, so
2082 for instance on NetBSD you might need to use "gmake" instead of
2086 If the system board that you have is not listed, then you will need
2087 to port U-Boot to your hardware platform. To do this, follow these
2090 1. Add a new configuration option for your board to the toplevel
2091 "Makefile" and to the "MAKEALL" script, using the existing
2092 entries as examples. Note that here and at many other places
2093 boards and other names are listed in alphabetical sort order. Please
2095 2. Create a new directory to hold your board specific code. Add any
2096 files you need. In your board directory, you will need at least
2097 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
2098 3. Create a new configuration file "include/configs/<board>.h" for
2100 3. If you're porting U-Boot to a new CPU, then also create a new
2101 directory to hold your CPU specific code. Add any files you need.
2102 4. Run "make <board>_config" with your new name.
2103 5. Type "make", and you should get a working "u-boot.srec" file
2104 to be installed on your target system.
2105 6. Debug and solve any problems that might arise.
2106 [Of course, this last step is much harder than it sounds.]
2109 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2110 ==============================================================
2112 If you have modified U-Boot sources (for instance added a new board
2113 or support for new devices, a new CPU, etc.) you are expected to
2114 provide feedback to the other developers. The feedback normally takes
2115 the form of a "patch", i. e. a context diff against a certain (latest
2116 official or latest in CVS) version of U-Boot sources.
2118 But before you submit such a patch, please verify that your modifi-
2119 cation did not break existing code. At least make sure that *ALL* of
2120 the supported boards compile WITHOUT ANY compiler warnings. To do so,
2121 just run the "MAKEALL" script, which will configure and build U-Boot
2122 for ALL supported system. Be warned, this will take a while. You can
2123 select which (cross) compiler to use by passing a `CROSS_COMPILE'
2124 environment variable to the script, i. e. to use the cross tools from
2125 MontaVista's Hard Hat Linux you can type
2127 CROSS_COMPILE=ppc_8xx- MAKEALL
2129 or to build on a native PowerPC system you can type
2131 CROSS_COMPILE=' ' MAKEALL
2133 See also "U-Boot Porting Guide" below.
2136 Monitor Commands - Overview:
2137 ============================
2139 go - start application at address 'addr'
2140 run - run commands in an environment variable
2141 bootm - boot application image from memory
2142 bootp - boot image via network using BootP/TFTP protocol
2143 tftpboot- boot image via network using TFTP protocol
2144 and env variables "ipaddr" and "serverip"
2145 (and eventually "gatewayip")
2146 rarpboot- boot image via network using RARP/TFTP protocol
2147 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2148 loads - load S-Record file over serial line
2149 loadb - load binary file over serial line (kermit mode)
2151 mm - memory modify (auto-incrementing)
2152 nm - memory modify (constant address)
2153 mw - memory write (fill)
2155 cmp - memory compare
2156 crc32 - checksum calculation
2157 imd - i2c memory display
2158 imm - i2c memory modify (auto-incrementing)
2159 inm - i2c memory modify (constant address)
2160 imw - i2c memory write (fill)
2161 icrc32 - i2c checksum calculation
2162 iprobe - probe to discover valid I2C chip addresses
2163 iloop - infinite loop on address range
2164 isdram - print SDRAM configuration information
2165 sspi - SPI utility commands
2166 base - print or set address offset
2167 printenv- print environment variables
2168 setenv - set environment variables
2169 saveenv - save environment variables to persistent storage
2170 protect - enable or disable FLASH write protection
2171 erase - erase FLASH memory
2172 flinfo - print FLASH memory information
2173 bdinfo - print Board Info structure
2174 iminfo - print header information for application image
2175 coninfo - print console devices and informations
2176 ide - IDE sub-system
2177 loop - infinite loop on address range
2178 mtest - simple RAM test
2179 icache - enable or disable instruction cache
2180 dcache - enable or disable data cache
2181 reset - Perform RESET of the CPU
2182 echo - echo args to console
2183 version - print monitor version
2184 help - print online help
2185 ? - alias for 'help'
2188 Monitor Commands - Detailed Description:
2189 ========================================
2193 For now: just type "help <command>".
2196 Environment Variables:
2197 ======================
2199 U-Boot supports user configuration using Environment Variables which
2200 can be made persistent by saving to Flash memory.
2202 Environment Variables are set using "setenv", printed using
2203 "printenv", and saved to Flash using "saveenv". Using "setenv"
2204 without a value can be used to delete a variable from the
2205 environment. As long as you don't save the environment you are
2206 working with an in-memory copy. In case the Flash area containing the
2207 environment is erased by accident, a default environment is provided.
2209 Some configuration options can be set using Environment Variables:
2211 baudrate - see CONFIG_BAUDRATE
2213 bootdelay - see CONFIG_BOOTDELAY
2215 bootcmd - see CONFIG_BOOTCOMMAND
2217 bootargs - Boot arguments when booting an RTOS image
2219 bootfile - Name of the image to load with TFTP
2221 autoload - if set to "no" (any string beginning with 'n'),
2222 "bootp" will just load perform a lookup of the
2223 configuration from the BOOTP server, but not try to
2224 load any image using TFTP
2226 autostart - if set to "yes", an image loaded using the "bootp",
2227 "rarpboot", "tftpboot" or "diskboot" commands will
2228 be automatically started (by internally calling
2231 If set to "no", a standalone image passed to the
2232 "bootm" command will be copied to the load address
2233 (and eventually uncompressed), but NOT be started.
2234 This can be used to load and uncompress arbitrary
2237 initrd_high - restrict positioning of initrd images:
2238 If this variable is not set, initrd images will be
2239 copied to the highest possible address in RAM; this
2240 is usually what you want since it allows for
2241 maximum initrd size. If for some reason you want to
2242 make sure that the initrd image is loaded below the
2243 CFG_BOOTMAPSZ limit, you can set this environment
2244 variable to a value of "no" or "off" or "0".
2245 Alternatively, you can set it to a maximum upper
2246 address to use (U-Boot will still check that it
2247 does not overwrite the U-Boot stack and data).
2249 For instance, when you have a system with 16 MB
2250 RAM, and want to reserve 4 MB from use by Linux,
2251 you can do this by adding "mem=12M" to the value of
2252 the "bootargs" variable. However, now you must make
2253 sure that the initrd image is placed in the first
2254 12 MB as well - this can be done with
2256 setenv initrd_high 00c00000
2258 If you set initrd_high to 0xFFFFFFFF, this is an
2259 indication to U-Boot that all addresses are legal
2260 for the Linux kernel, including addresses in flash
2261 memory. In this case U-Boot will NOT COPY the
2262 ramdisk at all. This may be useful to reduce the
2263 boot time on your system, but requires that this
2264 feature is supported by your Linux kernel.
2266 ipaddr - IP address; needed for tftpboot command
2268 loadaddr - Default load address for commands like "bootp",
2269 "rarpboot", "tftpboot", "loadb" or "diskboot"
2271 loads_echo - see CONFIG_LOADS_ECHO
2273 serverip - TFTP server IP address; needed for tftpboot command
2275 bootretry - see CONFIG_BOOT_RETRY_TIME
2277 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
2279 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
2282 The following environment variables may be used and automatically
2283 updated by the network boot commands ("bootp" and "rarpboot"),
2284 depending the information provided by your boot server:
2286 bootfile - see above
2287 dnsip - IP address of your Domain Name Server
2288 dnsip2 - IP address of your secondary Domain Name Server
2289 gatewayip - IP address of the Gateway (Router) to use
2290 hostname - Target hostname
2292 netmask - Subnet Mask
2293 rootpath - Pathname of the root filesystem on the NFS server
2294 serverip - see above
2297 There are two special Environment Variables:
2299 serial# - contains hardware identification information such
2300 as type string and/or serial number
2301 ethaddr - Ethernet address
2303 These variables can be set only once (usually during manufacturing of
2304 the board). U-Boot refuses to delete or overwrite these variables
2305 once they have been set once.
2308 Further special Environment Variables:
2310 ver - Contains the U-Boot version string as printed
2311 with the "version" command. This variable is
2312 readonly (see CONFIG_VERSION_VARIABLE).
2315 Please note that changes to some configuration parameters may take
2316 only effect after the next boot (yes, that's just like Windoze :-).
2319 Command Line Parsing:
2320 =====================
2322 There are two different command line parsers available with U-Boot:
2323 the old "simple" one, and the much more powerful "hush" shell:
2325 Old, simple command line parser:
2326 --------------------------------
2328 - supports environment variables (through setenv / saveenv commands)
2329 - several commands on one line, separated by ';'
2330 - variable substitution using "... $(name) ..." syntax
2331 - special characters ('$', ';') can be escaped by prefixing with '\',
2333 setenv bootcmd bootm \$(address)
2334 - You can also escape text by enclosing in single apostrophes, for example:
2335 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2340 - similar to Bourne shell, with control structures like
2341 if...then...else...fi, for...do...done; while...do...done,
2342 until...do...done, ...
2343 - supports environment ("global") variables (through setenv / saveenv
2344 commands) and local shell variables (through standard shell syntax
2345 "name=value"); only environment variables can be used with "run"
2351 (1) If a command line (or an environment variable executed by a "run"
2352 command) contains several commands separated by semicolon, and
2353 one of these commands fails, then the remaining commands will be
2356 (2) If you execute several variables with one call to run (i. e.
2357 calling run with a list af variables as arguments), any failing
2358 command will cause "run" to terminate, i. e. the remaining
2359 variables are not executed.
2361 Note for Redundant Ethernet Interfaces:
2362 =======================================
2364 Some boards come with redundant ethernet interfaces; U-Boot supports
2365 such configurations and is capable of automatic selection of a
2366 "working" interface when needed. MAC assignment works as follows:
2368 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2369 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2370 "eth1addr" (=>eth1), "eth2addr", ...
2372 If the network interface stores some valid MAC address (for instance
2373 in SROM), this is used as default address if there is NO correspon-
2374 ding setting in the environment; if the corresponding environment
2375 variable is set, this overrides the settings in the card; that means:
2377 o If the SROM has a valid MAC address, and there is no address in the
2378 environment, the SROM's address is used.
2380 o If there is no valid address in the SROM, and a definition in the
2381 environment exists, then the value from the environment variable is
2384 o If both the SROM and the environment contain a MAC address, and
2385 both addresses are the same, this MAC address is used.
2387 o If both the SROM and the environment contain a MAC address, and the
2388 addresses differ, the value from the environment is used and a
2391 o If neither SROM nor the environment contain a MAC address, an error
2398 The "boot" commands of this monitor operate on "image" files which
2399 can be basicly anything, preceeded by a special header; see the
2400 definitions in include/image.h for details; basicly, the header
2401 defines the following image properties:
2403 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2404 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2405 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2406 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2407 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2408 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2409 Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2410 * Compression Type (uncompressed, gzip, bzip2)
2416 The header is marked by a special Magic Number, and both the header
2417 and the data portions of the image are secured against corruption by
2424 Although U-Boot should support any OS or standalone application
2425 easily, the main focus has always been on Linux during the design of
2428 U-Boot includes many features that so far have been part of some
2429 special "boot loader" code within the Linux kernel. Also, any
2430 "initrd" images to be used are no longer part of one big Linux image;
2431 instead, kernel and "initrd" are separate images. This implementation
2432 serves several purposes:
2434 - the same features can be used for other OS or standalone
2435 applications (for instance: using compressed images to reduce the
2436 Flash memory footprint)
2438 - it becomes much easier to port new Linux kernel versions because
2439 lots of low-level, hardware dependent stuff are done by U-Boot
2441 - the same Linux kernel image can now be used with different "initrd"
2442 images; of course this also means that different kernel images can
2443 be run with the same "initrd". This makes testing easier (you don't
2444 have to build a new "zImage.initrd" Linux image when you just
2445 change a file in your "initrd"). Also, a field-upgrade of the
2446 software is easier now.
2452 Porting Linux to U-Boot based systems:
2453 ---------------------------------------
2455 U-Boot cannot save you from doing all the necessary modifications to
2456 configure the Linux device drivers for use with your target hardware
2457 (no, we don't intend to provide a full virtual machine interface to
2460 But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2462 Just make sure your machine specific header file (for instance
2463 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2464 Information structure as we define in include/u-boot.h, and make
2465 sure that your definition of IMAP_ADDR uses the same value as your
2466 U-Boot configuration in CFG_IMMR.
2469 Configuring the Linux kernel:
2470 -----------------------------
2472 No specific requirements for U-Boot. Make sure you have some root
2473 device (initial ramdisk, NFS) for your target system.
2476 Building a Linux Image:
2477 -----------------------
2479 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2480 not used. If you use recent kernel source, a new build target
2481 "uImage" will exist which automatically builds an image usable by
2482 U-Boot. Most older kernels also have support for a "pImage" target,
2483 which was introduced for our predecessor project PPCBoot and uses a
2484 100% compatible format.
2493 The "uImage" build target uses a special tool (in 'tools/mkimage') to
2494 encapsulate a compressed Linux kernel image with header information,
2495 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2497 * build a standard "vmlinux" kernel image (in ELF binary format):
2499 * convert the kernel into a raw binary image:
2501 ${CROSS_COMPILE}-objcopy -O binary \
2502 -R .note -R .comment \
2503 -S vmlinux linux.bin
2505 * compress the binary image:
2509 * package compressed binary image for U-Boot:
2511 mkimage -A ppc -O linux -T kernel -C gzip \
2512 -a 0 -e 0 -n "Linux Kernel Image" \
2513 -d linux.bin.gz uImage
2516 The "mkimage" tool can also be used to create ramdisk images for use
2517 with U-Boot, either separated from the Linux kernel image, or
2518 combined into one file. "mkimage" encapsulates the images with a 64
2519 byte header containing information about target architecture,
2520 operating system, image type, compression method, entry points, time
2521 stamp, CRC32 checksums, etc.
2523 "mkimage" can be called in two ways: to verify existing images and
2524 print the header information, or to build new images.
2526 In the first form (with "-l" option) mkimage lists the information
2527 contained in the header of an existing U-Boot image; this includes
2528 checksum verification:
2530 tools/mkimage -l image
2531 -l ==> list image header information
2533 The second form (with "-d" option) is used to build a U-Boot image
2534 from a "data file" which is used as image payload:
2536 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2537 -n name -d data_file image
2538 -A ==> set architecture to 'arch'
2539 -O ==> set operating system to 'os'
2540 -T ==> set image type to 'type'
2541 -C ==> set compression type 'comp'
2542 -a ==> set load address to 'addr' (hex)
2543 -e ==> set entry point to 'ep' (hex)
2544 -n ==> set image name to 'name'
2545 -d ==> use image data from 'datafile'
2547 Right now, all Linux kernels use the same load address (0x00000000),
2548 but the entry point address depends on the kernel version:
2550 - 2.2.x kernels have the entry point at 0x0000000C,
2551 - 2.3.x and later kernels have the entry point at 0x00000000.
2553 So a typical call to build a U-Boot image would read:
2555 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2556 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2557 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2558 > examples/uImage.TQM850L
2559 Image Name: 2.4.4 kernel for TQM850L
2560 Created: Wed Jul 19 02:34:59 2000
2561 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2562 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2563 Load Address: 0x00000000
2564 Entry Point: 0x00000000
2566 To verify the contents of the image (or check for corruption):
2568 -> tools/mkimage -l examples/uImage.TQM850L
2569 Image Name: 2.4.4 kernel for TQM850L
2570 Created: Wed Jul 19 02:34:59 2000
2571 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2572 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2573 Load Address: 0x00000000
2574 Entry Point: 0x00000000
2576 NOTE: for embedded systems where boot time is critical you can trade
2577 speed for memory and install an UNCOMPRESSED image instead: this
2578 needs more space in Flash, but boots much faster since it does not
2579 need to be uncompressed:
2581 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2582 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2583 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2584 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2585 > examples/uImage.TQM850L-uncompressed
2586 Image Name: 2.4.4 kernel for TQM850L
2587 Created: Wed Jul 19 02:34:59 2000
2588 Image Type: PowerPC Linux Kernel Image (uncompressed)
2589 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2590 Load Address: 0x00000000
2591 Entry Point: 0x00000000
2594 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2595 when your kernel is intended to use an initial ramdisk:
2597 -> tools/mkimage -n 'Simple Ramdisk Image' \
2598 > -A ppc -O linux -T ramdisk -C gzip \
2599 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2600 Image Name: Simple Ramdisk Image
2601 Created: Wed Jan 12 14:01:50 2000
2602 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2603 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2604 Load Address: 0x00000000
2605 Entry Point: 0x00000000
2608 Installing a Linux Image:
2609 -------------------------
2611 To downloading a U-Boot image over the serial (console) interface,
2612 you must convert the image to S-Record format:
2614 objcopy -I binary -O srec examples/image examples/image.srec
2616 The 'objcopy' does not understand the information in the U-Boot
2617 image header, so the resulting S-Record file will be relative to
2618 address 0x00000000. To load it to a given address, you need to
2619 specify the target address as 'offset' parameter with the 'loads'
2622 Example: install the image to address 0x40100000 (which on the
2623 TQM8xxL is in the first Flash bank):
2625 => erase 40100000 401FFFFF
2631 ## Ready for S-Record download ...
2632 ~>examples/image.srec
2633 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2635 15989 15990 15991 15992
2636 [file transfer complete]
2638 ## Start Addr = 0x00000000
2641 You can check the success of the download using the 'iminfo' command;
2642 this includes a checksum verification so you can be sure no data
2643 corruption happened:
2647 ## Checking Image at 40100000 ...
2648 Image Name: 2.2.13 for initrd on TQM850L
2649 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2650 Data Size: 335725 Bytes = 327 kB = 0 MB
2651 Load Address: 00000000
2652 Entry Point: 0000000c
2653 Verifying Checksum ... OK
2659 The "bootm" command is used to boot an application that is stored in
2660 memory (RAM or Flash). In case of a Linux kernel image, the contents
2661 of the "bootargs" environment variable is passed to the kernel as
2662 parameters. You can check and modify this variable using the
2663 "printenv" and "setenv" commands:
2666 => printenv bootargs
2667 bootargs=root=/dev/ram
2669 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2671 => printenv bootargs
2672 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2675 ## Booting Linux kernel at 40020000 ...
2676 Image Name: 2.2.13 for NFS on TQM850L
2677 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2678 Data Size: 381681 Bytes = 372 kB = 0 MB
2679 Load Address: 00000000
2680 Entry Point: 0000000c
2681 Verifying Checksum ... OK
2682 Uncompressing Kernel Image ... OK
2683 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
2684 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2685 time_init: decrementer frequency = 187500000/60
2686 Calibrating delay loop... 49.77 BogoMIPS
2687 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2690 If you want to boot a Linux kernel with initial ram disk, you pass
2691 the memory addresses of both the kernel and the initrd image (PPBCOOT
2692 format!) to the "bootm" command:
2694 => imi 40100000 40200000
2696 ## Checking Image at 40100000 ...
2697 Image Name: 2.2.13 for initrd on TQM850L
2698 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2699 Data Size: 335725 Bytes = 327 kB = 0 MB
2700 Load Address: 00000000
2701 Entry Point: 0000000c
2702 Verifying Checksum ... OK
2704 ## Checking Image at 40200000 ...
2705 Image Name: Simple Ramdisk Image
2706 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2707 Data Size: 566530 Bytes = 553 kB = 0 MB
2708 Load Address: 00000000
2709 Entry Point: 00000000
2710 Verifying Checksum ... OK
2712 => bootm 40100000 40200000
2713 ## Booting Linux kernel at 40100000 ...
2714 Image Name: 2.2.13 for initrd on TQM850L
2715 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2716 Data Size: 335725 Bytes = 327 kB = 0 MB
2717 Load Address: 00000000
2718 Entry Point: 0000000c
2719 Verifying Checksum ... OK
2720 Uncompressing Kernel Image ... OK
2721 ## Loading RAMDisk Image at 40200000 ...
2722 Image Name: Simple Ramdisk Image
2723 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2724 Data Size: 566530 Bytes = 553 kB = 0 MB
2725 Load Address: 00000000
2726 Entry Point: 00000000
2727 Verifying Checksum ... OK
2728 Loading Ramdisk ... OK
2729 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
2730 Boot arguments: root=/dev/ram
2731 time_init: decrementer frequency = 187500000/60
2732 Calibrating delay loop... 49.77 BogoMIPS
2734 RAMDISK: Compressed image found at block 0
2735 VFS: Mounted root (ext2 filesystem).
2739 More About U-Boot Image Types:
2740 ------------------------------
2742 U-Boot supports the following image types:
2744 "Standalone Programs" are directly runnable in the environment
2745 provided by U-Boot; it is expected that (if they behave
2746 well) you can continue to work in U-Boot after return from
2747 the Standalone Program.
2748 "OS Kernel Images" are usually images of some Embedded OS which
2749 will take over control completely. Usually these programs
2750 will install their own set of exception handlers, device
2751 drivers, set up the MMU, etc. - this means, that you cannot
2752 expect to re-enter U-Boot except by resetting the CPU.
2753 "RAMDisk Images" are more or less just data blocks, and their
2754 parameters (address, size) are passed to an OS kernel that is
2756 "Multi-File Images" contain several images, typically an OS
2757 (Linux) kernel image and one or more data images like
2758 RAMDisks. This construct is useful for instance when you want
2759 to boot over the network using BOOTP etc., where the boot
2760 server provides just a single image file, but you want to get
2761 for instance an OS kernel and a RAMDisk image.
2763 "Multi-File Images" start with a list of image sizes, each
2764 image size (in bytes) specified by an "uint32_t" in network
2765 byte order. This list is terminated by an "(uint32_t)0".
2766 Immediately after the terminating 0 follow the images, one by
2767 one, all aligned on "uint32_t" boundaries (size rounded up to
2768 a multiple of 4 bytes).
2770 "Firmware Images" are binary images containing firmware (like
2771 U-Boot or FPGA images) which usually will be programmed to
2774 "Script files" are command sequences that will be executed by
2775 U-Boot's command interpreter; this feature is especially
2776 useful when you configure U-Boot to use a real shell (hush)
2777 as command interpreter.
2783 One of the features of U-Boot is that you can dynamically load and
2784 run "standalone" applications, which can use some resources of
2785 U-Boot like console I/O functions or interrupt services.
2787 Two simple examples are included with the sources:
2792 'examples/hello_world.c' contains a small "Hello World" Demo
2793 application; it is automatically compiled when you build U-Boot.
2794 It's configured to run at address 0x00040004, so you can play with it
2798 ## Ready for S-Record download ...
2799 ~>examples/hello_world.srec
2800 1 2 3 4 5 6 7 8 9 10 11 ...
2801 [file transfer complete]
2803 ## Start Addr = 0x00040004
2805 => go 40004 Hello World! This is a test.
2806 ## Starting application at 0x00040004 ...
2817 Hit any key to exit ...
2819 ## Application terminated, rc = 0x0
2821 Another example, which demonstrates how to register a CPM interrupt
2822 handler with the U-Boot code, can be found in 'examples/timer.c'.
2823 Here, a CPM timer is set up to generate an interrupt every second.
2824 The interrupt service routine is trivial, just printing a '.'
2825 character, but this is just a demo program. The application can be
2826 controlled by the following keys:
2828 ? - print current values og the CPM Timer registers
2829 b - enable interrupts and start timer
2830 e - stop timer and disable interrupts
2831 q - quit application
2834 ## Ready for S-Record download ...
2835 ~>examples/timer.srec
2836 1 2 3 4 5 6 7 8 9 10 11 ...
2837 [file transfer complete]
2839 ## Start Addr = 0x00040004
2842 ## Starting application at 0x00040004 ...
2845 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
2848 [q, b, e, ?] Set interval 1000000 us
2851 [q, b, e, ?] ........
2852 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
2855 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
2858 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
2861 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
2863 [q, b, e, ?] ...Stopping timer
2865 [q, b, e, ?] ## Application terminated, rc = 0x0
2871 Over time, many people have reported problems when trying to use the
2872 "minicom" terminal emulation program for serial download. I (wd)
2873 consider minicom to be broken, and recommend not to use it. Under
2874 Unix, I recommend to use C-Kermit for general purpose use (and
2875 especially for kermit binary protocol download ("loadb" command), and
2876 use "cu" for S-Record download ("loads" command).
2878 Nevertheless, if you absolutely want to use it try adding this
2879 configuration to your "File transfer protocols" section:
2881 Name Program Name U/D FullScr IO-Red. Multi
2882 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
2883 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
2889 Starting at version 0.9.2, U-Boot supports NetBSD both as host
2890 (build U-Boot) and target system (boots NetBSD/mpc8xx).
2892 Building requires a cross environment; it is known to work on
2893 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
2894 need gmake since the Makefiles are not compatible with BSD make).
2895 Note that the cross-powerpc package does not install include files;
2896 attempting to build U-Boot will fail because <machine/ansi.h> is
2897 missing. This file has to be installed and patched manually:
2899 # cd /usr/pkg/cross/powerpc-netbsd/include
2901 # ln -s powerpc machine
2902 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
2903 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
2905 Native builds *don't* work due to incompatibilities between native
2906 and U-Boot include files.
2908 Booting assumes that (the first part of) the image booted is a
2909 stage-2 loader which in turn loads and then invokes the kernel
2910 proper. Loader sources will eventually appear in the NetBSD source
2911 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2912 meantime, send mail to bruno@exet-ag.de and/or wd@denx.de for
2916 Implementation Internals:
2917 =========================
2919 The following is not intended to be a complete description of every
2920 implementation detail. However, it should help to understand the
2921 inner workings of U-Boot and make it easier to port it to custom
2925 Initial Stack, Global Data:
2926 ---------------------------
2928 The implementation of U-Boot is complicated by the fact that U-Boot
2929 starts running out of ROM (flash memory), usually without access to
2930 system RAM (because the memory controller is not initialized yet).
2931 This means that we don't have writable Data or BSS segments, and BSS
2932 is not initialized as zero. To be able to get a C environment working
2933 at all, we have to allocate at least a minimal stack. Implementation
2934 options for this are defined and restricted by the CPU used: Some CPU
2935 models provide on-chip memory (like the IMMR area on MPC8xx and
2936 MPC826x processors), on others (parts of) the data cache can be
2937 locked as (mis-) used as memory, etc.
2939 Chris Hallinan posted a good summary of these issues to the
2940 u-boot-users mailing list:
2942 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
2943 From: "Chris Hallinan" <clh@net1plus.com>
2944 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
2947 Correct me if I'm wrong, folks, but the way I understand it
2948 is this: Using DCACHE as initial RAM for Stack, etc, does not
2949 require any physical RAM backing up the cache. The cleverness
2950 is that the cache is being used as a temporary supply of
2951 necessary storage before the SDRAM controller is setup. It's
2952 beyond the scope of this list to expain the details, but you
2953 can see how this works by studying the cache architecture and
2954 operation in the architecture and processor-specific manuals.
2956 OCM is On Chip Memory, which I believe the 405GP has 4K. It
2957 is another option for the system designer to use as an
2958 initial stack/ram area prior to SDRAM being available. Either
2959 option should work for you. Using CS 4 should be fine if your
2960 board designers haven't used it for something that would
2961 cause you grief during the initial boot! It is frequently not
2964 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
2965 with your processor/board/system design. The default value
2966 you will find in any recent u-boot distribution in
2967 Walnut405.h should work for you. I'd set it to a value larger
2968 than your SDRAM module. If you have a 64MB SDRAM module, set
2969 it above 400_0000. Just make sure your board has no resources
2970 that are supposed to respond to that address! That code in
2971 start.S has been around a while and should work as is when
2972 you get the config right.
2977 It is essential to remember this, since it has some impact on the C
2978 code for the initialization procedures:
2980 * Initialized global data (data segment) is read-only. Do not attempt
2983 * Do not use any unitialized global data (or implicitely initialized
2984 as zero data - BSS segment) at all - this is undefined, initiali-
2985 zation is performed later (when relocating to RAM).
2987 * Stack space is very limited. Avoid big data buffers or things like
2990 Having only the stack as writable memory limits means we cannot use
2991 normal global data to share information beween the code. But it
2992 turned out that the implementation of U-Boot can be greatly
2993 simplified by making a global data structure (gd_t) available to all
2994 functions. We could pass a pointer to this data as argument to _all_
2995 functions, but this would bloat the code. Instead we use a feature of
2996 the GCC compiler (Global Register Variables) to share the data: we
2997 place a pointer (gd) to the global data into a register which we
2998 reserve for this purpose.
3000 When choosing a register for such a purpose we are restricted by the
3001 relevant (E)ABI specifications for the current architecture, and by
3002 GCC's implementation.
3004 For PowerPC, the following registers have specific use:
3007 R3-R4: parameter passing and return values
3008 R5-R10: parameter passing
3009 R13: small data area pointer
3013 (U-Boot also uses R14 as internal GOT pointer.)
3015 ==> U-Boot will use R29 to hold a pointer to the global data
3017 Note: on PPC, we could use a static initializer (since the
3018 address of the global data structure is known at compile time),
3019 but it turned out that reserving a register results in somewhat
3020 smaller code - although the code savings are not that big (on
3021 average for all boards 752 bytes for the whole U-Boot image,
3022 624 text + 127 data).
3024 On ARM, the following registers are used:
3026 R0: function argument word/integer result
3027 R1-R3: function argument word
3029 R10: stack limit (used only if stack checking if enabled)
3030 R11: argument (frame) pointer
3031 R12: temporary workspace
3034 R15: program counter
3036 ==> U-Boot will use R8 to hold a pointer to the global data
3042 U-Boot runs in system state and uses physical addresses, i.e. the
3043 MMU is not used either for address mapping nor for memory protection.
3045 The available memory is mapped to fixed addresses using the memory
3046 controller. In this process, a contiguous block is formed for each
3047 memory type (Flash, SDRAM, SRAM), even when it consists of several
3048 physical memory banks.
3050 U-Boot is installed in the first 128 kB of the first Flash bank (on
3051 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3052 booting and sizing and initializing DRAM, the code relocates itself
3053 to the upper end of DRAM. Immediately below the U-Boot code some
3054 memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3055 configuration setting]. Below that, a structure with global Board
3056 Info data is placed, followed by the stack (growing downward).
3058 Additionally, some exception handler code is copied to the low 8 kB
3059 of DRAM (0x00000000 ... 0x00001FFF).
3061 So a typical memory configuration with 16 MB of DRAM could look like
3064 0x0000 0000 Exception Vector code
3067 0x0000 2000 Free for Application Use
3073 0x00FB FF20 Monitor Stack (Growing downward)
3074 0x00FB FFAC Board Info Data and permanent copy of global data
3075 0x00FC 0000 Malloc Arena
3078 0x00FE 0000 RAM Copy of Monitor Code
3079 ... eventually: LCD or video framebuffer
3080 ... eventually: pRAM (Protected RAM - unchanged by reset)
3081 0x00FF FFFF [End of RAM]
3084 System Initialization:
3085 ----------------------
3087 In the reset configuration, U-Boot starts at the reset entry point
3088 (on most PowerPC systens at address 0x00000100). Because of the reset
3089 configuration for CS0# this is a mirror of the onboard Flash memory.
3090 To be able to re-map memory U-Boot then jumps to its link address.
3091 To be able to implement the initialization code in C, a (small!)
3092 initial stack is set up in the internal Dual Ported RAM (in case CPUs
3093 which provide such a feature like MPC8xx or MPC8260), or in a locked
3094 part of the data cache. After that, U-Boot initializes the CPU core,
3095 the caches and the SIU.
3097 Next, all (potentially) available memory banks are mapped using a
3098 preliminary mapping. For example, we put them on 512 MB boundaries
3099 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3100 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3101 programmed for SDRAM access. Using the temporary configuration, a
3102 simple memory test is run that determines the size of the SDRAM
3105 When there is more than one SDRAM bank, and the banks are of
3106 different size, the largest is mapped first. For equal size, the first
3107 bank (CS2#) is mapped first. The first mapping is always for address
3108 0x00000000, with any additional banks following immediately to create
3109 contiguous memory starting from 0.
3111 Then, the monitor installs itself at the upper end of the SDRAM area
3112 and allocates memory for use by malloc() and for the global Board
3113 Info data; also, the exception vector code is copied to the low RAM
3114 pages, and the final stack is set up.
3116 Only after this relocation will you have a "normal" C environment;
3117 until that you are restricted in several ways, mostly because you are
3118 running from ROM, and because the code will have to be relocated to a
3122 U-Boot Porting Guide:
3123 ----------------------
3125 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3129 int main (int argc, char *argv[])
3131 sighandler_t no_more_time;
3133 signal (SIGALRM, no_more_time);
3134 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3136 if (available_money > available_manpower) {
3137 pay consultant to port U-Boot;
3141 Download latest U-Boot source;
3143 Subscribe to u-boot-users mailing list;
3146 email ("Hi, I am new to U-Boot, how do I get started?");
3150 Read the README file in the top level directory;
3151 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3152 Read the source, Luke;
3155 if (available_money > toLocalCurrency ($2500)) {
3158 Add a lot of aggravation and time;
3161 Create your own board support subdirectory;
3163 Create your own board config file;
3167 Add / modify source code;
3171 email ("Hi, I am having problems...");
3173 Send patch file to Wolfgang;
3178 void no_more_time (int sig)
3187 All contributions to U-Boot should conform to the Linux kernel
3188 coding style; see the file "Documentation/CodingStyle" in your Linux
3189 kernel source directory.
3191 Please note that U-Boot is implemented in C (and to some small parts
3192 in Assembler); no C++ is used, so please do not use C++ style
3193 comments (//) in your code.
3195 Please also stick to the following formatting rules:
3196 - remove any trailing white space
3197 - use TAB characters for indentation, not spaces
3198 - make sure NOT to use DOS '\r\n' line feeds
3199 - do not add more than 2 empty lines to source files
3200 - do not add trailing empty lines to source files
3202 Submissions which do not conform to the standards may be returned
3203 with a request to reformat the changes.
3209 Since the number of patches for U-Boot is growing, we need to
3210 establish some rules. Submissions which do not conform to these rules
3211 may be rejected, even when they contain important and valuable stuff.
3214 When you send a patch, please include the following information with
3217 * For bug fixes: a description of the bug and how your patch fixes
3218 this bug. Please try to include a way of demonstrating that the
3219 patch actually fixes something.
3221 * For new features: a description of the feature and your
3224 * A CHANGELOG entry as plaintext (separate from the patch)
3226 * For major contributions, your entry to the CREDITS file
3228 * When you add support for a new board, don't forget to add this
3229 board to the MAKEALL script, too.
3231 * If your patch adds new configuration options, don't forget to
3232 document these in the README file.
3234 * The patch itself. If you are accessing the CVS repository use "cvs
3235 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3236 version of diff does not support these options, then get the latest
3237 version of GNU diff.
3239 The current directory when running this command shall be the top
3240 level directory of the U-Boot source tree, or it's parent directory
3241 (i. e. please make sure that your patch includes sufficient
3242 directory information for the affected files).
3244 We accept patches as plain text, MIME attachments or as uuencoded
3247 * If one logical set of modifications affects or creates several
3248 files, all these changes shall be submitted in a SINGLE patch file.
3250 * Changesets that contain different, unrelated modifications shall be
3251 submitted as SEPARATE patches, one patch per changeset.
3256 * Before sending the patch, run the MAKEALL script on your patched
3257 source tree and make sure that no errors or warnings are reported
3258 for any of the boards.
3260 * Keep your modifications to the necessary minimum: A patch
3261 containing several unrelated changes or arbitrary reformats will be
3262 returned with a request to re-formatting / split it.
3264 * If you modify existing code, make sure that your new code does not
3265 add to the memory footprint of the code ;-) Small is beautiful!
3266 When adding new features, these should compile conditionally only
3267 (using #ifdef), and the resulting code with the new feature
3268 disabled must not need more memory than the old code without your
projects / platform / kernel / u-boot.git / blob