1 # SPDX-License-Identifier: GPL-2.0+
3 # (C) Copyright 2000 - 2013
4 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
9 This directory contains the source code for U-Boot, a boot loader for
10 Embedded boards based on PowerPC, ARM, MIPS and several other
11 processors, which can be installed in a boot ROM and used to
12 initialize and test the hardware or to download and run application
15 The development of U-Boot is closely related to Linux: some parts of
16 the source code originate in the Linux source tree, we have some
17 header files in common, and special provision has been made to
18 support booting of Linux images.
20 Some attention has been paid to make this software easily
21 configurable and extendable. For instance, all monitor commands are
22 implemented with the same call interface, so that it's very easy to
23 add new commands. Also, instead of permanently adding rarely used
24 code (for instance hardware test utilities) to the monitor, you can
25 load and run it dynamically.
31 In general, all boards for which a configuration option exists in the
32 Makefile have been tested to some extent and can be considered
33 "working". In fact, many of them are used in production systems.
35 In case of problems see the CHANGELOG file to find out who contributed
36 the specific port. In addition, there are various MAINTAINERS files
37 scattered throughout the U-Boot source identifying the people or
38 companies responsible for various boards and subsystems.
40 Note: As of August, 2010, there is no longer a CHANGELOG file in the
41 actual U-Boot source tree; however, it can be created dynamically
42 from the Git log using:
50 In case you have questions about, problems with or contributions for
51 U-Boot, you should send a message to the U-Boot mailing list at
52 <u-boot@lists.denx.de>. There is also an archive of previous traffic
53 on the mailing list - please search the archive before asking FAQ's.
54 Please see http://lists.denx.de/pipermail/u-boot and
55 http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
58 Where to get source code:
59 =========================
61 The U-Boot source code is maintained in the Git repository at
62 git://www.denx.de/git/u-boot.git ; you can browse it online at
63 http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
65 The "snapshot" links on this page allow you to download tarballs of
66 any version you might be interested in. Official releases are also
67 available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70 Pre-built (and tested) images are available from
71 ftp://ftp.denx.de/pub/u-boot/images/
77 - start from 8xxrom sources
78 - create PPCBoot project (http://sourceforge.net/projects/ppcboot)
80 - make it easier to add custom boards
81 - make it possible to add other [PowerPC] CPUs
82 - extend functions, especially:
83 * Provide extended interface to Linux boot loader
86 * ATA disk / SCSI ... boot
87 - create ARMBoot project (http://sourceforge.net/projects/armboot)
88 - add other CPU families (starting with ARM)
89 - create U-Boot project (http://sourceforge.net/projects/u-boot)
90 - current project page: see http://www.denx.de/wiki/U-Boot
96 The "official" name of this project is "Das U-Boot". The spelling
97 "U-Boot" shall be used in all written text (documentation, comments
98 in source files etc.). Example:
100 This is the README file for the U-Boot project.
102 File names etc. shall be based on the string "u-boot". Examples:
104 include/asm-ppc/u-boot.h
106 #include <asm/u-boot.h>
108 Variable names, preprocessor constants etc. shall be either based on
109 the string "u_boot" or on "U_BOOT". Example:
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
118 Starting with the release in October 2008, the names of the releases
119 were changed from numerical release numbers without deeper meaning
120 into a time stamp based numbering. Regular releases are identified by
121 names consisting of the calendar year and month of the release date.
122 Additional fields (if present) indicate release candidates or bug fix
123 releases in "stable" maintenance trees.
126 U-Boot v2009.11 - Release November 2009
127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
134 /arch Architecture specific files
135 /arc Files generic to ARC architecture
136 /arm Files generic to ARM architecture
137 /m68k Files generic to m68k architecture
138 /microblaze Files generic to microblaze architecture
139 /mips Files generic to MIPS architecture
140 /nds32 Files generic to NDS32 architecture
141 /nios2 Files generic to Altera NIOS2 architecture
142 /openrisc Files generic to OpenRISC architecture
143 /powerpc Files generic to PowerPC architecture
144 /riscv Files generic to RISC-V architecture
145 /sandbox Files generic to HW-independent "sandbox"
146 /sh Files generic to SH architecture
147 /x86 Files generic to x86 architecture
148 /api Machine/arch independent API for external apps
149 /board Board dependent files
150 /cmd U-Boot commands functions
151 /common Misc architecture independent functions
152 /configs Board default configuration files
153 /disk Code for disk drive partition handling
154 /doc Documentation (don't expect too much)
155 /drivers Commonly used device drivers
156 /dts Contains Makefile for building internal U-Boot fdt.
157 /examples Example code for standalone applications, etc.
158 /fs Filesystem code (cramfs, ext2, jffs2, etc.)
159 /include Header Files
160 /lib Library routines generic to all architectures
161 /Licenses Various license files
163 /post Power On Self Test
164 /scripts Various build scripts and Makefiles
165 /test Various unit test files
166 /tools Tools to build S-Record or U-Boot images, etc.
168 Software Configuration:
169 =======================
171 Configuration is usually done using C preprocessor defines; the
172 rationale behind that is to avoid dead code whenever possible.
174 There are two classes of configuration variables:
176 * Configuration _OPTIONS_:
177 These are selectable by the user and have names beginning with
180 * Configuration _SETTINGS_:
181 These depend on the hardware etc. and should not be meddled with if
182 you don't know what you're doing; they have names beginning with
185 Previously, all configuration was done by hand, which involved creating
186 symbolic links and editing configuration files manually. More recently,
187 U-Boot has added the Kbuild infrastructure used by the Linux kernel,
188 allowing you to use the "make menuconfig" command to configure your
192 Selection of Processor Architecture and Board Type:
193 ---------------------------------------------------
195 For all supported boards there are ready-to-use default
196 configurations available; just type "make <board_name>_defconfig".
198 Example: For a TQM823L module type:
201 make TQM823L_defconfig
203 Note: If you're looking for the default configuration file for a board
204 you're sure used to be there but is now missing, check the file
205 doc/README.scrapyard for a list of no longer supported boards.
210 U-Boot can be built natively to run on a Linux host using the 'sandbox'
211 board. This allows feature development which is not board- or architecture-
212 specific to be undertaken on a native platform. The sandbox is also used to
213 run some of U-Boot's tests.
215 See doc/arch/index.rst for more details.
218 Board Initialisation Flow:
219 --------------------------
221 This is the intended start-up flow for boards. This should apply for both
222 SPL and U-Boot proper (i.e. they both follow the same rules).
224 Note: "SPL" stands for "Secondary Program Loader," which is explained in
225 more detail later in this file.
227 At present, SPL mostly uses a separate code path, but the function names
228 and roles of each function are the same. Some boards or architectures
229 may not conform to this. At least most ARM boards which use
230 CONFIG_SPL_FRAMEWORK conform to this.
232 Execution typically starts with an architecture-specific (and possibly
233 CPU-specific) start.S file, such as:
235 - arch/arm/cpu/armv7/start.S
236 - arch/powerpc/cpu/mpc83xx/start.S
237 - arch/mips/cpu/start.S
239 and so on. From there, three functions are called; the purpose and
240 limitations of each of these functions are described below.
243 - purpose: essential init to permit execution to reach board_init_f()
244 - no global_data or BSS
245 - there is no stack (ARMv7 may have one but it will soon be removed)
246 - must not set up SDRAM or use console
247 - must only do the bare minimum to allow execution to continue to
249 - this is almost never needed
250 - return normally from this function
253 - purpose: set up the machine ready for running board_init_r():
254 i.e. SDRAM and serial UART
255 - global_data is available
257 - BSS is not available, so you cannot use global/static variables,
258 only stack variables and global_data
260 Non-SPL-specific notes:
261 - dram_init() is called to set up DRAM. If already done in SPL this
265 - you can override the entire board_init_f() function with your own
267 - preloader_console_init() can be called here in extremis
268 - should set up SDRAM, and anything needed to make the UART work
269 - these is no need to clear BSS, it will be done by crt0.S
270 - for specific scenarios on certain architectures an early BSS *can*
271 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
272 of BSS prior to entering board_init_f()) but doing so is discouraged.
273 Instead it is strongly recommended to architect any code changes
274 or additions such to not depend on the availability of BSS during
275 board_init_f() as indicated in other sections of this README to
276 maintain compatibility and consistency across the entire code base.
277 - must return normally from this function (don't call board_init_r()
280 Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
281 this point the stack and global_data are relocated to below
282 CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
286 - purpose: main execution, common code
287 - global_data is available
289 - BSS is available, all static/global variables can be used
290 - execution eventually continues to main_loop()
292 Non-SPL-specific notes:
293 - U-Boot is relocated to the top of memory and is now running from
297 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
298 CONFIG_SPL_STACK_R_ADDR points into SDRAM
299 - preloader_console_init() can be called here - typically this is
300 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
301 spl_board_init() function containing this call
302 - loads U-Boot or (in falcon mode) Linux
306 Configuration Options:
307 ----------------------
309 Configuration depends on the combination of board and CPU type; all
310 such information is kept in a configuration file
311 "include/configs/<board_name>.h".
313 Example: For a TQM823L module, all configuration settings are in
314 "include/configs/TQM823L.h".
317 Many of the options are named exactly as the corresponding Linux
318 kernel configuration options. The intention is to make it easier to
319 build a config tool - later.
321 - ARM Platform Bus Type(CCI):
322 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
323 provides full cache coherency between two clusters of multi-core
324 CPUs and I/O coherency for devices and I/O masters
326 CONFIG_SYS_FSL_HAS_CCI400
328 Defined For SoC that has cache coherent interconnect
331 CONFIG_SYS_FSL_HAS_CCN504
333 Defined for SoC that has cache coherent interconnect CCN-504
335 The following options need to be configured:
337 - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
339 - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
344 Specifies that the core is a 64-bit PowerPC implementation (implements
345 the "64" category of the Power ISA). This is necessary for ePAPR
346 compliance, among other possible reasons.
348 CONFIG_SYS_FSL_TBCLK_DIV
350 Defines the core time base clock divider ratio compared to the
351 system clock. On most PQ3 devices this is 8, on newer QorIQ
352 devices it can be 16 or 32. The ratio varies from SoC to Soc.
354 CONFIG_SYS_FSL_PCIE_COMPAT
356 Defines the string to utilize when trying to match PCIe device
357 tree nodes for the given platform.
359 CONFIG_SYS_FSL_ERRATUM_A004510
361 Enables a workaround for erratum A004510. If set,
362 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
363 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
365 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
366 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
368 Defines one or two SoC revisions (low 8 bits of SVR)
369 for which the A004510 workaround should be applied.
371 The rest of SVR is either not relevant to the decision
372 of whether the erratum is present (e.g. p2040 versus
373 p2041) or is implied by the build target, which controls
374 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
376 See Freescale App Note 4493 for more information about
379 CONFIG_A003399_NOR_WORKAROUND
380 Enables a workaround for IFC erratum A003399. It is only
381 required during NOR boot.
383 CONFIG_A008044_WORKAROUND
384 Enables a workaround for T1040/T1042 erratum A008044. It is only
385 required during NAND boot and valid for Rev 1.0 SoC revision
387 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
389 This is the value to write into CCSR offset 0x18600
390 according to the A004510 workaround.
392 CONFIG_SYS_FSL_DSP_DDR_ADDR
393 This value denotes start offset of DDR memory which is
394 connected exclusively to the DSP cores.
396 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
397 This value denotes start offset of M2 memory
398 which is directly connected to the DSP core.
400 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
401 This value denotes start offset of M3 memory which is directly
402 connected to the DSP core.
404 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
405 This value denotes start offset of DSP CCSR space.
407 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
408 Single Source Clock is clocking mode present in some of FSL SoC's.
409 In this mode, a single differential clock is used to supply
410 clocks to the sysclock, ddrclock and usbclock.
412 CONFIG_SYS_CPC_REINIT_F
413 This CONFIG is defined when the CPC is configured as SRAM at the
414 time of U-Boot entry and is required to be re-initialized.
417 Indicates this SoC supports deep sleep feature. If deep sleep is
418 supported, core will start to execute uboot when wakes up.
420 - Generic CPU options:
421 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
423 Defines the endianess of the CPU. Implementation of those
424 values is arch specific.
427 Freescale DDR driver in use. This type of DDR controller is
428 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
431 CONFIG_SYS_FSL_DDR_ADDR
432 Freescale DDR memory-mapped register base.
434 CONFIG_SYS_FSL_DDR_EMU
435 Specify emulator support for DDR. Some DDR features such as
436 deskew training are not available.
438 CONFIG_SYS_FSL_DDRC_GEN1
439 Freescale DDR1 controller.
441 CONFIG_SYS_FSL_DDRC_GEN2
442 Freescale DDR2 controller.
444 CONFIG_SYS_FSL_DDRC_GEN3
445 Freescale DDR3 controller.
447 CONFIG_SYS_FSL_DDRC_GEN4
448 Freescale DDR4 controller.
450 CONFIG_SYS_FSL_DDRC_ARM_GEN3
451 Freescale DDR3 controller for ARM-based SoCs.
454 Board config to use DDR1. It can be enabled for SoCs with
455 Freescale DDR1 or DDR2 controllers, depending on the board
459 Board config to use DDR2. It can be enabled for SoCs with
460 Freescale DDR2 or DDR3 controllers, depending on the board
464 Board config to use DDR3. It can be enabled for SoCs with
465 Freescale DDR3 or DDR3L controllers.
468 Board config to use DDR3L. It can be enabled for SoCs with
472 Board config to use DDR4. It can be enabled for SoCs with
475 CONFIG_SYS_FSL_IFC_BE
476 Defines the IFC controller register space as Big Endian
478 CONFIG_SYS_FSL_IFC_LE
479 Defines the IFC controller register space as Little Endian
481 CONFIG_SYS_FSL_IFC_CLK_DIV
482 Defines divider of platform clock(clock input to IFC controller).
484 CONFIG_SYS_FSL_LBC_CLK_DIV
485 Defines divider of platform clock(clock input to eLBC controller).
487 CONFIG_SYS_FSL_PBL_PBI
488 It enables addition of RCW (Power on reset configuration) in built image.
489 Please refer doc/README.pblimage for more details
491 CONFIG_SYS_FSL_PBL_RCW
492 It adds PBI(pre-boot instructions) commands in u-boot build image.
493 PBI commands can be used to configure SoC before it starts the execution.
494 Please refer doc/README.pblimage for more details
496 CONFIG_SYS_FSL_DDR_BE
497 Defines the DDR controller register space as Big Endian
499 CONFIG_SYS_FSL_DDR_LE
500 Defines the DDR controller register space as Little Endian
502 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
503 Physical address from the view of DDR controllers. It is the
504 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
505 it could be different for ARM SoCs.
507 CONFIG_SYS_FSL_DDR_INTLV_256B
508 DDR controller interleaving on 256-byte. This is a special
509 interleaving mode, handled by Dickens for Freescale layerscape
512 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
513 Number of controllers used as main memory.
515 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
516 Number of controllers used for other than main memory.
518 CONFIG_SYS_FSL_HAS_DP_DDR
519 Defines the SoC has DP-DDR used for DPAA.
521 CONFIG_SYS_FSL_SEC_BE
522 Defines the SEC controller register space as Big Endian
524 CONFIG_SYS_FSL_SEC_LE
525 Defines the SEC controller register space as Little Endian
528 CONFIG_SYS_INIT_SP_OFFSET
530 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
531 pointer. This is needed for the temporary stack before
534 CONFIG_XWAY_SWAP_BYTES
536 Enable compilation of tools/xway-swap-bytes needed for Lantiq
537 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
538 be swapped if a flash programmer is used.
541 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
543 Select high exception vectors of the ARM core, e.g., do not
544 clear the V bit of the c1 register of CP15.
547 Generic timer clock source frequency.
549 COUNTER_FREQUENCY_REAL
550 Generic timer clock source frequency if the real clock is
551 different from COUNTER_FREQUENCY, and can only be determined
555 CONFIG_TEGRA_SUPPORT_NON_SECURE
557 Support executing U-Boot in non-secure (NS) mode. Certain
558 impossible actions will be skipped if the CPU is in NS mode,
559 such as ARM architectural timer initialization.
561 - Linux Kernel Interface:
564 U-Boot stores all clock information in Hz
565 internally. For binary compatibility with older Linux
566 kernels (which expect the clocks passed in the
567 bd_info data to be in MHz) the environment variable
568 "clocks_in_mhz" can be defined so that U-Boot
569 converts clock data to MHZ before passing it to the
571 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
572 "clocks_in_mhz=1" is automatically included in the
575 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
577 When transferring memsize parameter to Linux, some versions
578 expect it to be in bytes, others in MB.
579 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
583 New kernel versions are expecting firmware settings to be
584 passed using flattened device trees (based on open firmware
588 * New libfdt-based support
589 * Adds the "fdt" command
590 * The bootm command automatically updates the fdt
592 OF_TBCLK - The timebase frequency.
593 OF_STDOUT_PATH - The path to the console device
595 boards with QUICC Engines require OF_QE to set UCC MAC
598 CONFIG_OF_BOARD_SETUP
600 Board code has addition modification that it wants to make
601 to the flat device tree before handing it off to the kernel
603 CONFIG_OF_SYSTEM_SETUP
605 Other code has addition modification that it wants to make
606 to the flat device tree before handing it off to the kernel.
607 This causes ft_system_setup() to be called before booting
612 U-Boot can detect if an IDE device is present or not.
613 If not, and this new config option is activated, U-Boot
614 removes the ATA node from the DTS before booting Linux,
615 so the Linux IDE driver does not probe the device and
616 crash. This is needed for buggy hardware (uc101) where
617 no pull down resistor is connected to the signal IDE5V_DD7.
619 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
621 This setting is mandatory for all boards that have only one
622 machine type and must be used to specify the machine type
623 number as it appears in the ARM machine registry
624 (see http://www.arm.linux.org.uk/developer/machines/).
625 Only boards that have multiple machine types supported
626 in a single configuration file and the machine type is
627 runtime discoverable, do not have to use this setting.
629 - vxWorks boot parameters:
631 bootvx constructs a valid bootline using the following
632 environments variables: bootdev, bootfile, ipaddr, netmask,
633 serverip, gatewayip, hostname, othbootargs.
634 It loads the vxWorks image pointed bootfile.
636 Note: If a "bootargs" environment is defined, it will overwride
637 the defaults discussed just above.
639 - Cache Configuration:
640 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
642 - Cache Configuration for ARM:
643 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
645 CONFIG_SYS_PL310_BASE - Physical base address of PL310
646 controller register space
651 Define this if you want support for Amba PrimeCell PL010 UARTs.
655 Define this if you want support for Amba PrimeCell PL011 UARTs.
659 If you have Amba PrimeCell PL011 UARTs, set this variable to
660 the clock speed of the UARTs.
664 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
665 define this to a list of base addresses for each (supported)
666 port. See e.g. include/configs/versatile.h
668 CONFIG_SERIAL_HW_FLOW_CONTROL
670 Define this variable to enable hw flow control in serial driver.
671 Current user of this option is drivers/serial/nsl16550.c driver
674 CONFIG_BAUDRATE - in bps
675 Select one of the baudrates listed in
676 CONFIG_SYS_BAUDRATE_TABLE, see below.
680 Only needed when CONFIG_BOOTDELAY is enabled;
681 define a command string that is automatically executed
682 when no character is read on the console interface
683 within "Boot Delay" after reset.
685 CONFIG_RAMBOOT and CONFIG_NFSBOOT
686 The value of these goes into the environment as
687 "ramboot" and "nfsboot" respectively, and can be used
688 as a convenience, when switching between booting from
691 - Serial Download Echo Mode:
693 If defined to 1, all characters received during a
694 serial download (using the "loads" command) are
695 echoed back. This might be needed by some terminal
696 emulations (like "cu"), but may as well just take
697 time on others. This setting #define's the initial
698 value of the "loads_echo" environment variable.
700 - Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
702 Select one of the baudrates listed in
703 CONFIG_SYS_BAUDRATE_TABLE, see below.
705 - Removal of commands
706 If no commands are needed to boot, you can disable
707 CONFIG_CMDLINE to remove them. In this case, the command line
708 will not be available, and when U-Boot wants to execute the
709 boot command (on start-up) it will call board_run_command()
710 instead. This can reduce image size significantly for very
711 simple boot procedures.
713 - Regular expression support:
715 If this variable is defined, U-Boot is linked against
716 the SLRE (Super Light Regular Expression) library,
717 which adds regex support to some commands, as for
718 example "env grep" and "setexpr".
722 If this variable is defined, U-Boot will use a device tree
723 to configure its devices, instead of relying on statically
724 compiled #defines in the board file. This option is
725 experimental and only available on a few boards. The device
726 tree is available in the global data as gd->fdt_blob.
728 U-Boot needs to get its device tree from somewhere. This can
729 be done using one of the three options below:
732 If this variable is defined, U-Boot will embed a device tree
733 binary in its image. This device tree file should be in the
734 board directory and called <soc>-<board>.dts. The binary file
735 is then picked up in board_init_f() and made available through
736 the global data structure as gd->fdt_blob.
739 If this variable is defined, U-Boot will build a device tree
740 binary. It will be called u-boot.dtb. Architecture-specific
741 code will locate it at run-time. Generally this works by:
743 cat u-boot.bin u-boot.dtb >image.bin
745 and in fact, U-Boot does this for you, creating a file called
746 u-boot-dtb.bin which is useful in the common case. You can
747 still use the individual files if you need something more
751 If this variable is defined, U-Boot will use the device tree
752 provided by the board at runtime instead of embedding one with
753 the image. Only boards defining board_fdt_blob_setup() support
754 this option (see include/fdtdec.h file).
758 If this variable is defined, it enables watchdog
759 support for the SoC. There must be support in the SoC
760 specific code for a watchdog. For the 8xx
761 CPUs, the SIU Watchdog feature is enabled in the SYPCR
762 register. When supported for a specific SoC is
763 available, then no further board specific code should
767 When using a watchdog circuitry external to the used
768 SoC, then define this variable and provide board
769 specific code for the "hw_watchdog_reset" function.
773 When CONFIG_CMD_DATE is selected, the type of the RTC
774 has to be selected, too. Define exactly one of the
777 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
778 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
779 CONFIG_RTC_MC146818 - use MC146818 RTC
780 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
781 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
782 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
783 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
784 CONFIG_RTC_DS164x - use Dallas DS164x RTC
785 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
786 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
787 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
788 CONFIG_SYS_RV3029_TCR - enable trickle charger on
791 Note that if the RTC uses I2C, then the I2C interface
792 must also be configured. See I2C Support, below.
795 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
797 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
798 chip-ngpio pairs that tell the PCA953X driver the number of
799 pins supported by a particular chip.
801 Note that if the GPIO device uses I2C, then the I2C interface
802 must also be configured. See I2C Support, below.
805 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
806 accesses and can checksum them or write a list of them out
807 to memory. See the 'iotrace' command for details. This is
808 useful for testing device drivers since it can confirm that
809 the driver behaves the same way before and after a code
810 change. Currently this is supported on sandbox and arm. To
811 add support for your architecture, add '#include <iotrace.h>'
812 to the bottom of arch/<arch>/include/asm/io.h and test.
814 Example output from the 'iotrace stats' command is below.
815 Note that if the trace buffer is exhausted, the checksum will
816 still continue to operate.
819 Start: 10000000 (buffer start address)
820 Size: 00010000 (buffer size)
821 Offset: 00000120 (current buffer offset)
822 Output: 10000120 (start + offset)
823 Count: 00000018 (number of trace records)
824 CRC32: 9526fb66 (CRC32 of all trace records)
828 When CONFIG_TIMESTAMP is selected, the timestamp
829 (date and time) of an image is printed by image
830 commands like bootm or iminfo. This option is
831 automatically enabled when you select CONFIG_CMD_DATE .
833 - Partition Labels (disklabels) Supported:
834 Zero or more of the following:
835 CONFIG_MAC_PARTITION Apple's MacOS partition table.
836 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
837 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
838 bootloader. Note 2TB partition limit; see
840 CONFIG_SCSI) you must configure support for at
841 least one non-MTD partition type as well.
844 CONFIG_IDE_RESET_ROUTINE - this is defined in several
845 board configurations files but used nowhere!
847 CONFIG_IDE_RESET - is this is defined, IDE Reset will
848 be performed by calling the function
849 ide_set_reset(int reset)
850 which has to be defined in a board specific file
855 Set this to enable ATAPI support.
860 Set this to enable support for disks larger than 137GB
861 Also look at CONFIG_SYS_64BIT_LBA.
862 Whithout these , LBA48 support uses 32bit variables and will 'only'
863 support disks up to 2.1TB.
865 CONFIG_SYS_64BIT_LBA:
866 When enabled, makes the IDE subsystem use 64bit sector addresses.
870 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
871 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
872 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
873 maximum numbers of LUNs, SCSI ID's and target
876 The environment variable 'scsidevs' is set to the number of
877 SCSI devices found during the last scan.
879 - NETWORK Support (PCI):
881 Support for Intel 8254x/8257x gigabit chips.
884 Utility code for direct access to the SPI bus on Intel 8257x.
885 This does not do anything useful unless you set at least one
886 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
888 CONFIG_E1000_SPI_GENERIC
889 Allow generic access to the SPI bus on the Intel 8257x, for
890 example with the "sspi" command.
893 Support for Digital 2114x chips.
896 Support for National dp83815 chips.
899 Support for National dp8382[01] gigabit chips.
901 - NETWORK Support (other):
903 CONFIG_DRIVER_AT91EMAC
904 Support for AT91RM9200 EMAC.
907 Define this to use reduced MII inteface
909 CONFIG_DRIVER_AT91EMAC_QUIET
910 If this defined, the driver is quiet.
911 The driver doen't show link status messages.
914 Support for the Calxeda XGMAC device
917 Support for SMSC's LAN91C96 chips.
919 CONFIG_LAN91C96_USE_32_BIT
920 Define this to enable 32 bit addressing
923 Support for SMSC's LAN91C111 chip
926 Define this to hold the physical address
927 of the device (I/O space)
929 CONFIG_SMC_USE_32_BIT
930 Define this if data bus is 32 bits
932 CONFIG_SMC_USE_IOFUNCS
933 Define this to use i/o functions instead of macros
934 (some hardware wont work with macros)
936 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
937 Define this if you have more then 3 PHYs.
940 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
942 CONFIG_FTGMAC100_EGIGA
943 Define this to use GE link update with gigabit PHY.
944 Define this if FTGMAC100 is connected to gigabit PHY.
945 If your system has 10/100 PHY only, it might not occur
946 wrong behavior. Because PHY usually return timeout or
947 useless data when polling gigabit status and gigabit
948 control registers. This behavior won't affect the
949 correctnessof 10/100 link speed update.
952 Support for Renesas on-chip Ethernet controller
954 CONFIG_SH_ETHER_USE_PORT
955 Define the number of ports to be used
957 CONFIG_SH_ETHER_PHY_ADDR
958 Define the ETH PHY's address
960 CONFIG_SH_ETHER_CACHE_WRITEBACK
961 If this option is set, the driver enables cache flush.
967 CONFIG_TPM_TIS_INFINEON
968 Support for Infineon i2c bus TPM devices. Only one device
969 per system is supported at this time.
971 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
972 Define the burst count bytes upper limit
975 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
977 CONFIG_TPM_ST33ZP24_I2C
978 Support for STMicroelectronics ST33ZP24 I2C devices.
979 Requires TPM_ST33ZP24 and I2C.
981 CONFIG_TPM_ST33ZP24_SPI
982 Support for STMicroelectronics ST33ZP24 SPI devices.
983 Requires TPM_ST33ZP24 and SPI.
986 Support for Atmel TWI TPM device. Requires I2C support.
989 Support for generic parallel port TPM devices. Only one device
990 per system is supported at this time.
992 CONFIG_TPM_TIS_BASE_ADDRESS
993 Base address where the generic TPM device is mapped
994 to. Contemporary x86 systems usually map it at
998 Define this to enable the TPM support library which provides
999 functional interfaces to some TPM commands.
1000 Requires support for a TPM device.
1002 CONFIG_TPM_AUTH_SESSIONS
1003 Define this to enable authorized functions in the TPM library.
1004 Requires CONFIG_TPM and CONFIG_SHA1.
1007 At the moment only the UHCI host controller is
1008 supported (PIP405, MIP405); define
1009 CONFIG_USB_UHCI to enable it.
1010 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1011 and define CONFIG_USB_STORAGE to enable the USB
1014 Supported are USB Keyboards and USB Floppy drives
1017 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1018 txfilltuning field in the EHCI controller on reset.
1020 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1021 HW module registers.
1024 Define the below if you wish to use the USB console.
1025 Once firmware is rebuilt from a serial console issue the
1026 command "setenv stdin usbtty; setenv stdout usbtty" and
1027 attach your USB cable. The Unix command "dmesg" should print
1028 it has found a new device. The environment variable usbtty
1029 can be set to gserial or cdc_acm to enable your device to
1030 appear to a USB host as a Linux gserial device or a
1031 Common Device Class Abstract Control Model serial device.
1032 If you select usbtty = gserial you should be able to enumerate
1034 # modprobe usbserial vendor=0xVendorID product=0xProductID
1035 else if using cdc_acm, simply setting the environment
1036 variable usbtty to be cdc_acm should suffice. The following
1037 might be defined in YourBoardName.h
1040 Define this to build a UDC device
1043 Define this to have a tty type of device available to
1044 talk to the UDC device
1047 Define this to enable the high speed support for usb
1048 device and usbtty. If this feature is enabled, a routine
1049 int is_usbd_high_speed(void)
1050 also needs to be defined by the driver to dynamically poll
1051 whether the enumeration has succeded at high speed or full
1054 CONFIG_SYS_CONSOLE_IS_IN_ENV
1055 Define this if you want stdin, stdout &/or stderr to
1058 If you have a USB-IF assigned VendorID then you may wish to
1059 define your own vendor specific values either in BoardName.h
1060 or directly in usbd_vendor_info.h. If you don't define
1061 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1062 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1063 should pretend to be a Linux device to it's target host.
1065 CONFIG_USBD_MANUFACTURER
1066 Define this string as the name of your company for
1067 - CONFIG_USBD_MANUFACTURER "my company"
1069 CONFIG_USBD_PRODUCT_NAME
1070 Define this string as the name of your product
1071 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1073 CONFIG_USBD_VENDORID
1074 Define this as your assigned Vendor ID from the USB
1075 Implementors Forum. This *must* be a genuine Vendor ID
1076 to avoid polluting the USB namespace.
1077 - CONFIG_USBD_VENDORID 0xFFFF
1079 CONFIG_USBD_PRODUCTID
1080 Define this as the unique Product ID
1082 - CONFIG_USBD_PRODUCTID 0xFFFF
1084 - ULPI Layer Support:
1085 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1086 the generic ULPI layer. The generic layer accesses the ULPI PHY
1087 via the platform viewport, so you need both the genric layer and
1088 the viewport enabled. Currently only Chipidea/ARC based
1089 viewport is supported.
1090 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1091 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1092 If your ULPI phy needs a different reference clock than the
1093 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1094 the appropriate value in Hz.
1097 The MMC controller on the Intel PXA is supported. To
1098 enable this define CONFIG_MMC. The MMC can be
1099 accessed from the boot prompt by mapping the device
1100 to physical memory similar to flash. Command line is
1101 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1102 the FAT fs. This is enabled with CONFIG_CMD_FAT.
1105 Support for Renesas on-chip MMCIF controller
1107 CONFIG_SH_MMCIF_ADDR
1108 Define the base address of MMCIF registers
1111 Define the clock frequency for MMCIF
1113 - USB Device Firmware Update (DFU) class support:
1115 This enables the USB portion of the DFU USB class
1118 This enables support for exposing NAND devices via DFU.
1121 This enables support for exposing RAM via DFU.
1122 Note: DFU spec refer to non-volatile memory usage, but
1123 allow usages beyond the scope of spec - here RAM usage,
1124 one that would help mostly the developer.
1126 CONFIG_SYS_DFU_DATA_BUF_SIZE
1127 Dfu transfer uses a buffer before writing data to the
1128 raw storage device. Make the size (in bytes) of this buffer
1129 configurable. The size of this buffer is also configurable
1130 through the "dfu_bufsiz" environment variable.
1132 CONFIG_SYS_DFU_MAX_FILE_SIZE
1133 When updating files rather than the raw storage device,
1134 we use a static buffer to copy the file into and then write
1135 the buffer once we've been given the whole file. Define
1136 this to the maximum filesize (in bytes) for the buffer.
1137 Default is 4 MiB if undefined.
1139 DFU_DEFAULT_POLL_TIMEOUT
1140 Poll timeout [ms], is the timeout a device can send to the
1141 host. The host must wait for this timeout before sending
1142 a subsequent DFU_GET_STATUS request to the device.
1144 DFU_MANIFEST_POLL_TIMEOUT
1145 Poll timeout [ms], which the device sends to the host when
1146 entering dfuMANIFEST state. Host waits this timeout, before
1147 sending again an USB request to the device.
1149 - Journaling Flash filesystem support:
1151 Define these for a default partition on a NAND device
1153 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1154 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1155 Define these for a default partition on a NOR device
1158 See Kconfig help for available keyboard drivers.
1162 Define this to enable a custom keyboard support.
1163 This simply calls drv_keyboard_init() which must be
1164 defined in your board-specific files. This option is deprecated
1165 and is only used by novena. For new boards, use driver model
1170 Enable the Freescale DIU video driver. Reference boards for
1171 SOCs that have a DIU should define this macro to enable DIU
1172 support, and should also define these other macros:
1177 CONFIG_VIDEO_SW_CURSOR
1178 CONFIG_VGA_AS_SINGLE_DEVICE
1180 CONFIG_VIDEO_BMP_LOGO
1182 The DIU driver will look for the 'video-mode' environment
1183 variable, and if defined, enable the DIU as a console during
1184 boot. See the documentation file doc/README.video for a
1185 description of this variable.
1187 - LCD Support: CONFIG_LCD
1189 Define this to enable LCD support (for output to LCD
1190 display); also select one of the supported displays
1191 by defining one of these:
1195 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1197 CONFIG_NEC_NL6448AC33:
1199 NEC NL6448AC33-18. Active, color, single scan.
1201 CONFIG_NEC_NL6448BC20
1203 NEC NL6448BC20-08. 6.5", 640x480.
1204 Active, color, single scan.
1206 CONFIG_NEC_NL6448BC33_54
1208 NEC NL6448BC33-54. 10.4", 640x480.
1209 Active, color, single scan.
1213 Sharp 320x240. Active, color, single scan.
1214 It isn't 16x9, and I am not sure what it is.
1216 CONFIG_SHARP_LQ64D341
1218 Sharp LQ64D341 display, 640x480.
1219 Active, color, single scan.
1223 HLD1045 display, 640x480.
1224 Active, color, single scan.
1228 Optrex CBL50840-2 NF-FW 99 22 M5
1230 Hitachi LMG6912RPFC-00T
1234 320x240. Black & white.
1236 CONFIG_LCD_ALIGNMENT
1238 Normally the LCD is page-aligned (typically 4KB). If this is
1239 defined then the LCD will be aligned to this value instead.
1240 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1241 here, since it is cheaper to change data cache settings on
1242 a per-section basis.
1247 Sometimes, for example if the display is mounted in portrait
1248 mode or even if it's mounted landscape but rotated by 180degree,
1249 we need to rotate our content of the display relative to the
1250 framebuffer, so that user can read the messages which are
1252 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1253 initialized with a given rotation from "vl_rot" out of
1254 "vidinfo_t" which is provided by the board specific code.
1255 The value for vl_rot is coded as following (matching to
1256 fbcon=rotate:<n> linux-kernel commandline):
1257 0 = no rotation respectively 0 degree
1258 1 = 90 degree rotation
1259 2 = 180 degree rotation
1260 3 = 270 degree rotation
1262 If CONFIG_LCD_ROTATION is not defined, the console will be
1263 initialized with 0degree rotation.
1267 Support drawing of RLE8-compressed bitmaps on the LCD.
1271 Enables an 'i2c edid' command which can read EDID
1272 information over I2C from an attached LCD display.
1274 - Splash Screen Support: CONFIG_SPLASH_SCREEN
1276 If this option is set, the environment is checked for
1277 a variable "splashimage". If found, the usual display
1278 of logo, copyright and system information on the LCD
1279 is suppressed and the BMP image at the address
1280 specified in "splashimage" is loaded instead. The
1281 console is redirected to the "nulldev", too. This
1282 allows for a "silent" boot where a splash screen is
1283 loaded very quickly after power-on.
1285 CONFIG_SPLASHIMAGE_GUARD
1287 If this option is set, then U-Boot will prevent the environment
1288 variable "splashimage" from being set to a problematic address
1289 (see doc/README.displaying-bmps).
1290 This option is useful for targets where, due to alignment
1291 restrictions, an improperly aligned BMP image will cause a data
1292 abort. If you think you will not have problems with unaligned
1293 accesses (for example because your toolchain prevents them)
1294 there is no need to set this option.
1296 CONFIG_SPLASH_SCREEN_ALIGN
1298 If this option is set the splash image can be freely positioned
1299 on the screen. Environment variable "splashpos" specifies the
1300 position as "x,y". If a positive number is given it is used as
1301 number of pixel from left/top. If a negative number is given it
1302 is used as number of pixel from right/bottom. You can also
1303 specify 'm' for centering the image.
1306 setenv splashpos m,m
1307 => image at center of screen
1309 setenv splashpos 30,20
1310 => image at x = 30 and y = 20
1312 setenv splashpos -10,m
1313 => vertically centered image
1314 at x = dspWidth - bmpWidth - 9
1316 - Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1318 If this option is set, additionally to standard BMP
1319 images, gzipped BMP images can be displayed via the
1320 splashscreen support or the bmp command.
1322 - Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1324 If this option is set, 8-bit RLE compressed BMP images
1325 can be displayed via the splashscreen support or the
1329 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1331 The clock frequency of the MII bus
1333 CONFIG_PHY_RESET_DELAY
1335 Some PHY like Intel LXT971A need extra delay after
1336 reset before any MII register access is possible.
1337 For such PHY, set this option to the usec delay
1338 required. (minimum 300usec for LXT971A)
1340 CONFIG_PHY_CMD_DELAY (ppc4xx)
1342 Some PHY like Intel LXT971A need extra delay after
1343 command issued before MII status register can be read
1348 Define a default value for the IP address to use for
1349 the default Ethernet interface, in case this is not
1350 determined through e.g. bootp.
1351 (Environment variable "ipaddr")
1353 - Server IP address:
1356 Defines a default value for the IP address of a TFTP
1357 server to contact when using the "tftboot" command.
1358 (Environment variable "serverip")
1360 CONFIG_KEEP_SERVERADDR
1362 Keeps the server's MAC address, in the env 'serveraddr'
1363 for passing to bootargs (like Linux's netconsole option)
1365 - Gateway IP address:
1368 Defines a default value for the IP address of the
1369 default router where packets to other networks are
1371 (Environment variable "gatewayip")
1376 Defines a default value for the subnet mask (or
1377 routing prefix) which is used to determine if an IP
1378 address belongs to the local subnet or needs to be
1379 forwarded through a router.
1380 (Environment variable "netmask")
1382 - BOOTP Recovery Mode:
1383 CONFIG_BOOTP_RANDOM_DELAY
1385 If you have many targets in a network that try to
1386 boot using BOOTP, you may want to avoid that all
1387 systems send out BOOTP requests at precisely the same
1388 moment (which would happen for instance at recovery
1389 from a power failure, when all systems will try to
1390 boot, thus flooding the BOOTP server. Defining
1391 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1392 inserted before sending out BOOTP requests. The
1393 following delays are inserted then:
1395 1st BOOTP request: delay 0 ... 1 sec
1396 2nd BOOTP request: delay 0 ... 2 sec
1397 3rd BOOTP request: delay 0 ... 4 sec
1399 BOOTP requests: delay 0 ... 8 sec
1401 CONFIG_BOOTP_ID_CACHE_SIZE
1403 BOOTP packets are uniquely identified using a 32-bit ID. The
1404 server will copy the ID from client requests to responses and
1405 U-Boot will use this to determine if it is the destination of
1406 an incoming response. Some servers will check that addresses
1407 aren't in use before handing them out (usually using an ARP
1408 ping) and therefore take up to a few hundred milliseconds to
1409 respond. Network congestion may also influence the time it
1410 takes for a response to make it back to the client. If that
1411 time is too long, U-Boot will retransmit requests. In order
1412 to allow earlier responses to still be accepted after these
1413 retransmissions, U-Boot's BOOTP client keeps a small cache of
1414 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1415 cache. The default is to keep IDs for up to four outstanding
1416 requests. Increasing this will allow U-Boot to accept offers
1417 from a BOOTP client in networks with unusually high latency.
1419 - DHCP Advanced Options:
1420 You can fine tune the DHCP functionality by defining
1421 CONFIG_BOOTP_* symbols:
1423 CONFIG_BOOTP_NISDOMAIN
1424 CONFIG_BOOTP_BOOTFILESIZE
1425 CONFIG_BOOTP_SEND_HOSTNAME
1426 CONFIG_BOOTP_NTPSERVER
1427 CONFIG_BOOTP_TIMEOFFSET
1428 CONFIG_BOOTP_VENDOREX
1429 CONFIG_BOOTP_MAY_FAIL
1431 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1432 environment variable, not the BOOTP server.
1434 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1435 after the configured retry count, the call will fail
1436 instead of starting over. This can be used to fail over
1437 to Link-local IP address configuration if the DHCP server
1440 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1441 to do a dynamic update of a DNS server. To do this, they
1442 need the hostname of the DHCP requester.
1443 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1444 of the "hostname" environment variable is passed as
1445 option 12 to the DHCP server.
1447 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1449 A 32bit value in microseconds for a delay between
1450 receiving a "DHCP Offer" and sending the "DHCP Request".
1451 This fixes a problem with certain DHCP servers that don't
1452 respond 100% of the time to a "DHCP request". E.g. On an
1453 AT91RM9200 processor running at 180MHz, this delay needed
1454 to be *at least* 15,000 usec before a Windows Server 2003
1455 DHCP server would reply 100% of the time. I recommend at
1456 least 50,000 usec to be safe. The alternative is to hope
1457 that one of the retries will be successful but note that
1458 the DHCP timeout and retry process takes a longer than
1461 - Link-local IP address negotiation:
1462 Negotiate with other link-local clients on the local network
1463 for an address that doesn't require explicit configuration.
1464 This is especially useful if a DHCP server cannot be guaranteed
1465 to exist in all environments that the device must operate.
1467 See doc/README.link-local for more information.
1469 - MAC address from environment variables
1471 FDT_SEQ_MACADDR_FROM_ENV
1473 Fix-up device tree with MAC addresses fetched sequentially from
1474 environment variables. This config work on assumption that
1475 non-usable ethernet node of device-tree are either not present
1476 or their status has been marked as "disabled".
1479 CONFIG_CDP_DEVICE_ID
1481 The device id used in CDP trigger frames.
1483 CONFIG_CDP_DEVICE_ID_PREFIX
1485 A two character string which is prefixed to the MAC address
1490 A printf format string which contains the ascii name of
1491 the port. Normally is set to "eth%d" which sets
1492 eth0 for the first Ethernet, eth1 for the second etc.
1494 CONFIG_CDP_CAPABILITIES
1496 A 32bit integer which indicates the device capabilities;
1497 0x00000010 for a normal host which does not forwards.
1501 An ascii string containing the version of the software.
1505 An ascii string containing the name of the platform.
1509 A 32bit integer sent on the trigger.
1511 CONFIG_CDP_POWER_CONSUMPTION
1513 A 16bit integer containing the power consumption of the
1514 device in .1 of milliwatts.
1516 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1518 A byte containing the id of the VLAN.
1520 - Status LED: CONFIG_LED_STATUS
1522 Several configurations allow to display the current
1523 status using a LED. For instance, the LED will blink
1524 fast while running U-Boot code, stop blinking as
1525 soon as a reply to a BOOTP request was received, and
1526 start blinking slow once the Linux kernel is running
1527 (supported by a status LED driver in the Linux
1528 kernel). Defining CONFIG_LED_STATUS enables this
1533 CONFIG_LED_STATUS_GPIO
1534 The status LED can be connected to a GPIO pin.
1535 In such cases, the gpio_led driver can be used as a
1536 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1537 to include the gpio_led driver in the U-Boot binary.
1539 CONFIG_GPIO_LED_INVERTED_TABLE
1540 Some GPIO connected LEDs may have inverted polarity in which
1541 case the GPIO high value corresponds to LED off state and
1542 GPIO low value corresponds to LED on state.
1543 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1544 with a list of GPIO LEDs that have inverted polarity.
1546 - I2C Support: CONFIG_SYS_I2C
1548 This enable the NEW i2c subsystem, and will allow you to use
1549 i2c commands at the u-boot command line (as long as you set
1550 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1551 for defining speed and slave address
1552 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1553 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1554 for defining speed and slave address
1555 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1556 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1557 for defining speed and slave address
1558 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1559 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1560 for defining speed and slave address
1562 - drivers/i2c/fsl_i2c.c:
1563 - activate i2c driver with CONFIG_SYS_I2C_FSL
1564 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1565 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1566 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1568 - If your board supports a second fsl i2c bus, define
1569 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1570 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1571 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1574 - drivers/i2c/tegra_i2c.c:
1575 - activate this driver with CONFIG_SYS_I2C_TEGRA
1576 - This driver adds 4 i2c buses with a fix speed from
1577 100000 and the slave addr 0!
1579 - drivers/i2c/ppc4xx_i2c.c
1580 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1581 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1582 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1584 - drivers/i2c/i2c_mxc.c
1585 - activate this driver with CONFIG_SYS_I2C_MXC
1586 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1587 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1588 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1589 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
1590 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1591 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1592 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1593 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1594 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1595 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
1596 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1597 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
1598 If those defines are not set, default value is 100000
1599 for speed, and 0 for slave.
1601 - drivers/i2c/rcar_i2c.c:
1602 - activate this driver with CONFIG_SYS_I2C_RCAR
1603 - This driver adds 4 i2c buses
1605 - drivers/i2c/sh_i2c.c:
1606 - activate this driver with CONFIG_SYS_I2C_SH
1607 - This driver adds from 2 to 5 i2c buses
1609 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1610 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1611 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1612 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1613 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1614 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1615 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1616 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1617 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1618 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
1619 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
1621 - drivers/i2c/omap24xx_i2c.c
1622 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1623 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1624 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1625 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1626 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1627 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1628 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1629 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1630 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1631 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1632 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1634 - drivers/i2c/s3c24x0_i2c.c:
1635 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1636 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1637 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1638 with a fix speed from 100000 and the slave addr 0!
1640 - drivers/i2c/ihs_i2c.c
1641 - activate this driver with CONFIG_SYS_I2C_IHS
1642 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1643 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1644 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1645 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1646 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1647 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1648 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1649 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1650 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1651 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1652 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1653 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
1654 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1655 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1656 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1657 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1658 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1659 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1660 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1661 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1662 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
1666 CONFIG_SYS_NUM_I2C_BUSES
1667 Hold the number of i2c buses you want to use.
1669 CONFIG_SYS_I2C_DIRECT_BUS
1670 define this, if you don't use i2c muxes on your hardware.
1671 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1674 CONFIG_SYS_I2C_MAX_HOPS
1675 define how many muxes are maximal consecutively connected
1676 on one i2c bus. If you not use i2c muxes, omit this
1679 CONFIG_SYS_I2C_BUSES
1680 hold a list of buses you want to use, only used if
1681 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1682 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1683 CONFIG_SYS_NUM_I2C_BUSES = 9:
1685 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1686 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1687 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1688 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1689 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1690 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1691 {1, {I2C_NULL_HOP}}, \
1692 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1693 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1697 bus 0 on adapter 0 without a mux
1698 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1699 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1700 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1701 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1702 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
1703 bus 6 on adapter 1 without a mux
1704 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1705 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
1707 If you do not have i2c muxes on your board, omit this define.
1709 - Legacy I2C Support:
1710 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
1711 then the following macros need to be defined (examples are
1712 from include/configs/lwmon.h):
1716 (Optional). Any commands necessary to enable the I2C
1717 controller or configure ports.
1719 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
1723 The code necessary to make the I2C data line active
1724 (driven). If the data line is open collector, this
1727 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1731 The code necessary to make the I2C data line tri-stated
1732 (inactive). If the data line is open collector, this
1735 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1739 Code that returns true if the I2C data line is high,
1742 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1746 If <bit> is true, sets the I2C data line high. If it
1747 is false, it clears it (low).
1749 eg: #define I2C_SDA(bit) \
1750 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
1751 else immr->im_cpm.cp_pbdat &= ~PB_SDA
1755 If <bit> is true, sets the I2C clock line high. If it
1756 is false, it clears it (low).
1758 eg: #define I2C_SCL(bit) \
1759 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
1760 else immr->im_cpm.cp_pbdat &= ~PB_SCL
1764 This delay is invoked four times per clock cycle so this
1765 controls the rate of data transfer. The data rate thus
1766 is 1 / (I2C_DELAY * 4). Often defined to be something
1769 #define I2C_DELAY udelay(2)
1771 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1773 If your arch supports the generic GPIO framework (asm/gpio.h),
1774 then you may alternatively define the two GPIOs that are to be
1775 used as SCL / SDA. Any of the previous I2C_xxx macros will
1776 have GPIO-based defaults assigned to them as appropriate.
1778 You should define these to the GPIO value as given directly to
1779 the generic GPIO functions.
1781 CONFIG_SYS_I2C_INIT_BOARD
1783 When a board is reset during an i2c bus transfer
1784 chips might think that the current transfer is still
1785 in progress. On some boards it is possible to access
1786 the i2c SCLK line directly, either by using the
1787 processor pin as a GPIO or by having a second pin
1788 connected to the bus. If this option is defined a
1789 custom i2c_init_board() routine in boards/xxx/board.c
1790 is run early in the boot sequence.
1792 CONFIG_I2C_MULTI_BUS
1794 This option allows the use of multiple I2C buses, each of which
1795 must have a controller. At any point in time, only one bus is
1796 active. To switch to a different bus, use the 'i2c dev' command.
1797 Note that bus numbering is zero-based.
1799 CONFIG_SYS_I2C_NOPROBES
1801 This option specifies a list of I2C devices that will be skipped
1802 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1803 is set, specify a list of bus-device pairs. Otherwise, specify
1804 a 1D array of device addresses
1807 #undef CONFIG_I2C_MULTI_BUS
1808 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1810 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1812 #define CONFIG_I2C_MULTI_BUS
1813 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1815 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1817 CONFIG_SYS_SPD_BUS_NUM
1819 If defined, then this indicates the I2C bus number for DDR SPD.
1820 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1822 CONFIG_SYS_RTC_BUS_NUM
1824 If defined, then this indicates the I2C bus number for the RTC.
1825 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1827 CONFIG_SOFT_I2C_READ_REPEATED_START
1829 defining this will force the i2c_read() function in
1830 the soft_i2c driver to perform an I2C repeated start
1831 between writing the address pointer and reading the
1832 data. If this define is omitted the default behaviour
1833 of doing a stop-start sequence will be used. Most I2C
1834 devices can use either method, but some require one or
1837 - SPI Support: CONFIG_SPI
1839 Enables SPI driver (so far only tested with
1840 SPI EEPROM, also an instance works with Crystal A/D and
1841 D/As on the SACSng board)
1845 Enables a software (bit-bang) SPI driver rather than
1846 using hardware support. This is a general purpose
1847 driver that only requires three general I/O port pins
1848 (two outputs, one input) to function. If this is
1849 defined, the board configuration must define several
1850 SPI configuration items (port pins to use, etc). For
1851 an example, see include/configs/sacsng.h.
1853 CONFIG_SYS_SPI_MXC_WAIT
1854 Timeout for waiting until spi transfer completed.
1855 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1857 - FPGA Support: CONFIG_FPGA
1859 Enables FPGA subsystem.
1861 CONFIG_FPGA_<vendor>
1863 Enables support for specific chip vendors.
1866 CONFIG_FPGA_<family>
1868 Enables support for FPGA family.
1869 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1873 Specify the number of FPGA devices to support.
1875 CONFIG_SYS_FPGA_PROG_FEEDBACK
1877 Enable printing of hash marks during FPGA configuration.
1879 CONFIG_SYS_FPGA_CHECK_BUSY
1881 Enable checks on FPGA configuration interface busy
1882 status by the configuration function. This option
1883 will require a board or device specific function to
1888 If defined, a function that provides delays in the FPGA
1889 configuration driver.
1891 CONFIG_SYS_FPGA_CHECK_CTRLC
1892 Allow Control-C to interrupt FPGA configuration
1894 CONFIG_SYS_FPGA_CHECK_ERROR
1896 Check for configuration errors during FPGA bitfile
1897 loading. For example, abort during Virtex II
1898 configuration if the INIT_B line goes low (which
1899 indicated a CRC error).
1901 CONFIG_SYS_FPGA_WAIT_INIT
1903 Maximum time to wait for the INIT_B line to de-assert
1904 after PROB_B has been de-asserted during a Virtex II
1905 FPGA configuration sequence. The default time is 500
1908 CONFIG_SYS_FPGA_WAIT_BUSY
1910 Maximum time to wait for BUSY to de-assert during
1911 Virtex II FPGA configuration. The default is 5 ms.
1913 CONFIG_SYS_FPGA_WAIT_CONFIG
1915 Time to wait after FPGA configuration. The default is
1918 - Configuration Management:
1922 If defined, this string will be added to the U-Boot
1923 version information (U_BOOT_VERSION)
1925 - Vendor Parameter Protection:
1927 U-Boot considers the values of the environment
1928 variables "serial#" (Board Serial Number) and
1929 "ethaddr" (Ethernet Address) to be parameters that
1930 are set once by the board vendor / manufacturer, and
1931 protects these variables from casual modification by
1932 the user. Once set, these variables are read-only,
1933 and write or delete attempts are rejected. You can
1934 change this behaviour:
1936 If CONFIG_ENV_OVERWRITE is #defined in your config
1937 file, the write protection for vendor parameters is
1938 completely disabled. Anybody can change or delete
1941 Alternatively, if you define _both_ an ethaddr in the
1942 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1943 Ethernet address is installed in the environment,
1944 which can be changed exactly ONCE by the user. [The
1945 serial# is unaffected by this, i. e. it remains
1948 The same can be accomplished in a more flexible way
1949 for any variable by configuring the type of access
1950 to allow for those variables in the ".flags" variable
1951 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1956 Define this variable to enable the reservation of
1957 "protected RAM", i. e. RAM which is not overwritten
1958 by U-Boot. Define CONFIG_PRAM to hold the number of
1959 kB you want to reserve for pRAM. You can overwrite
1960 this default value by defining an environment
1961 variable "pram" to the number of kB you want to
1962 reserve. Note that the board info structure will
1963 still show the full amount of RAM. If pRAM is
1964 reserved, a new environment variable "mem" will
1965 automatically be defined to hold the amount of
1966 remaining RAM in a form that can be passed as boot
1967 argument to Linux, for instance like that:
1969 setenv bootargs ... mem=\${mem}
1972 This way you can tell Linux not to use this memory,
1973 either, which results in a memory region that will
1974 not be affected by reboots.
1976 *WARNING* If your board configuration uses automatic
1977 detection of the RAM size, you must make sure that
1978 this memory test is non-destructive. So far, the
1979 following board configurations are known to be
1982 IVMS8, IVML24, SPD8xx,
1983 HERMES, IP860, RPXlite, LWMON,
1986 - Access to physical memory region (> 4GB)
1987 Some basic support is provided for operations on memory not
1988 normally accessible to U-Boot - e.g. some architectures
1989 support access to more than 4GB of memory on 32-bit
1990 machines using physical address extension or similar.
1991 Define CONFIG_PHYSMEM to access this basic support, which
1992 currently only supports clearing the memory.
1995 CONFIG_NET_RETRY_COUNT
1997 This variable defines the number of retries for
1998 network operations like ARP, RARP, TFTP, or BOOTP
1999 before giving up the operation. If not defined, a
2000 default value of 5 is used.
2004 Timeout waiting for an ARP reply in milliseconds.
2008 Timeout in milliseconds used in NFS protocol.
2009 If you encounter "ERROR: Cannot umount" in nfs command,
2010 try longer timeout such as
2011 #define CONFIG_NFS_TIMEOUT 10000UL
2013 - Command Interpreter:
2014 CONFIG_SYS_PROMPT_HUSH_PS2
2016 This defines the secondary prompt string, which is
2017 printed when the command interpreter needs more input
2018 to complete a command. Usually "> ".
2022 In the current implementation, the local variables
2023 space and global environment variables space are
2024 separated. Local variables are those you define by
2025 simply typing `name=value'. To access a local
2026 variable later on, you have write `$name' or
2027 `${name}'; to execute the contents of a variable
2028 directly type `$name' at the command prompt.
2030 Global environment variables are those you use
2031 setenv/printenv to work with. To run a command stored
2032 in such a variable, you need to use the run command,
2033 and you must not use the '$' sign to access them.
2035 To store commands and special characters in a
2036 variable, please use double quotation marks
2037 surrounding the whole text of the variable, instead
2038 of the backslashes before semicolons and special
2041 - Command Line Editing and History:
2042 CONFIG_CMDLINE_PS_SUPPORT
2044 Enable support for changing the command prompt string
2045 at run-time. Only static string is supported so far.
2046 The string is obtained from environment variables PS1
2049 - Default Environment:
2050 CONFIG_EXTRA_ENV_SETTINGS
2052 Define this to contain any number of null terminated
2053 strings (variable = value pairs) that will be part of
2054 the default environment compiled into the boot image.
2056 For example, place something like this in your
2057 board's config file:
2059 #define CONFIG_EXTRA_ENV_SETTINGS \
2063 Warning: This method is based on knowledge about the
2064 internal format how the environment is stored by the
2065 U-Boot code. This is NOT an official, exported
2066 interface! Although it is unlikely that this format
2067 will change soon, there is no guarantee either.
2068 You better know what you are doing here.
2070 Note: overly (ab)use of the default environment is
2071 discouraged. Make sure to check other ways to preset
2072 the environment like the "source" command or the
2075 CONFIG_DELAY_ENVIRONMENT
2077 Normally the environment is loaded when the board is
2078 initialised so that it is available to U-Boot. This inhibits
2079 that so that the environment is not available until
2080 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2081 this is instead controlled by the value of
2082 /config/load-environment.
2084 - TFTP Fixed UDP Port:
2087 If this is defined, the environment variable tftpsrcp
2088 is used to supply the TFTP UDP source port value.
2089 If tftpsrcp isn't defined, the normal pseudo-random port
2090 number generator is used.
2092 Also, the environment variable tftpdstp is used to supply
2093 the TFTP UDP destination port value. If tftpdstp isn't
2094 defined, the normal port 69 is used.
2096 The purpose for tftpsrcp is to allow a TFTP server to
2097 blindly start the TFTP transfer using the pre-configured
2098 target IP address and UDP port. This has the effect of
2099 "punching through" the (Windows XP) firewall, allowing
2100 the remainder of the TFTP transfer to proceed normally.
2101 A better solution is to properly configure the firewall,
2102 but sometimes that is not allowed.
2104 CONFIG_STANDALONE_LOAD_ADDR
2106 This option defines a board specific value for the
2107 address where standalone program gets loaded, thus
2108 overwriting the architecture dependent default
2111 - Frame Buffer Address:
2114 Define CONFIG_FB_ADDR if you want to use specific
2115 address for frame buffer. This is typically the case
2116 when using a graphics controller has separate video
2117 memory. U-Boot will then place the frame buffer at
2118 the given address instead of dynamically reserving it
2119 in system RAM by calling lcd_setmem(), which grabs
2120 the memory for the frame buffer depending on the
2121 configured panel size.
2123 Please see board_init_f function.
2125 - Automatic software updates via TFTP server
2127 CONFIG_UPDATE_TFTP_CNT_MAX
2128 CONFIG_UPDATE_TFTP_MSEC_MAX
2130 These options enable and control the auto-update feature;
2131 for a more detailed description refer to doc/README.update.
2133 - MTD Support (mtdparts command, UBI support)
2134 CONFIG_MTD_UBI_WL_THRESHOLD
2135 This parameter defines the maximum difference between the highest
2136 erase counter value and the lowest erase counter value of eraseblocks
2137 of UBI devices. When this threshold is exceeded, UBI starts performing
2138 wear leveling by means of moving data from eraseblock with low erase
2139 counter to eraseblocks with high erase counter.
2141 The default value should be OK for SLC NAND flashes, NOR flashes and
2142 other flashes which have eraseblock life-cycle 100000 or more.
2143 However, in case of MLC NAND flashes which typically have eraseblock
2144 life-cycle less than 10000, the threshold should be lessened (e.g.,
2145 to 128 or 256, although it does not have to be power of 2).
2149 CONFIG_MTD_UBI_BEB_LIMIT
2150 This option specifies the maximum bad physical eraseblocks UBI
2151 expects on the MTD device (per 1024 eraseblocks). If the
2152 underlying flash does not admit of bad eraseblocks (e.g. NOR
2153 flash), this value is ignored.
2155 NAND datasheets often specify the minimum and maximum NVM
2156 (Number of Valid Blocks) for the flashes' endurance lifetime.
2157 The maximum expected bad eraseblocks per 1024 eraseblocks
2158 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2159 which gives 20 for most NANDs (MaxNVB is basically the total
2160 count of eraseblocks on the chip).
2162 To put it differently, if this value is 20, UBI will try to
2163 reserve about 1.9% of physical eraseblocks for bad blocks
2164 handling. And that will be 1.9% of eraseblocks on the entire
2165 NAND chip, not just the MTD partition UBI attaches. This means
2166 that if you have, say, a NAND flash chip admits maximum 40 bad
2167 eraseblocks, and it is split on two MTD partitions of the same
2168 size, UBI will reserve 40 eraseblocks when attaching a
2173 CONFIG_MTD_UBI_FASTMAP
2174 Fastmap is a mechanism which allows attaching an UBI device
2175 in nearly constant time. Instead of scanning the whole MTD device it
2176 only has to locate a checkpoint (called fastmap) on the device.
2177 The on-flash fastmap contains all information needed to attach
2178 the device. Using fastmap makes only sense on large devices where
2179 attaching by scanning takes long. UBI will not automatically install
2180 a fastmap on old images, but you can set the UBI parameter
2181 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2182 that fastmap-enabled images are still usable with UBI implementations
2183 without fastmap support. On typical flash devices the whole fastmap
2184 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2186 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2187 Set this parameter to enable fastmap automatically on images
2191 CONFIG_MTD_UBI_FM_DEBUG
2192 Enable UBI fastmap debug
2197 Enable building of SPL globally.
2200 LDSCRIPT for linking the SPL binary.
2202 CONFIG_SPL_MAX_FOOTPRINT
2203 Maximum size in memory allocated to the SPL, BSS included.
2204 When defined, the linker checks that the actual memory
2205 used by SPL from _start to __bss_end does not exceed it.
2206 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
2207 must not be both defined at the same time.
2210 Maximum size of the SPL image (text, data, rodata, and
2211 linker lists sections), BSS excluded.
2212 When defined, the linker checks that the actual size does
2215 CONFIG_SPL_RELOC_TEXT_BASE
2216 Address to relocate to. If unspecified, this is equal to
2217 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2219 CONFIG_SPL_BSS_START_ADDR
2220 Link address for the BSS within the SPL binary.
2222 CONFIG_SPL_BSS_MAX_SIZE
2223 Maximum size in memory allocated to the SPL BSS.
2224 When defined, the linker checks that the actual memory used
2225 by SPL from __bss_start to __bss_end does not exceed it.
2226 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
2227 must not be both defined at the same time.
2230 Adress of the start of the stack SPL will use
2232 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2233 When defined, SPL will panic() if the image it has
2234 loaded does not have a signature.
2235 Defining this is useful when code which loads images
2236 in SPL cannot guarantee that absolutely all read errors
2238 An example is the LPC32XX MLC NAND driver, which will
2239 consider that a completely unreadable NAND block is bad,
2240 and thus should be skipped silently.
2242 CONFIG_SPL_RELOC_STACK
2243 Adress of the start of the stack SPL will use after
2244 relocation. If unspecified, this is equal to
2247 CONFIG_SYS_SPL_MALLOC_START
2248 Starting address of the malloc pool used in SPL.
2249 When this option is set the full malloc is used in SPL and
2250 it is set up by spl_init() and before that, the simple malloc()
2251 can be used if CONFIG_SYS_MALLOC_F is defined.
2253 CONFIG_SYS_SPL_MALLOC_SIZE
2254 The size of the malloc pool used in SPL.
2257 Enable booting directly to an OS from SPL.
2258 See also: doc/README.falcon
2260 CONFIG_SPL_DISPLAY_PRINT
2261 For ARM, enable an optional function to print more information
2262 about the running system.
2264 CONFIG_SPL_INIT_MINIMAL
2265 Arch init code should be built for a very small image
2267 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2268 Partition on the MMC to load U-Boot from when the MMC is being
2271 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2272 Sector to load kernel uImage from when MMC is being
2273 used in raw mode (for Falcon mode)
2275 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2276 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2277 Sector and number of sectors to load kernel argument
2278 parameters from when MMC is being used in raw mode
2281 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2282 Partition on the MMC to load U-Boot from when the MMC is being
2285 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2286 Filename to read to load U-Boot when reading from filesystem
2288 CONFIG_SPL_FS_LOAD_KERNEL_NAME
2289 Filename to read to load kernel uImage when reading
2290 from filesystem (for Falcon mode)
2292 CONFIG_SPL_FS_LOAD_ARGS_NAME
2293 Filename to read to load kernel argument parameters
2294 when reading from filesystem (for Falcon mode)
2296 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2297 Set this for NAND SPL on PPC mpc83xx targets, so that
2298 start.S waits for the rest of the SPL to load before
2299 continuing (the hardware starts execution after just
2300 loading the first page rather than the full 4K).
2302 CONFIG_SPL_SKIP_RELOCATE
2303 Avoid SPL relocation
2305 CONFIG_SPL_NAND_BASE
2306 Include nand_base.c in the SPL. Requires
2307 CONFIG_SPL_NAND_DRIVERS.
2309 CONFIG_SPL_NAND_DRIVERS
2310 SPL uses normal NAND drivers, not minimal drivers.
2312 CONFIG_SPL_NAND_IDENT
2313 SPL uses the chip ID list to identify the NAND flash.
2314 Requires CONFIG_SPL_NAND_BASE.
2317 Include standard software ECC in the SPL
2319 CONFIG_SPL_NAND_SIMPLE
2320 Support for NAND boot using simple NAND drivers that
2321 expose the cmd_ctrl() interface.
2324 Support for a lightweight UBI (fastmap) scanner and
2327 CONFIG_SPL_NAND_RAW_ONLY
2328 Support to boot only raw u-boot.bin images. Use this only
2329 if you need to save space.
2331 CONFIG_SPL_COMMON_INIT_DDR
2332 Set for common ddr init with serial presence detect in
2335 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2336 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2337 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2338 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2339 CONFIG_SYS_NAND_ECCBYTES
2340 Defines the size and behavior of the NAND that SPL uses
2343 CONFIG_SYS_NAND_U_BOOT_OFFS
2344 Location in NAND to read U-Boot from
2346 CONFIG_SYS_NAND_U_BOOT_DST
2347 Location in memory to load U-Boot to
2349 CONFIG_SYS_NAND_U_BOOT_SIZE
2350 Size of image to load
2352 CONFIG_SYS_NAND_U_BOOT_START
2353 Entry point in loaded image to jump to
2355 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2356 Define this if you need to first read the OOB and then the
2357 data. This is used, for example, on davinci platforms.
2359 CONFIG_SPL_RAM_DEVICE
2360 Support for running image already present in ram, in SPL binary
2363 Image offset to which the SPL should be padded before appending
2364 the SPL payload. By default, this is defined as
2365 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2366 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2367 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
2370 Final target image containing SPL and payload. Some SPLs
2371 use an arch-specific makefile fragment instead, for
2372 example if more than one image needs to be produced.
2374 CONFIG_SPL_FIT_PRINT
2375 Printing information about a FIT image adds quite a bit of
2376 code to SPL. So this is normally disabled in SPL. Use this
2377 option to re-enable it. This will affect the output of the
2378 bootm command when booting a FIT image.
2382 Enable building of TPL globally.
2385 Image offset to which the TPL should be padded before appending
2386 the TPL payload. By default, this is defined as
2387 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2388 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2389 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
2391 - Interrupt support (PPC):
2393 There are common interrupt_init() and timer_interrupt()
2394 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
2395 for CPU specific initialization. interrupt_init_cpu()
2396 should set decrementer_count to appropriate value. If
2397 CPU resets decrementer automatically after interrupt
2398 (ppc4xx) it should set decrementer_count to zero.
2399 timer_interrupt() calls timer_interrupt_cpu() for CPU
2400 specific handling. If board has watchdog / status_led
2401 / other_activity_monitor it works automatically from
2402 general timer_interrupt().
2405 Board initialization settings:
2406 ------------------------------
2408 During Initialization u-boot calls a number of board specific functions
2409 to allow the preparation of board specific prerequisites, e.g. pin setup
2410 before drivers are initialized. To enable these callbacks the
2411 following configuration macros have to be defined. Currently this is
2412 architecture specific, so please check arch/your_architecture/lib/board.c
2413 typically in board_init_f() and board_init_r().
2415 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2416 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2417 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
2418 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2420 Configuration Settings:
2421 -----------------------
2423 - MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2424 Optionally it can be defined to support 64-bit memory commands.
2426 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2427 undefine this when you're short of memory.
2429 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2430 width of the commands listed in the 'help' command output.
2432 - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
2433 prompt for user input.
2435 - CONFIG_SYS_CBSIZE: Buffer size for input from the Console
2437 - CONFIG_SYS_PBSIZE: Buffer size for Console output
2439 - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
2441 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2442 the application (usually a Linux kernel) when it is
2445 - CONFIG_SYS_BAUDRATE_TABLE:
2446 List of legal baudrate settings for this board.
2448 - CONFIG_SYS_MEM_RESERVE_SECURE
2449 Only implemented for ARMv8 for now.
2450 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2451 is substracted from total RAM and won't be reported to OS.
2452 This memory can be used as secure memory. A variable
2453 gd->arch.secure_ram is used to track the location. In systems
2454 the RAM base is not zero, or RAM is divided into banks,
2455 this variable needs to be recalcuated to get the address.
2457 - CONFIG_SYS_MEM_TOP_HIDE:
2458 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2459 this specified memory area will get subtracted from the top
2460 (end) of RAM and won't get "touched" at all by U-Boot. By
2461 fixing up gd->ram_size the Linux kernel should gets passed
2462 the now "corrected" memory size and won't touch it either.
2463 This should work for arch/ppc and arch/powerpc. Only Linux
2464 board ports in arch/powerpc with bootwrapper support that
2465 recalculate the memory size from the SDRAM controller setup
2466 will have to get fixed in Linux additionally.
2468 This option can be used as a workaround for the 440EPx/GRx
2469 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2472 WARNING: Please make sure that this value is a multiple of
2473 the Linux page size (normally 4k). If this is not the case,
2474 then the end address of the Linux memory will be located at a
2475 non page size aligned address and this could cause major
2478 - CONFIG_SYS_LOADS_BAUD_CHANGE:
2479 Enable temporary baudrate change while serial download
2481 - CONFIG_SYS_SDRAM_BASE:
2482 Physical start address of SDRAM. _Must_ be 0 here.
2484 - CONFIG_SYS_FLASH_BASE:
2485 Physical start address of Flash memory.
2487 - CONFIG_SYS_MONITOR_BASE:
2488 Physical start address of boot monitor code (set by
2489 make config files to be same as the text base address
2490 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
2491 CONFIG_SYS_FLASH_BASE when booting from flash.
2493 - CONFIG_SYS_MONITOR_LEN:
2494 Size of memory reserved for monitor code, used to
2495 determine _at_compile_time_ (!) if the environment is
2496 embedded within the U-Boot image, or in a separate
2499 - CONFIG_SYS_MALLOC_LEN:
2500 Size of DRAM reserved for malloc() use.
2502 - CONFIG_SYS_MALLOC_F_LEN
2503 Size of the malloc() pool for use before relocation. If
2504 this is defined, then a very simple malloc() implementation
2505 will become available before relocation. The address is just
2506 below the global data, and the stack is moved down to make
2509 This feature allocates regions with increasing addresses
2510 within the region. calloc() is supported, but realloc()
2511 is not available. free() is supported but does nothing.
2512 The memory will be freed (or in fact just forgotten) when
2513 U-Boot relocates itself.
2515 - CONFIG_SYS_MALLOC_SIMPLE
2516 Provides a simple and small malloc() and calloc() for those
2517 boards which do not use the full malloc in SPL (which is
2518 enabled with CONFIG_SYS_SPL_MALLOC_START).
2520 - CONFIG_SYS_NONCACHED_MEMORY:
2521 Size of non-cached memory area. This area of memory will be
2522 typically located right below the malloc() area and mapped
2523 uncached in the MMU. This is useful for drivers that would
2524 otherwise require a lot of explicit cache maintenance. For
2525 some drivers it's also impossible to properly maintain the
2526 cache. For example if the regions that need to be flushed
2527 are not a multiple of the cache-line size, *and* padding
2528 cannot be allocated between the regions to align them (i.e.
2529 if the HW requires a contiguous array of regions, and the
2530 size of each region is not cache-aligned), then a flush of
2531 one region may result in overwriting data that hardware has
2532 written to another region in the same cache-line. This can
2533 happen for example in network drivers where descriptors for
2534 buffers are typically smaller than the CPU cache-line (e.g.
2535 16 bytes vs. 32 or 64 bytes).
2537 Non-cached memory is only supported on 32-bit ARM at present.
2539 - CONFIG_SYS_BOOTM_LEN:
2540 Normally compressed uImages are limited to an
2541 uncompressed size of 8 MBytes. If this is not enough,
2542 you can define CONFIG_SYS_BOOTM_LEN in your board config file
2543 to adjust this setting to your needs.
2545 - CONFIG_SYS_BOOTMAPSZ:
2546 Maximum size of memory mapped by the startup code of
2547 the Linux kernel; all data that must be processed by
2548 the Linux kernel (bd_info, boot arguments, FDT blob if
2549 used) must be put below this limit, unless "bootm_low"
2550 environment variable is defined and non-zero. In such case
2551 all data for the Linux kernel must be between "bootm_low"
2552 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2553 variable "bootm_mapsize" will override the value of
2554 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2555 then the value in "bootm_size" will be used instead.
2557 - CONFIG_SYS_BOOT_RAMDISK_HIGH:
2558 Enable initrd_high functionality. If defined then the
2559 initrd_high feature is enabled and the bootm ramdisk subcommand
2562 - CONFIG_SYS_BOOT_GET_CMDLINE:
2563 Enables allocating and saving kernel cmdline in space between
2564 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2566 - CONFIG_SYS_BOOT_GET_KBD:
2567 Enables allocating and saving a kernel copy of the bd_info in
2568 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2570 - CONFIG_SYS_MAX_FLASH_BANKS:
2571 Max number of Flash memory banks
2573 - CONFIG_SYS_MAX_FLASH_SECT:
2574 Max number of sectors on a Flash chip
2576 - CONFIG_SYS_FLASH_ERASE_TOUT:
2577 Timeout for Flash erase operations (in ms)
2579 - CONFIG_SYS_FLASH_WRITE_TOUT:
2580 Timeout for Flash write operations (in ms)
2582 - CONFIG_SYS_FLASH_LOCK_TOUT
2583 Timeout for Flash set sector lock bit operation (in ms)
2585 - CONFIG_SYS_FLASH_UNLOCK_TOUT
2586 Timeout for Flash clear lock bits operation (in ms)
2588 - CONFIG_SYS_FLASH_PROTECTION
2589 If defined, hardware flash sectors protection is used
2590 instead of U-Boot software protection.
2592 - CONFIG_SYS_DIRECT_FLASH_TFTP:
2594 Enable TFTP transfers directly to flash memory;
2595 without this option such a download has to be
2596 performed in two steps: (1) download to RAM, and (2)
2597 copy from RAM to flash.
2599 The two-step approach is usually more reliable, since
2600 you can check if the download worked before you erase
2601 the flash, but in some situations (when system RAM is
2602 too limited to allow for a temporary copy of the
2603 downloaded image) this option may be very useful.
2605 - CONFIG_SYS_FLASH_CFI:
2606 Define if the flash driver uses extra elements in the
2607 common flash structure for storing flash geometry.
2609 - CONFIG_FLASH_CFI_DRIVER
2610 This option also enables the building of the cfi_flash driver
2611 in the drivers directory
2613 - CONFIG_FLASH_CFI_MTD
2614 This option enables the building of the cfi_mtd driver
2615 in the drivers directory. The driver exports CFI flash
2618 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
2619 Use buffered writes to flash.
2621 - CONFIG_FLASH_SPANSION_S29WS_N
2622 s29ws-n MirrorBit flash has non-standard addresses for buffered
2625 - CONFIG_SYS_FLASH_QUIET_TEST
2626 If this option is defined, the common CFI flash doesn't
2627 print it's warning upon not recognized FLASH banks. This
2628 is useful, if some of the configured banks are only
2629 optionally available.
2631 - CONFIG_FLASH_SHOW_PROGRESS
2632 If defined (must be an integer), print out countdown
2633 digits and dots. Recommended value: 45 (9..1) for 80
2634 column displays, 15 (3..1) for 40 column displays.
2636 - CONFIG_FLASH_VERIFY
2637 If defined, the content of the flash (destination) is compared
2638 against the source after the write operation. An error message
2639 will be printed when the contents are not identical.
2640 Please note that this option is useless in nearly all cases,
2641 since such flash programming errors usually are detected earlier
2642 while unprotecting/erasing/programming. Please only enable
2643 this option if you really know what you are doing.
2645 - CONFIG_SYS_RX_ETH_BUFFER:
2646 Defines the number of Ethernet receive buffers. On some
2647 Ethernet controllers it is recommended to set this value
2648 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2649 buffers can be full shortly after enabling the interface
2650 on high Ethernet traffic.
2651 Defaults to 4 if not defined.
2653 - CONFIG_ENV_MAX_ENTRIES
2655 Maximum number of entries in the hash table that is used
2656 internally to store the environment settings. The default
2657 setting is supposed to be generous and should work in most
2658 cases. This setting can be used to tune behaviour; see
2659 lib/hashtable.c for details.
2661 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2662 - CONFIG_ENV_FLAGS_LIST_STATIC
2663 Enable validation of the values given to environment variables when
2664 calling env set. Variables can be restricted to only decimal,
2665 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2666 the variables can also be restricted to IP address or MAC address.
2668 The format of the list is:
2669 type_attribute = [s|d|x|b|i|m]
2670 access_attribute = [a|r|o|c]
2671 attributes = type_attribute[access_attribute]
2672 entry = variable_name[:attributes]
2675 The type attributes are:
2676 s - String (default)
2679 b - Boolean ([1yYtT|0nNfF])
2683 The access attributes are:
2689 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2690 Define this to a list (string) to define the ".flags"
2691 environment variable in the default or embedded environment.
2693 - CONFIG_ENV_FLAGS_LIST_STATIC
2694 Define this to a list (string) to define validation that
2695 should be done if an entry is not found in the ".flags"
2696 environment variable. To override a setting in the static
2697 list, simply add an entry for the same variable name to the
2700 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2701 regular expression. This allows multiple variables to define the same
2702 flags without explicitly listing them for each variable.
2704 The following definitions that deal with the placement and management
2705 of environment data (variable area); in general, we support the
2706 following configurations:
2708 - CONFIG_BUILD_ENVCRC:
2710 Builds up envcrc with the target environment so that external utils
2711 may easily extract it and embed it in final U-Boot images.
2713 BE CAREFUL! The first access to the environment happens quite early
2714 in U-Boot initialization (when we try to get the setting of for the
2715 console baudrate). You *MUST* have mapped your NVRAM area then, or
2718 Please note that even with NVRAM we still use a copy of the
2719 environment in RAM: we could work on NVRAM directly, but we want to
2720 keep settings there always unmodified except somebody uses "saveenv"
2721 to save the current settings.
2723 BE CAREFUL! For some special cases, the local device can not use
2724 "saveenv" command. For example, the local device will get the
2725 environment stored in a remote NOR flash by SRIO or PCIE link,
2726 but it can not erase, write this NOR flash by SRIO or PCIE interface.
2728 - CONFIG_NAND_ENV_DST
2730 Defines address in RAM to which the nand_spl code should copy the
2731 environment. If redundant environment is used, it will be copied to
2732 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2734 Please note that the environment is read-only until the monitor
2735 has been relocated to RAM and a RAM copy of the environment has been
2736 created; also, when using EEPROM you will have to use env_get_f()
2737 until then to read environment variables.
2739 The environment is protected by a CRC32 checksum. Before the monitor
2740 is relocated into RAM, as a result of a bad CRC you will be working
2741 with the compiled-in default environment - *silently*!!! [This is
2742 necessary, because the first environment variable we need is the
2743 "baudrate" setting for the console - if we have a bad CRC, we don't
2744 have any device yet where we could complain.]
2746 Note: once the monitor has been relocated, then it will complain if
2747 the default environment is used; a new CRC is computed as soon as you
2748 use the "saveenv" command to store a valid environment.
2750 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2751 Echo the inverted Ethernet link state to the fault LED.
2753 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2754 also needs to be defined.
2756 - CONFIG_SYS_FAULT_MII_ADDR:
2757 MII address of the PHY to check for the Ethernet link state.
2759 - CONFIG_NS16550_MIN_FUNCTIONS:
2760 Define this if you desire to only have use of the NS16550_init
2761 and NS16550_putc functions for the serial driver located at
2762 drivers/serial/ns16550.c. This option is useful for saving
2763 space for already greatly restricted images, including but not
2764 limited to NAND_SPL configurations.
2766 - CONFIG_DISPLAY_BOARDINFO
2767 Display information about the board that U-Boot is running on
2768 when U-Boot starts up. The board function checkboard() is called
2771 - CONFIG_DISPLAY_BOARDINFO_LATE
2772 Similar to the previous option, but display this information
2773 later, once stdio is running and output goes to the LCD, if
2776 - CONFIG_BOARD_SIZE_LIMIT:
2777 Maximum size of the U-Boot image. When defined, the
2778 build system checks that the actual size does not
2781 Low Level (hardware related) configuration options:
2782 ---------------------------------------------------
2784 - CONFIG_SYS_CACHELINE_SIZE:
2785 Cache Line Size of the CPU.
2787 - CONFIG_SYS_CCSRBAR_DEFAULT:
2788 Default (power-on reset) physical address of CCSR on Freescale
2791 - CONFIG_SYS_CCSRBAR:
2792 Virtual address of CCSR. On a 32-bit build, this is typically
2793 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2795 - CONFIG_SYS_CCSRBAR_PHYS:
2796 Physical address of CCSR. CCSR can be relocated to a new
2797 physical address, if desired. In this case, this macro should
2798 be set to that address. Otherwise, it should be set to the
2799 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2800 is typically relocated on 36-bit builds. It is recommended
2801 that this macro be defined via the _HIGH and _LOW macros:
2803 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2804 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2806 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
2807 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2808 either 0 (32-bit build) or 0xF (36-bit build). This macro is
2809 used in assembly code, so it must not contain typecasts or
2810 integer size suffixes (e.g. "ULL").
2812 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
2813 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2814 used in assembly code, so it must not contain typecasts or
2815 integer size suffixes (e.g. "ULL").
2817 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2818 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2819 forced to a value that ensures that CCSR is not relocated.
2822 Most IDE controllers were designed to be connected with PCI
2823 interface. Only few of them were designed for AHB interface.
2824 When software is doing ATA command and data transfer to
2825 IDE devices through IDE-AHB controller, some additional
2826 registers accessing to these kind of IDE-AHB controller
2829 - CONFIG_SYS_IMMR: Physical address of the Internal Memory.
2830 DO NOT CHANGE unless you know exactly what you're
2831 doing! (11-4) [MPC8xx systems only]
2833 - CONFIG_SYS_INIT_RAM_ADDR:
2835 Start address of memory area that can be used for
2836 initial data and stack; please note that this must be
2837 writable memory that is working WITHOUT special
2838 initialization, i. e. you CANNOT use normal RAM which
2839 will become available only after programming the
2840 memory controller and running certain initialization
2843 U-Boot uses the following memory types:
2844 - MPC8xx: IMMR (internal memory of the CPU)
2846 - CONFIG_SYS_GBL_DATA_OFFSET:
2848 Offset of the initial data structure in the memory
2849 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2850 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2851 data is located at the end of the available space
2852 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
2853 GENERATED_GBL_DATA_SIZE), and the initial stack is just
2854 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2855 CONFIG_SYS_GBL_DATA_OFFSET) downward.
2858 On the MPC824X (or other systems that use the data
2859 cache for initial memory) the address chosen for
2860 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2861 point to an otherwise UNUSED address space between
2862 the top of RAM and the start of the PCI space.
2864 - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
2866 - CONFIG_SYS_OR_TIMING_SDRAM:
2869 - CONFIG_SYS_MAMR_PTA:
2870 periodic timer for refresh
2872 - FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2873 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2874 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2875 CONFIG_SYS_BR1_PRELIM:
2876 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2878 - SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2879 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2880 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2881 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2883 - CONFIG_PCI_ENUM_ONLY
2884 Only scan through and get the devices on the buses.
2885 Don't do any setup work, presumably because someone or
2886 something has already done it, and we don't need to do it
2887 a second time. Useful for platforms that are pre-booted
2888 by coreboot or similar.
2890 - CONFIG_PCI_INDIRECT_BRIDGE:
2891 Enable support for indirect PCI bridges.
2894 Chip has SRIO or not
2897 Board has SRIO 1 port available
2900 Board has SRIO 2 port available
2902 - CONFIG_SRIO_PCIE_BOOT_MASTER
2903 Board can support master function for Boot from SRIO and PCIE
2905 - CONFIG_SYS_SRIOn_MEM_VIRT:
2906 Virtual Address of SRIO port 'n' memory region
2908 - CONFIG_SYS_SRIOn_MEM_PHYxS:
2909 Physical Address of SRIO port 'n' memory region
2911 - CONFIG_SYS_SRIOn_MEM_SIZE:
2912 Size of SRIO port 'n' memory region
2914 - CONFIG_SYS_NAND_BUSWIDTH_16BIT
2915 Defined to tell the NAND controller that the NAND chip is using
2917 Not all NAND drivers use this symbol.
2918 Example of drivers that use it:
2919 - drivers/mtd/nand/raw/ndfc.c
2920 - drivers/mtd/nand/raw/mxc_nand.c
2922 - CONFIG_SYS_NDFC_EBC0_CFG
2923 Sets the EBC0_CFG register for the NDFC. If not defined
2924 a default value will be used.
2927 Get DDR timing information from an I2C EEPROM. Common
2928 with pluggable memory modules such as SODIMMs
2931 I2C address of the SPD EEPROM
2933 - CONFIG_SYS_SPD_BUS_NUM
2934 If SPD EEPROM is on an I2C bus other than the first
2935 one, specify here. Note that the value must resolve
2936 to something your driver can deal with.
2938 - CONFIG_SYS_DDR_RAW_TIMING
2939 Get DDR timing information from other than SPD. Common with
2940 soldered DDR chips onboard without SPD. DDR raw timing
2941 parameters are extracted from datasheet and hard-coded into
2942 header files or board specific files.
2944 - CONFIG_FSL_DDR_INTERACTIVE
2945 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2947 - CONFIG_FSL_DDR_SYNC_REFRESH
2948 Enable sync of refresh for multiple controllers.
2950 - CONFIG_FSL_DDR_BIST
2951 Enable built-in memory test for Freescale DDR controllers.
2953 - CONFIG_SYS_83XX_DDR_USES_CS0
2954 Only for 83xx systems. If specified, then DDR should
2955 be configured using CS0 and CS1 instead of CS2 and CS3.
2958 Enable RMII mode for all FECs.
2959 Note that this is a global option, we can't
2960 have one FEC in standard MII mode and another in RMII mode.
2962 - CONFIG_CRC32_VERIFY
2963 Add a verify option to the crc32 command.
2966 => crc32 -v <address> <count> <crc32>
2968 Where address/count indicate a memory area
2969 and crc32 is the correct crc32 which the
2973 Add the "loopw" memory command. This only takes effect if
2974 the memory commands are activated globally (CONFIG_CMD_MEMORY).
2976 - CONFIG_CMD_MX_CYCLIC
2977 Add the "mdc" and "mwc" memory commands. These are cyclic
2982 This command will print 4 bytes (10,11,12,13) each 500 ms.
2984 => mwc.l 100 12345678 10
2985 This command will write 12345678 to address 100 all 10 ms.
2987 This only takes effect if the memory commands are activated
2988 globally (CONFIG_CMD_MEMORY).
2990 - CONFIG_SKIP_LOWLEVEL_INIT
2991 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
2992 low level initializations (like setting up the memory
2993 controller) are omitted and/or U-Boot does not
2994 relocate itself into RAM.
2996 Normally this variable MUST NOT be defined. The only
2997 exception is when U-Boot is loaded (to RAM) by some
2998 other boot loader or by a debugger which performs
2999 these initializations itself.
3001 - CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3002 [ARM926EJ-S only] This allows just the call to lowlevel_init()
3003 to be skipped. The normal CP15 init (such as enabling the
3004 instruction cache) is still performed.
3007 Set when the currently-running compilation is for an artifact
3008 that will end up in the SPL (as opposed to the TPL or U-Boot
3009 proper). Code that needs stage-specific behavior should check
3013 Set when the currently-running compilation is for an artifact
3014 that will end up in the TPL (as opposed to the SPL or U-Boot
3015 proper). Code that needs stage-specific behavior should check
3018 - CONFIG_SYS_MPC85XX_NO_RESETVEC
3019 Only for 85xx systems. If this variable is specified, the section
3020 .resetvec is not kept and the section .bootpg is placed in the
3021 previous 4k of the .text section.
3023 - CONFIG_ARCH_MAP_SYSMEM
3024 Generally U-Boot (and in particular the md command) uses
3025 effective address. It is therefore not necessary to regard
3026 U-Boot address as virtual addresses that need to be translated
3027 to physical addresses. However, sandbox requires this, since
3028 it maintains its own little RAM buffer which contains all
3029 addressable memory. This option causes some memory accesses
3030 to be mapped through map_sysmem() / unmap_sysmem().
3032 - CONFIG_X86_RESET_VECTOR
3033 If defined, the x86 reset vector code is included. This is not
3034 needed when U-Boot is running from Coreboot.
3036 - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3037 Option to disable subpage write in NAND driver
3038 driver that uses this:
3039 drivers/mtd/nand/raw/davinci_nand.c
3041 Freescale QE/FMAN Firmware Support:
3042 -----------------------------------
3044 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3045 loading of "firmware", which is encoded in the QE firmware binary format.
3046 This firmware often needs to be loaded during U-Boot booting, so macros
3047 are used to identify the storage device (NOR flash, SPI, etc) and the address
3050 - CONFIG_SYS_FMAN_FW_ADDR
3051 The address in the storage device where the FMAN microcode is located. The
3052 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
3055 - CONFIG_SYS_QE_FW_ADDR
3056 The address in the storage device where the QE microcode is located. The
3057 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
3060 - CONFIG_SYS_QE_FMAN_FW_LENGTH
3061 The maximum possible size of the firmware. The firmware binary format
3062 has a field that specifies the actual size of the firmware, but it
3063 might not be possible to read any part of the firmware unless some
3064 local storage is allocated to hold the entire firmware first.
3066 - CONFIG_SYS_QE_FMAN_FW_IN_NOR
3067 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3068 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3069 virtual address in NOR flash.
3071 - CONFIG_SYS_QE_FMAN_FW_IN_NAND
3072 Specifies that QE/FMAN firmware is located in NAND flash.
3073 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3075 - CONFIG_SYS_QE_FMAN_FW_IN_MMC
3076 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3077 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3079 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3080 Specifies that QE/FMAN firmware is located in the remote (master)
3081 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3082 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3083 window->master inbound window->master LAW->the ucode address in
3084 master's memory space.
3086 Freescale Layerscape Management Complex Firmware Support:
3087 ---------------------------------------------------------
3088 The Freescale Layerscape Management Complex (MC) supports the loading of
3090 This firmware often needs to be loaded during U-Boot booting, so macros
3091 are used to identify the storage device (NOR flash, SPI, etc) and the address
3094 - CONFIG_FSL_MC_ENET
3095 Enable the MC driver for Layerscape SoCs.
3097 Freescale Layerscape Debug Server Support:
3098 -------------------------------------------
3099 The Freescale Layerscape Debug Server Support supports the loading of
3100 "Debug Server firmware" and triggering SP boot-rom.
3101 This firmware often needs to be loaded during U-Boot booting.
3103 - CONFIG_SYS_MC_RSV_MEM_ALIGN
3104 Define alignment of reserved memory MC requires
3109 In order to achieve reproducible builds, timestamps used in the U-Boot build
3110 process have to be set to a fixed value.
3112 This is done using the SOURCE_DATE_EPOCH environment variable.
3113 SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3114 option for U-Boot or an environment variable in U-Boot.
3116 SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3118 Building the Software:
3119 ======================
3121 Building U-Boot has been tested in several native build environments
3122 and in many different cross environments. Of course we cannot support
3123 all possibly existing versions of cross development tools in all
3124 (potentially obsolete) versions. In case of tool chain problems we
3125 recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3126 which is extensively used to build and test U-Boot.
3128 If you are not using a native environment, it is assumed that you
3129 have GNU cross compiling tools available in your path. In this case,
3130 you must set the environment variable CROSS_COMPILE in your shell.
3131 Note that no changes to the Makefile or any other source files are
3132 necessary. For example using the ELDK on a 4xx CPU, please enter:
3134 $ CROSS_COMPILE=ppc_4xx-
3135 $ export CROSS_COMPILE
3137 U-Boot is intended to be simple to build. After installing the
3138 sources you must configure U-Boot for one specific board type. This
3143 where "NAME_defconfig" is the name of one of the existing configu-
3144 rations; see configs/*_defconfig for supported names.
3146 Note: for some boards special configuration names may exist; check if
3147 additional information is available from the board vendor; for
3148 instance, the TQM823L systems are available without (standard)
3149 or with LCD support. You can select such additional "features"
3150 when choosing the configuration, i. e.
3152 make TQM823L_defconfig
3153 - will configure for a plain TQM823L, i. e. no LCD support
3155 make TQM823L_LCD_defconfig
3156 - will configure for a TQM823L with U-Boot console on LCD
3161 Finally, type "make all", and you should get some working U-Boot
3162 images ready for download to / installation on your system:
3164 - "u-boot.bin" is a raw binary image
3165 - "u-boot" is an image in ELF binary format
3166 - "u-boot.srec" is in Motorola S-Record format
3168 By default the build is performed locally and the objects are saved
3169 in the source directory. One of the two methods can be used to change
3170 this behavior and build U-Boot to some external directory:
3172 1. Add O= to the make command line invocations:
3174 make O=/tmp/build distclean
3175 make O=/tmp/build NAME_defconfig
3176 make O=/tmp/build all
3178 2. Set environment variable KBUILD_OUTPUT to point to the desired location:
3180 export KBUILD_OUTPUT=/tmp/build
3185 Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
3188 User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3189 setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3190 For example to treat all compiler warnings as errors:
3192 make KCFLAGS=-Werror
3194 Please be aware that the Makefiles assume you are using GNU make, so
3195 for instance on NetBSD you might need to use "gmake" instead of
3199 If the system board that you have is not listed, then you will need
3200 to port U-Boot to your hardware platform. To do this, follow these
3203 1. Create a new directory to hold your board specific code. Add any
3204 files you need. In your board directory, you will need at least
3205 the "Makefile" and a "<board>.c".
3206 2. Create a new configuration file "include/configs/<board>.h" for
3208 3. If you're porting U-Boot to a new CPU, then also create a new
3209 directory to hold your CPU specific code. Add any files you need.
3210 4. Run "make <board>_defconfig" with your new name.
3211 5. Type "make", and you should get a working "u-boot.srec" file
3212 to be installed on your target system.
3213 6. Debug and solve any problems that might arise.
3214 [Of course, this last step is much harder than it sounds.]
3217 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3218 ==============================================================
3220 If you have modified U-Boot sources (for instance added a new board
3221 or support for new devices, a new CPU, etc.) you are expected to
3222 provide feedback to the other developers. The feedback normally takes
3223 the form of a "patch", i.e. a context diff against a certain (latest
3224 official or latest in the git repository) version of U-Boot sources.
3226 But before you submit such a patch, please verify that your modifi-
3227 cation did not break existing code. At least make sure that *ALL* of
3228 the supported boards compile WITHOUT ANY compiler warnings. To do so,
3229 just run the buildman script (tools/buildman/buildman), which will
3230 configure and build U-Boot for ALL supported system. Be warned, this
3231 will take a while. Please see the buildman README, or run 'buildman -H'
3235 See also "U-Boot Porting Guide" below.
3238 Monitor Commands - Overview:
3239 ============================
3241 go - start application at address 'addr'
3242 run - run commands in an environment variable
3243 bootm - boot application image from memory
3244 bootp - boot image via network using BootP/TFTP protocol
3245 bootz - boot zImage from memory
3246 tftpboot- boot image via network using TFTP protocol
3247 and env variables "ipaddr" and "serverip"
3248 (and eventually "gatewayip")
3249 tftpput - upload a file via network using TFTP protocol
3250 rarpboot- boot image via network using RARP/TFTP protocol
3251 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3252 loads - load S-Record file over serial line
3253 loadb - load binary file over serial line (kermit mode)
3255 mm - memory modify (auto-incrementing)
3256 nm - memory modify (constant address)
3257 mw - memory write (fill)
3259 cmp - memory compare
3260 crc32 - checksum calculation
3261 i2c - I2C sub-system
3262 sspi - SPI utility commands
3263 base - print or set address offset
3264 printenv- print environment variables
3265 setenv - set environment variables
3266 saveenv - save environment variables to persistent storage
3267 protect - enable or disable FLASH write protection
3268 erase - erase FLASH memory
3269 flinfo - print FLASH memory information
3270 nand - NAND memory operations (see doc/README.nand)
3271 bdinfo - print Board Info structure
3272 iminfo - print header information for application image
3273 coninfo - print console devices and informations
3274 ide - IDE sub-system
3275 loop - infinite loop on address range
3276 loopw - infinite write loop on address range
3277 mtest - simple RAM test
3278 icache - enable or disable instruction cache
3279 dcache - enable or disable data cache
3280 reset - Perform RESET of the CPU
3281 echo - echo args to console
3282 version - print monitor version
3283 help - print online help
3284 ? - alias for 'help'
3287 Monitor Commands - Detailed Description:
3288 ========================================
3292 For now: just type "help <command>".
3295 Environment Variables:
3296 ======================
3298 U-Boot supports user configuration using Environment Variables which
3299 can be made persistent by saving to Flash memory.
3301 Environment Variables are set using "setenv", printed using
3302 "printenv", and saved to Flash using "saveenv". Using "setenv"
3303 without a value can be used to delete a variable from the
3304 environment. As long as you don't save the environment you are
3305 working with an in-memory copy. In case the Flash area containing the
3306 environment is erased by accident, a default environment is provided.
3308 Some configuration options can be set using Environment Variables.
3310 List of environment variables (most likely not complete):
3312 baudrate - see CONFIG_BAUDRATE
3314 bootdelay - see CONFIG_BOOTDELAY
3316 bootcmd - see CONFIG_BOOTCOMMAND
3318 bootargs - Boot arguments when booting an RTOS image
3320 bootfile - Name of the image to load with TFTP
3322 bootm_low - Memory range available for image processing in the bootm
3323 command can be restricted. This variable is given as
3324 a hexadecimal number and defines lowest address allowed
3325 for use by the bootm command. See also "bootm_size"
3326 environment variable. Address defined by "bootm_low" is
3327 also the base of the initial memory mapping for the Linux
3328 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3331 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3332 This variable is given as a hexadecimal number and it
3333 defines the size of the memory region starting at base
3334 address bootm_low that is accessible by the Linux kernel
3335 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3336 as the default value if it is defined, and bootm_size is
3339 bootm_size - Memory range available for image processing in the bootm
3340 command can be restricted. This variable is given as
3341 a hexadecimal number and defines the size of the region
3342 allowed for use by the bootm command. See also "bootm_low"
3343 environment variable.
3345 bootstopkeysha256, bootdelaykey, bootstopkey - See README.autoboot
3347 updatefile - Location of the software update file on a TFTP server, used
3348 by the automatic software update feature. Please refer to
3349 documentation in doc/README.update for more details.
3351 autoload - if set to "no" (any string beginning with 'n'),
3352 "bootp" will just load perform a lookup of the
3353 configuration from the BOOTP server, but not try to
3354 load any image using TFTP
3356 autostart - if set to "yes", an image loaded using the "bootp",
3357 "rarpboot", "tftpboot" or "diskboot" commands will
3358 be automatically started (by internally calling
3361 If set to "no", a standalone image passed to the
3362 "bootm" command will be copied to the load address
3363 (and eventually uncompressed), but NOT be started.
3364 This can be used to load and uncompress arbitrary
3367 fdt_high - if set this restricts the maximum address that the
3368 flattened device tree will be copied into upon boot.
3369 For example, if you have a system with 1 GB memory
3370 at physical address 0x10000000, while Linux kernel
3371 only recognizes the first 704 MB as low memory, you
3372 may need to set fdt_high as 0x3C000000 to have the
3373 device tree blob be copied to the maximum address
3374 of the 704 MB low memory, so that Linux kernel can
3375 access it during the boot procedure.
3377 If this is set to the special value 0xFFFFFFFF then
3378 the fdt will not be copied at all on boot. For this
3379 to work it must reside in writable memory, have
3380 sufficient padding on the end of it for u-boot to
3381 add the information it needs into it, and the memory
3382 must be accessible by the kernel.
3384 fdtcontroladdr- if set this is the address of the control flattened
3385 device tree used by U-Boot when CONFIG_OF_CONTROL is
3388 i2cfast - (PPC405GP|PPC405EP only)
3389 if set to 'y' configures Linux I2C driver for fast
3390 mode (400kHZ). This environment variable is used in
3391 initialization code. So, for changes to be effective
3392 it must be saved and board must be reset.
3394 initrd_high - restrict positioning of initrd images:
3395 If this variable is not set, initrd images will be
3396 copied to the highest possible address in RAM; this
3397 is usually what you want since it allows for
3398 maximum initrd size. If for some reason you want to
3399 make sure that the initrd image is loaded below the
3400 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3401 variable to a value of "no" or "off" or "0".
3402 Alternatively, you can set it to a maximum upper
3403 address to use (U-Boot will still check that it
3404 does not overwrite the U-Boot stack and data).
3406 For instance, when you have a system with 16 MB
3407 RAM, and want to reserve 4 MB from use by Linux,
3408 you can do this by adding "mem=12M" to the value of
3409 the "bootargs" variable. However, now you must make
3410 sure that the initrd image is placed in the first
3411 12 MB as well - this can be done with
3413 setenv initrd_high 00c00000
3415 If you set initrd_high to 0xFFFFFFFF, this is an
3416 indication to U-Boot that all addresses are legal
3417 for the Linux kernel, including addresses in flash
3418 memory. In this case U-Boot will NOT COPY the
3419 ramdisk at all. This may be useful to reduce the
3420 boot time on your system, but requires that this
3421 feature is supported by your Linux kernel.
3423 ipaddr - IP address; needed for tftpboot command
3425 loadaddr - Default load address for commands like "bootp",
3426 "rarpboot", "tftpboot", "loadb" or "diskboot"
3428 loads_echo - see CONFIG_LOADS_ECHO
3430 serverip - TFTP server IP address; needed for tftpboot command
3432 bootretry - see CONFIG_BOOT_RETRY_TIME
3434 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
3436 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
3438 ethprime - controls which interface is used first.
3440 ethact - controls which interface is currently active.
3441 For example you can do the following
3443 => setenv ethact FEC
3444 => ping 192.168.0.1 # traffic sent on FEC
3445 => setenv ethact SCC
3446 => ping 10.0.0.1 # traffic sent on SCC
3448 ethrotate - When set to "no" U-Boot does not go through all
3449 available network interfaces.
3450 It just stays at the currently selected interface.
3452 netretry - When set to "no" each network operation will
3453 either succeed or fail without retrying.
3454 When set to "once" the network operation will
3455 fail when all the available network interfaces
3456 are tried once without success.
3457 Useful on scripts which control the retry operation
3460 npe_ucode - set load address for the NPE microcode
3462 silent_linux - If set then Linux will be told to boot silently, by
3463 changing the console to be empty. If "yes" it will be
3464 made silent. If "no" it will not be made silent. If
3465 unset, then it will be made silent if the U-Boot console
3468 tftpsrcp - If this is set, the value is used for TFTP's
3471 tftpdstp - If this is set, the value is used for TFTP's UDP
3472 destination port instead of the Well Know Port 69.
3474 tftpblocksize - Block size to use for TFTP transfers; if not set,
3475 we use the TFTP server's default block size
3477 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3478 seconds, minimum value is 1000 = 1 second). Defines
3479 when a packet is considered to be lost so it has to
3480 be retransmitted. The default is 5000 = 5 seconds.
3481 Lowering this value may make downloads succeed
3482 faster in networks with high packet loss rates or
3483 with unreliable TFTP servers.
3485 tftptimeoutcountmax - maximum count of TFTP timeouts (no
3486 unit, minimum value = 0). Defines how many timeouts
3487 can happen during a single file transfer before that
3488 transfer is aborted. The default is 10, and 0 means
3489 'no timeouts allowed'. Increasing this value may help
3490 downloads succeed with high packet loss rates, or with
3491 unreliable TFTP servers or client hardware.
3493 vlan - When set to a value < 4095 the traffic over
3494 Ethernet is encapsulated/received over 802.1q
3497 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
3498 Unsigned value, in milliseconds. If not set, the period will
3499 be either the default (28000), or a value based on
3500 CONFIG_NET_RETRY_COUNT, if defined. This value has
3501 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
3503 The following image location variables contain the location of images
3504 used in booting. The "Image" column gives the role of the image and is
3505 not an environment variable name. The other columns are environment
3506 variable names. "File Name" gives the name of the file on a TFTP
3507 server, "RAM Address" gives the location in RAM the image will be
3508 loaded to, and "Flash Location" gives the image's address in NOR
3509 flash or offset in NAND flash.
3511 *Note* - these variables don't have to be defined for all boards, some
3512 boards currently use other variables for these purposes, and some
3513 boards use these variables for other purposes.
3515 Image File Name RAM Address Flash Location
3516 ----- --------- ----------- --------------
3517 u-boot u-boot u-boot_addr_r u-boot_addr
3518 Linux kernel bootfile kernel_addr_r kernel_addr
3519 device tree blob fdtfile fdt_addr_r fdt_addr
3520 ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
3522 The following environment variables may be used and automatically
3523 updated by the network boot commands ("bootp" and "rarpboot"),
3524 depending the information provided by your boot server:
3526 bootfile - see above
3527 dnsip - IP address of your Domain Name Server
3528 dnsip2 - IP address of your secondary Domain Name Server
3529 gatewayip - IP address of the Gateway (Router) to use
3530 hostname - Target hostname
3532 netmask - Subnet Mask
3533 rootpath - Pathname of the root filesystem on the NFS server
3534 serverip - see above
3537 There are two special Environment Variables:
3539 serial# - contains hardware identification information such
3540 as type string and/or serial number
3541 ethaddr - Ethernet address
3543 These variables can be set only once (usually during manufacturing of
3544 the board). U-Boot refuses to delete or overwrite these variables
3545 once they have been set once.
3548 Further special Environment Variables:
3550 ver - Contains the U-Boot version string as printed
3551 with the "version" command. This variable is
3552 readonly (see CONFIG_VERSION_VARIABLE).
3555 Please note that changes to some configuration parameters may take
3556 only effect after the next boot (yes, that's just like Windoze :-).
3559 Callback functions for environment variables:
3560 ---------------------------------------------
3562 For some environment variables, the behavior of u-boot needs to change
3563 when their values are changed. This functionality allows functions to
3564 be associated with arbitrary variables. On creation, overwrite, or
3565 deletion, the callback will provide the opportunity for some side
3566 effect to happen or for the change to be rejected.
3568 The callbacks are named and associated with a function using the
3569 U_BOOT_ENV_CALLBACK macro in your board or driver code.
3571 These callbacks are associated with variables in one of two ways. The
3572 static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
3573 in the board configuration to a string that defines a list of
3574 associations. The list must be in the following format:
3576 entry = variable_name[:callback_name]
3579 If the callback name is not specified, then the callback is deleted.
3580 Spaces are also allowed anywhere in the list.
3582 Callbacks can also be associated by defining the ".callbacks" variable
3583 with the same list format above. Any association in ".callbacks" will
3584 override any association in the static list. You can define
3585 CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
3586 ".callbacks" environment variable in the default or embedded environment.
3588 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3589 regular expression. This allows multiple variables to be connected to
3590 the same callback without explicitly listing them all out.
3592 The signature of the callback functions is:
3594 int callback(const char *name, const char *value, enum env_op op, int flags)
3596 * name - changed environment variable
3597 * value - new value of the environment variable
3598 * op - operation (create, overwrite, or delete)
3599 * flags - attributes of the environment variable change, see flags H_* in
3602 The return value is 0 if the variable change is accepted and 1 otherwise.
3604 Command Line Parsing:
3605 =====================
3607 There are two different command line parsers available with U-Boot:
3608 the old "simple" one, and the much more powerful "hush" shell:
3610 Old, simple command line parser:
3611 --------------------------------
3613 - supports environment variables (through setenv / saveenv commands)
3614 - several commands on one line, separated by ';'
3615 - variable substitution using "... ${name} ..." syntax
3616 - special characters ('$', ';') can be escaped by prefixing with '\',
3618 setenv bootcmd bootm \${address}
3619 - You can also escape text by enclosing in single apostrophes, for example:
3620 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3625 - similar to Bourne shell, with control structures like
3626 if...then...else...fi, for...do...done; while...do...done,
3627 until...do...done, ...
3628 - supports environment ("global") variables (through setenv / saveenv
3629 commands) and local shell variables (through standard shell syntax
3630 "name=value"); only environment variables can be used with "run"
3636 (1) If a command line (or an environment variable executed by a "run"
3637 command) contains several commands separated by semicolon, and
3638 one of these commands fails, then the remaining commands will be
3641 (2) If you execute several variables with one call to run (i. e.
3642 calling run with a list of variables as arguments), any failing
3643 command will cause "run" to terminate, i. e. the remaining
3644 variables are not executed.
3646 Note for Redundant Ethernet Interfaces:
3647 =======================================
3649 Some boards come with redundant Ethernet interfaces; U-Boot supports
3650 such configurations and is capable of automatic selection of a
3651 "working" interface when needed. MAC assignment works as follows:
3653 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3654 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3655 "eth1addr" (=>eth1), "eth2addr", ...
3657 If the network interface stores some valid MAC address (for instance
3658 in SROM), this is used as default address if there is NO correspon-
3659 ding setting in the environment; if the corresponding environment
3660 variable is set, this overrides the settings in the card; that means:
3662 o If the SROM has a valid MAC address, and there is no address in the
3663 environment, the SROM's address is used.
3665 o If there is no valid address in the SROM, and a definition in the
3666 environment exists, then the value from the environment variable is
3669 o If both the SROM and the environment contain a MAC address, and
3670 both addresses are the same, this MAC address is used.
3672 o If both the SROM and the environment contain a MAC address, and the
3673 addresses differ, the value from the environment is used and a
3676 o If neither SROM nor the environment contain a MAC address, an error
3677 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
3678 a random, locally-assigned MAC is used.
3680 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3681 will be programmed into hardware as part of the initialization process. This
3682 may be skipped by setting the appropriate 'ethmacskip' environment variable.
3683 The naming convention is as follows:
3684 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3689 U-Boot is capable of booting (and performing other auxiliary operations on)
3690 images in two formats:
3692 New uImage format (FIT)
3693 -----------------------
3695 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3696 to Flattened Device Tree). It allows the use of images with multiple
3697 components (several kernels, ramdisks, etc.), with contents protected by
3698 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3704 Old image format is based on binary files which can be basically anything,
3705 preceded by a special header; see the definitions in include/image.h for
3706 details; basically, the header defines the following image properties:
3708 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3709 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3710 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3711 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3713 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
3714 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3715 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
3716 * Compression Type (uncompressed, gzip, bzip2)
3722 The header is marked by a special Magic Number, and both the header
3723 and the data portions of the image are secured against corruption by
3730 Although U-Boot should support any OS or standalone application
3731 easily, the main focus has always been on Linux during the design of
3734 U-Boot includes many features that so far have been part of some
3735 special "boot loader" code within the Linux kernel. Also, any
3736 "initrd" images to be used are no longer part of one big Linux image;
3737 instead, kernel and "initrd" are separate images. This implementation
3738 serves several purposes:
3740 - the same features can be used for other OS or standalone
3741 applications (for instance: using compressed images to reduce the
3742 Flash memory footprint)
3744 - it becomes much easier to port new Linux kernel versions because
3745 lots of low-level, hardware dependent stuff are done by U-Boot
3747 - the same Linux kernel image can now be used with different "initrd"
3748 images; of course this also means that different kernel images can
3749 be run with the same "initrd". This makes testing easier (you don't
3750 have to build a new "zImage.initrd" Linux image when you just
3751 change a file in your "initrd"). Also, a field-upgrade of the
3752 software is easier now.
3758 Porting Linux to U-Boot based systems:
3759 ---------------------------------------
3761 U-Boot cannot save you from doing all the necessary modifications to
3762 configure the Linux device drivers for use with your target hardware
3763 (no, we don't intend to provide a full virtual machine interface to
3766 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3768 Just make sure your machine specific header file (for instance
3769 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
3770 Information structure as we define in include/asm-<arch>/u-boot.h,
3771 and make sure that your definition of IMAP_ADDR uses the same value
3772 as your U-Boot configuration in CONFIG_SYS_IMMR.
3774 Note that U-Boot now has a driver model, a unified model for drivers.
3775 If you are adding a new driver, plumb it into driver model. If there
3776 is no uclass available, you are encouraged to create one. See
3780 Configuring the Linux kernel:
3781 -----------------------------
3783 No specific requirements for U-Boot. Make sure you have some root
3784 device (initial ramdisk, NFS) for your target system.
3787 Building a Linux Image:
3788 -----------------------
3790 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3791 not used. If you use recent kernel source, a new build target
3792 "uImage" will exist which automatically builds an image usable by
3793 U-Boot. Most older kernels also have support for a "pImage" target,
3794 which was introduced for our predecessor project PPCBoot and uses a
3795 100% compatible format.
3799 make TQM850L_defconfig
3804 The "uImage" build target uses a special tool (in 'tools/mkimage') to
3805 encapsulate a compressed Linux kernel image with header information,
3806 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
3808 * build a standard "vmlinux" kernel image (in ELF binary format):
3810 * convert the kernel into a raw binary image:
3812 ${CROSS_COMPILE}-objcopy -O binary \
3813 -R .note -R .comment \
3814 -S vmlinux linux.bin
3816 * compress the binary image:
3820 * package compressed binary image for U-Boot:
3822 mkimage -A ppc -O linux -T kernel -C gzip \
3823 -a 0 -e 0 -n "Linux Kernel Image" \
3824 -d linux.bin.gz uImage
3827 The "mkimage" tool can also be used to create ramdisk images for use
3828 with U-Boot, either separated from the Linux kernel image, or
3829 combined into one file. "mkimage" encapsulates the images with a 64
3830 byte header containing information about target architecture,
3831 operating system, image type, compression method, entry points, time
3832 stamp, CRC32 checksums, etc.
3834 "mkimage" can be called in two ways: to verify existing images and
3835 print the header information, or to build new images.
3837 In the first form (with "-l" option) mkimage lists the information
3838 contained in the header of an existing U-Boot image; this includes
3839 checksum verification:
3841 tools/mkimage -l image
3842 -l ==> list image header information
3844 The second form (with "-d" option) is used to build a U-Boot image
3845 from a "data file" which is used as image payload:
3847 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3848 -n name -d data_file image
3849 -A ==> set architecture to 'arch'
3850 -O ==> set operating system to 'os'
3851 -T ==> set image type to 'type'
3852 -C ==> set compression type 'comp'
3853 -a ==> set load address to 'addr' (hex)
3854 -e ==> set entry point to 'ep' (hex)
3855 -n ==> set image name to 'name'
3856 -d ==> use image data from 'datafile'
3858 Right now, all Linux kernels for PowerPC systems use the same load
3859 address (0x00000000), but the entry point address depends on the
3862 - 2.2.x kernels have the entry point at 0x0000000C,
3863 - 2.3.x and later kernels have the entry point at 0x00000000.
3865 So a typical call to build a U-Boot image would read:
3867 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3868 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3869 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
3870 > examples/uImage.TQM850L
3871 Image Name: 2.4.4 kernel for TQM850L
3872 Created: Wed Jul 19 02:34:59 2000
3873 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3874 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3875 Load Address: 0x00000000
3876 Entry Point: 0x00000000
3878 To verify the contents of the image (or check for corruption):
3880 -> tools/mkimage -l examples/uImage.TQM850L
3881 Image Name: 2.4.4 kernel for TQM850L
3882 Created: Wed Jul 19 02:34:59 2000
3883 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3884 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3885 Load Address: 0x00000000
3886 Entry Point: 0x00000000
3888 NOTE: for embedded systems where boot time is critical you can trade
3889 speed for memory and install an UNCOMPRESSED image instead: this
3890 needs more space in Flash, but boots much faster since it does not
3891 need to be uncompressed:
3893 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
3894 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3895 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3896 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
3897 > examples/uImage.TQM850L-uncompressed
3898 Image Name: 2.4.4 kernel for TQM850L
3899 Created: Wed Jul 19 02:34:59 2000
3900 Image Type: PowerPC Linux Kernel Image (uncompressed)
3901 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3902 Load Address: 0x00000000
3903 Entry Point: 0x00000000
3906 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3907 when your kernel is intended to use an initial ramdisk:
3909 -> tools/mkimage -n 'Simple Ramdisk Image' \
3910 > -A ppc -O linux -T ramdisk -C gzip \
3911 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3912 Image Name: Simple Ramdisk Image
3913 Created: Wed Jan 12 14:01:50 2000
3914 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3915 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3916 Load Address: 0x00000000
3917 Entry Point: 0x00000000
3919 The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
3920 option performs the converse operation of the mkimage's second form (the "-d"
3921 option). Given an image built by mkimage, the dumpimage extracts a "data file"
3924 tools/dumpimage -i image -T type -p position data_file
3925 -i ==> extract from the 'image' a specific 'data_file'
3926 -T ==> set image type to 'type'
3927 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
3930 Installing a Linux Image:
3931 -------------------------
3933 To downloading a U-Boot image over the serial (console) interface,
3934 you must convert the image to S-Record format:
3936 objcopy -I binary -O srec examples/image examples/image.srec
3938 The 'objcopy' does not understand the information in the U-Boot
3939 image header, so the resulting S-Record file will be relative to
3940 address 0x00000000. To load it to a given address, you need to
3941 specify the target address as 'offset' parameter with the 'loads'
3944 Example: install the image to address 0x40100000 (which on the
3945 TQM8xxL is in the first Flash bank):
3947 => erase 40100000 401FFFFF
3953 ## Ready for S-Record download ...
3954 ~>examples/image.srec
3955 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3957 15989 15990 15991 15992
3958 [file transfer complete]
3960 ## Start Addr = 0x00000000
3963 You can check the success of the download using the 'iminfo' command;
3964 this includes a checksum verification so you can be sure no data
3965 corruption happened:
3969 ## Checking Image at 40100000 ...
3970 Image Name: 2.2.13 for initrd on TQM850L
3971 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3972 Data Size: 335725 Bytes = 327 kB = 0 MB
3973 Load Address: 00000000
3974 Entry Point: 0000000c
3975 Verifying Checksum ... OK
3981 The "bootm" command is used to boot an application that is stored in
3982 memory (RAM or Flash). In case of a Linux kernel image, the contents
3983 of the "bootargs" environment variable is passed to the kernel as
3984 parameters. You can check and modify this variable using the
3985 "printenv" and "setenv" commands:
3988 => printenv bootargs
3989 bootargs=root=/dev/ram
3991 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3993 => printenv bootargs
3994 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3997 ## Booting Linux kernel at 40020000 ...
3998 Image Name: 2.2.13 for NFS on TQM850L
3999 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4000 Data Size: 381681 Bytes = 372 kB = 0 MB
4001 Load Address: 00000000
4002 Entry Point: 0000000c
4003 Verifying Checksum ... OK
4004 Uncompressing Kernel Image ... OK
4005 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
4006 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4007 time_init: decrementer frequency = 187500000/60
4008 Calibrating delay loop... 49.77 BogoMIPS
4009 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4012 If you want to boot a Linux kernel with initial RAM disk, you pass
4013 the memory addresses of both the kernel and the initrd image (PPBCOOT
4014 format!) to the "bootm" command:
4016 => imi 40100000 40200000
4018 ## Checking Image at 40100000 ...
4019 Image Name: 2.2.13 for initrd on TQM850L
4020 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4021 Data Size: 335725 Bytes = 327 kB = 0 MB
4022 Load Address: 00000000
4023 Entry Point: 0000000c
4024 Verifying Checksum ... OK
4026 ## Checking Image at 40200000 ...
4027 Image Name: Simple Ramdisk Image
4028 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4029 Data Size: 566530 Bytes = 553 kB = 0 MB
4030 Load Address: 00000000
4031 Entry Point: 00000000
4032 Verifying Checksum ... OK
4034 => bootm 40100000 40200000
4035 ## Booting Linux kernel at 40100000 ...
4036 Image Name: 2.2.13 for initrd on TQM850L
4037 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4038 Data Size: 335725 Bytes = 327 kB = 0 MB
4039 Load Address: 00000000
4040 Entry Point: 0000000c
4041 Verifying Checksum ... OK
4042 Uncompressing Kernel Image ... OK
4043 ## Loading RAMDisk Image at 40200000 ...
4044 Image Name: Simple Ramdisk Image
4045 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4046 Data Size: 566530 Bytes = 553 kB = 0 MB
4047 Load Address: 00000000
4048 Entry Point: 00000000
4049 Verifying Checksum ... OK
4050 Loading Ramdisk ... OK
4051 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
4052 Boot arguments: root=/dev/ram
4053 time_init: decrementer frequency = 187500000/60
4054 Calibrating delay loop... 49.77 BogoMIPS
4056 RAMDISK: Compressed image found at block 0
4057 VFS: Mounted root (ext2 filesystem).
4061 Boot Linux and pass a flat device tree:
4064 First, U-Boot must be compiled with the appropriate defines. See the section
4065 titled "Linux Kernel Interface" above for a more in depth explanation. The
4066 following is an example of how to start a kernel and pass an updated
4072 oft=oftrees/mpc8540ads.dtb
4073 => tftp $oftaddr $oft
4074 Speed: 1000, full duplex
4076 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4077 Filename 'oftrees/mpc8540ads.dtb'.
4078 Load address: 0x300000
4081 Bytes transferred = 4106 (100a hex)
4082 => tftp $loadaddr $bootfile
4083 Speed: 1000, full duplex
4085 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4087 Load address: 0x200000
4088 Loading:############
4090 Bytes transferred = 1029407 (fb51f hex)
4095 => bootm $loadaddr - $oftaddr
4096 ## Booting image at 00200000 ...
4097 Image Name: Linux-2.6.17-dirty
4098 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4099 Data Size: 1029343 Bytes = 1005.2 kB
4100 Load Address: 00000000
4101 Entry Point: 00000000
4102 Verifying Checksum ... OK
4103 Uncompressing Kernel Image ... OK
4104 Booting using flat device tree at 0x300000
4105 Using MPC85xx ADS machine description
4106 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4110 More About U-Boot Image Types:
4111 ------------------------------
4113 U-Boot supports the following image types:
4115 "Standalone Programs" are directly runnable in the environment
4116 provided by U-Boot; it is expected that (if they behave
4117 well) you can continue to work in U-Boot after return from
4118 the Standalone Program.
4119 "OS Kernel Images" are usually images of some Embedded OS which
4120 will take over control completely. Usually these programs
4121 will install their own set of exception handlers, device
4122 drivers, set up the MMU, etc. - this means, that you cannot
4123 expect to re-enter U-Boot except by resetting the CPU.
4124 "RAMDisk Images" are more or less just data blocks, and their
4125 parameters (address, size) are passed to an OS kernel that is
4127 "Multi-File Images" contain several images, typically an OS
4128 (Linux) kernel image and one or more data images like
4129 RAMDisks. This construct is useful for instance when you want
4130 to boot over the network using BOOTP etc., where the boot
4131 server provides just a single image file, but you want to get
4132 for instance an OS kernel and a RAMDisk image.
4134 "Multi-File Images" start with a list of image sizes, each
4135 image size (in bytes) specified by an "uint32_t" in network
4136 byte order. This list is terminated by an "(uint32_t)0".
4137 Immediately after the terminating 0 follow the images, one by
4138 one, all aligned on "uint32_t" boundaries (size rounded up to
4139 a multiple of 4 bytes).
4141 "Firmware Images" are binary images containing firmware (like
4142 U-Boot or FPGA images) which usually will be programmed to
4145 "Script files" are command sequences that will be executed by
4146 U-Boot's command interpreter; this feature is especially
4147 useful when you configure U-Boot to use a real shell (hush)
4148 as command interpreter.
4150 Booting the Linux zImage:
4151 -------------------------
4153 On some platforms, it's possible to boot Linux zImage. This is done
4154 using the "bootz" command. The syntax of "bootz" command is the same
4155 as the syntax of "bootm" command.
4157 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
4158 kernel with raw initrd images. The syntax is slightly different, the
4159 address of the initrd must be augmented by it's size, in the following
4160 format: "<initrd addres>:<initrd size>".
4166 One of the features of U-Boot is that you can dynamically load and
4167 run "standalone" applications, which can use some resources of
4168 U-Boot like console I/O functions or interrupt services.
4170 Two simple examples are included with the sources:
4175 'examples/hello_world.c' contains a small "Hello World" Demo
4176 application; it is automatically compiled when you build U-Boot.
4177 It's configured to run at address 0x00040004, so you can play with it
4181 ## Ready for S-Record download ...
4182 ~>examples/hello_world.srec
4183 1 2 3 4 5 6 7 8 9 10 11 ...
4184 [file transfer complete]
4186 ## Start Addr = 0x00040004
4188 => go 40004 Hello World! This is a test.
4189 ## Starting application at 0x00040004 ...
4200 Hit any key to exit ...
4202 ## Application terminated, rc = 0x0
4204 Another example, which demonstrates how to register a CPM interrupt
4205 handler with the U-Boot code, can be found in 'examples/timer.c'.
4206 Here, a CPM timer is set up to generate an interrupt every second.
4207 The interrupt service routine is trivial, just printing a '.'
4208 character, but this is just a demo program. The application can be
4209 controlled by the following keys:
4211 ? - print current values og the CPM Timer registers
4212 b - enable interrupts and start timer
4213 e - stop timer and disable interrupts
4214 q - quit application
4217 ## Ready for S-Record download ...
4218 ~>examples/timer.srec
4219 1 2 3 4 5 6 7 8 9 10 11 ...
4220 [file transfer complete]
4222 ## Start Addr = 0x00040004
4225 ## Starting application at 0x00040004 ...
4228 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4231 [q, b, e, ?] Set interval 1000000 us
4234 [q, b, e, ?] ........
4235 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4238 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4241 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4244 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4246 [q, b, e, ?] ...Stopping timer
4248 [q, b, e, ?] ## Application terminated, rc = 0x0
4254 Over time, many people have reported problems when trying to use the
4255 "minicom" terminal emulation program for serial download. I (wd)
4256 consider minicom to be broken, and recommend not to use it. Under
4257 Unix, I recommend to use C-Kermit for general purpose use (and
4258 especially for kermit binary protocol download ("loadb" command), and
4259 use "cu" for S-Record download ("loads" command). See
4260 http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4261 for help with kermit.
4264 Nevertheless, if you absolutely want to use it try adding this
4265 configuration to your "File transfer protocols" section:
4267 Name Program Name U/D FullScr IO-Red. Multi
4268 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4269 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
4275 Starting at version 0.9.2, U-Boot supports NetBSD both as host
4276 (build U-Boot) and target system (boots NetBSD/mpc8xx).
4278 Building requires a cross environment; it is known to work on
4279 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4280 need gmake since the Makefiles are not compatible with BSD make).
4281 Note that the cross-powerpc package does not install include files;
4282 attempting to build U-Boot will fail because <machine/ansi.h> is
4283 missing. This file has to be installed and patched manually:
4285 # cd /usr/pkg/cross/powerpc-netbsd/include
4287 # ln -s powerpc machine
4288 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4289 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
4291 Native builds *don't* work due to incompatibilities between native
4292 and U-Boot include files.
4294 Booting assumes that (the first part of) the image booted is a
4295 stage-2 loader which in turn loads and then invokes the kernel
4296 proper. Loader sources will eventually appear in the NetBSD source
4297 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
4298 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4301 Implementation Internals:
4302 =========================
4304 The following is not intended to be a complete description of every
4305 implementation detail. However, it should help to understand the
4306 inner workings of U-Boot and make it easier to port it to custom
4310 Initial Stack, Global Data:
4311 ---------------------------
4313 The implementation of U-Boot is complicated by the fact that U-Boot
4314 starts running out of ROM (flash memory), usually without access to
4315 system RAM (because the memory controller is not initialized yet).
4316 This means that we don't have writable Data or BSS segments, and BSS
4317 is not initialized as zero. To be able to get a C environment working
4318 at all, we have to allocate at least a minimal stack. Implementation
4319 options for this are defined and restricted by the CPU used: Some CPU
4320 models provide on-chip memory (like the IMMR area on MPC8xx and
4321 MPC826x processors), on others (parts of) the data cache can be
4322 locked as (mis-) used as memory, etc.
4324 Chris Hallinan posted a good summary of these issues to the
4325 U-Boot mailing list:
4327 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4328 From: "Chris Hallinan" <clh@net1plus.com>
4329 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4332 Correct me if I'm wrong, folks, but the way I understand it
4333 is this: Using DCACHE as initial RAM for Stack, etc, does not
4334 require any physical RAM backing up the cache. The cleverness
4335 is that the cache is being used as a temporary supply of
4336 necessary storage before the SDRAM controller is setup. It's
4337 beyond the scope of this list to explain the details, but you
4338 can see how this works by studying the cache architecture and
4339 operation in the architecture and processor-specific manuals.
4341 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4342 is another option for the system designer to use as an
4343 initial stack/RAM area prior to SDRAM being available. Either
4344 option should work for you. Using CS 4 should be fine if your
4345 board designers haven't used it for something that would
4346 cause you grief during the initial boot! It is frequently not
4349 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
4350 with your processor/board/system design. The default value
4351 you will find in any recent u-boot distribution in
4352 walnut.h should work for you. I'd set it to a value larger
4353 than your SDRAM module. If you have a 64MB SDRAM module, set
4354 it above 400_0000. Just make sure your board has no resources
4355 that are supposed to respond to that address! That code in
4356 start.S has been around a while and should work as is when
4357 you get the config right.
4362 It is essential to remember this, since it has some impact on the C
4363 code for the initialization procedures:
4365 * Initialized global data (data segment) is read-only. Do not attempt
4368 * Do not use any uninitialized global data (or implicitly initialized
4369 as zero data - BSS segment) at all - this is undefined, initiali-
4370 zation is performed later (when relocating to RAM).
4372 * Stack space is very limited. Avoid big data buffers or things like
4375 Having only the stack as writable memory limits means we cannot use
4376 normal global data to share information between the code. But it
4377 turned out that the implementation of U-Boot can be greatly
4378 simplified by making a global data structure (gd_t) available to all
4379 functions. We could pass a pointer to this data as argument to _all_
4380 functions, but this would bloat the code. Instead we use a feature of
4381 the GCC compiler (Global Register Variables) to share the data: we
4382 place a pointer (gd) to the global data into a register which we
4383 reserve for this purpose.
4385 When choosing a register for such a purpose we are restricted by the
4386 relevant (E)ABI specifications for the current architecture, and by
4387 GCC's implementation.
4389 For PowerPC, the following registers have specific use:
4391 R2: reserved for system use
4392 R3-R4: parameter passing and return values
4393 R5-R10: parameter passing
4394 R13: small data area pointer
4398 (U-Boot also uses R12 as internal GOT pointer. r12
4399 is a volatile register so r12 needs to be reset when
4400 going back and forth between asm and C)
4402 ==> U-Boot will use R2 to hold a pointer to the global data
4404 Note: on PPC, we could use a static initializer (since the
4405 address of the global data structure is known at compile time),
4406 but it turned out that reserving a register results in somewhat
4407 smaller code - although the code savings are not that big (on
4408 average for all boards 752 bytes for the whole U-Boot image,
4409 624 text + 127 data).
4411 On ARM, the following registers are used:
4413 R0: function argument word/integer result
4414 R1-R3: function argument word
4415 R9: platform specific
4416 R10: stack limit (used only if stack checking is enabled)
4417 R11: argument (frame) pointer
4418 R12: temporary workspace
4421 R15: program counter
4423 ==> U-Boot will use R9 to hold a pointer to the global data
4425 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
4427 On Nios II, the ABI is documented here:
4428 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4430 ==> U-Boot will use gp to hold a pointer to the global data
4432 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4433 to access small data sections, so gp is free.
4435 On NDS32, the following registers are used:
4437 R0-R1: argument/return
4439 R15: temporary register for assembler
4440 R16: trampoline register
4441 R28: frame pointer (FP)
4442 R29: global pointer (GP)
4443 R30: link register (LP)
4444 R31: stack pointer (SP)
4445 PC: program counter (PC)
4447 ==> U-Boot will use R10 to hold a pointer to the global data
4449 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4450 or current versions of GCC may "optimize" the code too much.
4452 On RISC-V, the following registers are used:
4454 x0: hard-wired zero (zero)
4455 x1: return address (ra)
4456 x2: stack pointer (sp)
4457 x3: global pointer (gp)
4458 x4: thread pointer (tp)
4459 x5: link register (t0)
4460 x8: frame pointer (fp)
4461 x10-x11: arguments/return values (a0-1)
4462 x12-x17: arguments (a2-7)
4463 x28-31: temporaries (t3-6)
4464 pc: program counter (pc)
4466 ==> U-Boot will use gp to hold a pointer to the global data
4471 U-Boot runs in system state and uses physical addresses, i.e. the
4472 MMU is not used either for address mapping nor for memory protection.
4474 The available memory is mapped to fixed addresses using the memory
4475 controller. In this process, a contiguous block is formed for each
4476 memory type (Flash, SDRAM, SRAM), even when it consists of several
4477 physical memory banks.
4479 U-Boot is installed in the first 128 kB of the first Flash bank (on
4480 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4481 booting and sizing and initializing DRAM, the code relocates itself
4482 to the upper end of DRAM. Immediately below the U-Boot code some
4483 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4484 configuration setting]. Below that, a structure with global Board
4485 Info data is placed, followed by the stack (growing downward).
4487 Additionally, some exception handler code is copied to the low 8 kB
4488 of DRAM (0x00000000 ... 0x00001FFF).
4490 So a typical memory configuration with 16 MB of DRAM could look like
4493 0x0000 0000 Exception Vector code
4496 0x0000 2000 Free for Application Use
4502 0x00FB FF20 Monitor Stack (Growing downward)
4503 0x00FB FFAC Board Info Data and permanent copy of global data
4504 0x00FC 0000 Malloc Arena
4507 0x00FE 0000 RAM Copy of Monitor Code
4508 ... eventually: LCD or video framebuffer
4509 ... eventually: pRAM (Protected RAM - unchanged by reset)
4510 0x00FF FFFF [End of RAM]
4513 System Initialization:
4514 ----------------------
4516 In the reset configuration, U-Boot starts at the reset entry point
4517 (on most PowerPC systems at address 0x00000100). Because of the reset
4518 configuration for CS0# this is a mirror of the on board Flash memory.
4519 To be able to re-map memory U-Boot then jumps to its link address.
4520 To be able to implement the initialization code in C, a (small!)
4521 initial stack is set up in the internal Dual Ported RAM (in case CPUs
4522 which provide such a feature like), or in a locked part of the data
4523 cache. After that, U-Boot initializes the CPU core, the caches and
4526 Next, all (potentially) available memory banks are mapped using a
4527 preliminary mapping. For example, we put them on 512 MB boundaries
4528 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4529 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4530 programmed for SDRAM access. Using the temporary configuration, a
4531 simple memory test is run that determines the size of the SDRAM
4534 When there is more than one SDRAM bank, and the banks are of
4535 different size, the largest is mapped first. For equal size, the first
4536 bank (CS2#) is mapped first. The first mapping is always for address
4537 0x00000000, with any additional banks following immediately to create
4538 contiguous memory starting from 0.
4540 Then, the monitor installs itself at the upper end of the SDRAM area
4541 and allocates memory for use by malloc() and for the global Board
4542 Info data; also, the exception vector code is copied to the low RAM
4543 pages, and the final stack is set up.
4545 Only after this relocation will you have a "normal" C environment;
4546 until that you are restricted in several ways, mostly because you are
4547 running from ROM, and because the code will have to be relocated to a
4551 U-Boot Porting Guide:
4552 ----------------------
4554 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4558 int main(int argc, char *argv[])
4560 sighandler_t no_more_time;
4562 signal(SIGALRM, no_more_time);
4563 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4565 if (available_money > available_manpower) {
4566 Pay consultant to port U-Boot;
4570 Download latest U-Boot source;
4572 Subscribe to u-boot mailing list;
4575 email("Hi, I am new to U-Boot, how do I get started?");
4578 Read the README file in the top level directory;
4579 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4580 Read applicable doc/README.*;
4581 Read the source, Luke;
4582 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
4585 if (available_money > toLocalCurrency ($2500))
4588 Add a lot of aggravation and time;
4590 if (a similar board exists) { /* hopefully... */
4591 cp -a board/<similar> board/<myboard>
4592 cp include/configs/<similar>.h include/configs/<myboard>.h
4594 Create your own board support subdirectory;
4595 Create your own board include/configs/<myboard>.h file;
4597 Edit new board/<myboard> files
4598 Edit new include/configs/<myboard>.h
4603 Add / modify source code;
4607 email("Hi, I am having problems...");
4609 Send patch file to the U-Boot email list;
4610 if (reasonable critiques)
4611 Incorporate improvements from email list code review;
4613 Defend code as written;
4619 void no_more_time (int sig)
4628 All contributions to U-Boot should conform to the Linux kernel
4629 coding style; see the kernel coding style guide at
4630 https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
4631 script "scripts/Lindent" in your Linux kernel source directory.
4633 Source files originating from a different project (for example the
4634 MTD subsystem) are generally exempt from these guidelines and are not
4635 reformatted to ease subsequent migration to newer versions of those
4638 Please note that U-Boot is implemented in C (and to some small parts in
4639 Assembler); no C++ is used, so please do not use C++ style comments (//)
4642 Please also stick to the following formatting rules:
4643 - remove any trailing white space
4644 - use TAB characters for indentation and vertical alignment, not spaces
4645 - make sure NOT to use DOS '\r\n' line feeds
4646 - do not add more than 2 consecutive empty lines to source files
4647 - do not add trailing empty lines to source files
4649 Submissions which do not conform to the standards may be returned
4650 with a request to reformat the changes.
4656 Since the number of patches for U-Boot is growing, we need to
4657 establish some rules. Submissions which do not conform to these rules
4658 may be rejected, even when they contain important and valuable stuff.
4660 Please see http://www.denx.de/wiki/U-Boot/Patches for details.
4662 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4663 see https://lists.denx.de/listinfo/u-boot
4665 When you send a patch, please include the following information with
4668 * For bug fixes: a description of the bug and how your patch fixes
4669 this bug. Please try to include a way of demonstrating that the
4670 patch actually fixes something.
4672 * For new features: a description of the feature and your
4675 * For major contributions, add a MAINTAINERS file with your
4676 information and associated file and directory references.
4678 * When you add support for a new board, don't forget to add a
4679 maintainer e-mail address to the boards.cfg file, too.
4681 * If your patch adds new configuration options, don't forget to
4682 document these in the README file.
4684 * The patch itself. If you are using git (which is *strongly*
4685 recommended) you can easily generate the patch using the
4686 "git format-patch". If you then use "git send-email" to send it to
4687 the U-Boot mailing list, you will avoid most of the common problems
4688 with some other mail clients.
4690 If you cannot use git, use "diff -purN OLD NEW". If your version of
4691 diff does not support these options, then get the latest version of
4694 The current directory when running this command shall be the parent
4695 directory of the U-Boot source tree (i. e. please make sure that
4696 your patch includes sufficient directory information for the
4699 We prefer patches as plain text. MIME attachments are discouraged,
4700 and compressed attachments must not be used.
4702 * If one logical set of modifications affects or creates several
4703 files, all these changes shall be submitted in a SINGLE patch file.
4705 * Changesets that contain different, unrelated modifications shall be
4706 submitted as SEPARATE patches, one patch per changeset.
4711 * Before sending the patch, run the buildman script on your patched
4712 source tree and make sure that no errors or warnings are reported
4713 for any of the boards.
4715 * Keep your modifications to the necessary minimum: A patch
4716 containing several unrelated changes or arbitrary reformats will be
4717 returned with a request to re-formatting / split it.
4719 * If you modify existing code, make sure that your new code does not
4720 add to the memory footprint of the code ;-) Small is beautiful!
4721 When adding new features, these should compile conditionally only
4722 (using #ifdef), and the resulting code with the new feature
4723 disabled must not need more memory than the old code without your
4726 * Remember that there is a size limit of 100 kB per message on the
4727 u-boot mailing list. Bigger patches will be moderated. If they are
4728 reasonable and not too big, they will be acknowledged. But patches
4729 bigger than the size limit should be avoided.