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
251 MicroBlaze based CPUs:
252 ----------------------
256 ----------------------
260 - Board Type: Define exactly one of
262 PowerPC based boards:
263 ---------------------
265 CONFIG_ADCIOP CONFIG_FPS860L CONFIG_OXC
266 CONFIG_ADS860 CONFIG_GEN860T CONFIG_PCI405
267 CONFIG_AMX860 CONFIG_GENIETV CONFIG_PCIPPC2
268 CONFIG_AP1000 CONFIG_GTH CONFIG_PCIPPC6
269 CONFIG_AR405 CONFIG_gw8260 CONFIG_pcu_e
270 CONFIG_BAB7xx CONFIG_hermes CONFIG_PIP405
271 CONFIG_BC3450 CONFIG_hymod CONFIG_PM826
272 CONFIG_c2mon CONFIG_IAD210 CONFIG_ppmc8260
273 CONFIG_CANBT CONFIG_ICU862 CONFIG_QS823
274 CONFIG_CCM CONFIG_IP860 CONFIG_QS850
275 CONFIG_CMI CONFIG_IPHASE4539 CONFIG_QS860T
276 CONFIG_cogent_mpc8260 CONFIG_IVML24 CONFIG_RBC823
277 CONFIG_cogent_mpc8xx CONFIG_IVML24_128 CONFIG_RPXClassic
278 CONFIG_CPCI405 CONFIG_IVML24_256 CONFIG_RPXlite
279 CONFIG_CPCI4052 CONFIG_IVMS8 CONFIG_RPXsuper
280 CONFIG_CPCIISER4 CONFIG_IVMS8_128 CONFIG_rsdproto
281 CONFIG_CPU86 CONFIG_IVMS8_256 CONFIG_sacsng
282 CONFIG_CRAYL1 CONFIG_JSE CONFIG_Sandpoint8240
283 CONFIG_CSB272 CONFIG_LANTEC CONFIG_Sandpoint8245
284 CONFIG_CU824 CONFIG_LITE5200B CONFIG_sbc8260
285 CONFIG_DASA_SIM CONFIG_lwmon CONFIG_sbc8560
286 CONFIG_DB64360 CONFIG_MBX CONFIG_SM850
287 CONFIG_DB64460 CONFIG_MBX860T CONFIG_SPD823TS
288 CONFIG_DU405 CONFIG_MHPC CONFIG_STXGP3
289 CONFIG_DUET_ADS CONFIG_MIP405 CONFIG_SXNI855T
290 CONFIG_EBONY CONFIG_MOUSSE CONFIG_TQM823L
291 CONFIG_ELPPC CONFIG_MPC8260ADS CONFIG_TQM8260
292 CONFIG_ELPT860 CONFIG_MPC8540ADS CONFIG_TQM850L
293 CONFIG_ep8260 CONFIG_MPC8540EVAL CONFIG_TQM855L
294 CONFIG_ERIC CONFIG_MPC8560ADS CONFIG_TQM860L
295 CONFIG_ESTEEM192E CONFIG_MUSENKI CONFIG_TTTech
296 CONFIG_ETX094 CONFIG_MVS1 CONFIG_UTX8245
297 CONFIG_EVB64260 CONFIG_NETPHONE CONFIG_V37
298 CONFIG_FADS823 CONFIG_NETTA CONFIG_W7OLMC
299 CONFIG_FADS850SAR CONFIG_NETVIA CONFIG_W7OLMG
300 CONFIG_FADS860T CONFIG_NX823 CONFIG_WALNUT
301 CONFIG_FLAGADM CONFIG_OCRTC CONFIG_ZPC1900
302 CONFIG_FPS850L CONFIG_ORSG CONFIG_ZUMA
307 CONFIG_ARMADILLO, CONFIG_AT91RM9200DK, CONFIG_CERF250,
308 CONFIG_CSB637, CONFIG_DELTA, CONFIG_DNP1110,
309 CONFIG_EP7312, CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE,
310 CONFIG_IMPA7, CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610,
311 CONFIG_KB9202, CONFIG_LART, CONFIG_LPD7A400,
312 CONFIG_LUBBOCK, CONFIG_OSK_OMAP5912, CONFIG_OMAP2420H4,
313 CONFIG_SHANNON, CONFIG_P2_OMAP730, CONFIG_SMDK2400,
314 CONFIG_SMDK2410, CONFIG_TRAB, CONFIG_VCMA9
316 MicroBlaze based boards:
317 ------------------------
322 ------------------------
324 CONFIG_PCI5441 CONFIG_PK1C20
327 - CPU Module Type: (if CONFIG_COGENT is defined)
328 Define exactly one of
330 --- FIXME --- not tested yet:
331 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
332 CONFIG_CMA287_23, CONFIG_CMA287_50
334 - Motherboard Type: (if CONFIG_COGENT is defined)
335 Define exactly one of
336 CONFIG_CMA101, CONFIG_CMA102
338 - Motherboard I/O Modules: (if CONFIG_COGENT is defined)
339 Define one or more of
342 - Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
343 Define one or more of
344 CONFIG_LCD_HEARTBEAT - update a character position on
345 the lcd display every second with
348 - Board flavour: (if CONFIG_MPC8260ADS is defined)
351 CFG_8260ADS - original MPC8260ADS
352 CFG_8266ADS - MPC8266ADS
353 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
354 CFG_8272ADS - MPC8272ADS
356 - MPC824X Family Member (if CONFIG_MPC824X is defined)
357 Define exactly one of
358 CONFIG_MPC8240, CONFIG_MPC8245
360 - 8xx CPU Options: (if using an MPC8xx cpu)
361 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
362 get_gclk_freq() cannot work
363 e.g. if there is no 32KHz
364 reference PIT/RTC clock
365 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
368 - 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
371 CONFIG_8xx_CPUCLK_DEFAULT
372 See doc/README.MPC866
376 Define this to measure the actual CPU clock instead
377 of relying on the correctness of the configured
378 values. Mostly useful for board bringup to make sure
379 the PLL is locked at the intended frequency. Note
380 that this requires a (stable) reference clock (32 kHz
381 RTC clock or CFG_8XX_XIN)
383 - Intel Monahans options:
384 CFG_MONAHANS_RUN_MODE_OSC_RATIO
386 Defines the Monahans run mode to oscillator
387 ratio. Valid values are 8, 16, 24, 31. The core
388 frequency is this value multiplied by 13 MHz.
390 CFG_MONAHANS_TURBO_RUN_MODE_RATIO
392 Defines the Monahans turbo mode to oscillator
393 ratio. Valid values are 1 (default if undefined) and
394 2. The core frequency as calculated above is multiplied
397 - Linux Kernel Interface:
400 U-Boot stores all clock information in Hz
401 internally. For binary compatibility with older Linux
402 kernels (which expect the clocks passed in the
403 bd_info data to be in MHz) the environment variable
404 "clocks_in_mhz" can be defined so that U-Boot
405 converts clock data to MHZ before passing it to the
407 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
408 "clocks_in_mhz=1" is automatically included in the
411 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
413 When transfering memsize parameter to linux, some versions
414 expect it to be in bytes, others in MB.
415 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
419 New kernel versions are expecting firmware settings to be
420 passed using flat open firmware trees.
421 The environment variable "disable_of", when set, disables this
424 CONFIG_OF_FLAT_TREE_MAX_SIZE
426 The maximum size of the constructed OF tree.
428 OF_CPU - The proper name of the cpus node.
429 OF_SOC - The proper name of the soc node.
430 OF_TBCLK - The timebase frequency.
431 OF_STDOUT_PATH - The path to the console device
435 The resulting flat device tree will have a copy of the bd_t.
436 Space should be pre-allocated in the dts for the bd_t.
438 CONFIG_OF_HAS_UBOOT_ENV
440 The resulting flat device tree will have a copy of u-boot's
441 environment variables
443 CONFIG_OF_BOARD_SETUP
445 Board code has addition modification that it wants to make
446 to the flat device tree before handing it off to the kernel
451 Define this if you want support for Amba PrimeCell PL010 UARTs.
455 Define this if you want support for Amba PrimeCell PL011 UARTs.
459 If you have Amba PrimeCell PL011 UARTs, set this variable to
460 the clock speed of the UARTs.
464 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
465 define this to a list of base addresses for each (supported)
466 port. See e.g. include/configs/versatile.h
470 Depending on board, define exactly one serial port
471 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
472 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
473 console by defining CONFIG_8xx_CONS_NONE
475 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
476 port routines must be defined elsewhere
477 (i.e. serial_init(), serial_getc(), ...)
480 Enables console device for a color framebuffer. Needs following
481 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
482 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
484 VIDEO_HW_RECTFILL graphic chip supports
487 VIDEO_HW_BITBLT graphic chip supports
488 bit-blit (cf. smiLynxEM)
489 VIDEO_VISIBLE_COLS visible pixel columns
491 VIDEO_VISIBLE_ROWS visible pixel rows
492 VIDEO_PIXEL_SIZE bytes per pixel
493 VIDEO_DATA_FORMAT graphic data format
494 (0-5, cf. cfb_console.c)
495 VIDEO_FB_ADRS framebuffer address
496 VIDEO_KBD_INIT_FCT keyboard int fct
497 (i.e. i8042_kbd_init())
498 VIDEO_TSTC_FCT test char fct
500 VIDEO_GETC_FCT get char fct
502 CONFIG_CONSOLE_CURSOR cursor drawing on/off
503 (requires blink timer
505 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
506 CONFIG_CONSOLE_TIME display time/date info in
508 (requires CFG_CMD_DATE)
509 CONFIG_VIDEO_LOGO display Linux logo in
511 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
512 linux_logo.h for logo.
513 Requires CONFIG_VIDEO_LOGO
514 CONFIG_CONSOLE_EXTRA_INFO
515 addional board info beside
518 When CONFIG_CFB_CONSOLE is defined, video console is
519 default i/o. Serial console can be forced with
520 environment 'console=serial'.
522 When CONFIG_SILENT_CONSOLE is defined, all console
523 messages (by U-Boot and Linux!) can be silenced with
524 the "silent" environment variable. See
525 doc/README.silent for more information.
528 CONFIG_BAUDRATE - in bps
529 Select one of the baudrates listed in
530 CFG_BAUDRATE_TABLE, see below.
531 CFG_BRGCLK_PRESCALE, baudrate prescale
533 - Interrupt driven serial port input:
534 CONFIG_SERIAL_SOFTWARE_FIFO
537 Use an interrupt handler for receiving data on the
538 serial port. It also enables using hardware handshake
539 (RTS/CTS) and UART's built-in FIFO. Set the number of
540 bytes the interrupt driven input buffer should have.
542 Leave undefined to disable this feature, including
543 disable the buffer and hardware handshake.
545 - Console UART Number:
549 If defined internal UART1 (and not UART0) is used
550 as default U-Boot console.
552 - Boot Delay: CONFIG_BOOTDELAY - in seconds
553 Delay before automatically booting the default image;
554 set to -1 to disable autoboot.
556 See doc/README.autoboot for these options that
557 work with CONFIG_BOOTDELAY. None are required.
558 CONFIG_BOOT_RETRY_TIME
559 CONFIG_BOOT_RETRY_MIN
560 CONFIG_AUTOBOOT_KEYED
561 CONFIG_AUTOBOOT_PROMPT
562 CONFIG_AUTOBOOT_DELAY_STR
563 CONFIG_AUTOBOOT_STOP_STR
564 CONFIG_AUTOBOOT_DELAY_STR2
565 CONFIG_AUTOBOOT_STOP_STR2
566 CONFIG_ZERO_BOOTDELAY_CHECK
567 CONFIG_RESET_TO_RETRY
571 Only needed when CONFIG_BOOTDELAY is enabled;
572 define a command string that is automatically executed
573 when no character is read on the console interface
574 within "Boot Delay" after reset.
577 This can be used to pass arguments to the bootm
578 command. The value of CONFIG_BOOTARGS goes into the
579 environment value "bootargs".
581 CONFIG_RAMBOOT and CONFIG_NFSBOOT
582 The value of these goes into the environment as
583 "ramboot" and "nfsboot" respectively, and can be used
584 as a convenience, when switching between booting from
590 When this option is #defined, the existence of the
591 environment variable "preboot" will be checked
592 immediately before starting the CONFIG_BOOTDELAY
593 countdown and/or running the auto-boot command resp.
594 entering interactive mode.
596 This feature is especially useful when "preboot" is
597 automatically generated or modified. For an example
598 see the LWMON board specific code: here "preboot" is
599 modified when the user holds down a certain
600 combination of keys on the (special) keyboard when
603 - Serial Download Echo Mode:
605 If defined to 1, all characters received during a
606 serial download (using the "loads" command) are
607 echoed back. This might be needed by some terminal
608 emulations (like "cu"), but may as well just take
609 time on others. This setting #define's the initial
610 value of the "loads_echo" environment variable.
612 - Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
614 Select one of the baudrates listed in
615 CFG_BAUDRATE_TABLE, see below.
619 Most monitor functions can be selected (or
620 de-selected) by adjusting the definition of
621 CONFIG_COMMANDS; to select individual functions,
622 #define CONFIG_COMMANDS by "OR"ing any of the
625 #define enables commands:
626 -------------------------
627 CFG_CMD_ASKENV * ask for env variable
628 CFG_CMD_AUTOSCRIPT Autoscript Support
630 CFG_CMD_BEDBUG * Include BedBug Debugger
631 CFG_CMD_BMP * BMP support
632 CFG_CMD_BSP * Board specific commands
634 CFG_CMD_CACHE * icache, dcache
635 CFG_CMD_CONSOLE coninfo
636 CFG_CMD_DATE * support for RTC, date/time...
637 CFG_CMD_DHCP * DHCP support
638 CFG_CMD_DIAG * Diagnostics
639 CFG_CMD_DOC * Disk-On-Chip Support
640 CFG_CMD_DTT * Digital Therm and Thermostat
641 CFG_CMD_ECHO echo arguments
642 CFG_CMD_EEPROM * EEPROM read/write support
643 CFG_CMD_ELF * bootelf, bootvx
645 CFG_CMD_FDC * Floppy Disk Support
646 CFG_CMD_FAT * FAT partition support
647 CFG_CMD_FDOS * Dos diskette Support
648 CFG_CMD_FLASH flinfo, erase, protect
649 CFG_CMD_FPGA FPGA device initialization support
650 CFG_CMD_HWFLOW * RTS/CTS hw flow control
651 CFG_CMD_I2C * I2C serial bus support
652 CFG_CMD_IDE * IDE harddisk support
654 CFG_CMD_IMLS List all found images
655 CFG_CMD_IMMAP * IMMR dump support
656 CFG_CMD_IRQ * irqinfo
657 CFG_CMD_ITEST Integer/string test of 2 values
658 CFG_CMD_JFFS2 * JFFS2 Support
662 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
664 CFG_CMD_MISC Misc functions like sleep etc
665 CFG_CMD_MMC * MMC memory mapped support
666 CFG_CMD_MII * MII utility commands
667 CFG_CMD_NAND * NAND support
668 CFG_CMD_NET bootp, tftpboot, rarpboot
669 CFG_CMD_PCI * pciinfo
670 CFG_CMD_PCMCIA * PCMCIA support
671 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
672 CFG_CMD_PORTIO * Port I/O
673 CFG_CMD_REGINFO * Register dump
674 CFG_CMD_RUN run command in env variable
675 CFG_CMD_SAVES * save S record dump
676 CFG_CMD_SCSI * SCSI Support
677 CFG_CMD_SDRAM * print SDRAM configuration information
678 (requires CFG_CMD_I2C)
679 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
680 CFG_CMD_SPI * SPI serial bus support
681 CFG_CMD_USB * USB support
682 CFG_CMD_VFD * VFD support (TRAB)
683 CFG_CMD_BSP * Board SPecific functions
684 CFG_CMD_CDP * Cisco Discover Protocol support
685 -----------------------------------------------
688 CONFIG_CMD_DFL Default configuration; at the moment
689 this is includes all commands, except
690 the ones marked with "*" in the list
693 If you don't define CONFIG_COMMANDS it defaults to
694 CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
695 override the default settings in the respective
698 EXAMPLE: If you want all functions except of network
699 support you can write:
701 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
704 Note: Don't enable the "icache" and "dcache" commands
705 (configuration option CFG_CMD_CACHE) unless you know
706 what you (and your U-Boot users) are doing. Data
707 cache cannot be enabled on systems like the 8xx or
708 8260 (where accesses to the IMMR region must be
709 uncached), and it cannot be disabled on all other
710 systems where we (mis-) use the data cache to hold an
711 initial stack and some data.
714 XXX - this list needs to get updated!
718 If this variable is defined, it enables watchdog
719 support. There must be support in the platform specific
720 code for a watchdog. For the 8xx and 8260 CPUs, the
721 SIU Watchdog feature is enabled in the SYPCR
725 CONFIG_VERSION_VARIABLE
726 If this variable is defined, an environment variable
727 named "ver" is created by U-Boot showing the U-Boot
728 version as printed by the "version" command.
729 This variable is readonly.
733 When CFG_CMD_DATE is selected, the type of the RTC
734 has to be selected, too. Define exactly one of the
737 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
738 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
739 CONFIG_RTC_MC146818 - use MC146818 RTC
740 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
741 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
742 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
743 CONFIG_RTC_DS164x - use Dallas DS164x RTC
744 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
746 Note that if the RTC uses I2C, then the I2C interface
747 must also be configured. See I2C Support, below.
751 When CONFIG_TIMESTAMP is selected, the timestamp
752 (date and time) of an image is printed by image
753 commands like bootm or iminfo. This option is
754 automatically enabled when you select CFG_CMD_DATE .
757 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
758 and/or CONFIG_ISO_PARTITION
760 If IDE or SCSI support is enabled (CFG_CMD_IDE or
761 CFG_CMD_SCSI) you must configure support for at least
762 one partition type as well.
765 CONFIG_IDE_RESET_ROUTINE - this is defined in several
766 board configurations files but used nowhere!
768 CONFIG_IDE_RESET - is this is defined, IDE Reset will
769 be performed by calling the function
770 ide_set_reset(int reset)
771 which has to be defined in a board specific file
776 Set this to enable ATAPI support.
781 Set this to enable support for disks larger than 137GB
782 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
783 Whithout these , LBA48 support uses 32bit variables and will 'only'
784 support disks up to 2.1TB.
787 When enabled, makes the IDE subsystem use 64bit sector addresses.
791 At the moment only there is only support for the
792 SYM53C8XX SCSI controller; define
793 CONFIG_SCSI_SYM53C8XX to enable it.
795 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
796 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
797 CFG_SCSI_MAX_LUN] can be adjusted to define the
798 maximum numbers of LUNs, SCSI ID's and target
800 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
802 - NETWORK Support (PCI):
804 Support for Intel 8254x gigabit chips.
807 Support for Intel 82557/82559/82559ER chips.
808 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
809 write routine for first time initialisation.
812 Support for Digital 2114x chips.
813 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
814 modem chip initialisation (KS8761/QS6611).
817 Support for National dp83815 chips.
820 Support for National dp8382[01] gigabit chips.
822 - NETWORK Support (other):
824 CONFIG_DRIVER_LAN91C96
825 Support for SMSC's LAN91C96 chips.
828 Define this to hold the physical address
829 of the LAN91C96's I/O space
831 CONFIG_LAN91C96_USE_32_BIT
832 Define this to enable 32 bit addressing
834 CONFIG_DRIVER_SMC91111
835 Support for SMSC's LAN91C111 chip
838 Define this to hold the physical address
839 of the device (I/O space)
841 CONFIG_SMC_USE_32_BIT
842 Define this if data bus is 32 bits
844 CONFIG_SMC_USE_IOFUNCS
845 Define this to use i/o functions instead of macros
846 (some hardware wont work with macros)
849 At the moment only the UHCI host controller is
850 supported (PIP405, MIP405, MPC5200); define
851 CONFIG_USB_UHCI to enable it.
852 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
853 and define CONFIG_USB_STORAGE to enable the USB
856 Supported are USB Keyboards and USB Floppy drives
858 MPC5200 USB requires additional defines:
860 for 528 MHz Clock: 0x0001bbbb
862 for differential drivers: 0x00001000
863 for single ended drivers: 0x00005000
866 Define the below if you wish to use the USB console.
867 Once firmware is rebuilt from a serial console issue the
868 command "setenv stdin usbtty; setenv stdout usbtty" and
869 attach your usb cable. The Unix command "dmesg" should print
870 it has found a new device. The environment variable usbtty
871 can be set to gserial or cdc_acm to enable your device to
872 appear to a USB host as a Linux gserial device or a
873 Common Device Class Abstract Control Model serial device.
874 If you select usbtty = gserial you should be able to enumerate
876 # modprobe usbserial vendor=0xVendorID product=0xProductID
877 else if using cdc_acm, simply setting the environment
878 variable usbtty to be cdc_acm should suffice. The following
879 might be defined in YourBoardName.h
882 Define this to build a UDC device
885 Define this to have a tty type of device available to
886 talk to the UDC device
888 CFG_CONSOLE_IS_IN_ENV
889 Define this if you want stdin, stdout &/or stderr to
893 CFG_USB_EXTC_CLK 0xBLAH
894 Derive USB clock from external clock "blah"
895 - CFG_USB_EXTC_CLK 0x02
897 CFG_USB_BRG_CLK 0xBLAH
898 Derive USB clock from brgclk
899 - CFG_USB_BRG_CLK 0x04
901 If you have a USB-IF assigned VendorID then you may wish to
902 define your own vendor specific values either in BoardName.h
903 or directly in usbd_vendor_info.h. If you don't define
904 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
905 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
906 should pretend to be a Linux device to it's target host.
908 CONFIG_USBD_MANUFACTURER
909 Define this string as the name of your company for
910 - CONFIG_USBD_MANUFACTURER "my company"
912 CONFIG_USBD_PRODUCT_NAME
913 Define this string as the name of your product
914 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
917 Define this as your assigned Vendor ID from the USB
918 Implementors Forum. This *must* be a genuine Vendor ID
919 to avoid polluting the USB namespace.
920 - CONFIG_USBD_VENDORID 0xFFFF
922 CONFIG_USBD_PRODUCTID
923 Define this as the unique Product ID
925 - CONFIG_USBD_PRODUCTID 0xFFFF
929 The MMC controller on the Intel PXA is supported. To
930 enable this define CONFIG_MMC. The MMC can be
931 accessed from the boot prompt by mapping the device
932 to physical memory similar to flash. Command line is
933 enabled with CFG_CMD_MMC. The MMC driver also works with
934 the FAT fs. This is enabled with CFG_CMD_FAT.
936 - Journaling Flash filesystem support:
937 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
938 CONFIG_JFFS2_NAND_DEV
939 Define these for a default partition on a NAND device
941 CFG_JFFS2_FIRST_SECTOR,
942 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
943 Define these for a default partition on a NOR device
946 Define this to create an own partition. You have to provide a
947 function struct part_info* jffs2_part_info(int part_num)
949 If you define only one JFFS2 partition you may also want to
950 #define CFG_JFFS_SINGLE_PART 1
951 to disable the command chpart. This is the default when you
952 have not defined a custom partition
957 Define this to enable standard (PC-Style) keyboard
961 Standard PC keyboard driver with US (is default) and
962 GERMAN key layout (switch via environment 'keymap=de') support.
963 Export function i8042_kbd_init, i8042_tstc and i8042_getc
964 for cfb_console. Supports cursor blinking.
969 Define this to enable video support (for output to
974 Enable Chips & Technologies 69000 Video chip
976 CONFIG_VIDEO_SMI_LYNXEM
977 Enable Silicon Motion SMI 712/710/810 Video chip. The
978 video output is selected via environment 'videoout'
979 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
982 For the CT69000 and SMI_LYNXEM drivers, videomode is
983 selected via environment 'videomode'. Two diferent ways
985 - "videomode=num" 'num' is a standard LiLo mode numbers.
986 Following standard modes are supported (* is default):
988 Colors 640x480 800x600 1024x768 1152x864 1280x1024
989 -------------+---------------------------------------------
990 8 bits | 0x301* 0x303 0x305 0x161 0x307
991 15 bits | 0x310 0x313 0x316 0x162 0x319
992 16 bits | 0x311 0x314 0x317 0x163 0x31A
993 24 bits | 0x312 0x315 0x318 ? 0x31B
994 -------------+---------------------------------------------
995 (i.e. setenv videomode 317; saveenv; reset;)
997 - "videomode=bootargs" all the video parameters are parsed
998 from the bootargs. (See drivers/videomodes.c)
1001 CONFIG_VIDEO_SED13806
1002 Enable Epson SED13806 driver. This driver supports 8bpp
1003 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1004 or CONFIG_VIDEO_SED13806_16BPP
1009 Define this to enable a custom keyboard support.
1010 This simply calls drv_keyboard_init() which must be
1011 defined in your board-specific files.
1012 The only board using this so far is RBC823.
1014 - LCD Support: CONFIG_LCD
1016 Define this to enable LCD support (for output to LCD
1017 display); also select one of the supported displays
1018 by defining one of these:
1020 CONFIG_NEC_NL6448AC33:
1022 NEC NL6448AC33-18. Active, color, single scan.
1024 CONFIG_NEC_NL6448BC20
1026 NEC NL6448BC20-08. 6.5", 640x480.
1027 Active, color, single scan.
1029 CONFIG_NEC_NL6448BC33_54
1031 NEC NL6448BC33-54. 10.4", 640x480.
1032 Active, color, single scan.
1036 Sharp 320x240. Active, color, single scan.
1037 It isn't 16x9, and I am not sure what it is.
1039 CONFIG_SHARP_LQ64D341
1041 Sharp LQ64D341 display, 640x480.
1042 Active, color, single scan.
1046 HLD1045 display, 640x480.
1047 Active, color, single scan.
1051 Optrex CBL50840-2 NF-FW 99 22 M5
1053 Hitachi LMG6912RPFC-00T
1057 320x240. Black & white.
1059 Normally display is black on white background; define
1060 CFG_WHITE_ON_BLACK to get it inverted.
1062 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1064 If this option is set, the environment is checked for
1065 a variable "splashimage". If found, the usual display
1066 of logo, copyright and system information on the LCD
1067 is suppressed and the BMP image at the address
1068 specified in "splashimage" is loaded instead. The
1069 console is redirected to the "nulldev", too. This
1070 allows for a "silent" boot where a splash screen is
1071 loaded very quickly after power-on.
1073 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1075 If this option is set, additionally to standard BMP
1076 images, gzipped BMP images can be displayed via the
1077 splashscreen support or the bmp command.
1079 - Compression support:
1082 If this option is set, support for bzip2 compressed
1083 images is included. If not, only uncompressed and gzip
1084 compressed images are supported.
1086 NOTE: the bzip2 algorithm requires a lot of RAM, so
1087 the malloc area (as defined by CFG_MALLOC_LEN) should
1093 The address of PHY on MII bus.
1095 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1097 The clock frequency of the MII bus
1101 If this option is set, support for speed/duplex
1102 detection of Gigabit PHY is included.
1104 CONFIG_PHY_RESET_DELAY
1106 Some PHY like Intel LXT971A need extra delay after
1107 reset before any MII register access is possible.
1108 For such PHY, set this option to the usec delay
1109 required. (minimum 300usec for LXT971A)
1111 CONFIG_PHY_CMD_DELAY (ppc4xx)
1113 Some PHY like Intel LXT971A need extra delay after
1114 command issued before MII status register can be read
1121 Define a default value for ethernet address to use
1122 for the respective ethernet interface, in case this
1123 is not determined automatically.
1128 Define a default value for the IP address to use for
1129 the default ethernet interface, in case this is not
1130 determined through e.g. bootp.
1132 - Server IP address:
1135 Defines a default value for theIP address of a TFTP
1136 server to contact when using the "tftboot" command.
1138 - BOOTP Recovery Mode:
1139 CONFIG_BOOTP_RANDOM_DELAY
1141 If you have many targets in a network that try to
1142 boot using BOOTP, you may want to avoid that all
1143 systems send out BOOTP requests at precisely the same
1144 moment (which would happen for instance at recovery
1145 from a power failure, when all systems will try to
1146 boot, thus flooding the BOOTP server. Defining
1147 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1148 inserted before sending out BOOTP requests. The
1149 following delays are insterted then:
1151 1st BOOTP request: delay 0 ... 1 sec
1152 2nd BOOTP request: delay 0 ... 2 sec
1153 3rd BOOTP request: delay 0 ... 4 sec
1155 BOOTP requests: delay 0 ... 8 sec
1157 - DHCP Advanced Options:
1160 You can fine tune the DHCP functionality by adding
1161 these flags to the CONFIG_BOOTP_MASK define:
1163 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1164 serverip from a DHCP server, it is possible that more
1165 than one DNS serverip is offered to the client.
1166 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1167 serverip will be stored in the additional environment
1168 variable "dnsip2". The first DNS serverip is always
1169 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1170 is added to the CONFIG_BOOTP_MASK.
1172 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1173 to do a dynamic update of a DNS server. To do this, they
1174 need the hostname of the DHCP requester.
1175 If CONFIG_BOOP_SEND_HOSTNAME is added to the
1176 CONFIG_BOOTP_MASK, the content of the "hostname"
1177 environment variable is passed as option 12 to
1181 CONFIG_CDP_DEVICE_ID
1183 The device id used in CDP trigger frames.
1185 CONFIG_CDP_DEVICE_ID_PREFIX
1187 A two character string which is prefixed to the MAC address
1192 A printf format string which contains the ascii name of
1193 the port. Normally is set to "eth%d" which sets
1194 eth0 for the first ethernet, eth1 for the second etc.
1196 CONFIG_CDP_CAPABILITIES
1198 A 32bit integer which indicates the device capabilities;
1199 0x00000010 for a normal host which does not forwards.
1203 An ascii string containing the version of the software.
1207 An ascii string containing the name of the platform.
1211 A 32bit integer sent on the trigger.
1213 CONFIG_CDP_POWER_CONSUMPTION
1215 A 16bit integer containing the power consumption of the
1216 device in .1 of milliwatts.
1218 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1220 A byte containing the id of the VLAN.
1222 - Status LED: CONFIG_STATUS_LED
1224 Several configurations allow to display the current
1225 status using a LED. For instance, the LED will blink
1226 fast while running U-Boot code, stop blinking as
1227 soon as a reply to a BOOTP request was received, and
1228 start blinking slow once the Linux kernel is running
1229 (supported by a status LED driver in the Linux
1230 kernel). Defining CONFIG_STATUS_LED enables this
1233 - CAN Support: CONFIG_CAN_DRIVER
1235 Defining CONFIG_CAN_DRIVER enables CAN driver support
1236 on those systems that support this (optional)
1237 feature, like the TQM8xxL modules.
1239 - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1241 These enable I2C serial bus commands. Defining either of
1242 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1243 include the appropriate I2C driver for the selected cpu.
1245 This will allow you to use i2c commands at the u-boot
1246 command line (as long as you set CFG_CMD_I2C in
1247 CONFIG_COMMANDS) and communicate with i2c based realtime
1248 clock chips. See common/cmd_i2c.c for a description of the
1249 command line interface.
1251 CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1253 CONFIG_SOFT_I2C configures u-boot to use a software (aka
1254 bit-banging) driver instead of CPM or similar hardware
1257 There are several other quantities that must also be
1258 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1260 In both cases you will need to define CFG_I2C_SPEED
1261 to be the frequency (in Hz) at which you wish your i2c bus
1262 to run and CFG_I2C_SLAVE to be the address of this node (ie
1263 the cpu's i2c node address).
1265 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1266 sets the cpu up as a master node and so its address should
1267 therefore be cleared to 0 (See, eg, MPC823e User's Manual
1268 p.16-473). So, set CFG_I2C_SLAVE to 0.
1270 That's all that's required for CONFIG_HARD_I2C.
1272 If you use the software i2c interface (CONFIG_SOFT_I2C)
1273 then the following macros need to be defined (examples are
1274 from include/configs/lwmon.h):
1278 (Optional). Any commands necessary to enable the I2C
1279 controller or configure ports.
1281 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
1285 (Only for MPC8260 CPU). The I/O port to use (the code
1286 assumes both bits are on the same port). Valid values
1287 are 0..3 for ports A..D.
1291 The code necessary to make the I2C data line active
1292 (driven). If the data line is open collector, this
1295 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1299 The code necessary to make the I2C data line tri-stated
1300 (inactive). If the data line is open collector, this
1303 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1307 Code that returns TRUE if the I2C data line is high,
1310 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1314 If <bit> is TRUE, sets the I2C data line high. If it
1315 is FALSE, it clears it (low).
1317 eg: #define I2C_SDA(bit) \
1318 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
1319 else immr->im_cpm.cp_pbdat &= ~PB_SDA
1323 If <bit> is TRUE, sets the I2C clock line high. If it
1324 is FALSE, it clears it (low).
1326 eg: #define I2C_SCL(bit) \
1327 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
1328 else immr->im_cpm.cp_pbdat &= ~PB_SCL
1332 This delay is invoked four times per clock cycle so this
1333 controls the rate of data transfer. The data rate thus
1334 is 1 / (I2C_DELAY * 4). Often defined to be something
1337 #define I2C_DELAY udelay(2)
1341 When a board is reset during an i2c bus transfer
1342 chips might think that the current transfer is still
1343 in progress. On some boards it is possible to access
1344 the i2c SCLK line directly, either by using the
1345 processor pin as a GPIO or by having a second pin
1346 connected to the bus. If this option is defined a
1347 custom i2c_init_board() routine in boards/xxx/board.c
1348 is run early in the boot sequence.
1350 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1352 This option enables configuration of bi_iic_fast[] flags
1353 in u-boot bd_info structure based on u-boot environment
1354 variable "i2cfast". (see also i2cfast)
1356 - SPI Support: CONFIG_SPI
1358 Enables SPI driver (so far only tested with
1359 SPI EEPROM, also an instance works with Crystal A/D and
1360 D/As on the SACSng board)
1364 Enables extended (16-bit) SPI EEPROM addressing.
1365 (symmetrical to CONFIG_I2C_X)
1369 Enables a software (bit-bang) SPI driver rather than
1370 using hardware support. This is a general purpose
1371 driver that only requires three general I/O port pins
1372 (two outputs, one input) to function. If this is
1373 defined, the board configuration must define several
1374 SPI configuration items (port pins to use, etc). For
1375 an example, see include/configs/sacsng.h.
1377 - FPGA Support: CONFIG_FPGA_COUNT
1379 Specify the number of FPGA devices to support.
1383 Used to specify the types of FPGA devices. For example,
1384 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
1386 CFG_FPGA_PROG_FEEDBACK
1388 Enable printing of hash marks during FPGA configuration.
1392 Enable checks on FPGA configuration interface busy
1393 status by the configuration function. This option
1394 will require a board or device specific function to
1399 If defined, a function that provides delays in the FPGA
1400 configuration driver.
1402 CFG_FPGA_CHECK_CTRLC
1403 Allow Control-C to interrupt FPGA configuration
1405 CFG_FPGA_CHECK_ERROR
1407 Check for configuration errors during FPGA bitfile
1408 loading. For example, abort during Virtex II
1409 configuration if the INIT_B line goes low (which
1410 indicated a CRC error).
1414 Maximum time to wait for the INIT_B line to deassert
1415 after PROB_B has been deasserted during a Virtex II
1416 FPGA configuration sequence. The default time is 500
1421 Maximum time to wait for BUSY to deassert during
1422 Virtex II FPGA configuration. The default is 5 mS.
1424 CFG_FPGA_WAIT_CONFIG
1426 Time to wait after FPGA configuration. The default is
1429 - Configuration Management:
1432 If defined, this string will be added to the U-Boot
1433 version information (U_BOOT_VERSION)
1435 - Vendor Parameter Protection:
1437 U-Boot considers the values of the environment
1438 variables "serial#" (Board Serial Number) and
1439 "ethaddr" (Ethernet Address) to be parameters that
1440 are set once by the board vendor / manufacturer, and
1441 protects these variables from casual modification by
1442 the user. Once set, these variables are read-only,
1443 and write or delete attempts are rejected. You can
1444 change this behviour:
1446 If CONFIG_ENV_OVERWRITE is #defined in your config
1447 file, the write protection for vendor parameters is
1448 completely disabled. Anybody can change or delete
1451 Alternatively, if you #define _both_ CONFIG_ETHADDR
1452 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1453 ethernet address is installed in the environment,
1454 which can be changed exactly ONCE by the user. [The
1455 serial# is unaffected by this, i. e. it remains
1461 Define this variable to enable the reservation of
1462 "protected RAM", i. e. RAM which is not overwritten
1463 by U-Boot. Define CONFIG_PRAM to hold the number of
1464 kB you want to reserve for pRAM. You can overwrite
1465 this default value by defining an environment
1466 variable "pram" to the number of kB you want to
1467 reserve. Note that the board info structure will
1468 still show the full amount of RAM. If pRAM is
1469 reserved, a new environment variable "mem" will
1470 automatically be defined to hold the amount of
1471 remaining RAM in a form that can be passed as boot
1472 argument to Linux, for instance like that:
1474 setenv bootargs ... mem=\${mem}
1477 This way you can tell Linux not to use this memory,
1478 either, which results in a memory region that will
1479 not be affected by reboots.
1481 *WARNING* If your board configuration uses automatic
1482 detection of the RAM size, you must make sure that
1483 this memory test is non-destructive. So far, the
1484 following board configurations are known to be
1487 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1488 HERMES, IP860, RPXlite, LWMON, LANTEC,
1489 PCU_E, FLAGADM, TQM8260
1494 Define this variable to stop the system in case of a
1495 fatal error, so that you have to reset it manually.
1496 This is probably NOT a good idea for an embedded
1497 system where you want to system to reboot
1498 automatically as fast as possible, but it may be
1499 useful during development since you can try to debug
1500 the conditions that lead to the situation.
1502 CONFIG_NET_RETRY_COUNT
1504 This variable defines the number of retries for
1505 network operations like ARP, RARP, TFTP, or BOOTP
1506 before giving up the operation. If not defined, a
1507 default value of 5 is used.
1509 - Command Interpreter:
1512 Enable auto completion of commands using TAB.
1516 Define this variable to enable the "hush" shell (from
1517 Busybox) as command line interpreter, thus enabling
1518 powerful command line syntax like
1519 if...then...else...fi conditionals or `&&' and '||'
1520 constructs ("shell scripts").
1522 If undefined, you get the old, much simpler behaviour
1523 with a somewhat smaller memory footprint.
1528 This defines the secondary prompt string, which is
1529 printed when the command interpreter needs more input
1530 to complete a command. Usually "> ".
1534 In the current implementation, the local variables
1535 space and global environment variables space are
1536 separated. Local variables are those you define by
1537 simply typing `name=value'. To access a local
1538 variable later on, you have write `$name' or
1539 `${name}'; to execute the contents of a variable
1540 directly type `$name' at the command prompt.
1542 Global environment variables are those you use
1543 setenv/printenv to work with. To run a command stored
1544 in such a variable, you need to use the run command,
1545 and you must not use the '$' sign to access them.
1547 To store commands and special characters in a
1548 variable, please use double quotation marks
1549 surrounding the whole text of the variable, instead
1550 of the backslashes before semicolons and special
1553 - Default Environment:
1554 CONFIG_EXTRA_ENV_SETTINGS
1556 Define this to contain any number of null terminated
1557 strings (variable = value pairs) that will be part of
1558 the default environment compiled into the boot image.
1560 For example, place something like this in your
1561 board's config file:
1563 #define CONFIG_EXTRA_ENV_SETTINGS \
1567 Warning: This method is based on knowledge about the
1568 internal format how the environment is stored by the
1569 U-Boot code. This is NOT an official, exported
1570 interface! Although it is unlikely that this format
1571 will change soon, there is no guarantee either.
1572 You better know what you are doing here.
1574 Note: overly (ab)use of the default environment is
1575 discouraged. Make sure to check other ways to preset
1576 the environment like the autoscript function or the
1579 - DataFlash Support:
1580 CONFIG_HAS_DATAFLASH
1582 Defining this option enables DataFlash features and
1583 allows to read/write in Dataflash via the standard
1586 - SystemACE Support:
1589 Adding this option adds support for Xilinx SystemACE
1590 chips attached via some sort of local bus. The address
1591 of the chip must alsh be defined in the
1592 CFG_SYSTEMACE_BASE macro. For example:
1594 #define CONFIG_SYSTEMACE
1595 #define CFG_SYSTEMACE_BASE 0xf0000000
1597 When SystemACE support is added, the "ace" device type
1598 becomes available to the fat commands, i.e. fatls.
1600 - TFTP Fixed UDP Port:
1603 If this is defined, the environment variable tftpsrcp
1604 is used to supply the TFTP UDP source port value.
1605 If tftpsrcp isn't defined, the normal pseudo-random port
1606 number generator is used.
1608 Also, the environment variable tftpdstp is used to supply
1609 the TFTP UDP destination port value. If tftpdstp isn't
1610 defined, the normal port 69 is used.
1612 The purpose for tftpsrcp is to allow a TFTP server to
1613 blindly start the TFTP transfer using the pre-configured
1614 target IP address and UDP port. This has the effect of
1615 "punching through" the (Windows XP) firewall, allowing
1616 the remainder of the TFTP transfer to proceed normally.
1617 A better solution is to properly configure the firewall,
1618 but sometimes that is not allowed.
1620 - Show boot progress:
1621 CONFIG_SHOW_BOOT_PROGRESS
1623 Defining this option allows to add some board-
1624 specific code (calling a user-provided function
1625 "show_boot_progress(int)") that enables you to show
1626 the system's boot progress on some display (for
1627 example, some LED's) on your board. At the moment,
1628 the following checkpoints are implemented:
1631 1 common/cmd_bootm.c before attempting to boot an image
1632 -1 common/cmd_bootm.c Image header has bad magic number
1633 2 common/cmd_bootm.c Image header has correct magic number
1634 -2 common/cmd_bootm.c Image header has bad checksum
1635 3 common/cmd_bootm.c Image header has correct checksum
1636 -3 common/cmd_bootm.c Image data has bad checksum
1637 4 common/cmd_bootm.c Image data has correct checksum
1638 -4 common/cmd_bootm.c Image is for unsupported architecture
1639 5 common/cmd_bootm.c Architecture check OK
1640 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1641 6 common/cmd_bootm.c Image Type check OK
1642 -6 common/cmd_bootm.c gunzip uncompression error
1643 -7 common/cmd_bootm.c Unimplemented compression type
1644 7 common/cmd_bootm.c Uncompression OK
1645 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1646 8 common/cmd_bootm.c Image Type check OK
1647 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1648 9 common/cmd_bootm.c Start initial ramdisk verification
1649 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1650 -11 common/cmd_bootm.c Ramdisk header has bad checksum
1651 10 common/cmd_bootm.c Ramdisk header is OK
1652 -12 common/cmd_bootm.c Ramdisk data has bad checksum
1653 11 common/cmd_bootm.c Ramdisk data has correct checksum
1654 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1655 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1656 13 common/cmd_bootm.c Start multifile image verification
1657 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1658 15 common/cmd_bootm.c All preparation done, transferring control to OS
1660 -30 lib_ppc/board.c Fatal error, hang the system
1661 -31 post/post.c POST test failed, detected by post_output_backlog()
1662 -32 post/post.c POST test failed, detected by post_run_single()
1664 -1 common/cmd_doc.c Bad usage of "doc" command
1665 -1 common/cmd_doc.c No boot device
1666 -1 common/cmd_doc.c Unknown Chip ID on boot device
1667 -1 common/cmd_doc.c Read Error on boot device
1668 -1 common/cmd_doc.c Image header has bad magic number
1670 -1 common/cmd_ide.c Bad usage of "ide" command
1671 -1 common/cmd_ide.c No boot device
1672 -1 common/cmd_ide.c Unknown boot device
1673 -1 common/cmd_ide.c Unknown partition table
1674 -1 common/cmd_ide.c Invalid partition type
1675 -1 common/cmd_ide.c Read Error on boot device
1676 -1 common/cmd_ide.c Image header has bad magic number
1678 -1 common/cmd_nand.c Bad usage of "nand" command
1679 -1 common/cmd_nand.c No boot device
1680 -1 common/cmd_nand.c Unknown Chip ID on boot device
1681 -1 common/cmd_nand.c Read Error on boot device
1682 -1 common/cmd_nand.c Image header has bad magic number
1684 -1 common/env_common.c Environment has a bad CRC, using default
1690 [so far only for SMDK2400 and TRAB boards]
1692 - Modem support endable:
1693 CONFIG_MODEM_SUPPORT
1695 - RTS/CTS Flow control enable:
1698 - Modem debug support:
1699 CONFIG_MODEM_SUPPORT_DEBUG
1701 Enables debugging stuff (char screen[1024], dbg())
1702 for modem support. Useful only with BDI2000.
1704 - Interrupt support (PPC):
1706 There are common interrupt_init() and timer_interrupt()
1707 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1708 for cpu specific initialization. interrupt_init_cpu()
1709 should set decrementer_count to appropriate value. If
1710 cpu resets decrementer automatically after interrupt
1711 (ppc4xx) it should set decrementer_count to zero.
1712 timer_interrupt() calls timer_interrupt_cpu() for cpu
1713 specific handling. If board has watchdog / status_led
1714 / other_activity_monitor it works automatically from
1715 general timer_interrupt().
1719 In the target system modem support is enabled when a
1720 specific key (key combination) is pressed during
1721 power-on. Otherwise U-Boot will boot normally
1722 (autoboot). The key_pressed() fuction is called from
1723 board_init(). Currently key_pressed() is a dummy
1724 function, returning 1 and thus enabling modem
1727 If there are no modem init strings in the
1728 environment, U-Boot proceed to autoboot; the
1729 previous output (banner, info printfs) will be
1732 See also: doc/README.Modem
1735 Configuration Settings:
1736 -----------------------
1738 - CFG_LONGHELP: Defined when you want long help messages included;
1739 undefine this when you're short of memory.
1741 - CFG_PROMPT: This is what U-Boot prints on the console to
1742 prompt for user input.
1744 - CFG_CBSIZE: Buffer size for input from the Console
1746 - CFG_PBSIZE: Buffer size for Console output
1748 - CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1750 - CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1751 the application (usually a Linux kernel) when it is
1754 - CFG_BAUDRATE_TABLE:
1755 List of legal baudrate settings for this board.
1757 - CFG_CONSOLE_INFO_QUIET
1758 Suppress display of console information at boot.
1760 - CFG_CONSOLE_IS_IN_ENV
1761 If the board specific function
1762 extern int overwrite_console (void);
1763 returns 1, the stdin, stderr and stdout are switched to the
1764 serial port, else the settings in the environment are used.
1766 - CFG_CONSOLE_OVERWRITE_ROUTINE
1767 Enable the call to overwrite_console().
1769 - CFG_CONSOLE_ENV_OVERWRITE
1770 Enable overwrite of previous console environment settings.
1772 - CFG_MEMTEST_START, CFG_MEMTEST_END:
1773 Begin and End addresses of the area used by the
1777 Enable an alternate, more extensive memory test.
1779 - CFG_MEMTEST_SCRATCH:
1780 Scratch address used by the alternate memory test
1781 You only need to set this if address zero isn't writeable
1783 - CFG_TFTP_LOADADDR:
1784 Default load address for network file downloads
1786 - CFG_LOADS_BAUD_CHANGE:
1787 Enable temporary baudrate change while serial download
1790 Physical start address of SDRAM. _Must_ be 0 here.
1793 Physical start address of Motherboard I/O (if using a
1797 Physical start address of Flash memory.
1800 Physical start address of boot monitor code (set by
1801 make config files to be same as the text base address
1802 (TEXT_BASE) used when linking) - same as
1803 CFG_FLASH_BASE when booting from flash.
1806 Size of memory reserved for monitor code, used to
1807 determine _at_compile_time_ (!) if the environment is
1808 embedded within the U-Boot image, or in a separate
1812 Size of DRAM reserved for malloc() use.
1815 Normally compressed uImages are limited to an
1816 uncompressed size of 8 MBytes. If this is not enough,
1817 you can define CFG_BOOTM_LEN in your board config file
1818 to adjust this setting to your needs.
1821 Maximum size of memory mapped by the startup code of
1822 the Linux kernel; all data that must be processed by
1823 the Linux kernel (bd_info, boot arguments, eventually
1824 initrd image) must be put below this limit.
1826 - CFG_MAX_FLASH_BANKS:
1827 Max number of Flash memory banks
1829 - CFG_MAX_FLASH_SECT:
1830 Max number of sectors on a Flash chip
1832 - CFG_FLASH_ERASE_TOUT:
1833 Timeout for Flash erase operations (in ms)
1835 - CFG_FLASH_WRITE_TOUT:
1836 Timeout for Flash write operations (in ms)
1838 - CFG_FLASH_LOCK_TOUT
1839 Timeout for Flash set sector lock bit operation (in ms)
1841 - CFG_FLASH_UNLOCK_TOUT
1842 Timeout for Flash clear lock bits operation (in ms)
1844 - CFG_FLASH_PROTECTION
1845 If defined, hardware flash sectors protection is used
1846 instead of U-Boot software protection.
1848 - CFG_DIRECT_FLASH_TFTP:
1850 Enable TFTP transfers directly to flash memory;
1851 without this option such a download has to be
1852 performed in two steps: (1) download to RAM, and (2)
1853 copy from RAM to flash.
1855 The two-step approach is usually more reliable, since
1856 you can check if the download worked before you erase
1857 the flash, but in some situations (when sytem RAM is
1858 too limited to allow for a tempory copy of the
1859 downloaded image) this option may be very useful.
1862 Define if the flash driver uses extra elements in the
1863 common flash structure for storing flash geometry.
1865 - CFG_FLASH_CFI_DRIVER
1866 This option also enables the building of the cfi_flash driver
1867 in the drivers directory
1869 - CFG_FLASH_QUIET_TEST
1870 If this option is defined, the common CFI flash doesn't
1871 print it's warning upon not recognized FLASH banks. This
1872 is useful, if some of the configured banks are only
1873 optionally available.
1875 - CFG_RX_ETH_BUFFER:
1876 Defines the number of ethernet receive buffers. On some
1877 ethernet controllers it is recommended to set this value
1878 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1879 buffers can be full shortly after enabling the interface
1880 on high ethernet traffic.
1881 Defaults to 4 if not defined.
1883 The following definitions that deal with the placement and management
1884 of environment data (variable area); in general, we support the
1885 following configurations:
1887 - CFG_ENV_IS_IN_FLASH:
1889 Define this if the environment is in flash memory.
1891 a) The environment occupies one whole flash sector, which is
1892 "embedded" in the text segment with the U-Boot code. This
1893 happens usually with "bottom boot sector" or "top boot
1894 sector" type flash chips, which have several smaller
1895 sectors at the start or the end. For instance, such a
1896 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1897 such a case you would place the environment in one of the
1898 4 kB sectors - with U-Boot code before and after it. With
1899 "top boot sector" type flash chips, you would put the
1900 environment in one of the last sectors, leaving a gap
1901 between U-Boot and the environment.
1905 Offset of environment data (variable area) to the
1906 beginning of flash memory; for instance, with bottom boot
1907 type flash chips the second sector can be used: the offset
1908 for this sector is given here.
1910 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1914 This is just another way to specify the start address of
1915 the flash sector containing the environment (instead of
1918 - CFG_ENV_SECT_SIZE:
1920 Size of the sector containing the environment.
1923 b) Sometimes flash chips have few, equal sized, BIG sectors.
1924 In such a case you don't want to spend a whole sector for
1929 If you use this in combination with CFG_ENV_IS_IN_FLASH
1930 and CFG_ENV_SECT_SIZE, you can specify to use only a part
1931 of this flash sector for the environment. This saves
1932 memory for the RAM copy of the environment.
1934 It may also save flash memory if you decide to use this
1935 when your environment is "embedded" within U-Boot code,
1936 since then the remainder of the flash sector could be used
1937 for U-Boot code. It should be pointed out that this is
1938 STRONGLY DISCOURAGED from a robustness point of view:
1939 updating the environment in flash makes it always
1940 necessary to erase the WHOLE sector. If something goes
1941 wrong before the contents has been restored from a copy in
1942 RAM, your target system will be dead.
1944 - CFG_ENV_ADDR_REDUND
1947 These settings describe a second storage area used to hold
1948 a redundand copy of the environment data, so that there is
1949 a valid backup copy in case there is a power failure during
1950 a "saveenv" operation.
1952 BE CAREFUL! Any changes to the flash layout, and some changes to the
1953 source code will make it necessary to adapt <board>/u-boot.lds*
1957 - CFG_ENV_IS_IN_NVRAM:
1959 Define this if you have some non-volatile memory device
1960 (NVRAM, battery buffered SRAM) which you want to use for the
1966 These two #defines are used to determin the memory area you
1967 want to use for environment. It is assumed that this memory
1968 can just be read and written to, without any special
1971 BE CAREFUL! The first access to the environment happens quite early
1972 in U-Boot initalization (when we try to get the setting of for the
1973 console baudrate). You *MUST* have mappend your NVRAM area then, or
1976 Please note that even with NVRAM we still use a copy of the
1977 environment in RAM: we could work on NVRAM directly, but we want to
1978 keep settings there always unmodified except somebody uses "saveenv"
1979 to save the current settings.
1982 - CFG_ENV_IS_IN_EEPROM:
1984 Use this if you have an EEPROM or similar serial access
1985 device and a driver for it.
1990 These two #defines specify the offset and size of the
1991 environment area within the total memory of your EEPROM.
1993 - CFG_I2C_EEPROM_ADDR:
1994 If defined, specified the chip address of the EEPROM device.
1995 The default address is zero.
1997 - CFG_EEPROM_PAGE_WRITE_BITS:
1998 If defined, the number of bits used to address bytes in a
1999 single page in the EEPROM device. A 64 byte page, for example
2000 would require six bits.
2002 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2003 If defined, the number of milliseconds to delay between
2004 page writes. The default is zero milliseconds.
2006 - CFG_I2C_EEPROM_ADDR_LEN:
2007 The length in bytes of the EEPROM memory array address. Note
2008 that this is NOT the chip address length!
2010 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
2011 EEPROM chips that implement "address overflow" are ones
2012 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2013 address and the extra bits end up in the "chip address" bit
2014 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2017 Note that we consider the length of the address field to
2018 still be one byte because the extra address bits are hidden
2019 in the chip address.
2022 The size in bytes of the EEPROM device.
2025 - CFG_ENV_IS_IN_DATAFLASH:
2027 Define this if you have a DataFlash memory device which you
2028 want to use for the environment.
2034 These three #defines specify the offset and size of the
2035 environment area within the total memory of your DataFlash placed
2036 at the specified address.
2038 - CFG_ENV_IS_IN_NAND:
2040 Define this if you have a NAND device which you want to use
2041 for the environment.
2046 These two #defines specify the offset and size of the environment
2047 area within the first NAND device.
2049 - CFG_ENV_OFFSET_REDUND
2051 This setting describes a second storage area of CFG_ENV_SIZE
2052 size used to hold a redundant copy of the environment data,
2053 so that there is a valid backup copy in case there is a
2054 power failure during a "saveenv" operation.
2056 Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2057 to a block boundary, and CFG_ENV_SIZE must be a multiple of
2058 the NAND devices block size.
2060 - CFG_SPI_INIT_OFFSET
2062 Defines offset to the initial SPI buffer area in DPRAM. The
2063 area is used at an early stage (ROM part) if the environment
2064 is configured to reside in the SPI EEPROM: We need a 520 byte
2065 scratch DPRAM area. It is used between the two initialization
2066 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2067 to be a good choice since it makes it far enough from the
2068 start of the data area as well as from the stack pointer.
2070 Please note that the environment is read-only as long as the monitor
2071 has been relocated to RAM and a RAM copy of the environment has been
2072 created; also, when using EEPROM you will have to use getenv_r()
2073 until then to read environment variables.
2075 The environment is protected by a CRC32 checksum. Before the monitor
2076 is relocated into RAM, as a result of a bad CRC you will be working
2077 with the compiled-in default environment - *silently*!!! [This is
2078 necessary, because the first environment variable we need is the
2079 "baudrate" setting for the console - if we have a bad CRC, we don't
2080 have any device yet where we could complain.]
2082 Note: once the monitor has been relocated, then it will complain if
2083 the default environment is used; a new CRC is computed as soon as you
2084 use the "saveenv" command to store a valid environment.
2086 - CFG_FAULT_ECHO_LINK_DOWN:
2087 Echo the inverted Ethernet link state to the fault LED.
2089 Note: If this option is active, then CFG_FAULT_MII_ADDR
2090 also needs to be defined.
2092 - CFG_FAULT_MII_ADDR:
2093 MII address of the PHY to check for the Ethernet link state.
2095 - CFG_64BIT_VSPRINTF:
2096 Makes vsprintf (and all *printf functions) support printing
2097 of 64bit values by using the L quantifier
2099 - CFG_64BIT_STRTOUL:
2100 Adds simple_strtoull that returns a 64bit value
2102 Low Level (hardware related) configuration options:
2103 ---------------------------------------------------
2105 - CFG_CACHELINE_SIZE:
2106 Cache Line Size of the CPU.
2109 Default address of the IMMR after system reset.
2111 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2112 and RPXsuper) to be able to adjust the position of
2113 the IMMR register after a reset.
2115 - Floppy Disk Support:
2116 CFG_FDC_DRIVE_NUMBER
2118 the default drive number (default value 0)
2122 defines the spacing between fdc chipset registers
2127 defines the offset of register from address. It
2128 depends on which part of the data bus is connected to
2129 the fdc chipset. (default value 0)
2131 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
2132 CFG_FDC_DRIVE_NUMBER are undefined, they take their
2135 if CFG_FDC_HW_INIT is defined, then the function
2136 fdc_hw_init() is called at the beginning of the FDC
2137 setup. fdc_hw_init() must be provided by the board
2138 source code. It is used to make hardware dependant
2141 - CFG_IMMR: Physical address of the Internal Memory.
2142 DO NOT CHANGE unless you know exactly what you're
2143 doing! (11-4) [MPC8xx/82xx systems only]
2145 - CFG_INIT_RAM_ADDR:
2147 Start address of memory area that can be used for
2148 initial data and stack; please note that this must be
2149 writable memory that is working WITHOUT special
2150 initialization, i. e. you CANNOT use normal RAM which
2151 will become available only after programming the
2152 memory controller and running certain initialization
2155 U-Boot uses the following memory types:
2156 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2157 - MPC824X: data cache
2158 - PPC4xx: data cache
2160 - CFG_GBL_DATA_OFFSET:
2162 Offset of the initial data structure in the memory
2163 area defined by CFG_INIT_RAM_ADDR. Usually
2164 CFG_GBL_DATA_OFFSET is chosen such that the initial
2165 data is located at the end of the available space
2166 (sometimes written as (CFG_INIT_RAM_END -
2167 CFG_INIT_DATA_SIZE), and the initial stack is just
2168 below that area (growing from (CFG_INIT_RAM_ADDR +
2169 CFG_GBL_DATA_OFFSET) downward.
2172 On the MPC824X (or other systems that use the data
2173 cache for initial memory) the address chosen for
2174 CFG_INIT_RAM_ADDR is basically arbitrary - it must
2175 point to an otherwise UNUSED address space between
2176 the top of RAM and the start of the PCI space.
2178 - CFG_SIUMCR: SIU Module Configuration (11-6)
2180 - CFG_SYPCR: System Protection Control (11-9)
2182 - CFG_TBSCR: Time Base Status and Control (11-26)
2184 - CFG_PISCR: Periodic Interrupt Status and Control (11-31)
2186 - CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
2188 - CFG_SCCR: System Clock and reset Control Register (15-27)
2190 - CFG_OR_TIMING_SDRAM:
2194 periodic timer for refresh
2196 - CFG_DER: Debug Event Register (37-47)
2198 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2199 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2200 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2202 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2204 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2205 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2206 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2207 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2209 - CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2210 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2211 Machine Mode Register and Memory Periodic Timer
2212 Prescaler definitions (SDRAM timing)
2214 - CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2215 enable I2C microcode relocation patch (MPC8xx);
2216 define relocation offset in DPRAM [DSP2]
2218 - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2219 enable SPI microcode relocation patch (MPC8xx);
2220 define relocation offset in DPRAM [SCC4]
2223 Use OSCM clock mode on MBX8xx board. Be careful,
2224 wrong setting might damage your board. Read
2225 doc/README.MBX before setting this variable!
2227 - CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2228 Offset of the bootmode word in DPRAM used by post
2229 (Power On Self Tests). This definition overrides
2230 #define'd default value in commproc.h resp.
2233 - CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2234 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2235 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2236 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2237 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2238 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2239 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
2240 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2241 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2243 - CONFIG_ETHER_ON_FEC[12]
2244 Define to enable FEC[12] on a 8xx series processor.
2246 - CONFIG_FEC[12]_PHY
2247 Define to the hardcoded PHY address which corresponds
2248 to the given FEC; i. e.
2249 #define CONFIG_FEC1_PHY 4
2250 means that the PHY with address 4 is connected to FEC1
2252 When set to -1, means to probe for first available.
2254 - CONFIG_FEC[12]_PHY_NORXERR
2255 The PHY does not have a RXERR line (RMII only).
2256 (so program the FEC to ignore it).
2259 Enable RMII mode for all FECs.
2260 Note that this is a global option, we can't
2261 have one FEC in standard MII mode and another in RMII mode.
2263 - CONFIG_CRC32_VERIFY
2264 Add a verify option to the crc32 command.
2267 => crc32 -v <address> <count> <crc32>
2269 Where address/count indicate a memory area
2270 and crc32 is the correct crc32 which the
2274 Add the "loopw" memory command. This only takes effect if
2275 the memory commands are activated globally (CFG_CMD_MEM).
2278 Add the "mdc" and "mwc" memory commands. These are cyclic
2283 This command will print 4 bytes (10,11,12,13) each 500 ms.
2285 => mwc.l 100 12345678 10
2286 This command will write 12345678 to address 100 all 10 ms.
2288 This only takes effect if the memory commands are activated
2289 globally (CFG_CMD_MEM).
2291 - CONFIG_SKIP_LOWLEVEL_INIT
2292 - CONFIG_SKIP_RELOCATE_UBOOT
2294 [ARM only] If these variables are defined, then
2295 certain low level initializations (like setting up
2296 the memory controller) are omitted and/or U-Boot does
2297 not relocate itself into RAM.
2298 Normally these variables MUST NOT be defined. The
2299 only exception is when U-Boot is loaded (to RAM) by
2300 some other boot loader or by a debugger which
2301 performs these intializations itself.
2304 Building the Software:
2305 ======================
2307 Building U-Boot has been tested in native PPC environments (on a
2308 PowerBook G3 running LinuxPPC 2000) and in cross environments
2309 (running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2312 If you are not using a native PPC environment, it is assumed that you
2313 have the GNU cross compiling tools available in your path and named
2314 with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2315 you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2316 the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2319 CROSS_COMPILE = ppc_4xx-
2322 U-Boot is intended to be simple to build. After installing the
2323 sources you must configure U-Boot for one specific board type. This
2328 where "NAME_config" is the name of one of the existing
2329 configurations; the following names are supported:
2331 ADCIOP_config FPS860L_config omap730p2_config
2332 ADS860_config GEN860T_config pcu_e_config
2334 AR405_config GENIETV_config PIP405_config
2335 at91rm9200dk_config GTH_config QS823_config
2336 CANBT_config hermes_config QS850_config
2337 cmi_mpc5xx_config hymod_config QS860T_config
2338 cogent_common_config IP860_config RPXlite_config
2339 cogent_mpc8260_config IVML24_config RPXlite_DW_config
2340 cogent_mpc8xx_config IVMS8_config RPXsuper_config
2341 CPCI405_config JSE_config rsdproto_config
2342 CPCIISER4_config LANTEC_config Sandpoint8240_config
2343 csb272_config lwmon_config sbc8260_config
2344 CU824_config MBX860T_config sbc8560_33_config
2345 DUET_ADS_config MBX_config sbc8560_66_config
2346 EBONY_config MPC8260ADS_config SM850_config
2347 ELPT860_config MPC8540ADS_config SPD823TS_config
2348 ESTEEM192E_config MPC8540EVAL_config stxgp3_config
2349 ETX094_config MPC8560ADS_config SXNI855T_config
2350 FADS823_config NETVIA_config TQM823L_config
2351 FADS850SAR_config omap1510inn_config TQM850L_config
2352 FADS860T_config omap1610h2_config TQM855L_config
2353 FPS850L_config omap1610inn_config TQM860L_config
2354 omap5912osk_config walnut_config
2355 omap2420h4_config Yukon8220_config
2358 Note: for some board special configuration names may exist; check if
2359 additional information is available from the board vendor; for
2360 instance, the TQM823L systems are available without (standard)
2361 or with LCD support. You can select such additional "features"
2362 when chosing the configuration, i. e.
2365 - will configure for a plain TQM823L, i. e. no LCD support
2367 make TQM823L_LCD_config
2368 - will configure for a TQM823L with U-Boot console on LCD
2373 Finally, type "make all", and you should get some working U-Boot
2374 images ready for download to / installation on your system:
2376 - "u-boot.bin" is a raw binary image
2377 - "u-boot" is an image in ELF binary format
2378 - "u-boot.srec" is in Motorola S-Record format
2381 Please be aware that the Makefiles assume you are using GNU make, so
2382 for instance on NetBSD you might need to use "gmake" instead of
2386 If the system board that you have is not listed, then you will need
2387 to port U-Boot to your hardware platform. To do this, follow these
2390 1. Add a new configuration option for your board to the toplevel
2391 "Makefile" and to the "MAKEALL" script, using the existing
2392 entries as examples. Note that here and at many other places
2393 boards and other names are listed in alphabetical sort order. Please
2395 2. Create a new directory to hold your board specific code. Add any
2396 files you need. In your board directory, you will need at least
2397 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
2398 3. Create a new configuration file "include/configs/<board>.h" for
2400 3. If you're porting U-Boot to a new CPU, then also create a new
2401 directory to hold your CPU specific code. Add any files you need.
2402 4. Run "make <board>_config" with your new name.
2403 5. Type "make", and you should get a working "u-boot.srec" file
2404 to be installed on your target system.
2405 6. Debug and solve any problems that might arise.
2406 [Of course, this last step is much harder than it sounds.]
2409 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2410 ==============================================================
2412 If you have modified U-Boot sources (for instance added a new board
2413 or support for new devices, a new CPU, etc.) you are expected to
2414 provide feedback to the other developers. The feedback normally takes
2415 the form of a "patch", i. e. a context diff against a certain (latest
2416 official or latest in CVS) version of U-Boot sources.
2418 But before you submit such a patch, please verify that your modifi-
2419 cation did not break existing code. At least make sure that *ALL* of
2420 the supported boards compile WITHOUT ANY compiler warnings. To do so,
2421 just run the "MAKEALL" script, which will configure and build U-Boot
2422 for ALL supported system. Be warned, this will take a while. You can
2423 select which (cross) compiler to use by passing a `CROSS_COMPILE'
2424 environment variable to the script, i. e. to use the cross tools from
2425 MontaVista's Hard Hat Linux you can type
2427 CROSS_COMPILE=ppc_8xx- MAKEALL
2429 or to build on a native PowerPC system you can type
2431 CROSS_COMPILE=' ' MAKEALL
2433 See also "U-Boot Porting Guide" below.
2436 Monitor Commands - Overview:
2437 ============================
2439 go - start application at address 'addr'
2440 run - run commands in an environment variable
2441 bootm - boot application image from memory
2442 bootp - boot image via network using BootP/TFTP protocol
2443 tftpboot- boot image via network using TFTP protocol
2444 and env variables "ipaddr" and "serverip"
2445 (and eventually "gatewayip")
2446 rarpboot- boot image via network using RARP/TFTP protocol
2447 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2448 loads - load S-Record file over serial line
2449 loadb - load binary file over serial line (kermit mode)
2451 mm - memory modify (auto-incrementing)
2452 nm - memory modify (constant address)
2453 mw - memory write (fill)
2455 cmp - memory compare
2456 crc32 - checksum calculation
2457 imd - i2c memory display
2458 imm - i2c memory modify (auto-incrementing)
2459 inm - i2c memory modify (constant address)
2460 imw - i2c memory write (fill)
2461 icrc32 - i2c checksum calculation
2462 iprobe - probe to discover valid I2C chip addresses
2463 iloop - infinite loop on address range
2464 isdram - print SDRAM configuration information
2465 sspi - SPI utility commands
2466 base - print or set address offset
2467 printenv- print environment variables
2468 setenv - set environment variables
2469 saveenv - save environment variables to persistent storage
2470 protect - enable or disable FLASH write protection
2471 erase - erase FLASH memory
2472 flinfo - print FLASH memory information
2473 bdinfo - print Board Info structure
2474 iminfo - print header information for application image
2475 coninfo - print console devices and informations
2476 ide - IDE sub-system
2477 loop - infinite loop on address range
2478 loopw - infinite write loop on address range
2479 mtest - simple RAM test
2480 icache - enable or disable instruction cache
2481 dcache - enable or disable data cache
2482 reset - Perform RESET of the CPU
2483 echo - echo args to console
2484 version - print monitor version
2485 help - print online help
2486 ? - alias for 'help'
2489 Monitor Commands - Detailed Description:
2490 ========================================
2494 For now: just type "help <command>".
2497 Environment Variables:
2498 ======================
2500 U-Boot supports user configuration using Environment Variables which
2501 can be made persistent by saving to Flash memory.
2503 Environment Variables are set using "setenv", printed using
2504 "printenv", and saved to Flash using "saveenv". Using "setenv"
2505 without a value can be used to delete a variable from the
2506 environment. As long as you don't save the environment you are
2507 working with an in-memory copy. In case the Flash area containing the
2508 environment is erased by accident, a default environment is provided.
2510 Some configuration options can be set using Environment Variables:
2512 baudrate - see CONFIG_BAUDRATE
2514 bootdelay - see CONFIG_BOOTDELAY
2516 bootcmd - see CONFIG_BOOTCOMMAND
2518 bootargs - Boot arguments when booting an RTOS image
2520 bootfile - Name of the image to load with TFTP
2522 autoload - if set to "no" (any string beginning with 'n'),
2523 "bootp" will just load perform a lookup of the
2524 configuration from the BOOTP server, but not try to
2525 load any image using TFTP
2527 autostart - if set to "yes", an image loaded using the "bootp",
2528 "rarpboot", "tftpboot" or "diskboot" commands will
2529 be automatically started (by internally calling
2532 If set to "no", a standalone image passed to the
2533 "bootm" command will be copied to the load address
2534 (and eventually uncompressed), but NOT be started.
2535 This can be used to load and uncompress arbitrary
2538 i2cfast - (PPC405GP|PPC405EP only)
2539 if set to 'y' configures Linux I2C driver for fast
2540 mode (400kHZ). This environment variable is used in
2541 initialization code. So, for changes to be effective
2542 it must be saved and board must be reset.
2544 initrd_high - restrict positioning of initrd images:
2545 If this variable is not set, initrd images will be
2546 copied to the highest possible address in RAM; this
2547 is usually what you want since it allows for
2548 maximum initrd size. If for some reason you want to
2549 make sure that the initrd image is loaded below the
2550 CFG_BOOTMAPSZ limit, you can set this environment
2551 variable to a value of "no" or "off" or "0".
2552 Alternatively, you can set it to a maximum upper
2553 address to use (U-Boot will still check that it
2554 does not overwrite the U-Boot stack and data).
2556 For instance, when you have a system with 16 MB
2557 RAM, and want to reserve 4 MB from use by Linux,
2558 you can do this by adding "mem=12M" to the value of
2559 the "bootargs" variable. However, now you must make
2560 sure that the initrd image is placed in the first
2561 12 MB as well - this can be done with
2563 setenv initrd_high 00c00000
2565 If you set initrd_high to 0xFFFFFFFF, this is an
2566 indication to U-Boot that all addresses are legal
2567 for the Linux kernel, including addresses in flash
2568 memory. In this case U-Boot will NOT COPY the
2569 ramdisk at all. This may be useful to reduce the
2570 boot time on your system, but requires that this
2571 feature is supported by your Linux kernel.
2573 ipaddr - IP address; needed for tftpboot command
2575 loadaddr - Default load address for commands like "bootp",
2576 "rarpboot", "tftpboot", "loadb" or "diskboot"
2578 loads_echo - see CONFIG_LOADS_ECHO
2580 serverip - TFTP server IP address; needed for tftpboot command
2582 bootretry - see CONFIG_BOOT_RETRY_TIME
2584 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
2586 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
2588 ethprime - When CONFIG_NET_MULTI is enabled controls which
2589 interface is used first.
2591 ethact - When CONFIG_NET_MULTI is enabled controls which
2592 interface is currently active. For example you
2593 can do the following
2595 => setenv ethact FEC ETHERNET
2596 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2597 => setenv ethact SCC ETHERNET
2598 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2600 netretry - When set to "no" each network operation will
2601 either succeed or fail without retrying.
2602 When set to "once" the network operation will
2603 fail when all the available network interfaces
2604 are tried once without success.
2605 Useful on scripts which control the retry operation
2608 tftpsrcport - If this is set, the value is used for TFTP's
2611 tftpdstport - If this is set, the value is used for TFTP's UDP
2612 destination port instead of the Well Know Port 69.
2614 vlan - When set to a value < 4095 the traffic over
2615 ethernet is encapsulated/received over 802.1q
2618 The following environment variables may be used and automatically
2619 updated by the network boot commands ("bootp" and "rarpboot"),
2620 depending the information provided by your boot server:
2622 bootfile - see above
2623 dnsip - IP address of your Domain Name Server
2624 dnsip2 - IP address of your secondary Domain Name Server
2625 gatewayip - IP address of the Gateway (Router) to use
2626 hostname - Target hostname
2628 netmask - Subnet Mask
2629 rootpath - Pathname of the root filesystem on the NFS server
2630 serverip - see above
2633 There are two special Environment Variables:
2635 serial# - contains hardware identification information such
2636 as type string and/or serial number
2637 ethaddr - Ethernet address
2639 These variables can be set only once (usually during manufacturing of
2640 the board). U-Boot refuses to delete or overwrite these variables
2641 once they have been set once.
2644 Further special Environment Variables:
2646 ver - Contains the U-Boot version string as printed
2647 with the "version" command. This variable is
2648 readonly (see CONFIG_VERSION_VARIABLE).
2651 Please note that changes to some configuration parameters may take
2652 only effect after the next boot (yes, that's just like Windoze :-).
2655 Command Line Parsing:
2656 =====================
2658 There are two different command line parsers available with U-Boot:
2659 the old "simple" one, and the much more powerful "hush" shell:
2661 Old, simple command line parser:
2662 --------------------------------
2664 - supports environment variables (through setenv / saveenv commands)
2665 - several commands on one line, separated by ';'
2666 - variable substitution using "... ${name} ..." syntax
2667 - special characters ('$', ';') can be escaped by prefixing with '\',
2669 setenv bootcmd bootm \${address}
2670 - You can also escape text by enclosing in single apostrophes, for example:
2671 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2676 - similar to Bourne shell, with control structures like
2677 if...then...else...fi, for...do...done; while...do...done,
2678 until...do...done, ...
2679 - supports environment ("global") variables (through setenv / saveenv
2680 commands) and local shell variables (through standard shell syntax
2681 "name=value"); only environment variables can be used with "run"
2687 (1) If a command line (or an environment variable executed by a "run"
2688 command) contains several commands separated by semicolon, and
2689 one of these commands fails, then the remaining commands will be
2692 (2) If you execute several variables with one call to run (i. e.
2693 calling run with a list af variables as arguments), any failing
2694 command will cause "run" to terminate, i. e. the remaining
2695 variables are not executed.
2697 Note for Redundant Ethernet Interfaces:
2698 =======================================
2700 Some boards come with redundant ethernet interfaces; U-Boot supports
2701 such configurations and is capable of automatic selection of a
2702 "working" interface when needed. MAC assignment works as follows:
2704 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2705 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2706 "eth1addr" (=>eth1), "eth2addr", ...
2708 If the network interface stores some valid MAC address (for instance
2709 in SROM), this is used as default address if there is NO correspon-
2710 ding setting in the environment; if the corresponding environment
2711 variable is set, this overrides the settings in the card; that means:
2713 o If the SROM has a valid MAC address, and there is no address in the
2714 environment, the SROM's address is used.
2716 o If there is no valid address in the SROM, and a definition in the
2717 environment exists, then the value from the environment variable is
2720 o If both the SROM and the environment contain a MAC address, and
2721 both addresses are the same, this MAC address is used.
2723 o If both the SROM and the environment contain a MAC address, and the
2724 addresses differ, the value from the environment is used and a
2727 o If neither SROM nor the environment contain a MAC address, an error
2734 The "boot" commands of this monitor operate on "image" files which
2735 can be basicly anything, preceeded by a special header; see the
2736 definitions in include/image.h for details; basicly, the header
2737 defines the following image properties:
2739 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2740 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2741 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2742 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2743 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2744 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2745 Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2746 * Compression Type (uncompressed, gzip, bzip2)
2752 The header is marked by a special Magic Number, and both the header
2753 and the data portions of the image are secured against corruption by
2760 Although U-Boot should support any OS or standalone application
2761 easily, the main focus has always been on Linux during the design of
2764 U-Boot includes many features that so far have been part of some
2765 special "boot loader" code within the Linux kernel. Also, any
2766 "initrd" images to be used are no longer part of one big Linux image;
2767 instead, kernel and "initrd" are separate images. This implementation
2768 serves several purposes:
2770 - the same features can be used for other OS or standalone
2771 applications (for instance: using compressed images to reduce the
2772 Flash memory footprint)
2774 - it becomes much easier to port new Linux kernel versions because
2775 lots of low-level, hardware dependent stuff are done by U-Boot
2777 - the same Linux kernel image can now be used with different "initrd"
2778 images; of course this also means that different kernel images can
2779 be run with the same "initrd". This makes testing easier (you don't
2780 have to build a new "zImage.initrd" Linux image when you just
2781 change a file in your "initrd"). Also, a field-upgrade of the
2782 software is easier now.
2788 Porting Linux to U-Boot based systems:
2789 ---------------------------------------
2791 U-Boot cannot save you from doing all the necessary modifications to
2792 configure the Linux device drivers for use with your target hardware
2793 (no, we don't intend to provide a full virtual machine interface to
2796 But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2798 Just make sure your machine specific header file (for instance
2799 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2800 Information structure as we define in include/u-boot.h, and make
2801 sure that your definition of IMAP_ADDR uses the same value as your
2802 U-Boot configuration in CFG_IMMR.
2805 Configuring the Linux kernel:
2806 -----------------------------
2808 No specific requirements for U-Boot. Make sure you have some root
2809 device (initial ramdisk, NFS) for your target system.
2812 Building a Linux Image:
2813 -----------------------
2815 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2816 not used. If you use recent kernel source, a new build target
2817 "uImage" will exist which automatically builds an image usable by
2818 U-Boot. Most older kernels also have support for a "pImage" target,
2819 which was introduced for our predecessor project PPCBoot and uses a
2820 100% compatible format.
2829 The "uImage" build target uses a special tool (in 'tools/mkimage') to
2830 encapsulate a compressed Linux kernel image with header information,
2831 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2833 * build a standard "vmlinux" kernel image (in ELF binary format):
2835 * convert the kernel into a raw binary image:
2837 ${CROSS_COMPILE}-objcopy -O binary \
2838 -R .note -R .comment \
2839 -S vmlinux linux.bin
2841 * compress the binary image:
2845 * package compressed binary image for U-Boot:
2847 mkimage -A ppc -O linux -T kernel -C gzip \
2848 -a 0 -e 0 -n "Linux Kernel Image" \
2849 -d linux.bin.gz uImage
2852 The "mkimage" tool can also be used to create ramdisk images for use
2853 with U-Boot, either separated from the Linux kernel image, or
2854 combined into one file. "mkimage" encapsulates the images with a 64
2855 byte header containing information about target architecture,
2856 operating system, image type, compression method, entry points, time
2857 stamp, CRC32 checksums, etc.
2859 "mkimage" can be called in two ways: to verify existing images and
2860 print the header information, or to build new images.
2862 In the first form (with "-l" option) mkimage lists the information
2863 contained in the header of an existing U-Boot image; this includes
2864 checksum verification:
2866 tools/mkimage -l image
2867 -l ==> list image header information
2869 The second form (with "-d" option) is used to build a U-Boot image
2870 from a "data file" which is used as image payload:
2872 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2873 -n name -d data_file image
2874 -A ==> set architecture to 'arch'
2875 -O ==> set operating system to 'os'
2876 -T ==> set image type to 'type'
2877 -C ==> set compression type 'comp'
2878 -a ==> set load address to 'addr' (hex)
2879 -e ==> set entry point to 'ep' (hex)
2880 -n ==> set image name to 'name'
2881 -d ==> use image data from 'datafile'
2883 Right now, all Linux kernels for PowerPC systems use the same load
2884 address (0x00000000), but the entry point address depends on the
2887 - 2.2.x kernels have the entry point at 0x0000000C,
2888 - 2.3.x and later kernels have the entry point at 0x00000000.
2890 So a typical call to build a U-Boot image would read:
2892 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2893 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2894 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2895 > examples/uImage.TQM850L
2896 Image Name: 2.4.4 kernel for TQM850L
2897 Created: Wed Jul 19 02:34:59 2000
2898 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2899 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2900 Load Address: 0x00000000
2901 Entry Point: 0x00000000
2903 To verify the contents of the image (or check for corruption):
2905 -> tools/mkimage -l examples/uImage.TQM850L
2906 Image Name: 2.4.4 kernel for TQM850L
2907 Created: Wed Jul 19 02:34:59 2000
2908 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2909 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2910 Load Address: 0x00000000
2911 Entry Point: 0x00000000
2913 NOTE: for embedded systems where boot time is critical you can trade
2914 speed for memory and install an UNCOMPRESSED image instead: this
2915 needs more space in Flash, but boots much faster since it does not
2916 need to be uncompressed:
2918 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2919 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2920 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2921 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2922 > examples/uImage.TQM850L-uncompressed
2923 Image Name: 2.4.4 kernel for TQM850L
2924 Created: Wed Jul 19 02:34:59 2000
2925 Image Type: PowerPC Linux Kernel Image (uncompressed)
2926 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2927 Load Address: 0x00000000
2928 Entry Point: 0x00000000
2931 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2932 when your kernel is intended to use an initial ramdisk:
2934 -> tools/mkimage -n 'Simple Ramdisk Image' \
2935 > -A ppc -O linux -T ramdisk -C gzip \
2936 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2937 Image Name: Simple Ramdisk Image
2938 Created: Wed Jan 12 14:01:50 2000
2939 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2940 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2941 Load Address: 0x00000000
2942 Entry Point: 0x00000000
2945 Installing a Linux Image:
2946 -------------------------
2948 To downloading a U-Boot image over the serial (console) interface,
2949 you must convert the image to S-Record format:
2951 objcopy -I binary -O srec examples/image examples/image.srec
2953 The 'objcopy' does not understand the information in the U-Boot
2954 image header, so the resulting S-Record file will be relative to
2955 address 0x00000000. To load it to a given address, you need to
2956 specify the target address as 'offset' parameter with the 'loads'
2959 Example: install the image to address 0x40100000 (which on the
2960 TQM8xxL is in the first Flash bank):
2962 => erase 40100000 401FFFFF
2968 ## Ready for S-Record download ...
2969 ~>examples/image.srec
2970 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2972 15989 15990 15991 15992
2973 [file transfer complete]
2975 ## Start Addr = 0x00000000
2978 You can check the success of the download using the 'iminfo' command;
2979 this includes a checksum verification so you can be sure no data
2980 corruption happened:
2984 ## Checking Image at 40100000 ...
2985 Image Name: 2.2.13 for initrd on TQM850L
2986 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2987 Data Size: 335725 Bytes = 327 kB = 0 MB
2988 Load Address: 00000000
2989 Entry Point: 0000000c
2990 Verifying Checksum ... OK
2996 The "bootm" command is used to boot an application that is stored in
2997 memory (RAM or Flash). In case of a Linux kernel image, the contents
2998 of the "bootargs" environment variable is passed to the kernel as
2999 parameters. You can check and modify this variable using the
3000 "printenv" and "setenv" commands:
3003 => printenv bootargs
3004 bootargs=root=/dev/ram
3006 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3008 => printenv bootargs
3009 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3012 ## Booting Linux kernel at 40020000 ...
3013 Image Name: 2.2.13 for NFS on TQM850L
3014 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3015 Data Size: 381681 Bytes = 372 kB = 0 MB
3016 Load Address: 00000000
3017 Entry Point: 0000000c
3018 Verifying Checksum ... OK
3019 Uncompressing Kernel Image ... OK
3020 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
3021 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3022 time_init: decrementer frequency = 187500000/60
3023 Calibrating delay loop... 49.77 BogoMIPS
3024 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3027 If you want to boot a Linux kernel with initial ram disk, you pass
3028 the memory addresses of both the kernel and the initrd image (PPBCOOT
3029 format!) to the "bootm" command:
3031 => imi 40100000 40200000
3033 ## Checking Image at 40100000 ...
3034 Image Name: 2.2.13 for initrd on TQM850L
3035 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3036 Data Size: 335725 Bytes = 327 kB = 0 MB
3037 Load Address: 00000000
3038 Entry Point: 0000000c
3039 Verifying Checksum ... OK
3041 ## Checking Image at 40200000 ...
3042 Image Name: Simple Ramdisk Image
3043 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3044 Data Size: 566530 Bytes = 553 kB = 0 MB
3045 Load Address: 00000000
3046 Entry Point: 00000000
3047 Verifying Checksum ... OK
3049 => bootm 40100000 40200000
3050 ## Booting Linux kernel at 40100000 ...
3051 Image Name: 2.2.13 for initrd on TQM850L
3052 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3053 Data Size: 335725 Bytes = 327 kB = 0 MB
3054 Load Address: 00000000
3055 Entry Point: 0000000c
3056 Verifying Checksum ... OK
3057 Uncompressing Kernel Image ... OK
3058 ## Loading RAMDisk Image at 40200000 ...
3059 Image Name: Simple Ramdisk Image
3060 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3061 Data Size: 566530 Bytes = 553 kB = 0 MB
3062 Load Address: 00000000
3063 Entry Point: 00000000
3064 Verifying Checksum ... OK
3065 Loading Ramdisk ... OK
3066 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
3067 Boot arguments: root=/dev/ram
3068 time_init: decrementer frequency = 187500000/60
3069 Calibrating delay loop... 49.77 BogoMIPS
3071 RAMDISK: Compressed image found at block 0
3072 VFS: Mounted root (ext2 filesystem).
3076 More About U-Boot Image Types:
3077 ------------------------------
3079 U-Boot supports the following image types:
3081 "Standalone Programs" are directly runnable in the environment
3082 provided by U-Boot; it is expected that (if they behave
3083 well) you can continue to work in U-Boot after return from
3084 the Standalone Program.
3085 "OS Kernel Images" are usually images of some Embedded OS which
3086 will take over control completely. Usually these programs
3087 will install their own set of exception handlers, device
3088 drivers, set up the MMU, etc. - this means, that you cannot
3089 expect to re-enter U-Boot except by resetting the CPU.
3090 "RAMDisk Images" are more or less just data blocks, and their
3091 parameters (address, size) are passed to an OS kernel that is
3093 "Multi-File Images" contain several images, typically an OS
3094 (Linux) kernel image and one or more data images like
3095 RAMDisks. This construct is useful for instance when you want
3096 to boot over the network using BOOTP etc., where the boot
3097 server provides just a single image file, but you want to get
3098 for instance an OS kernel and a RAMDisk image.
3100 "Multi-File Images" start with a list of image sizes, each
3101 image size (in bytes) specified by an "uint32_t" in network
3102 byte order. This list is terminated by an "(uint32_t)0".
3103 Immediately after the terminating 0 follow the images, one by
3104 one, all aligned on "uint32_t" boundaries (size rounded up to
3105 a multiple of 4 bytes).
3107 "Firmware Images" are binary images containing firmware (like
3108 U-Boot or FPGA images) which usually will be programmed to
3111 "Script files" are command sequences that will be executed by
3112 U-Boot's command interpreter; this feature is especially
3113 useful when you configure U-Boot to use a real shell (hush)
3114 as command interpreter.
3120 One of the features of U-Boot is that you can dynamically load and
3121 run "standalone" applications, which can use some resources of
3122 U-Boot like console I/O functions or interrupt services.
3124 Two simple examples are included with the sources:
3129 'examples/hello_world.c' contains a small "Hello World" Demo
3130 application; it is automatically compiled when you build U-Boot.
3131 It's configured to run at address 0x00040004, so you can play with it
3135 ## Ready for S-Record download ...
3136 ~>examples/hello_world.srec
3137 1 2 3 4 5 6 7 8 9 10 11 ...
3138 [file transfer complete]
3140 ## Start Addr = 0x00040004
3142 => go 40004 Hello World! This is a test.
3143 ## Starting application at 0x00040004 ...
3154 Hit any key to exit ...
3156 ## Application terminated, rc = 0x0
3158 Another example, which demonstrates how to register a CPM interrupt
3159 handler with the U-Boot code, can be found in 'examples/timer.c'.
3160 Here, a CPM timer is set up to generate an interrupt every second.
3161 The interrupt service routine is trivial, just printing a '.'
3162 character, but this is just a demo program. The application can be
3163 controlled by the following keys:
3165 ? - print current values og the CPM Timer registers
3166 b - enable interrupts and start timer
3167 e - stop timer and disable interrupts
3168 q - quit application
3171 ## Ready for S-Record download ...
3172 ~>examples/timer.srec
3173 1 2 3 4 5 6 7 8 9 10 11 ...
3174 [file transfer complete]
3176 ## Start Addr = 0x00040004
3179 ## Starting application at 0x00040004 ...
3182 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3185 [q, b, e, ?] Set interval 1000000 us
3188 [q, b, e, ?] ........
3189 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3192 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3195 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3198 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3200 [q, b, e, ?] ...Stopping timer
3202 [q, b, e, ?] ## Application terminated, rc = 0x0
3208 Over time, many people have reported problems when trying to use the
3209 "minicom" terminal emulation program for serial download. I (wd)
3210 consider minicom to be broken, and recommend not to use it. Under
3211 Unix, I recommend to use C-Kermit for general purpose use (and
3212 especially for kermit binary protocol download ("loadb" command), and
3213 use "cu" for S-Record download ("loads" command).
3215 Nevertheless, if you absolutely want to use it try adding this
3216 configuration to your "File transfer protocols" section:
3218 Name Program Name U/D FullScr IO-Red. Multi
3219 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3220 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
3226 Starting at version 0.9.2, U-Boot supports NetBSD both as host
3227 (build U-Boot) and target system (boots NetBSD/mpc8xx).
3229 Building requires a cross environment; it is known to work on
3230 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3231 need gmake since the Makefiles are not compatible with BSD make).
3232 Note that the cross-powerpc package does not install include files;
3233 attempting to build U-Boot will fail because <machine/ansi.h> is
3234 missing. This file has to be installed and patched manually:
3236 # cd /usr/pkg/cross/powerpc-netbsd/include
3238 # ln -s powerpc machine
3239 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3240 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
3242 Native builds *don't* work due to incompatibilities between native
3243 and U-Boot include files.
3245 Booting assumes that (the first part of) the image booted is a
3246 stage-2 loader which in turn loads and then invokes the kernel
3247 proper. Loader sources will eventually appear in the NetBSD source
3248 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
3249 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3252 Implementation Internals:
3253 =========================
3255 The following is not intended to be a complete description of every
3256 implementation detail. However, it should help to understand the
3257 inner workings of U-Boot and make it easier to port it to custom
3261 Initial Stack, Global Data:
3262 ---------------------------
3264 The implementation of U-Boot is complicated by the fact that U-Boot
3265 starts running out of ROM (flash memory), usually without access to
3266 system RAM (because the memory controller is not initialized yet).
3267 This means that we don't have writable Data or BSS segments, and BSS
3268 is not initialized as zero. To be able to get a C environment working
3269 at all, we have to allocate at least a minimal stack. Implementation
3270 options for this are defined and restricted by the CPU used: Some CPU
3271 models provide on-chip memory (like the IMMR area on MPC8xx and
3272 MPC826x processors), on others (parts of) the data cache can be
3273 locked as (mis-) used as memory, etc.
3275 Chris Hallinan posted a good summary of these issues to the
3276 u-boot-users mailing list:
3278 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3279 From: "Chris Hallinan" <clh@net1plus.com>
3280 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3283 Correct me if I'm wrong, folks, but the way I understand it
3284 is this: Using DCACHE as initial RAM for Stack, etc, does not
3285 require any physical RAM backing up the cache. The cleverness
3286 is that the cache is being used as a temporary supply of
3287 necessary storage before the SDRAM controller is setup. It's
3288 beyond the scope of this list to expain the details, but you
3289 can see how this works by studying the cache architecture and
3290 operation in the architecture and processor-specific manuals.
3292 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3293 is another option for the system designer to use as an
3294 initial stack/ram area prior to SDRAM being available. Either
3295 option should work for you. Using CS 4 should be fine if your
3296 board designers haven't used it for something that would
3297 cause you grief during the initial boot! It is frequently not
3300 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3301 with your processor/board/system design. The default value
3302 you will find in any recent u-boot distribution in
3303 walnut.h should work for you. I'd set it to a value larger
3304 than your SDRAM module. If you have a 64MB SDRAM module, set
3305 it above 400_0000. Just make sure your board has no resources
3306 that are supposed to respond to that address! That code in
3307 start.S has been around a while and should work as is when
3308 you get the config right.
3313 It is essential to remember this, since it has some impact on the C
3314 code for the initialization procedures:
3316 * Initialized global data (data segment) is read-only. Do not attempt
3319 * Do not use any unitialized global data (or implicitely initialized
3320 as zero data - BSS segment) at all - this is undefined, initiali-
3321 zation is performed later (when relocating to RAM).
3323 * Stack space is very limited. Avoid big data buffers or things like
3326 Having only the stack as writable memory limits means we cannot use
3327 normal global data to share information beween the code. But it
3328 turned out that the implementation of U-Boot can be greatly
3329 simplified by making a global data structure (gd_t) available to all
3330 functions. We could pass a pointer to this data as argument to _all_
3331 functions, but this would bloat the code. Instead we use a feature of
3332 the GCC compiler (Global Register Variables) to share the data: we
3333 place a pointer (gd) to the global data into a register which we
3334 reserve for this purpose.
3336 When choosing a register for such a purpose we are restricted by the
3337 relevant (E)ABI specifications for the current architecture, and by
3338 GCC's implementation.
3340 For PowerPC, the following registers have specific use:
3343 R3-R4: parameter passing and return values
3344 R5-R10: parameter passing
3345 R13: small data area pointer
3349 (U-Boot also uses R14 as internal GOT pointer.)
3351 ==> U-Boot will use R29 to hold a pointer to the global data
3353 Note: on PPC, we could use a static initializer (since the
3354 address of the global data structure is known at compile time),
3355 but it turned out that reserving a register results in somewhat
3356 smaller code - although the code savings are not that big (on
3357 average for all boards 752 bytes for the whole U-Boot image,
3358 624 text + 127 data).
3360 On ARM, the following registers are used:
3362 R0: function argument word/integer result
3363 R1-R3: function argument word
3365 R10: stack limit (used only if stack checking if enabled)
3366 R11: argument (frame) pointer
3367 R12: temporary workspace
3370 R15: program counter
3372 ==> U-Boot will use R8 to hold a pointer to the global data
3374 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3375 or current versions of GCC may "optimize" the code too much.
3380 U-Boot runs in system state and uses physical addresses, i.e. the
3381 MMU is not used either for address mapping nor for memory protection.
3383 The available memory is mapped to fixed addresses using the memory
3384 controller. In this process, a contiguous block is formed for each
3385 memory type (Flash, SDRAM, SRAM), even when it consists of several
3386 physical memory banks.
3388 U-Boot is installed in the first 128 kB of the first Flash bank (on
3389 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3390 booting and sizing and initializing DRAM, the code relocates itself
3391 to the upper end of DRAM. Immediately below the U-Boot code some
3392 memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3393 configuration setting]. Below that, a structure with global Board
3394 Info data is placed, followed by the stack (growing downward).
3396 Additionally, some exception handler code is copied to the low 8 kB
3397 of DRAM (0x00000000 ... 0x00001FFF).
3399 So a typical memory configuration with 16 MB of DRAM could look like
3402 0x0000 0000 Exception Vector code
3405 0x0000 2000 Free for Application Use
3411 0x00FB FF20 Monitor Stack (Growing downward)
3412 0x00FB FFAC Board Info Data and permanent copy of global data
3413 0x00FC 0000 Malloc Arena
3416 0x00FE 0000 RAM Copy of Monitor Code
3417 ... eventually: LCD or video framebuffer
3418 ... eventually: pRAM (Protected RAM - unchanged by reset)
3419 0x00FF FFFF [End of RAM]
3422 System Initialization:
3423 ----------------------
3425 In the reset configuration, U-Boot starts at the reset entry point
3426 (on most PowerPC systens at address 0x00000100). Because of the reset
3427 configuration for CS0# this is a mirror of the onboard Flash memory.
3428 To be able to re-map memory U-Boot then jumps to its link address.
3429 To be able to implement the initialization code in C, a (small!)
3430 initial stack is set up in the internal Dual Ported RAM (in case CPUs
3431 which provide such a feature like MPC8xx or MPC8260), or in a locked
3432 part of the data cache. After that, U-Boot initializes the CPU core,
3433 the caches and the SIU.
3435 Next, all (potentially) available memory banks are mapped using a
3436 preliminary mapping. For example, we put them on 512 MB boundaries
3437 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3438 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3439 programmed for SDRAM access. Using the temporary configuration, a
3440 simple memory test is run that determines the size of the SDRAM
3443 When there is more than one SDRAM bank, and the banks are of
3444 different size, the largest is mapped first. For equal size, the first
3445 bank (CS2#) is mapped first. The first mapping is always for address
3446 0x00000000, with any additional banks following immediately to create
3447 contiguous memory starting from 0.
3449 Then, the monitor installs itself at the upper end of the SDRAM area
3450 and allocates memory for use by malloc() and for the global Board
3451 Info data; also, the exception vector code is copied to the low RAM
3452 pages, and the final stack is set up.
3454 Only after this relocation will you have a "normal" C environment;
3455 until that you are restricted in several ways, mostly because you are
3456 running from ROM, and because the code will have to be relocated to a
3460 U-Boot Porting Guide:
3461 ----------------------
3463 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3467 int main (int argc, char *argv[])
3469 sighandler_t no_more_time;
3471 signal (SIGALRM, no_more_time);
3472 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3474 if (available_money > available_manpower) {
3475 pay consultant to port U-Boot;
3479 Download latest U-Boot source;
3481 Subscribe to u-boot-users mailing list;
3484 email ("Hi, I am new to U-Boot, how do I get started?");
3488 Read the README file in the top level directory;
3489 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3490 Read the source, Luke;
3493 if (available_money > toLocalCurrency ($2500)) {
3496 Add a lot of aggravation and time;
3499 Create your own board support subdirectory;
3501 Create your own board config file;
3505 Add / modify source code;
3509 email ("Hi, I am having problems...");
3511 Send patch file to Wolfgang;
3516 void no_more_time (int sig)
3525 All contributions to U-Boot should conform to the Linux kernel
3526 coding style; see the file "Documentation/CodingStyle" in your Linux
3527 kernel source directory.
3529 Please note that U-Boot is implemented in C (and to some small parts
3530 in Assembler); no C++ is used, so please do not use C++ style
3531 comments (//) in your code.
3533 Please also stick to the following formatting rules:
3534 - remove any trailing white space
3535 - use TAB characters for indentation, not spaces
3536 - make sure NOT to use DOS '\r\n' line feeds
3537 - do not add more than 2 empty lines to source files
3538 - do not add trailing empty lines to source files
3540 Submissions which do not conform to the standards may be returned
3541 with a request to reformat the changes.
3547 Since the number of patches for U-Boot is growing, we need to
3548 establish some rules. Submissions which do not conform to these rules
3549 may be rejected, even when they contain important and valuable stuff.
3551 Patches shall be sent to the u-boot-users mailing list.
3553 When you send a patch, please include the following information with
3556 * For bug fixes: a description of the bug and how your patch fixes
3557 this bug. Please try to include a way of demonstrating that the
3558 patch actually fixes something.
3560 * For new features: a description of the feature and your
3563 * A CHANGELOG entry as plaintext (separate from the patch)
3565 * For major contributions, your entry to the CREDITS file
3567 * When you add support for a new board, don't forget to add this
3568 board to the MAKEALL script, too.
3570 * If your patch adds new configuration options, don't forget to
3571 document these in the README file.
3573 * The patch itself. If you are accessing the CVS repository use "cvs
3574 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3575 version of diff does not support these options, then get the latest
3576 version of GNU diff.
3578 The current directory when running this command shall be the top
3579 level directory of the U-Boot source tree, or it's parent directory
3580 (i. e. please make sure that your patch includes sufficient
3581 directory information for the affected files).
3583 We accept patches as plain text, MIME attachments or as uuencoded
3586 * If one logical set of modifications affects or creates several
3587 files, all these changes shall be submitted in a SINGLE patch file.
3589 * Changesets that contain different, unrelated modifications shall be
3590 submitted as SEPARATE patches, one patch per changeset.
3595 * Before sending the patch, run the MAKEALL script on your patched
3596 source tree and make sure that no errors or warnings are reported
3597 for any of the boards.
3599 * Keep your modifications to the necessary minimum: A patch
3600 containing several unrelated changes or arbitrary reformats will be
3601 returned with a request to re-formatting / split it.
3603 * If you modify existing code, make sure that your new code does not
3604 add to the memory footprint of the code ;-) Small is beautiful!
3605 When adding new features, these should compile conditionally only
3606 (using #ifdef), and the resulting code with the new feature
3607 disabled must not need more memory than the old code without your
3610 * Remember that there is a size limit of 40 kB per message on the
3611 u-boot-users mailing list. Compression may help.
projects / karo-tx-uboot.git / blob