2 # (C) Copyright 2000 - 2005
3 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 # See file CREDITS for list of people who contributed to this
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; either version 2 of
11 # the License, or (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston,
27 This directory contains the source code for U-Boot, a boot loader for
28 Embedded boards based on PowerPC, ARM, MIPS and several other
29 processors, which can be installed in a boot ROM and used to
30 initialize and test the hardware or to download and run application
33 The development of U-Boot is closely related to Linux: some parts of
34 the source code originate in the Linux source tree, we have some
35 header files in common, and special provision has been made to
36 support booting of Linux images.
38 Some attention has been paid to make this software easily
39 configurable and extendable. For instance, all monitor commands are
40 implemented with the same call interface, so that it's very easy to
41 add new commands. Also, instead of permanently adding rarely used
42 code (for instance hardware test utilities) to the monitor, you can
43 load and run it dynamically.
49 In general, all boards for which a configuration option exists in the
50 Makefile have been tested to some extent and can be considered
51 "working". In fact, many of them are used in production systems.
53 In case of problems see the CHANGELOG and CREDITS files to find out
54 who contributed the specific port.
60 In case you have questions about, problems with or contributions for
61 U-Boot you should send a message to the U-Boot mailing list at
62 <u-boot-users@lists.sourceforge.net>. There is also an archive of
63 previous traffic on the mailing list - please search the archive
64 before asking FAQ's. Please see
65 http://lists.sourceforge.net/lists/listinfo/u-boot-users/
71 - start from 8xxrom sources
72 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
74 - make it easier to add custom boards
75 - make it possible to add other [PowerPC] CPUs
76 - extend functions, especially:
77 * Provide extended interface to Linux boot loader
80 * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
81 - create ARMBoot project (http://sourceforge.net/projects/armboot)
82 - add other CPU families (starting with ARM)
83 - create U-Boot project (http://sourceforge.net/projects/u-boot)
89 The "official" name of this project is "Das U-Boot". The spelling
90 "U-Boot" shall be used in all written text (documentation, comments
91 in source files etc.). Example:
93 This is the README file for the U-Boot project.
95 File names etc. shall be based on the string "u-boot". Examples:
97 include/asm-ppc/u-boot.h
99 #include <asm/u-boot.h>
101 Variable names, preprocessor constants etc. shall be either based on
102 the string "u_boot" or on "U_BOOT". Example:
104 U_BOOT_VERSION u_boot_logo
105 IH_OS_U_BOOT u_boot_hush_start
111 U-Boot uses a 3 level version number containing a version, a
112 sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
113 sub-version "34", and patchlevel "4".
115 The patchlevel is used to indicate certain stages of development
116 between released versions, i. e. officially released versions of
117 U-Boot will always have a patchlevel of "0".
123 - board Board dependent files
124 - common Misc architecture independent functions
125 - cpu CPU specific files
126 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
127 - arm720t Files specific to ARM 720 CPUs
128 - arm920t Files specific to ARM 920 CPUs
129 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
130 - imx Files specific to Freescale MC9328 i.MX CPUs
131 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
132 - arm925t Files specific to ARM 925 CPUs
133 - arm926ejs Files specific to ARM 926 CPUs
134 - arm1136 Files specific to ARM 1136 CPUs
135 - i386 Files specific to i386 CPUs
136 - ixp Files specific to Intel XScale IXP CPUs
137 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
138 - mips Files specific to MIPS CPUs
139 - mpc5xx Files specific to Freescale MPC5xx CPUs
140 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
141 - mpc8xx Files specific to Freescale MPC8xx CPUs
142 - mpc8220 Files specific to Freescale MPC8220 CPUs
143 - mpc824x Files specific to Freescale MPC824x CPUs
144 - mpc8260 Files specific to Freescale MPC8260 CPUs
145 - mpc85xx Files specific to Freescale MPC85xx CPUs
146 - nios Files specific to Altera NIOS CPUs
147 - nios2 Files specific to Altera Nios-II CPUs
148 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
149 - pxa Files specific to Intel XScale PXA CPUs
150 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
151 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
152 - disk Code for disk drive partition handling
153 - doc Documentation (don't expect too much)
154 - drivers Commonly used device drivers
155 - dtt Digital Thermometer and Thermostat drivers
156 - examples Example code for standalone applications, etc.
157 - include Header Files
158 - lib_arm Files generic to ARM architecture
159 - lib_generic Files generic to all architectures
160 - lib_i386 Files generic to i386 architecture
161 - lib_m68k Files generic to m68k architecture
162 - lib_mips Files generic to MIPS architecture
163 - lib_nios Files generic to NIOS architecture
164 - lib_ppc Files generic to PowerPC architecture
165 - net Networking code
166 - post Power On Self Test
167 - rtc Real Time Clock drivers
168 - tools Tools to build S-Record or U-Boot images, etc.
170 Software Configuration:
171 =======================
173 Configuration is usually done using C preprocessor defines; the
174 rationale behind that is to avoid dead code whenever possible.
176 There are two classes of configuration variables:
178 * Configuration _OPTIONS_:
179 These are selectable by the user and have names beginning with
182 * Configuration _SETTINGS_:
183 These depend on the hardware etc. and should not be meddled with if
184 you don't know what you're doing; they have names beginning with
187 Later we will add a configuration tool - probably similar to or even
188 identical to what's used for the Linux kernel. Right now, we have to
189 do the configuration by hand, which means creating some symbolic
190 links and editing some configuration files. We use the TQM8xxL boards
194 Selection of Processor Architecture and Board Type:
195 ---------------------------------------------------
197 For all supported boards there are ready-to-use default
198 configurations available; just type "make <board_name>_config".
200 Example: For a TQM823L module type:
205 For the Cogent platform, you need to specify the cpu type as well;
206 e.g. "make cogent_mpc8xx_config". And also configure the cogent
207 directory according to the instructions in cogent/README.
210 Configuration Options:
211 ----------------------
213 Configuration depends on the combination of board and CPU type; all
214 such information is kept in a configuration file
215 "include/configs/<board_name>.h".
217 Example: For a TQM823L module, all configuration settings are in
218 "include/configs/TQM823L.h".
221 Many of the options are named exactly as the corresponding Linux
222 kernel configuration options. The intention is to make it easier to
223 build a config tool - later.
226 The following options need to be configured:
228 - CPU Type: Define exactly one of
232 CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860
235 or CONFIG_MPC824X, CONFIG_MPC8260
250 MicroBlaze based CPUs:
251 ----------------------
255 ----------------------
259 - Board Type: Define exactly one of
261 PowerPC based boards:
262 ---------------------
264 CONFIG_ADCIOP CONFIG_GEN860T CONFIG_PCIPPC2
265 CONFIG_ADS860 CONFIG_GENIETV CONFIG_PCIPPC6
266 CONFIG_AMX860 CONFIG_GTH CONFIG_pcu_e
267 CONFIG_AP1000 CONFIG_gw8260 CONFIG_PIP405
268 CONFIG_AR405 CONFIG_hermes CONFIG_PM826
269 CONFIG_BAB7xx CONFIG_hymod CONFIG_ppmc8260
270 CONFIG_c2mon CONFIG_IAD210 CONFIG_QS823
271 CONFIG_CANBT CONFIG_ICU862 CONFIG_QS850
272 CONFIG_CCM CONFIG_IP860 CONFIG_QS860T
273 CONFIG_CMI CONFIG_IPHASE4539 CONFIG_RBC823
274 CONFIG_cogent_mpc8260 CONFIG_IVML24 CONFIG_RPXClassic
275 CONFIG_cogent_mpc8xx CONFIG_IVML24_128 CONFIG_RPXlite
276 CONFIG_CPCI405 CONFIG_IVML24_256 CONFIG_RPXsuper
277 CONFIG_CPCI4052 CONFIG_IVMS8 CONFIG_rsdproto
278 CONFIG_CPCIISER4 CONFIG_IVMS8_128 CONFIG_sacsng
279 CONFIG_CPU86 CONFIG_IVMS8_256 CONFIG_Sandpoint8240
280 CONFIG_CRAYL1 CONFIG_JSE CONFIG_Sandpoint8245
281 CONFIG_CSB272 CONFIG_LANTEC CONFIG_sbc8260
282 CONFIG_CU824 CONFIG_lwmon CONFIG_sbc8560
283 CONFIG_DASA_SIM CONFIG_MBX CONFIG_SM850
284 CONFIG_DB64360 CONFIG_MBX860T CONFIG_SPD823TS
285 CONFIG_DB64460 CONFIG_MHPC CONFIG_STXGP3
286 CONFIG_DU405 CONFIG_MIP405 CONFIG_SXNI855T
287 CONFIG_DUET_ADS CONFIG_MOUSSE CONFIG_TQM823L
288 CONFIG_EBONY CONFIG_MPC8260ADS CONFIG_TQM8260
289 CONFIG_ELPPC CONFIG_MPC8540ADS CONFIG_TQM850L
290 CONFIG_ELPT860 CONFIG_MPC8540EVAL CONFIG_TQM855L
291 CONFIG_ep8260 CONFIG_MPC8560ADS CONFIG_TQM860L
292 CONFIG_ERIC CONFIG_MUSENKI CONFIG_TTTech
293 CONFIG_ESTEEM192E CONFIG_MVS1 CONFIG_UTX8245
294 CONFIG_ETX094 CONFIG_NETPHONE CONFIG_V37
295 CONFIG_EVB64260 CONFIG_NETTA CONFIG_W7OLMC
296 CONFIG_FADS823 CONFIG_NETVIA CONFIG_W7OLMG
297 CONFIG_FADS850SAR CONFIG_NX823 CONFIG_WALNUT
298 CONFIG_FADS860T CONFIG_OCRTC CONFIG_ZPC1900
299 CONFIG_FLAGADM CONFIG_ORSG CONFIG_ZUMA
300 CONFIG_FPS850L CONFIG_OXC
301 CONFIG_FPS860L CONFIG_PCI405
306 CONFIG_ARMADILLO, CONFIG_AT91RM9200DK, CONFIG_CERF250,
307 CONFIG_CSB637, CONFIG_DNP1110, CONFIG_EP7312,
308 CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE, CONFIG_IMPA7,
309 CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610, CONFIG_KB9202,
310 CONFIG_LART, CONFIG_LPD7A400, CONFIG_LUBBOCK,
311 CONFIG_OSK_OMAP5912, CONFIG_OMAP2420H4, CONFIG_SHANNON,
312 CONFIG_P2_OMAP730, CONFIG_SMDK2400, CONFIG_SMDK2410,
313 CONFIG_TRAB, CONFIG_VCMA9
315 MicroBlaze based boards:
316 ------------------------
321 ------------------------
323 CONFIG_PCI5441 CONFIG_PK1C20
326 - CPU Module Type: (if CONFIG_COGENT is defined)
327 Define exactly one of
329 --- FIXME --- not tested yet:
330 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
331 CONFIG_CMA287_23, CONFIG_CMA287_50
333 - Motherboard Type: (if CONFIG_COGENT is defined)
334 Define exactly one of
335 CONFIG_CMA101, CONFIG_CMA102
337 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
338 Define one or more of
341 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
342 Define one or more of
343 CONFIG_LCD_HEARTBEAT - update a character position on
344 the lcd display every second with
347 - Board flavour: (if CONFIG_MPC8260ADS is defined)
350 CFG_8260ADS - original MPC8260ADS
351 CFG_8266ADS - MPC8266ADS
352 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
353 CFG_8272ADS - MPC8272ADS
355 - MPC824X Family Member (if CONFIG_MPC824X is defined)
356 Define exactly one of
357 CONFIG_MPC8240, CONFIG_MPC8245
359 - 8xx CPU Options: (if using an MPC8xx cpu)
360 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
361 get_gclk_freq() cannot work
362 e.g. if there is no 32KHz
363 reference PIT/RTC clock
364 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
367 - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
370 CONFIG_8xx_CPUCLK_DEFAULT
371 See doc/README.MPC866
375 Define this to measure the actual CPU clock instead
376 of relying on the correctness of the configured
377 values. Mostly useful for board bringup to make sure
378 the PLL is locked at the intended frequency. Note
379 that this requires a (stable) reference clock (32 kHz
380 RTC clock or CFG_8XX_XIN)
382 - Linux Kernel Interface:
385 U-Boot stores all clock information in Hz
386 internally. For binary compatibility with older Linux
387 kernels (which expect the clocks passed in the
388 bd_info data to be in MHz) the environment variable
389 "clocks_in_mhz" can be defined so that U-Boot
390 converts clock data to MHZ before passing it to the
392 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
393 "clocks_in_mhz=1" is automatically included in the
396 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
398 When transfering memsize parameter to linux, some versions
399 expect it to be in bytes, others in MB.
400 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
404 New kernel versions are expecting firmware settings to be
405 passed using flat open firmware trees.
406 The environment variable "disable_of", when set, disables this
409 CONFIG_OF_FLAT_TREE_MAX_SIZE
411 The maximum size of the constructed OF tree.
413 OF_CPU - The proper name of the cpus node.
414 OF_TBCLK - The timebase frequency.
418 The resulting flat device tree will have a copy of the bd_t.
419 Space should be pre-allocated in the dts for the bd_t.
421 CONFIG_OF_HAS_UBOOT_ENV
423 The resulting flat device tree will have a copy of u-boot's
424 environment variables
429 Define this if you want support for Amba PrimeCell PL010 UARTs.
433 Define this if you want support for Amba PrimeCell PL011 UARTs.
437 If you have Amba PrimeCell PL011 UARTs, set this variable to
438 the clock speed of the UARTs.
442 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
443 define this to a list of base addresses for each (supported)
444 port. See e.g. include/configs/versatile.h
448 Depending on board, define exactly one serial port
449 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
450 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
451 console by defining CONFIG_8xx_CONS_NONE
453 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
454 port routines must be defined elsewhere
455 (i.e. serial_init(), serial_getc(), ...)
458 Enables console device for a color framebuffer. Needs following
459 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
460 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
462 VIDEO_HW_RECTFILL graphic chip supports
465 VIDEO_HW_BITBLT graphic chip supports
466 bit-blit (cf. smiLynxEM)
467 VIDEO_VISIBLE_COLS visible pixel columns
469 VIDEO_VISIBLE_ROWS visible pixel rows
470 VIDEO_PIXEL_SIZE bytes per pixel
471 VIDEO_DATA_FORMAT graphic data format
472 (0-5, cf. cfb_console.c)
473 VIDEO_FB_ADRS framebuffer address
474 VIDEO_KBD_INIT_FCT keyboard int fct
475 (i.e. i8042_kbd_init())
476 VIDEO_TSTC_FCT test char fct
478 VIDEO_GETC_FCT get char fct
480 CONFIG_CONSOLE_CURSOR cursor drawing on/off
481 (requires blink timer
483 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
484 CONFIG_CONSOLE_TIME display time/date info in
486 (requires CFG_CMD_DATE)
487 CONFIG_VIDEO_LOGO display Linux logo in
489 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
490 linux_logo.h for logo.
491 Requires CONFIG_VIDEO_LOGO
492 CONFIG_CONSOLE_EXTRA_INFO
493 addional board info beside
496 When CONFIG_CFB_CONSOLE is defined, video console is
497 default i/o. Serial console can be forced with
498 environment 'console=serial'.
500 When CONFIG_SILENT_CONSOLE is defined, all console
501 messages (by U-Boot and Linux!) can be silenced with
502 the "silent" environment variable. See
503 doc/README.silent for more information.
506 CONFIG_BAUDRATE - in bps
507 Select one of the baudrates listed in
508 CFG_BAUDRATE_TABLE, see below.
509 CFG_BRGCLK_PRESCALE, baudrate prescale
511 - Interrupt driven serial port input:
512 CONFIG_SERIAL_SOFTWARE_FIFO
515 Use an interrupt handler for receiving data on the
516 serial port. It also enables using hardware handshake
517 (RTS/CTS) and UART's built-in FIFO. Set the number of
518 bytes the interrupt driven input buffer should have.
520 Leave undefined to disable this feature, including
521 disable the buffer and hardware handshake.
523 - Console UART Number:
527 If defined internal UART1 (and not UART0) is used
528 as default U-Boot console.
530 - Boot Delay: CONFIG_BOOTDELAY - in seconds
531 Delay before automatically booting the default image;
532 set to -1 to disable autoboot.
534 See doc/README.autoboot for these options that
535 work with CONFIG_BOOTDELAY. None are required.
536 CONFIG_BOOT_RETRY_TIME
537 CONFIG_BOOT_RETRY_MIN
538 CONFIG_AUTOBOOT_KEYED
539 CONFIG_AUTOBOOT_PROMPT
540 CONFIG_AUTOBOOT_DELAY_STR
541 CONFIG_AUTOBOOT_STOP_STR
542 CONFIG_AUTOBOOT_DELAY_STR2
543 CONFIG_AUTOBOOT_STOP_STR2
544 CONFIG_ZERO_BOOTDELAY_CHECK
545 CONFIG_RESET_TO_RETRY
549 Only needed when CONFIG_BOOTDELAY is enabled;
550 define a command string that is automatically executed
551 when no character is read on the console interface
552 within "Boot Delay" after reset.
555 This can be used to pass arguments to the bootm
556 command. The value of CONFIG_BOOTARGS goes into the
557 environment value "bootargs".
559 CONFIG_RAMBOOT and CONFIG_NFSBOOT
560 The value of these goes into the environment as
561 "ramboot" and "nfsboot" respectively, and can be used
562 as a convenience, when switching between booting from
568 When this option is #defined, the existence of the
569 environment variable "preboot" will be checked
570 immediately before starting the CONFIG_BOOTDELAY
571 countdown and/or running the auto-boot command resp.
572 entering interactive mode.
574 This feature is especially useful when "preboot" is
575 automatically generated or modified. For an example
576 see the LWMON board specific code: here "preboot" is
577 modified when the user holds down a certain
578 combination of keys on the (special) keyboard when
581 - Serial Download Echo Mode:
583 If defined to 1, all characters received during a
584 serial download (using the "loads" command) are
585 echoed back. This might be needed by some terminal
586 emulations (like "cu"), but may as well just take
587 time on others. This setting #define's the initial
588 value of the "loads_echo" environment variable.
590 - Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
592 Select one of the baudrates listed in
593 CFG_BAUDRATE_TABLE, see below.
597 Most monitor functions can be selected (or
598 de-selected) by adjusting the definition of
599 CONFIG_COMMANDS; to select individual functions,
600 #define CONFIG_COMMANDS by "OR"ing any of the
603 #define enables commands:
604 -------------------------
605 CFG_CMD_ASKENV * ask for env variable
606 CFG_CMD_AUTOSCRIPT Autoscript Support
608 CFG_CMD_BEDBUG * Include BedBug Debugger
609 CFG_CMD_BMP * BMP support
610 CFG_CMD_BSP * Board specific commands
612 CFG_CMD_CACHE * icache, dcache
613 CFG_CMD_CONSOLE coninfo
614 CFG_CMD_DATE * support for RTC, date/time...
615 CFG_CMD_DHCP * DHCP support
616 CFG_CMD_DIAG * Diagnostics
617 CFG_CMD_DOC * Disk-On-Chip Support
618 CFG_CMD_DTT * Digital Therm and Thermostat
619 CFG_CMD_ECHO * echo arguments
620 CFG_CMD_EEPROM * EEPROM read/write support
621 CFG_CMD_ELF * bootelf, bootvx
623 CFG_CMD_FDC * Floppy Disk Support
624 CFG_CMD_FAT * FAT partition support
625 CFG_CMD_FDOS * Dos diskette Support
626 CFG_CMD_FLASH flinfo, erase, protect
627 CFG_CMD_FPGA FPGA device initialization support
628 CFG_CMD_HWFLOW * RTS/CTS hw flow control
629 CFG_CMD_I2C * I2C serial bus support
630 CFG_CMD_IDE * IDE harddisk support
632 CFG_CMD_IMLS List all found images
633 CFG_CMD_IMMAP * IMMR dump support
634 CFG_CMD_IRQ * irqinfo
635 CFG_CMD_ITEST Integer/string test of 2 values
636 CFG_CMD_JFFS2 * JFFS2 Support
640 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
642 CFG_CMD_MISC Misc functions like sleep etc
643 CFG_CMD_MMC * MMC memory mapped support
644 CFG_CMD_MII * MII utility commands
645 CFG_CMD_NAND * NAND support
646 CFG_CMD_NET bootp, tftpboot, rarpboot
647 CFG_CMD_PCI * pciinfo
648 CFG_CMD_PCMCIA * PCMCIA support
649 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
650 CFG_CMD_PORTIO * Port I/O
651 CFG_CMD_REGINFO * Register dump
652 CFG_CMD_RUN run command in env variable
653 CFG_CMD_SAVES * save S record dump
654 CFG_CMD_SCSI * SCSI Support
655 CFG_CMD_SDRAM * print SDRAM configuration information
656 (requires CFG_CMD_I2C)
657 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
658 CFG_CMD_SPI * SPI serial bus support
659 CFG_CMD_USB * USB support
660 CFG_CMD_VFD * VFD support (TRAB)
661 CFG_CMD_BSP * Board SPecific functions
662 CFG_CMD_CDP * Cisco Discover Protocol support
663 -----------------------------------------------
666 CONFIG_CMD_DFL Default configuration; at the moment
667 this is includes all commands, except
668 the ones marked with "*" in the list
671 If you don't define CONFIG_COMMANDS it defaults to
672 CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
673 override the default settings in the respective
676 EXAMPLE: If you want all functions except of network
677 support you can write:
679 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
682 Note: Don't enable the "icache" and "dcache" commands
683 (configuration option CFG_CMD_CACHE) unless you know
684 what you (and your U-Boot users) are doing. Data
685 cache cannot be enabled on systems like the 8xx or
686 8260 (where accesses to the IMMR region must be
687 uncached), and it cannot be disabled on all other
688 systems where we (mis-) use the data cache to hold an
689 initial stack and some data.
692 XXX - this list needs to get updated!
696 If this variable is defined, it enables watchdog
697 support. There must be support in the platform specific
698 code for a watchdog. For the 8xx and 8260 CPUs, the
699 SIU Watchdog feature is enabled in the SYPCR
703 CONFIG_VERSION_VARIABLE
704 If this variable is defined, an environment variable
705 named "ver" is created by U-Boot showing the U-Boot
706 version as printed by the "version" command.
707 This variable is readonly.
711 When CFG_CMD_DATE is selected, the type of the RTC
712 has to be selected, too. Define exactly one of the
715 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
716 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
717 CONFIG_RTC_MC146818 - use MC146818 RTC
718 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
719 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
720 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
721 CONFIG_RTC_DS164x - use Dallas DS164x RTC
722 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
724 Note that if the RTC uses I2C, then the I2C interface
725 must also be configured. See I2C Support, below.
729 When CONFIG_TIMESTAMP is selected, the timestamp
730 (date and time) of an image is printed by image
731 commands like bootm or iminfo. This option is
732 automatically enabled when you select CFG_CMD_DATE .
735 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
736 and/or CONFIG_ISO_PARTITION
738 If IDE or SCSI support is enabled (CFG_CMD_IDE or
739 CFG_CMD_SCSI) you must configure support for at least
740 one partition type as well.
743 CONFIG_IDE_RESET_ROUTINE - this is defined in several
744 board configurations files but used nowhere!
746 CONFIG_IDE_RESET - is this is defined, IDE Reset will
747 be performed by calling the function
748 ide_set_reset(int reset)
749 which has to be defined in a board specific file
754 Set this to enable ATAPI support.
759 Set this to enable support for disks larger than 137GB
760 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
761 Whithout these , LBA48 support uses 32bit variables and will 'only'
762 support disks up to 2.1TB.
765 When enabled, makes the IDE subsystem use 64bit sector addresses.
769 At the moment only there is only support for the
770 SYM53C8XX SCSI controller; define
771 CONFIG_SCSI_SYM53C8XX to enable it.
773 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
774 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
775 CFG_SCSI_MAX_LUN] can be adjusted to define the
776 maximum numbers of LUNs, SCSI ID's and target
778 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
780 - NETWORK Support (PCI):
782 Support for Intel 8254x gigabit chips.
785 Support for Intel 82557/82559/82559ER chips.
786 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
787 write routine for first time initialisation.
790 Support for Digital 2114x chips.
791 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
792 modem chip initialisation (KS8761/QS6611).
795 Support for National dp83815 chips.
798 Support for National dp8382[01] gigabit chips.
800 - NETWORK Support (other):
802 CONFIG_DRIVER_LAN91C96
803 Support for SMSC's LAN91C96 chips.
806 Define this to hold the physical address
807 of the LAN91C96's I/O space
809 CONFIG_LAN91C96_USE_32_BIT
810 Define this to enable 32 bit addressing
812 CONFIG_DRIVER_SMC91111
813 Support for SMSC's LAN91C111 chip
816 Define this to hold the physical address
817 of the device (I/O space)
819 CONFIG_SMC_USE_32_BIT
820 Define this if data bus is 32 bits
822 CONFIG_SMC_USE_IOFUNCS
823 Define this to use i/o functions instead of macros
824 (some hardware wont work with macros)
827 At the moment only the UHCI host controller is
828 supported (PIP405, MIP405, MPC5200); define
829 CONFIG_USB_UHCI to enable it.
830 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
831 and define CONFIG_USB_STORAGE to enable the USB
834 Supported are USB Keyboards and USB Floppy drives
836 MPC5200 USB requires additional defines:
838 for 528 MHz Clock: 0x0001bbbb
840 for differential drivers: 0x00001000
841 for single ended drivers: 0x00005000
845 The MMC controller on the Intel PXA is supported. To
846 enable this define CONFIG_MMC. The MMC can be
847 accessed from the boot prompt by mapping the device
848 to physical memory similar to flash. Command line is
849 enabled with CFG_CMD_MMC. The MMC driver also works with
850 the FAT fs. This is enabled with CFG_CMD_FAT.
852 - Journaling Flash filesystem support:
853 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
854 CONFIG_JFFS2_NAND_DEV
855 Define these for a default partition on a NAND device
857 CFG_JFFS2_FIRST_SECTOR,
858 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
859 Define these for a default partition on a NOR device
862 Define this to create an own partition. You have to provide a
863 function struct part_info* jffs2_part_info(int part_num)
865 If you define only one JFFS2 partition you may also want to
866 #define CFG_JFFS_SINGLE_PART 1
867 to disable the command chpart. This is the default when you
868 have not defined a custom partition
873 Define this to enable standard (PC-Style) keyboard
877 Standard PC keyboard driver with US (is default) and
878 GERMAN key layout (switch via environment 'keymap=de') support.
879 Export function i8042_kbd_init, i8042_tstc and i8042_getc
880 for cfb_console. Supports cursor blinking.
885 Define this to enable video support (for output to
890 Enable Chips & Technologies 69000 Video chip
892 CONFIG_VIDEO_SMI_LYNXEM
893 Enable Silicon Motion SMI 712/710/810 Video chip. The
894 video output is selected via environment 'videoout'
895 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
898 For the CT69000 and SMI_LYNXEM drivers, videomode is
899 selected via environment 'videomode'. Two diferent ways
901 - "videomode=num" 'num' is a standard LiLo mode numbers.
902 Following standard modes are supported (* is default):
904 Colors 640x480 800x600 1024x768 1152x864 1280x1024
905 -------------+---------------------------------------------
906 8 bits | 0x301* 0x303 0x305 0x161 0x307
907 15 bits | 0x310 0x313 0x316 0x162 0x319
908 16 bits | 0x311 0x314 0x317 0x163 0x31A
909 24 bits | 0x312 0x315 0x318 ? 0x31B
910 -------------+---------------------------------------------
911 (i.e. setenv videomode 317; saveenv; reset;)
913 - "videomode=bootargs" all the video parameters are parsed
914 from the bootargs. (See drivers/videomodes.c)
917 CONFIG_VIDEO_SED13806
918 Enable Epson SED13806 driver. This driver supports 8bpp
919 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
920 or CONFIG_VIDEO_SED13806_16BPP
925 Define this to enable a custom keyboard support.
926 This simply calls drv_keyboard_init() which must be
927 defined in your board-specific files.
928 The only board using this so far is RBC823.
930 - LCD Support: CONFIG_LCD
932 Define this to enable LCD support (for output to LCD
933 display); also select one of the supported displays
934 by defining one of these:
936 CONFIG_NEC_NL6448AC33:
938 NEC NL6448AC33-18. Active, color, single scan.
940 CONFIG_NEC_NL6448BC20
942 NEC NL6448BC20-08. 6.5", 640x480.
943 Active, color, single scan.
945 CONFIG_NEC_NL6448BC33_54
947 NEC NL6448BC33-54. 10.4", 640x480.
948 Active, color, single scan.
952 Sharp 320x240. Active, color, single scan.
953 It isn't 16x9, and I am not sure what it is.
955 CONFIG_SHARP_LQ64D341
957 Sharp LQ64D341 display, 640x480.
958 Active, color, single scan.
962 HLD1045 display, 640x480.
963 Active, color, single scan.
967 Optrex CBL50840-2 NF-FW 99 22 M5
969 Hitachi LMG6912RPFC-00T
973 320x240. Black & white.
975 Normally display is black on white background; define
976 CFG_WHITE_ON_BLACK to get it inverted.
978 - Splash Screen Support: CONFIG_SPLASH_SCREEN
980 If this option is set, the environment is checked for
981 a variable "splashimage". If found, the usual display
982 of logo, copyright and system information on the LCD
983 is suppressed and the BMP image at the address
984 specified in "splashimage" is loaded instead. The
985 console is redirected to the "nulldev", too. This
986 allows for a "silent" boot where a splash screen is
987 loaded very quickly after power-on.
989 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
991 If this option is set, additionally to standard BMP
992 images, gzipped BMP images can be displayed via the
993 splashscreen support or the bmp command.
995 - Compression support:
998 If this option is set, support for bzip2 compressed
999 images is included. If not, only uncompressed and gzip
1000 compressed images are supported.
1002 NOTE: the bzip2 algorithm requires a lot of RAM, so
1003 the malloc area (as defined by CFG_MALLOC_LEN) should
1009 The address of PHY on MII bus.
1011 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1013 The clock frequency of the MII bus
1017 If this option is set, support for speed/duplex
1018 detection of Gigabit PHY is included.
1020 CONFIG_PHY_RESET_DELAY
1022 Some PHY like Intel LXT971A need extra delay after
1023 reset before any MII register access is possible.
1024 For such PHY, set this option to the usec delay
1025 required. (minimum 300usec for LXT971A)
1027 CONFIG_PHY_CMD_DELAY (ppc4xx)
1029 Some PHY like Intel LXT971A need extra delay after
1030 command issued before MII status register can be read
1037 Define a default value for ethernet address to use
1038 for the respective ethernet interface, in case this
1039 is not determined automatically.
1044 Define a default value for the IP address to use for
1045 the default ethernet interface, in case this is not
1046 determined through e.g. bootp.
1048 - Server IP address:
1051 Defines a default value for theIP address of a TFTP
1052 server to contact when using the "tftboot" command.
1054 - BOOTP Recovery Mode:
1055 CONFIG_BOOTP_RANDOM_DELAY
1057 If you have many targets in a network that try to
1058 boot using BOOTP, you may want to avoid that all
1059 systems send out BOOTP requests at precisely the same
1060 moment (which would happen for instance at recovery
1061 from a power failure, when all systems will try to
1062 boot, thus flooding the BOOTP server. Defining
1063 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1064 inserted before sending out BOOTP requests. The
1065 following delays are insterted then:
1067 1st BOOTP request: delay 0 ... 1 sec
1068 2nd BOOTP request: delay 0 ... 2 sec
1069 3rd BOOTP request: delay 0 ... 4 sec
1071 BOOTP requests: delay 0 ... 8 sec
1073 - DHCP Advanced Options:
1076 You can fine tune the DHCP functionality by adding
1077 these flags to the CONFIG_BOOTP_MASK define:
1079 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1080 serverip from a DHCP server, it is possible that more
1081 than one DNS serverip is offered to the client.
1082 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1083 serverip will be stored in the additional environment
1084 variable "dnsip2". The first DNS serverip is always
1085 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1086 is added to the CONFIG_BOOTP_MASK.
1088 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1089 to do a dynamic update of a DNS server. To do this, they
1090 need the hostname of the DHCP requester.
1091 If CONFIG_BOOP_SEND_HOSTNAME is added to the
1092 CONFIG_BOOTP_MASK, the content of the "hostname"
1093 environment variable is passed as option 12 to
1097 CONFIG_CDP_DEVICE_ID
1099 The device id used in CDP trigger frames.
1101 CONFIG_CDP_DEVICE_ID_PREFIX
1103 A two character string which is prefixed to the MAC address
1108 A printf format string which contains the ascii name of
1109 the port. Normally is set to "eth%d" which sets
1110 eth0 for the first ethernet, eth1 for the second etc.
1112 CONFIG_CDP_CAPABILITIES
1114 A 32bit integer which indicates the device capabilities;
1115 0x00000010 for a normal host which does not forwards.
1119 An ascii string containing the version of the software.
1123 An ascii string containing the name of the platform.
1127 A 32bit integer sent on the trigger.
1129 CONFIG_CDP_POWER_CONSUMPTION
1131 A 16bit integer containing the power consumption of the
1132 device in .1 of milliwatts.
1134 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1136 A byte containing the id of the VLAN.
1138 - Status LED: CONFIG_STATUS_LED
1140 Several configurations allow to display the current
1141 status using a LED. For instance, the LED will blink
1142 fast while running U-Boot code, stop blinking as
1143 soon as a reply to a BOOTP request was received, and
1144 start blinking slow once the Linux kernel is running
1145 (supported by a status LED driver in the Linux
1146 kernel). Defining CONFIG_STATUS_LED enables this
1149 - CAN Support: CONFIG_CAN_DRIVER
1151 Defining CONFIG_CAN_DRIVER enables CAN driver support
1152 on those systems that support this (optional)
1153 feature, like the TQM8xxL modules.
1155 - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1157 These enable I2C serial bus commands. Defining either of
1158 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1159 include the appropriate I2C driver for the selected cpu.
1161 This will allow you to use i2c commands at the u-boot
1162 command line (as long as you set CFG_CMD_I2C in
1163 CONFIG_COMMANDS) and communicate with i2c based realtime
1164 clock chips. See common/cmd_i2c.c for a description of the
1165 command line interface.
1167 CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1169 CONFIG_SOFT_I2C configures u-boot to use a software (aka
1170 bit-banging) driver instead of CPM or similar hardware
1173 There are several other quantities that must also be
1174 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1176 In both cases you will need to define CFG_I2C_SPEED
1177 to be the frequency (in Hz) at which you wish your i2c bus
1178 to run and CFG_I2C_SLAVE to be the address of this node (ie
1179 the cpu's i2c node address).
1181 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1182 sets the cpu up as a master node and so its address should
1183 therefore be cleared to 0 (See, eg, MPC823e User's Manual
1184 p.16-473). So, set CFG_I2C_SLAVE to 0.
1186 That's all that's required for CONFIG_HARD_I2C.
1188 If you use the software i2c interface (CONFIG_SOFT_I2C)
1189 then the following macros need to be defined (examples are
1190 from include/configs/lwmon.h):
1194 (Optional). Any commands necessary to enable the I2C
1195 controller or configure ports.
1197 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
1201 (Only for MPC8260 CPU). The I/O port to use (the code
1202 assumes both bits are on the same port). Valid values
1203 are 0..3 for ports A..D.
1207 The code necessary to make the I2C data line active
1208 (driven). If the data line is open collector, this
1211 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1215 The code necessary to make the I2C data line tri-stated
1216 (inactive). If the data line is open collector, this
1219 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1223 Code that returns TRUE if the I2C data line is high,
1226 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1230 If <bit> is TRUE, sets the I2C data line high. If it
1231 is FALSE, it clears it (low).
1233 eg: #define I2C_SDA(bit) \
1234 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
1235 else immr->im_cpm.cp_pbdat &= ~PB_SDA
1239 If <bit> is TRUE, sets the I2C clock line high. If it
1240 is FALSE, it clears it (low).
1242 eg: #define I2C_SCL(bit) \
1243 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
1244 else immr->im_cpm.cp_pbdat &= ~PB_SCL
1248 This delay is invoked four times per clock cycle so this
1249 controls the rate of data transfer. The data rate thus
1250 is 1 / (I2C_DELAY * 4). Often defined to be something
1253 #define I2C_DELAY udelay(2)
1257 When a board is reset during an i2c bus transfer
1258 chips might think that the current transfer is still
1259 in progress. On some boards it is possible to access
1260 the i2c SCLK line directly, either by using the
1261 processor pin as a GPIO or by having a second pin
1262 connected to the bus. If this option is defined a
1263 custom i2c_init_board() routine in boards/xxx/board.c
1264 is run early in the boot sequence.
1266 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1268 This option enables configuration of bi_iic_fast[] flags
1269 in u-boot bd_info structure based on u-boot environment
1270 variable "i2cfast". (see also i2cfast)
1272 - SPI Support: CONFIG_SPI
1274 Enables SPI driver (so far only tested with
1275 SPI EEPROM, also an instance works with Crystal A/D and
1276 D/As on the SACSng board)
1280 Enables extended (16-bit) SPI EEPROM addressing.
1281 (symmetrical to CONFIG_I2C_X)
1285 Enables a software (bit-bang) SPI driver rather than
1286 using hardware support. This is a general purpose
1287 driver that only requires three general I/O port pins
1288 (two outputs, one input) to function. If this is
1289 defined, the board configuration must define several
1290 SPI configuration items (port pins to use, etc). For
1291 an example, see include/configs/sacsng.h.
1293 - FPGA Support: CONFIG_FPGA_COUNT
1295 Specify the number of FPGA devices to support.
1299 Used to specify the types of FPGA devices. For example,
1300 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
1302 CFG_FPGA_PROG_FEEDBACK
1304 Enable printing of hash marks during FPGA configuration.
1308 Enable checks on FPGA configuration interface busy
1309 status by the configuration function. This option
1310 will require a board or device specific function to
1315 If defined, a function that provides delays in the FPGA
1316 configuration driver.
1318 CFG_FPGA_CHECK_CTRLC
1319 Allow Control-C to interrupt FPGA configuration
1321 CFG_FPGA_CHECK_ERROR
1323 Check for configuration errors during FPGA bitfile
1324 loading. For example, abort during Virtex II
1325 configuration if the INIT_B line goes low (which
1326 indicated a CRC error).
1330 Maximum time to wait for the INIT_B line to deassert
1331 after PROB_B has been deasserted during a Virtex II
1332 FPGA configuration sequence. The default time is 500
1337 Maximum time to wait for BUSY to deassert during
1338 Virtex II FPGA configuration. The default is 5 mS.
1340 CFG_FPGA_WAIT_CONFIG
1342 Time to wait after FPGA configuration. The default is
1345 - Configuration Management:
1348 If defined, this string will be added to the U-Boot
1349 version information (U_BOOT_VERSION)
1351 - Vendor Parameter Protection:
1353 U-Boot considers the values of the environment
1354 variables "serial#" (Board Serial Number) and
1355 "ethaddr" (Ethernet Address) to be parameters that
1356 are set once by the board vendor / manufacturer, and
1357 protects these variables from casual modification by
1358 the user. Once set, these variables are read-only,
1359 and write or delete attempts are rejected. You can
1360 change this behviour:
1362 If CONFIG_ENV_OVERWRITE is #defined in your config
1363 file, the write protection for vendor parameters is
1364 completely disabled. Anybody can change or delete
1367 Alternatively, if you #define _both_ CONFIG_ETHADDR
1368 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1369 ethernet address is installed in the environment,
1370 which can be changed exactly ONCE by the user. [The
1371 serial# is unaffected by this, i. e. it remains
1377 Define this variable to enable the reservation of
1378 "protected RAM", i. e. RAM which is not overwritten
1379 by U-Boot. Define CONFIG_PRAM to hold the number of
1380 kB you want to reserve for pRAM. You can overwrite
1381 this default value by defining an environment
1382 variable "pram" to the number of kB you want to
1383 reserve. Note that the board info structure will
1384 still show the full amount of RAM. If pRAM is
1385 reserved, a new environment variable "mem" will
1386 automatically be defined to hold the amount of
1387 remaining RAM in a form that can be passed as boot
1388 argument to Linux, for instance like that:
1390 setenv bootargs ... mem=\${mem}
1393 This way you can tell Linux not to use this memory,
1394 either, which results in a memory region that will
1395 not be affected by reboots.
1397 *WARNING* If your board configuration uses automatic
1398 detection of the RAM size, you must make sure that
1399 this memory test is non-destructive. So far, the
1400 following board configurations are known to be
1403 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1404 HERMES, IP860, RPXlite, LWMON, LANTEC,
1405 PCU_E, FLAGADM, TQM8260
1410 Define this variable to stop the system in case of a
1411 fatal error, so that you have to reset it manually.
1412 This is probably NOT a good idea for an embedded
1413 system where you want to system to reboot
1414 automatically as fast as possible, but it may be
1415 useful during development since you can try to debug
1416 the conditions that lead to the situation.
1418 CONFIG_NET_RETRY_COUNT
1420 This variable defines the number of retries for
1421 network operations like ARP, RARP, TFTP, or BOOTP
1422 before giving up the operation. If not defined, a
1423 default value of 5 is used.
1425 - Command Interpreter:
1428 Enable auto completion of commands using TAB.
1432 Define this variable to enable the "hush" shell (from
1433 Busybox) as command line interpreter, thus enabling
1434 powerful command line syntax like
1435 if...then...else...fi conditionals or `&&' and '||'
1436 constructs ("shell scripts").
1438 If undefined, you get the old, much simpler behaviour
1439 with a somewhat smaller memory footprint.
1444 This defines the secondary prompt string, which is
1445 printed when the command interpreter needs more input
1446 to complete a command. Usually "> ".
1450 In the current implementation, the local variables
1451 space and global environment variables space are
1452 separated. Local variables are those you define by
1453 simply typing `name=value'. To access a local
1454 variable later on, you have write `$name' or
1455 `${name}'; to execute the contents of a variable
1456 directly type `$name' at the command prompt.
1458 Global environment variables are those you use
1459 setenv/printenv to work with. To run a command stored
1460 in such a variable, you need to use the run command,
1461 and you must not use the '$' sign to access them.
1463 To store commands and special characters in a
1464 variable, please use double quotation marks
1465 surrounding the whole text of the variable, instead
1466 of the backslashes before semicolons and special
1469 - Default Environment:
1470 CONFIG_EXTRA_ENV_SETTINGS
1472 Define this to contain any number of null terminated
1473 strings (variable = value pairs) that will be part of
1474 the default environment compiled into the boot image.
1476 For example, place something like this in your
1477 board's config file:
1479 #define CONFIG_EXTRA_ENV_SETTINGS \
1483 Warning: This method is based on knowledge about the
1484 internal format how the environment is stored by the
1485 U-Boot code. This is NOT an official, exported
1486 interface! Although it is unlikely that this format
1487 will change soon, there is no guarantee either.
1488 You better know what you are doing here.
1490 Note: overly (ab)use of the default environment is
1491 discouraged. Make sure to check other ways to preset
1492 the environment like the autoscript function or the
1495 - DataFlash Support:
1496 CONFIG_HAS_DATAFLASH
1498 Defining this option enables DataFlash features and
1499 allows to read/write in Dataflash via the standard
1502 - SystemACE Support:
1505 Adding this option adds support for Xilinx SystemACE
1506 chips attached via some sort of local bus. The address
1507 of the chip must alsh be defined in the
1508 CFG_SYSTEMACE_BASE macro. For example:
1510 #define CONFIG_SYSTEMACE
1511 #define CFG_SYSTEMACE_BASE 0xf0000000
1513 When SystemACE support is added, the "ace" device type
1514 becomes available to the fat commands, i.e. fatls.
1516 - TFTP Fixed UDP Port:
1519 If this is defined, the environment variable tftpsrcp
1520 is used to supply the TFTP UDP source port value.
1521 If tftpsrcp isn't defined, the normal pseudo-random port
1522 number generator is used.
1524 Also, the environment variable tftpdstp is used to supply
1525 the TFTP UDP destination port value. If tftpdstp isn't
1526 defined, the normal port 69 is used.
1528 The purpose for tftpsrcp is to allow a TFTP server to
1529 blindly start the TFTP transfer using the pre-configured
1530 target IP address and UDP port. This has the effect of
1531 "punching through" the (Windows XP) firewall, allowing
1532 the remainder of the TFTP transfer to proceed normally.
1533 A better solution is to properly configure the firewall,
1534 but sometimes that is not allowed.
1536 - Show boot progress:
1537 CONFIG_SHOW_BOOT_PROGRESS
1539 Defining this option allows to add some board-
1540 specific code (calling a user-provided function
1541 "show_boot_progress(int)") that enables you to show
1542 the system's boot progress on some display (for
1543 example, some LED's) on your board. At the moment,
1544 the following checkpoints are implemented:
1547 1 common/cmd_bootm.c before attempting to boot an image
1548 -1 common/cmd_bootm.c Image header has bad magic number
1549 2 common/cmd_bootm.c Image header has correct magic number
1550 -2 common/cmd_bootm.c Image header has bad checksum
1551 3 common/cmd_bootm.c Image header has correct checksum
1552 -3 common/cmd_bootm.c Image data has bad checksum
1553 4 common/cmd_bootm.c Image data has correct checksum
1554 -4 common/cmd_bootm.c Image is for unsupported architecture
1555 5 common/cmd_bootm.c Architecture check OK
1556 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1557 6 common/cmd_bootm.c Image Type check OK
1558 -6 common/cmd_bootm.c gunzip uncompression error
1559 -7 common/cmd_bootm.c Unimplemented compression type
1560 7 common/cmd_bootm.c Uncompression OK
1561 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1562 8 common/cmd_bootm.c Image Type check OK
1563 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1564 9 common/cmd_bootm.c Start initial ramdisk verification
1565 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1566 -11 common/cmd_bootm.c Ramdisk header has bad checksum
1567 10 common/cmd_bootm.c Ramdisk header is OK
1568 -12 common/cmd_bootm.c Ramdisk data has bad checksum
1569 11 common/cmd_bootm.c Ramdisk data has correct checksum
1570 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1571 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1572 13 common/cmd_bootm.c Start multifile image verification
1573 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1574 15 common/cmd_bootm.c All preparation done, transferring control to OS
1576 -30 lib_ppc/board.c Fatal error, hang the system
1577 -31 post/post.c POST test failed, detected by post_output_backlog()
1578 -32 post/post.c POST test failed, detected by post_run_single()
1580 -1 common/cmd_doc.c Bad usage of "doc" command
1581 -1 common/cmd_doc.c No boot device
1582 -1 common/cmd_doc.c Unknown Chip ID on boot device
1583 -1 common/cmd_doc.c Read Error on boot device
1584 -1 common/cmd_doc.c Image header has bad magic number
1586 -1 common/cmd_ide.c Bad usage of "ide" command
1587 -1 common/cmd_ide.c No boot device
1588 -1 common/cmd_ide.c Unknown boot device
1589 -1 common/cmd_ide.c Unknown partition table
1590 -1 common/cmd_ide.c Invalid partition type
1591 -1 common/cmd_ide.c Read Error on boot device
1592 -1 common/cmd_ide.c Image header has bad magic number
1594 -1 common/cmd_nand.c Bad usage of "nand" command
1595 -1 common/cmd_nand.c No boot device
1596 -1 common/cmd_nand.c Unknown Chip ID on boot device
1597 -1 common/cmd_nand.c Read Error on boot device
1598 -1 common/cmd_nand.c Image header has bad magic number
1600 -1 common/env_common.c Environment has a bad CRC, using default
1606 [so far only for SMDK2400 and TRAB boards]
1608 - Modem support endable:
1609 CONFIG_MODEM_SUPPORT
1611 - RTS/CTS Flow control enable:
1614 - Modem debug support:
1615 CONFIG_MODEM_SUPPORT_DEBUG
1617 Enables debugging stuff (char screen[1024], dbg())
1618 for modem support. Useful only with BDI2000.
1620 - Interrupt support (PPC):
1622 There are common interrupt_init() and timer_interrupt()
1623 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1624 for cpu specific initialization. interrupt_init_cpu()
1625 should set decrementer_count to appropriate value. If
1626 cpu resets decrementer automatically after interrupt
1627 (ppc4xx) it should set decrementer_count to zero.
1628 timer_interrupt() calls timer_interrupt_cpu() for cpu
1629 specific handling. If board has watchdog / status_led
1630 / other_activity_monitor it works automatically from
1631 general timer_interrupt().
1635 In the target system modem support is enabled when a
1636 specific key (key combination) is pressed during
1637 power-on. Otherwise U-Boot will boot normally
1638 (autoboot). The key_pressed() fuction is called from
1639 board_init(). Currently key_pressed() is a dummy
1640 function, returning 1 and thus enabling modem
1643 If there are no modem init strings in the
1644 environment, U-Boot proceed to autoboot; the
1645 previous output (banner, info printfs) will be
1648 See also: doc/README.Modem
1651 Configuration Settings:
1652 -----------------------
1654 - CFG_LONGHELP: Defined when you want long help messages included;
1655 undefine this when you're short of memory.
1657 - CFG_PROMPT: This is what U-Boot prints on the console to
1658 prompt for user input.
1660 - CFG_CBSIZE: Buffer size for input from the Console
1662 - CFG_PBSIZE: Buffer size for Console output
1664 - CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1666 - CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1667 the application (usually a Linux kernel) when it is
1670 - CFG_BAUDRATE_TABLE:
1671 List of legal baudrate settings for this board.
1673 - CFG_CONSOLE_INFO_QUIET
1674 Suppress display of console information at boot.
1676 - CFG_CONSOLE_IS_IN_ENV
1677 If the board specific function
1678 extern int overwrite_console (void);
1679 returns 1, the stdin, stderr and stdout are switched to the
1680 serial port, else the settings in the environment are used.
1682 - CFG_CONSOLE_OVERWRITE_ROUTINE
1683 Enable the call to overwrite_console().
1685 - CFG_CONSOLE_ENV_OVERWRITE
1686 Enable overwrite of previous console environment settings.
1688 - CFG_MEMTEST_START, CFG_MEMTEST_END:
1689 Begin and End addresses of the area used by the
1693 Enable an alternate, more extensive memory test.
1695 - CFG_MEMTEST_SCRATCH:
1696 Scratch address used by the alternate memory test
1697 You only need to set this if address zero isn't writeable
1699 - CFG_TFTP_LOADADDR:
1700 Default load address for network file downloads
1702 - CFG_LOADS_BAUD_CHANGE:
1703 Enable temporary baudrate change while serial download
1706 Physical start address of SDRAM. _Must_ be 0 here.
1709 Physical start address of Motherboard I/O (if using a
1713 Physical start address of Flash memory.
1716 Physical start address of boot monitor code (set by
1717 make config files to be same as the text base address
1718 (TEXT_BASE) used when linking) - same as
1719 CFG_FLASH_BASE when booting from flash.
1722 Size of memory reserved for monitor code, used to
1723 determine _at_compile_time_ (!) if the environment is
1724 embedded within the U-Boot image, or in a separate
1728 Size of DRAM reserved for malloc() use.
1731 Maximum size of memory mapped by the startup code of
1732 the Linux kernel; all data that must be processed by
1733 the Linux kernel (bd_info, boot arguments, eventually
1734 initrd image) must be put below this limit.
1736 - CFG_MAX_FLASH_BANKS:
1737 Max number of Flash memory banks
1739 - CFG_MAX_FLASH_SECT:
1740 Max number of sectors on a Flash chip
1742 - CFG_FLASH_ERASE_TOUT:
1743 Timeout for Flash erase operations (in ms)
1745 - CFG_FLASH_WRITE_TOUT:
1746 Timeout for Flash write operations (in ms)
1748 - CFG_FLASH_LOCK_TOUT
1749 Timeout for Flash set sector lock bit operation (in ms)
1751 - CFG_FLASH_UNLOCK_TOUT
1752 Timeout for Flash clear lock bits operation (in ms)
1754 - CFG_FLASH_PROTECTION
1755 If defined, hardware flash sectors protection is used
1756 instead of U-Boot software protection.
1758 - CFG_DIRECT_FLASH_TFTP:
1760 Enable TFTP transfers directly to flash memory;
1761 without this option such a download has to be
1762 performed in two steps: (1) download to RAM, and (2)
1763 copy from RAM to flash.
1765 The two-step approach is usually more reliable, since
1766 you can check if the download worked before you erase
1767 the flash, but in some situations (when sytem RAM is
1768 too limited to allow for a tempory copy of the
1769 downloaded image) this option may be very useful.
1772 Define if the flash driver uses extra elements in the
1773 common flash structure for storing flash geometry.
1775 - CFG_FLASH_CFI_DRIVER
1776 This option also enables the building of the cfi_flash driver
1777 in the drivers directory
1779 - CFG_FLASH_QUIET_TEST
1780 If this option is defined, the common CFI flash doesn't
1781 print it's warning upon not recognized FLASH banks. This
1782 is useful, if some of the configured banks are only
1783 optionally available.
1785 - CFG_RX_ETH_BUFFER:
1786 Defines the number of ethernet receive buffers. On some
1787 ethernet controllers it is recommended to set this value
1788 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1789 buffers can be full shortly after enabling the interface
1790 on high ethernet traffic.
1791 Defaults to 4 if not defined.
1793 The following definitions that deal with the placement and management
1794 of environment data (variable area); in general, we support the
1795 following configurations:
1797 - CFG_ENV_IS_IN_FLASH:
1799 Define this if the environment is in flash memory.
1801 a) The environment occupies one whole flash sector, which is
1802 "embedded" in the text segment with the U-Boot code. This
1803 happens usually with "bottom boot sector" or "top boot
1804 sector" type flash chips, which have several smaller
1805 sectors at the start or the end. For instance, such a
1806 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1807 such a case you would place the environment in one of the
1808 4 kB sectors - with U-Boot code before and after it. With
1809 "top boot sector" type flash chips, you would put the
1810 environment in one of the last sectors, leaving a gap
1811 between U-Boot and the environment.
1815 Offset of environment data (variable area) to the
1816 beginning of flash memory; for instance, with bottom boot
1817 type flash chips the second sector can be used: the offset
1818 for this sector is given here.
1820 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1824 This is just another way to specify the start address of
1825 the flash sector containing the environment (instead of
1828 - CFG_ENV_SECT_SIZE:
1830 Size of the sector containing the environment.
1833 b) Sometimes flash chips have few, equal sized, BIG sectors.
1834 In such a case you don't want to spend a whole sector for
1839 If you use this in combination with CFG_ENV_IS_IN_FLASH
1840 and CFG_ENV_SECT_SIZE, you can specify to use only a part
1841 of this flash sector for the environment. This saves
1842 memory for the RAM copy of the environment.
1844 It may also save flash memory if you decide to use this
1845 when your environment is "embedded" within U-Boot code,
1846 since then the remainder of the flash sector could be used
1847 for U-Boot code. It should be pointed out that this is
1848 STRONGLY DISCOURAGED from a robustness point of view:
1849 updating the environment in flash makes it always
1850 necessary to erase the WHOLE sector. If something goes
1851 wrong before the contents has been restored from a copy in
1852 RAM, your target system will be dead.
1854 - CFG_ENV_ADDR_REDUND
1857 These settings describe a second storage area used to hold
1858 a redundand copy of the environment data, so that there is
1859 a valid backup copy in case there is a power failure during
1860 a "saveenv" operation.
1862 BE CAREFUL! Any changes to the flash layout, and some changes to the
1863 source code will make it necessary to adapt <board>/u-boot.lds*
1867 - CFG_ENV_IS_IN_NVRAM:
1869 Define this if you have some non-volatile memory device
1870 (NVRAM, battery buffered SRAM) which you want to use for the
1876 These two #defines are used to determin the memory area you
1877 want to use for environment. It is assumed that this memory
1878 can just be read and written to, without any special
1881 BE CAREFUL! The first access to the environment happens quite early
1882 in U-Boot initalization (when we try to get the setting of for the
1883 console baudrate). You *MUST* have mappend your NVRAM area then, or
1886 Please note that even with NVRAM we still use a copy of the
1887 environment in RAM: we could work on NVRAM directly, but we want to
1888 keep settings there always unmodified except somebody uses "saveenv"
1889 to save the current settings.
1892 - CFG_ENV_IS_IN_EEPROM:
1894 Use this if you have an EEPROM or similar serial access
1895 device and a driver for it.
1900 These two #defines specify the offset and size of the
1901 environment area within the total memory of your EEPROM.
1903 - CFG_I2C_EEPROM_ADDR:
1904 If defined, specified the chip address of the EEPROM device.
1905 The default address is zero.
1907 - CFG_EEPROM_PAGE_WRITE_BITS:
1908 If defined, the number of bits used to address bytes in a
1909 single page in the EEPROM device. A 64 byte page, for example
1910 would require six bits.
1912 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1913 If defined, the number of milliseconds to delay between
1914 page writes. The default is zero milliseconds.
1916 - CFG_I2C_EEPROM_ADDR_LEN:
1917 The length in bytes of the EEPROM memory array address. Note
1918 that this is NOT the chip address length!
1920 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
1921 EEPROM chips that implement "address overflow" are ones
1922 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
1923 address and the extra bits end up in the "chip address" bit
1924 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
1927 Note that we consider the length of the address field to
1928 still be one byte because the extra address bits are hidden
1929 in the chip address.
1932 The size in bytes of the EEPROM device.
1935 - CFG_ENV_IS_IN_DATAFLASH:
1937 Define this if you have a DataFlash memory device which you
1938 want to use for the environment.
1944 These three #defines specify the offset and size of the
1945 environment area within the total memory of your DataFlash placed
1946 at the specified address.
1948 - CFG_ENV_IS_IN_NAND:
1950 Define this if you have a NAND device which you want to use
1951 for the environment.
1956 These two #defines specify the offset and size of the environment
1957 area within the first NAND device.
1959 - CFG_SPI_INIT_OFFSET
1961 Defines offset to the initial SPI buffer area in DPRAM. The
1962 area is used at an early stage (ROM part) if the environment
1963 is configured to reside in the SPI EEPROM: We need a 520 byte
1964 scratch DPRAM area. It is used between the two initialization
1965 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1966 to be a good choice since it makes it far enough from the
1967 start of the data area as well as from the stack pointer.
1969 Please note that the environment is read-only as long as the monitor
1970 has been relocated to RAM and a RAM copy of the environment has been
1971 created; also, when using EEPROM you will have to use getenv_r()
1972 until then to read environment variables.
1974 The environment is protected by a CRC32 checksum. Before the monitor
1975 is relocated into RAM, as a result of a bad CRC you will be working
1976 with the compiled-in default environment - *silently*!!! [This is
1977 necessary, because the first environment variable we need is the
1978 "baudrate" setting for the console - if we have a bad CRC, we don't
1979 have any device yet where we could complain.]
1981 Note: once the monitor has been relocated, then it will complain if
1982 the default environment is used; a new CRC is computed as soon as you
1983 use the "saveenv" command to store a valid environment.
1985 - CFG_FAULT_ECHO_LINK_DOWN:
1986 Echo the inverted Ethernet link state to the fault LED.
1988 Note: If this option is active, then CFG_FAULT_MII_ADDR
1989 also needs to be defined.
1991 - CFG_FAULT_MII_ADDR:
1992 MII address of the PHY to check for the Ethernet link state.
1994 - CFG_64BIT_VSPRINTF:
1995 Makes vsprintf (and all *printf functions) support printing
1996 of 64bit values by using the L quantifier
1998 - CFG_64BIT_STRTOUL:
1999 Adds simple_strtoull that returns a 64bit value
2001 Low Level (hardware related) configuration options:
2002 ---------------------------------------------------
2004 - CFG_CACHELINE_SIZE:
2005 Cache Line Size of the CPU.
2008 Default address of the IMMR after system reset.
2010 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2011 and RPXsuper) to be able to adjust the position of
2012 the IMMR register after a reset.
2014 - Floppy Disk Support:
2015 CFG_FDC_DRIVE_NUMBER
2017 the default drive number (default value 0)
2021 defines the spacing between fdc chipset registers
2026 defines the offset of register from address. It
2027 depends on which part of the data bus is connected to
2028 the fdc chipset. (default value 0)
2030 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
2031 CFG_FDC_DRIVE_NUMBER are undefined, they take their
2034 if CFG_FDC_HW_INIT is defined, then the function
2035 fdc_hw_init() is called at the beginning of the FDC
2036 setup. fdc_hw_init() must be provided by the board
2037 source code. It is used to make hardware dependant
2040 - CFG_IMMR: Physical address of the Internal Memory.
2041 DO NOT CHANGE unless you know exactly what you're
2042 doing! (11-4) [MPC8xx/82xx systems only]
2044 - CFG_INIT_RAM_ADDR:
2046 Start address of memory area that can be used for
2047 initial data and stack; please note that this must be
2048 writable memory that is working WITHOUT special
2049 initialization, i. e. you CANNOT use normal RAM which
2050 will become available only after programming the
2051 memory controller and running certain initialization
2054 U-Boot uses the following memory types:
2055 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2056 - MPC824X: data cache
2057 - PPC4xx: data cache
2059 - CFG_GBL_DATA_OFFSET:
2061 Offset of the initial data structure in the memory
2062 area defined by CFG_INIT_RAM_ADDR. Usually
2063 CFG_GBL_DATA_OFFSET is chosen such that the initial
2064 data is located at the end of the available space
2065 (sometimes written as (CFG_INIT_RAM_END -
2066 CFG_INIT_DATA_SIZE), and the initial stack is just
2067 below that area (growing from (CFG_INIT_RAM_ADDR +
2068 CFG_GBL_DATA_OFFSET) downward.
2071 On the MPC824X (or other systems that use the data
2072 cache for initial memory) the address chosen for
2073 CFG_INIT_RAM_ADDR is basically arbitrary - it must
2074 point to an otherwise UNUSED address space between
2075 the top of RAM and the start of the PCI space.
2077 - CFG_SIUMCR: SIU Module Configuration (11-6)
2079 - CFG_SYPCR: System Protection Control (11-9)
2081 - CFG_TBSCR: Time Base Status and Control (11-26)
2083 - CFG_PISCR: Periodic Interrupt Status and Control (11-31)
2085 - CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
2087 - CFG_SCCR: System Clock and reset Control Register (15-27)
2089 - CFG_OR_TIMING_SDRAM:
2093 periodic timer for refresh
2095 - CFG_DER: Debug Event Register (37-47)
2097 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2098 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2099 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2101 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2103 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2104 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2105 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2106 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2108 - CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2109 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2110 Machine Mode Register and Memory Periodic Timer
2111 Prescaler definitions (SDRAM timing)
2113 - CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2114 enable I2C microcode relocation patch (MPC8xx);
2115 define relocation offset in DPRAM [DSP2]
2117 - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2118 enable SPI microcode relocation patch (MPC8xx);
2119 define relocation offset in DPRAM [SCC4]
2122 Use OSCM clock mode on MBX8xx board. Be careful,
2123 wrong setting might damage your board. Read
2124 doc/README.MBX before setting this variable!
2126 - CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2127 Offset of the bootmode word in DPRAM used by post
2128 (Power On Self Tests). This definition overrides
2129 #define'd default value in commproc.h resp.
2132 - CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2133 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2134 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2135 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2136 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2137 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2138 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
2139 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2140 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2142 - CONFIG_ETHER_ON_FEC[12]
2143 Define to enable FEC[12] on a 8xx series processor.
2145 - CONFIG_FEC[12]_PHY
2146 Define to the hardcoded PHY address which corresponds
2147 to the given FEC; i. e.
2148 #define CONFIG_FEC1_PHY 4
2149 means that the PHY with address 4 is connected to FEC1
2151 When set to -1, means to probe for first available.
2153 - CONFIG_FEC[12]_PHY_NORXERR
2154 The PHY does not have a RXERR line (RMII only).
2155 (so program the FEC to ignore it).
2158 Enable RMII mode for all FECs.
2159 Note that this is a global option, we can't
2160 have one FEC in standard MII mode and another in RMII mode.
2162 - CONFIG_CRC32_VERIFY
2163 Add a verify option to the crc32 command.
2166 => crc32 -v <address> <count> <crc32>
2168 Where address/count indicate a memory area
2169 and crc32 is the correct crc32 which the
2173 Add the "loopw" memory command. This only takes effect if
2174 the memory commands are activated globally (CFG_CMD_MEM).
2177 Add the "mdc" and "mwc" memory commands. These are cyclic
2182 This command will print 4 bytes (10,11,12,13) each 500 ms.
2184 => mwc.l 100 12345678 10
2185 This command will write 12345678 to address 100 all 10 ms.
2187 This only takes effect if the memory commands are activated
2188 globally (CFG_CMD_MEM).
2190 - CONFIG_SKIP_LOWLEVEL_INIT
2191 - CONFIG_SKIP_RELOCATE_UBOOT
2193 [ARM only] If these variables are defined, then
2194 certain low level initializations (like setting up
2195 the memory controller) are omitted and/or U-Boot does
2196 not relocate itself into RAM.
2197 Normally these variables MUST NOT be defined. The
2198 only exception is when U-Boot is loaded (to RAM) by
2199 some other boot loader or by a debugger which
2200 performs these intializations itself.
2203 Building the Software:
2204 ======================
2206 Building U-Boot has been tested in native PPC environments (on a
2207 PowerBook G3 running LinuxPPC 2000) and in cross environments
2208 (running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2211 If you are not using a native PPC environment, it is assumed that you
2212 have the GNU cross compiling tools available in your path and named
2213 with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2214 you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2215 the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2218 CROSS_COMPILE = ppc_4xx-
2221 U-Boot is intended to be simple to build. After installing the
2222 sources you must configure U-Boot for one specific board type. This
2227 where "NAME_config" is the name of one of the existing
2228 configurations; the following names are supported:
2230 ADCIOP_config FPS860L_config omap730p2_config
2231 ADS860_config GEN860T_config pcu_e_config
2233 AR405_config GENIETV_config PIP405_config
2234 at91rm9200dk_config GTH_config QS823_config
2235 CANBT_config hermes_config QS850_config
2236 cmi_mpc5xx_config hymod_config QS860T_config
2237 cogent_common_config IP860_config RPXlite_config
2238 cogent_mpc8260_config IVML24_config RPXlite_DW_config
2239 cogent_mpc8xx_config IVMS8_config RPXsuper_config
2240 CPCI405_config JSE_config rsdproto_config
2241 CPCIISER4_config LANTEC_config Sandpoint8240_config
2242 csb272_config lwmon_config sbc8260_config
2243 CU824_config MBX860T_config sbc8560_33_config
2244 DUET_ADS_config MBX_config sbc8560_66_config
2245 EBONY_config MPC8260ADS_config SM850_config
2246 ELPT860_config MPC8540ADS_config SPD823TS_config
2247 ESTEEM192E_config MPC8540EVAL_config stxgp3_config
2248 ETX094_config MPC8560ADS_config SXNI855T_config
2249 FADS823_config NETVIA_config TQM823L_config
2250 FADS850SAR_config omap1510inn_config TQM850L_config
2251 FADS860T_config omap1610h2_config TQM855L_config
2252 FPS850L_config omap1610inn_config TQM860L_config
2253 omap5912osk_config walnut_config
2254 omap2420h4_config Yukon8220_config
2257 Note: for some board special configuration names may exist; check if
2258 additional information is available from the board vendor; for
2259 instance, the TQM823L systems are available without (standard)
2260 or with LCD support. You can select such additional "features"
2261 when chosing the configuration, i. e.
2264 - will configure for a plain TQM823L, i. e. no LCD support
2266 make TQM823L_LCD_config
2267 - will configure for a TQM823L with U-Boot console on LCD
2272 Finally, type "make all", and you should get some working U-Boot
2273 images ready for download to / installation on your system:
2275 - "u-boot.bin" is a raw binary image
2276 - "u-boot" is an image in ELF binary format
2277 - "u-boot.srec" is in Motorola S-Record format
2280 Please be aware that the Makefiles assume you are using GNU make, so
2281 for instance on NetBSD you might need to use "gmake" instead of
2285 If the system board that you have is not listed, then you will need
2286 to port U-Boot to your hardware platform. To do this, follow these
2289 1. Add a new configuration option for your board to the toplevel
2290 "Makefile" and to the "MAKEALL" script, using the existing
2291 entries as examples. Note that here and at many other places
2292 boards and other names are listed in alphabetical sort order. Please
2294 2. Create a new directory to hold your board specific code. Add any
2295 files you need. In your board directory, you will need at least
2296 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
2297 3. Create a new configuration file "include/configs/<board>.h" for
2299 3. If you're porting U-Boot to a new CPU, then also create a new
2300 directory to hold your CPU specific code. Add any files you need.
2301 4. Run "make <board>_config" with your new name.
2302 5. Type "make", and you should get a working "u-boot.srec" file
2303 to be installed on your target system.
2304 6. Debug and solve any problems that might arise.
2305 [Of course, this last step is much harder than it sounds.]
2308 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2309 ==============================================================
2311 If you have modified U-Boot sources (for instance added a new board
2312 or support for new devices, a new CPU, etc.) you are expected to
2313 provide feedback to the other developers. The feedback normally takes
2314 the form of a "patch", i. e. a context diff against a certain (latest
2315 official or latest in CVS) version of U-Boot sources.
2317 But before you submit such a patch, please verify that your modifi-
2318 cation did not break existing code. At least make sure that *ALL* of
2319 the supported boards compile WITHOUT ANY compiler warnings. To do so,
2320 just run the "MAKEALL" script, which will configure and build U-Boot
2321 for ALL supported system. Be warned, this will take a while. You can
2322 select which (cross) compiler to use by passing a `CROSS_COMPILE'
2323 environment variable to the script, i. e. to use the cross tools from
2324 MontaVista's Hard Hat Linux you can type
2326 CROSS_COMPILE=ppc_8xx- MAKEALL
2328 or to build on a native PowerPC system you can type
2330 CROSS_COMPILE=' ' MAKEALL
2332 See also "U-Boot Porting Guide" below.
2335 Monitor Commands - Overview:
2336 ============================
2338 go - start application at address 'addr'
2339 run - run commands in an environment variable
2340 bootm - boot application image from memory
2341 bootp - boot image via network using BootP/TFTP protocol
2342 tftpboot- boot image via network using TFTP protocol
2343 and env variables "ipaddr" and "serverip"
2344 (and eventually "gatewayip")
2345 rarpboot- boot image via network using RARP/TFTP protocol
2346 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2347 loads - load S-Record file over serial line
2348 loadb - load binary file over serial line (kermit mode)
2350 mm - memory modify (auto-incrementing)
2351 nm - memory modify (constant address)
2352 mw - memory write (fill)
2354 cmp - memory compare
2355 crc32 - checksum calculation
2356 imd - i2c memory display
2357 imm - i2c memory modify (auto-incrementing)
2358 inm - i2c memory modify (constant address)
2359 imw - i2c memory write (fill)
2360 icrc32 - i2c checksum calculation
2361 iprobe - probe to discover valid I2C chip addresses
2362 iloop - infinite loop on address range
2363 isdram - print SDRAM configuration information
2364 sspi - SPI utility commands
2365 base - print or set address offset
2366 printenv- print environment variables
2367 setenv - set environment variables
2368 saveenv - save environment variables to persistent storage
2369 protect - enable or disable FLASH write protection
2370 erase - erase FLASH memory
2371 flinfo - print FLASH memory information
2372 bdinfo - print Board Info structure
2373 iminfo - print header information for application image
2374 coninfo - print console devices and informations
2375 ide - IDE sub-system
2376 loop - infinite loop on address range
2377 loopw - infinite write loop on address range
2378 mtest - simple RAM test
2379 icache - enable or disable instruction cache
2380 dcache - enable or disable data cache
2381 reset - Perform RESET of the CPU
2382 echo - echo args to console
2383 version - print monitor version
2384 help - print online help
2385 ? - alias for 'help'
2388 Monitor Commands - Detailed Description:
2389 ========================================
2393 For now: just type "help <command>".
2396 Environment Variables:
2397 ======================
2399 U-Boot supports user configuration using Environment Variables which
2400 can be made persistent by saving to Flash memory.
2402 Environment Variables are set using "setenv", printed using
2403 "printenv", and saved to Flash using "saveenv". Using "setenv"
2404 without a value can be used to delete a variable from the
2405 environment. As long as you don't save the environment you are
2406 working with an in-memory copy. In case the Flash area containing the
2407 environment is erased by accident, a default environment is provided.
2409 Some configuration options can be set using Environment Variables:
2411 baudrate - see CONFIG_BAUDRATE
2413 bootdelay - see CONFIG_BOOTDELAY
2415 bootcmd - see CONFIG_BOOTCOMMAND
2417 bootargs - Boot arguments when booting an RTOS image
2419 bootfile - Name of the image to load with TFTP
2421 autoload - if set to "no" (any string beginning with 'n'),
2422 "bootp" will just load perform a lookup of the
2423 configuration from the BOOTP server, but not try to
2424 load any image using TFTP
2426 autostart - if set to "yes", an image loaded using the "bootp",
2427 "rarpboot", "tftpboot" or "diskboot" commands will
2428 be automatically started (by internally calling
2431 If set to "no", a standalone image passed to the
2432 "bootm" command will be copied to the load address
2433 (and eventually uncompressed), but NOT be started.
2434 This can be used to load and uncompress arbitrary
2437 i2cfast - (PPC405GP|PPC405EP only)
2438 if set to 'y' configures Linux I2C driver for fast
2439 mode (400kHZ). This environment variable is used in
2440 initialization code. So, for changes to be effective
2441 it must be saved and board must be reset.
2443 initrd_high - restrict positioning of initrd images:
2444 If this variable is not set, initrd images will be
2445 copied to the highest possible address in RAM; this
2446 is usually what you want since it allows for
2447 maximum initrd size. If for some reason you want to
2448 make sure that the initrd image is loaded below the
2449 CFG_BOOTMAPSZ limit, you can set this environment
2450 variable to a value of "no" or "off" or "0".
2451 Alternatively, you can set it to a maximum upper
2452 address to use (U-Boot will still check that it
2453 does not overwrite the U-Boot stack and data).
2455 For instance, when you have a system with 16 MB
2456 RAM, and want to reserve 4 MB from use by Linux,
2457 you can do this by adding "mem=12M" to the value of
2458 the "bootargs" variable. However, now you must make
2459 sure that the initrd image is placed in the first
2460 12 MB as well - this can be done with
2462 setenv initrd_high 00c00000
2464 If you set initrd_high to 0xFFFFFFFF, this is an
2465 indication to U-Boot that all addresses are legal
2466 for the Linux kernel, including addresses in flash
2467 memory. In this case U-Boot will NOT COPY the
2468 ramdisk at all. This may be useful to reduce the
2469 boot time on your system, but requires that this
2470 feature is supported by your Linux kernel.
2472 ipaddr - IP address; needed for tftpboot command
2474 loadaddr - Default load address for commands like "bootp",
2475 "rarpboot", "tftpboot", "loadb" or "diskboot"
2477 loads_echo - see CONFIG_LOADS_ECHO
2479 serverip - TFTP server IP address; needed for tftpboot command
2481 bootretry - see CONFIG_BOOT_RETRY_TIME
2483 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
2485 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
2487 ethprime - When CONFIG_NET_MULTI is enabled controls which
2488 interface is used first.
2490 ethact - When CONFIG_NET_MULTI is enabled controls which
2491 interface is currently active. For example you
2492 can do the following
2494 => setenv ethact FEC ETHERNET
2495 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2496 => setenv ethact SCC ETHERNET
2497 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2499 netretry - When set to "no" each network operation will
2500 either succeed or fail without retrying.
2501 When set to "once" the network operation will
2502 fail when all the available network interfaces
2503 are tried once without success.
2504 Useful on scripts which control the retry operation
2507 tftpsrcport - If this is set, the value is used for TFTP's
2510 tftpdstport - If this is set, the value is used for TFTP's UDP
2511 destination port instead of the Well Know Port 69.
2513 vlan - When set to a value < 4095 the traffic over
2514 ethernet is encapsulated/received over 802.1q
2517 The following environment variables may be used and automatically
2518 updated by the network boot commands ("bootp" and "rarpboot"),
2519 depending the information provided by your boot server:
2521 bootfile - see above
2522 dnsip - IP address of your Domain Name Server
2523 dnsip2 - IP address of your secondary Domain Name Server
2524 gatewayip - IP address of the Gateway (Router) to use
2525 hostname - Target hostname
2527 netmask - Subnet Mask
2528 rootpath - Pathname of the root filesystem on the NFS server
2529 serverip - see above
2532 There are two special Environment Variables:
2534 serial# - contains hardware identification information such
2535 as type string and/or serial number
2536 ethaddr - Ethernet address
2538 These variables can be set only once (usually during manufacturing of
2539 the board). U-Boot refuses to delete or overwrite these variables
2540 once they have been set once.
2543 Further special Environment Variables:
2545 ver - Contains the U-Boot version string as printed
2546 with the "version" command. This variable is
2547 readonly (see CONFIG_VERSION_VARIABLE).
2550 Please note that changes to some configuration parameters may take
2551 only effect after the next boot (yes, that's just like Windoze :-).
2554 Command Line Parsing:
2555 =====================
2557 There are two different command line parsers available with U-Boot:
2558 the old "simple" one, and the much more powerful "hush" shell:
2560 Old, simple command line parser:
2561 --------------------------------
2563 - supports environment variables (through setenv / saveenv commands)
2564 - several commands on one line, separated by ';'
2565 - variable substitution using "... ${name} ..." syntax
2566 - special characters ('$', ';') can be escaped by prefixing with '\',
2568 setenv bootcmd bootm \${address}
2569 - You can also escape text by enclosing in single apostrophes, for example:
2570 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2575 - similar to Bourne shell, with control structures like
2576 if...then...else...fi, for...do...done; while...do...done,
2577 until...do...done, ...
2578 - supports environment ("global") variables (through setenv / saveenv
2579 commands) and local shell variables (through standard shell syntax
2580 "name=value"); only environment variables can be used with "run"
2586 (1) If a command line (or an environment variable executed by a "run"
2587 command) contains several commands separated by semicolon, and
2588 one of these commands fails, then the remaining commands will be
2591 (2) If you execute several variables with one call to run (i. e.
2592 calling run with a list af variables as arguments), any failing
2593 command will cause "run" to terminate, i. e. the remaining
2594 variables are not executed.
2596 Note for Redundant Ethernet Interfaces:
2597 =======================================
2599 Some boards come with redundant ethernet interfaces; U-Boot supports
2600 such configurations and is capable of automatic selection of a
2601 "working" interface when needed. MAC assignment works as follows:
2603 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2604 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2605 "eth1addr" (=>eth1), "eth2addr", ...
2607 If the network interface stores some valid MAC address (for instance
2608 in SROM), this is used as default address if there is NO correspon-
2609 ding setting in the environment; if the corresponding environment
2610 variable is set, this overrides the settings in the card; that means:
2612 o If the SROM has a valid MAC address, and there is no address in the
2613 environment, the SROM's address is used.
2615 o If there is no valid address in the SROM, and a definition in the
2616 environment exists, then the value from the environment variable is
2619 o If both the SROM and the environment contain a MAC address, and
2620 both addresses are the same, this MAC address is used.
2622 o If both the SROM and the environment contain a MAC address, and the
2623 addresses differ, the value from the environment is used and a
2626 o If neither SROM nor the environment contain a MAC address, an error
2633 The "boot" commands of this monitor operate on "image" files which
2634 can be basicly anything, preceeded by a special header; see the
2635 definitions in include/image.h for details; basicly, the header
2636 defines the following image properties:
2638 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2639 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2640 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2641 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2642 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2643 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2644 Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2645 * Compression Type (uncompressed, gzip, bzip2)
2651 The header is marked by a special Magic Number, and both the header
2652 and the data portions of the image are secured against corruption by
2659 Although U-Boot should support any OS or standalone application
2660 easily, the main focus has always been on Linux during the design of
2663 U-Boot includes many features that so far have been part of some
2664 special "boot loader" code within the Linux kernel. Also, any
2665 "initrd" images to be used are no longer part of one big Linux image;
2666 instead, kernel and "initrd" are separate images. This implementation
2667 serves several purposes:
2669 - the same features can be used for other OS or standalone
2670 applications (for instance: using compressed images to reduce the
2671 Flash memory footprint)
2673 - it becomes much easier to port new Linux kernel versions because
2674 lots of low-level, hardware dependent stuff are done by U-Boot
2676 - the same Linux kernel image can now be used with different "initrd"
2677 images; of course this also means that different kernel images can
2678 be run with the same "initrd". This makes testing easier (you don't
2679 have to build a new "zImage.initrd" Linux image when you just
2680 change a file in your "initrd"). Also, a field-upgrade of the
2681 software is easier now.
2687 Porting Linux to U-Boot based systems:
2688 ---------------------------------------
2690 U-Boot cannot save you from doing all the necessary modifications to
2691 configure the Linux device drivers for use with your target hardware
2692 (no, we don't intend to provide a full virtual machine interface to
2695 But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2697 Just make sure your machine specific header file (for instance
2698 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2699 Information structure as we define in include/u-boot.h, and make
2700 sure that your definition of IMAP_ADDR uses the same value as your
2701 U-Boot configuration in CFG_IMMR.
2704 Configuring the Linux kernel:
2705 -----------------------------
2707 No specific requirements for U-Boot. Make sure you have some root
2708 device (initial ramdisk, NFS) for your target system.
2711 Building a Linux Image:
2712 -----------------------
2714 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2715 not used. If you use recent kernel source, a new build target
2716 "uImage" will exist which automatically builds an image usable by
2717 U-Boot. Most older kernels also have support for a "pImage" target,
2718 which was introduced for our predecessor project PPCBoot and uses a
2719 100% compatible format.
2728 The "uImage" build target uses a special tool (in 'tools/mkimage') to
2729 encapsulate a compressed Linux kernel image with header information,
2730 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2732 * build a standard "vmlinux" kernel image (in ELF binary format):
2734 * convert the kernel into a raw binary image:
2736 ${CROSS_COMPILE}-objcopy -O binary \
2737 -R .note -R .comment \
2738 -S vmlinux linux.bin
2740 * compress the binary image:
2744 * package compressed binary image for U-Boot:
2746 mkimage -A ppc -O linux -T kernel -C gzip \
2747 -a 0 -e 0 -n "Linux Kernel Image" \
2748 -d linux.bin.gz uImage
2751 The "mkimage" tool can also be used to create ramdisk images for use
2752 with U-Boot, either separated from the Linux kernel image, or
2753 combined into one file. "mkimage" encapsulates the images with a 64
2754 byte header containing information about target architecture,
2755 operating system, image type, compression method, entry points, time
2756 stamp, CRC32 checksums, etc.
2758 "mkimage" can be called in two ways: to verify existing images and
2759 print the header information, or to build new images.
2761 In the first form (with "-l" option) mkimage lists the information
2762 contained in the header of an existing U-Boot image; this includes
2763 checksum verification:
2765 tools/mkimage -l image
2766 -l ==> list image header information
2768 The second form (with "-d" option) is used to build a U-Boot image
2769 from a "data file" which is used as image payload:
2771 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2772 -n name -d data_file image
2773 -A ==> set architecture to 'arch'
2774 -O ==> set operating system to 'os'
2775 -T ==> set image type to 'type'
2776 -C ==> set compression type 'comp'
2777 -a ==> set load address to 'addr' (hex)
2778 -e ==> set entry point to 'ep' (hex)
2779 -n ==> set image name to 'name'
2780 -d ==> use image data from 'datafile'
2782 Right now, all Linux kernels for PowerPC systems use the same load
2783 address (0x00000000), but the entry point address depends on the
2786 - 2.2.x kernels have the entry point at 0x0000000C,
2787 - 2.3.x and later kernels have the entry point at 0x00000000.
2789 So a typical call to build a U-Boot image would read:
2791 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2792 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2793 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2794 > examples/uImage.TQM850L
2795 Image Name: 2.4.4 kernel for TQM850L
2796 Created: Wed Jul 19 02:34:59 2000
2797 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2798 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2799 Load Address: 0x00000000
2800 Entry Point: 0x00000000
2802 To verify the contents of the image (or check for corruption):
2804 -> tools/mkimage -l examples/uImage.TQM850L
2805 Image Name: 2.4.4 kernel for TQM850L
2806 Created: Wed Jul 19 02:34:59 2000
2807 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2808 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2809 Load Address: 0x00000000
2810 Entry Point: 0x00000000
2812 NOTE: for embedded systems where boot time is critical you can trade
2813 speed for memory and install an UNCOMPRESSED image instead: this
2814 needs more space in Flash, but boots much faster since it does not
2815 need to be uncompressed:
2817 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2818 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2819 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2820 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2821 > examples/uImage.TQM850L-uncompressed
2822 Image Name: 2.4.4 kernel for TQM850L
2823 Created: Wed Jul 19 02:34:59 2000
2824 Image Type: PowerPC Linux Kernel Image (uncompressed)
2825 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2826 Load Address: 0x00000000
2827 Entry Point: 0x00000000
2830 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2831 when your kernel is intended to use an initial ramdisk:
2833 -> tools/mkimage -n 'Simple Ramdisk Image' \
2834 > -A ppc -O linux -T ramdisk -C gzip \
2835 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2836 Image Name: Simple Ramdisk Image
2837 Created: Wed Jan 12 14:01:50 2000
2838 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2839 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2840 Load Address: 0x00000000
2841 Entry Point: 0x00000000
2844 Installing a Linux Image:
2845 -------------------------
2847 To downloading a U-Boot image over the serial (console) interface,
2848 you must convert the image to S-Record format:
2850 objcopy -I binary -O srec examples/image examples/image.srec
2852 The 'objcopy' does not understand the information in the U-Boot
2853 image header, so the resulting S-Record file will be relative to
2854 address 0x00000000. To load it to a given address, you need to
2855 specify the target address as 'offset' parameter with the 'loads'
2858 Example: install the image to address 0x40100000 (which on the
2859 TQM8xxL is in the first Flash bank):
2861 => erase 40100000 401FFFFF
2867 ## Ready for S-Record download ...
2868 ~>examples/image.srec
2869 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2871 15989 15990 15991 15992
2872 [file transfer complete]
2874 ## Start Addr = 0x00000000
2877 You can check the success of the download using the 'iminfo' command;
2878 this includes a checksum verification so you can be sure no data
2879 corruption happened:
2883 ## Checking Image at 40100000 ...
2884 Image Name: 2.2.13 for initrd on TQM850L
2885 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2886 Data Size: 335725 Bytes = 327 kB = 0 MB
2887 Load Address: 00000000
2888 Entry Point: 0000000c
2889 Verifying Checksum ... OK
2895 The "bootm" command is used to boot an application that is stored in
2896 memory (RAM or Flash). In case of a Linux kernel image, the contents
2897 of the "bootargs" environment variable is passed to the kernel as
2898 parameters. You can check and modify this variable using the
2899 "printenv" and "setenv" commands:
2902 => printenv bootargs
2903 bootargs=root=/dev/ram
2905 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2907 => printenv bootargs
2908 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2911 ## Booting Linux kernel at 40020000 ...
2912 Image Name: 2.2.13 for NFS on TQM850L
2913 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2914 Data Size: 381681 Bytes = 372 kB = 0 MB
2915 Load Address: 00000000
2916 Entry Point: 0000000c
2917 Verifying Checksum ... OK
2918 Uncompressing Kernel Image ... OK
2919 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
2920 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2921 time_init: decrementer frequency = 187500000/60
2922 Calibrating delay loop... 49.77 BogoMIPS
2923 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2926 If you want to boot a Linux kernel with initial ram disk, you pass
2927 the memory addresses of both the kernel and the initrd image (PPBCOOT
2928 format!) to the "bootm" command:
2930 => imi 40100000 40200000
2932 ## Checking Image at 40100000 ...
2933 Image Name: 2.2.13 for initrd on TQM850L
2934 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2935 Data Size: 335725 Bytes = 327 kB = 0 MB
2936 Load Address: 00000000
2937 Entry Point: 0000000c
2938 Verifying Checksum ... OK
2940 ## Checking Image at 40200000 ...
2941 Image Name: Simple Ramdisk Image
2942 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2943 Data Size: 566530 Bytes = 553 kB = 0 MB
2944 Load Address: 00000000
2945 Entry Point: 00000000
2946 Verifying Checksum ... OK
2948 => bootm 40100000 40200000
2949 ## Booting Linux kernel at 40100000 ...
2950 Image Name: 2.2.13 for initrd on TQM850L
2951 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2952 Data Size: 335725 Bytes = 327 kB = 0 MB
2953 Load Address: 00000000
2954 Entry Point: 0000000c
2955 Verifying Checksum ... OK
2956 Uncompressing Kernel Image ... OK
2957 ## Loading RAMDisk Image at 40200000 ...
2958 Image Name: Simple Ramdisk Image
2959 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2960 Data Size: 566530 Bytes = 553 kB = 0 MB
2961 Load Address: 00000000
2962 Entry Point: 00000000
2963 Verifying Checksum ... OK
2964 Loading Ramdisk ... OK
2965 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
2966 Boot arguments: root=/dev/ram
2967 time_init: decrementer frequency = 187500000/60
2968 Calibrating delay loop... 49.77 BogoMIPS
2970 RAMDISK: Compressed image found at block 0
2971 VFS: Mounted root (ext2 filesystem).
2975 More About U-Boot Image Types:
2976 ------------------------------
2978 U-Boot supports the following image types:
2980 "Standalone Programs" are directly runnable in the environment
2981 provided by U-Boot; it is expected that (if they behave
2982 well) you can continue to work in U-Boot after return from
2983 the Standalone Program.
2984 "OS Kernel Images" are usually images of some Embedded OS which
2985 will take over control completely. Usually these programs
2986 will install their own set of exception handlers, device
2987 drivers, set up the MMU, etc. - this means, that you cannot
2988 expect to re-enter U-Boot except by resetting the CPU.
2989 "RAMDisk Images" are more or less just data blocks, and their
2990 parameters (address, size) are passed to an OS kernel that is
2992 "Multi-File Images" contain several images, typically an OS
2993 (Linux) kernel image and one or more data images like
2994 RAMDisks. This construct is useful for instance when you want
2995 to boot over the network using BOOTP etc., where the boot
2996 server provides just a single image file, but you want to get
2997 for instance an OS kernel and a RAMDisk image.
2999 "Multi-File Images" start with a list of image sizes, each
3000 image size (in bytes) specified by an "uint32_t" in network
3001 byte order. This list is terminated by an "(uint32_t)0".
3002 Immediately after the terminating 0 follow the images, one by
3003 one, all aligned on "uint32_t" boundaries (size rounded up to
3004 a multiple of 4 bytes).
3006 "Firmware Images" are binary images containing firmware (like
3007 U-Boot or FPGA images) which usually will be programmed to
3010 "Script files" are command sequences that will be executed by
3011 U-Boot's command interpreter; this feature is especially
3012 useful when you configure U-Boot to use a real shell (hush)
3013 as command interpreter.
3019 One of the features of U-Boot is that you can dynamically load and
3020 run "standalone" applications, which can use some resources of
3021 U-Boot like console I/O functions or interrupt services.
3023 Two simple examples are included with the sources:
3028 'examples/hello_world.c' contains a small "Hello World" Demo
3029 application; it is automatically compiled when you build U-Boot.
3030 It's configured to run at address 0x00040004, so you can play with it
3034 ## Ready for S-Record download ...
3035 ~>examples/hello_world.srec
3036 1 2 3 4 5 6 7 8 9 10 11 ...
3037 [file transfer complete]
3039 ## Start Addr = 0x00040004
3041 => go 40004 Hello World! This is a test.
3042 ## Starting application at 0x00040004 ...
3053 Hit any key to exit ...
3055 ## Application terminated, rc = 0x0
3057 Another example, which demonstrates how to register a CPM interrupt
3058 handler with the U-Boot code, can be found in 'examples/timer.c'.
3059 Here, a CPM timer is set up to generate an interrupt every second.
3060 The interrupt service routine is trivial, just printing a '.'
3061 character, but this is just a demo program. The application can be
3062 controlled by the following keys:
3064 ? - print current values og the CPM Timer registers
3065 b - enable interrupts and start timer
3066 e - stop timer and disable interrupts
3067 q - quit application
3070 ## Ready for S-Record download ...
3071 ~>examples/timer.srec
3072 1 2 3 4 5 6 7 8 9 10 11 ...
3073 [file transfer complete]
3075 ## Start Addr = 0x00040004
3078 ## Starting application at 0x00040004 ...
3081 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3084 [q, b, e, ?] Set interval 1000000 us
3087 [q, b, e, ?] ........
3088 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3091 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3094 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3097 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3099 [q, b, e, ?] ...Stopping timer
3101 [q, b, e, ?] ## Application terminated, rc = 0x0
3107 Over time, many people have reported problems when trying to use the
3108 "minicom" terminal emulation program for serial download. I (wd)
3109 consider minicom to be broken, and recommend not to use it. Under
3110 Unix, I recommend to use C-Kermit for general purpose use (and
3111 especially for kermit binary protocol download ("loadb" command), and
3112 use "cu" for S-Record download ("loads" command).
3114 Nevertheless, if you absolutely want to use it try adding this
3115 configuration to your "File transfer protocols" section:
3117 Name Program Name U/D FullScr IO-Red. Multi
3118 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3119 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
3125 Starting at version 0.9.2, U-Boot supports NetBSD both as host
3126 (build U-Boot) and target system (boots NetBSD/mpc8xx).
3128 Building requires a cross environment; it is known to work on
3129 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3130 need gmake since the Makefiles are not compatible with BSD make).
3131 Note that the cross-powerpc package does not install include files;
3132 attempting to build U-Boot will fail because <machine/ansi.h> is
3133 missing. This file has to be installed and patched manually:
3135 # cd /usr/pkg/cross/powerpc-netbsd/include
3137 # ln -s powerpc machine
3138 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3139 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
3141 Native builds *don't* work due to incompatibilities between native
3142 and U-Boot include files.
3144 Booting assumes that (the first part of) the image booted is a
3145 stage-2 loader which in turn loads and then invokes the kernel
3146 proper. Loader sources will eventually appear in the NetBSD source
3147 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
3148 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3151 Implementation Internals:
3152 =========================
3154 The following is not intended to be a complete description of every
3155 implementation detail. However, it should help to understand the
3156 inner workings of U-Boot and make it easier to port it to custom
3160 Initial Stack, Global Data:
3161 ---------------------------
3163 The implementation of U-Boot is complicated by the fact that U-Boot
3164 starts running out of ROM (flash memory), usually without access to
3165 system RAM (because the memory controller is not initialized yet).
3166 This means that we don't have writable Data or BSS segments, and BSS
3167 is not initialized as zero. To be able to get a C environment working
3168 at all, we have to allocate at least a minimal stack. Implementation
3169 options for this are defined and restricted by the CPU used: Some CPU
3170 models provide on-chip memory (like the IMMR area on MPC8xx and
3171 MPC826x processors), on others (parts of) the data cache can be
3172 locked as (mis-) used as memory, etc.
3174 Chris Hallinan posted a good summary of these issues to the
3175 u-boot-users mailing list:
3177 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3178 From: "Chris Hallinan" <clh@net1plus.com>
3179 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3182 Correct me if I'm wrong, folks, but the way I understand it
3183 is this: Using DCACHE as initial RAM for Stack, etc, does not
3184 require any physical RAM backing up the cache. The cleverness
3185 is that the cache is being used as a temporary supply of
3186 necessary storage before the SDRAM controller is setup. It's
3187 beyond the scope of this list to expain the details, but you
3188 can see how this works by studying the cache architecture and
3189 operation in the architecture and processor-specific manuals.
3191 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3192 is another option for the system designer to use as an
3193 initial stack/ram area prior to SDRAM being available. Either
3194 option should work for you. Using CS 4 should be fine if your
3195 board designers haven't used it for something that would
3196 cause you grief during the initial boot! It is frequently not
3199 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3200 with your processor/board/system design. The default value
3201 you will find in any recent u-boot distribution in
3202 walnut.h should work for you. I'd set it to a value larger
3203 than your SDRAM module. If you have a 64MB SDRAM module, set
3204 it above 400_0000. Just make sure your board has no resources
3205 that are supposed to respond to that address! That code in
3206 start.S has been around a while and should work as is when
3207 you get the config right.
3212 It is essential to remember this, since it has some impact on the C
3213 code for the initialization procedures:
3215 * Initialized global data (data segment) is read-only. Do not attempt
3218 * Do not use any unitialized global data (or implicitely initialized
3219 as zero data - BSS segment) at all - this is undefined, initiali-
3220 zation is performed later (when relocating to RAM).
3222 * Stack space is very limited. Avoid big data buffers or things like
3225 Having only the stack as writable memory limits means we cannot use
3226 normal global data to share information beween the code. But it
3227 turned out that the implementation of U-Boot can be greatly
3228 simplified by making a global data structure (gd_t) available to all
3229 functions. We could pass a pointer to this data as argument to _all_
3230 functions, but this would bloat the code. Instead we use a feature of
3231 the GCC compiler (Global Register Variables) to share the data: we
3232 place a pointer (gd) to the global data into a register which we
3233 reserve for this purpose.
3235 When choosing a register for such a purpose we are restricted by the
3236 relevant (E)ABI specifications for the current architecture, and by
3237 GCC's implementation.
3239 For PowerPC, the following registers have specific use:
3242 R3-R4: parameter passing and return values
3243 R5-R10: parameter passing
3244 R13: small data area pointer
3248 (U-Boot also uses R14 as internal GOT pointer.)
3250 ==> U-Boot will use R29 to hold a pointer to the global data
3252 Note: on PPC, we could use a static initializer (since the
3253 address of the global data structure is known at compile time),
3254 but it turned out that reserving a register results in somewhat
3255 smaller code - although the code savings are not that big (on
3256 average for all boards 752 bytes for the whole U-Boot image,
3257 624 text + 127 data).
3259 On ARM, the following registers are used:
3261 R0: function argument word/integer result
3262 R1-R3: function argument word
3264 R10: stack limit (used only if stack checking if enabled)
3265 R11: argument (frame) pointer
3266 R12: temporary workspace
3269 R15: program counter
3271 ==> U-Boot will use R8 to hold a pointer to the global data
3277 U-Boot runs in system state and uses physical addresses, i.e. the
3278 MMU is not used either for address mapping nor for memory protection.
3280 The available memory is mapped to fixed addresses using the memory
3281 controller. In this process, a contiguous block is formed for each
3282 memory type (Flash, SDRAM, SRAM), even when it consists of several
3283 physical memory banks.
3285 U-Boot is installed in the first 128 kB of the first Flash bank (on
3286 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3287 booting and sizing and initializing DRAM, the code relocates itself
3288 to the upper end of DRAM. Immediately below the U-Boot code some
3289 memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3290 configuration setting]. Below that, a structure with global Board
3291 Info data is placed, followed by the stack (growing downward).
3293 Additionally, some exception handler code is copied to the low 8 kB
3294 of DRAM (0x00000000 ... 0x00001FFF).
3296 So a typical memory configuration with 16 MB of DRAM could look like
3299 0x0000 0000 Exception Vector code
3302 0x0000 2000 Free for Application Use
3308 0x00FB FF20 Monitor Stack (Growing downward)
3309 0x00FB FFAC Board Info Data and permanent copy of global data
3310 0x00FC 0000 Malloc Arena
3313 0x00FE 0000 RAM Copy of Monitor Code
3314 ... eventually: LCD or video framebuffer
3315 ... eventually: pRAM (Protected RAM - unchanged by reset)
3316 0x00FF FFFF [End of RAM]
3319 System Initialization:
3320 ----------------------
3322 In the reset configuration, U-Boot starts at the reset entry point
3323 (on most PowerPC systens at address 0x00000100). Because of the reset
3324 configuration for CS0# this is a mirror of the onboard Flash memory.
3325 To be able to re-map memory U-Boot then jumps to its link address.
3326 To be able to implement the initialization code in C, a (small!)
3327 initial stack is set up in the internal Dual Ported RAM (in case CPUs
3328 which provide such a feature like MPC8xx or MPC8260), or in a locked
3329 part of the data cache. After that, U-Boot initializes the CPU core,
3330 the caches and the SIU.
3332 Next, all (potentially) available memory banks are mapped using a
3333 preliminary mapping. For example, we put them on 512 MB boundaries
3334 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3335 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3336 programmed for SDRAM access. Using the temporary configuration, a
3337 simple memory test is run that determines the size of the SDRAM
3340 When there is more than one SDRAM bank, and the banks are of
3341 different size, the largest is mapped first. For equal size, the first
3342 bank (CS2#) is mapped first. The first mapping is always for address
3343 0x00000000, with any additional banks following immediately to create
3344 contiguous memory starting from 0.
3346 Then, the monitor installs itself at the upper end of the SDRAM area
3347 and allocates memory for use by malloc() and for the global Board
3348 Info data; also, the exception vector code is copied to the low RAM
3349 pages, and the final stack is set up.
3351 Only after this relocation will you have a "normal" C environment;
3352 until that you are restricted in several ways, mostly because you are
3353 running from ROM, and because the code will have to be relocated to a
3357 U-Boot Porting Guide:
3358 ----------------------
3360 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3364 int main (int argc, char *argv[])
3366 sighandler_t no_more_time;
3368 signal (SIGALRM, no_more_time);
3369 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3371 if (available_money > available_manpower) {
3372 pay consultant to port U-Boot;
3376 Download latest U-Boot source;
3378 Subscribe to u-boot-users mailing list;
3381 email ("Hi, I am new to U-Boot, how do I get started?");
3385 Read the README file in the top level directory;
3386 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3387 Read the source, Luke;
3390 if (available_money > toLocalCurrency ($2500)) {
3393 Add a lot of aggravation and time;
3396 Create your own board support subdirectory;
3398 Create your own board config file;
3402 Add / modify source code;
3406 email ("Hi, I am having problems...");
3408 Send patch file to Wolfgang;
3413 void no_more_time (int sig)
3422 All contributions to U-Boot should conform to the Linux kernel
3423 coding style; see the file "Documentation/CodingStyle" in your Linux
3424 kernel source directory.
3426 Please note that U-Boot is implemented in C (and to some small parts
3427 in Assembler); no C++ is used, so please do not use C++ style
3428 comments (//) in your code.
3430 Please also stick to the following formatting rules:
3431 - remove any trailing white space
3432 - use TAB characters for indentation, not spaces
3433 - make sure NOT to use DOS '\r\n' line feeds
3434 - do not add more than 2 empty lines to source files
3435 - do not add trailing empty lines to source files
3437 Submissions which do not conform to the standards may be returned
3438 with a request to reformat the changes.
3444 Since the number of patches for U-Boot is growing, we need to
3445 establish some rules. Submissions which do not conform to these rules
3446 may be rejected, even when they contain important and valuable stuff.
3448 Patches shall be sent to the u-boot-users mailing list.
3450 When you send a patch, please include the following information with
3453 * For bug fixes: a description of the bug and how your patch fixes
3454 this bug. Please try to include a way of demonstrating that the
3455 patch actually fixes something.
3457 * For new features: a description of the feature and your
3460 * A CHANGELOG entry as plaintext (separate from the patch)
3462 * For major contributions, your entry to the CREDITS file
3464 * When you add support for a new board, don't forget to add this
3465 board to the MAKEALL script, too.
3467 * If your patch adds new configuration options, don't forget to
3468 document these in the README file.
3470 * The patch itself. If you are accessing the CVS repository use "cvs
3471 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3472 version of diff does not support these options, then get the latest
3473 version of GNU diff.
3475 The current directory when running this command shall be the top
3476 level directory of the U-Boot source tree, or it's parent directory
3477 (i. e. please make sure that your patch includes sufficient
3478 directory information for the affected files).
3480 We accept patches as plain text, MIME attachments or as uuencoded
3483 * If one logical set of modifications affects or creates several
3484 files, all these changes shall be submitted in a SINGLE patch file.
3486 * Changesets that contain different, unrelated modifications shall be
3487 submitted as SEPARATE patches, one patch per changeset.
3492 * Before sending the patch, run the MAKEALL script on your patched
3493 source tree and make sure that no errors or warnings are reported
3494 for any of the boards.
3496 * Keep your modifications to the necessary minimum: A patch
3497 containing several unrelated changes or arbitrary reformats will be
3498 returned with a request to re-formatting / split it.
3500 * If you modify existing code, make sure that your new code does not
3501 add to the memory footprint of the code ;-) Small is beautiful!
3502 When adding new features, these should compile conditionally only
3503 (using #ifdef), and the resulting code with the new feature
3504 disabled must not need more memory than the old code without your
3507 * Remember that there is a size limit of 40 kB per message on the
3508 u-boot-users mailing list. Compression may help.
projects / platform / kernel / u-boot.git / blob