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 https://lists.denx.de/pipermail/u-boot and
55 https://marc.info/?l=u-boot
57 Where to get source code:
58 =========================
60 The U-Boot source code is maintained in the Git repository at
61 https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
62 https://source.denx.de/u-boot/u-boot
64 The "Tags" links on this page allow you to download tarballs of
65 any version you might be interested in. Official releases are also
66 available from the DENX file server through HTTPS or FTP.
67 https://ftp.denx.de/pub/u-boot/
68 ftp://ftp.denx.de/pub/u-boot/
74 - start from 8xxrom sources
75 - create PPCBoot project (https://sourceforge.net/projects/ppcboot)
77 - make it easier to add custom boards
78 - make it possible to add other [PowerPC] CPUs
79 - extend functions, especially:
80 * Provide extended interface to Linux boot loader
83 * ATA disk / SCSI ... boot
84 - create ARMBoot project (https://sourceforge.net/projects/armboot)
85 - add other CPU families (starting with ARM)
86 - create U-Boot project (https://sourceforge.net/projects/u-boot)
87 - current project page: see https://www.denx.de/wiki/U-Boot
93 The "official" name of this project is "Das U-Boot". The spelling
94 "U-Boot" shall be used in all written text (documentation, comments
95 in source files etc.). Example:
97 This is the README file for the U-Boot project.
99 File names etc. shall be based on the string "u-boot". Examples:
101 include/asm-ppc/u-boot.h
103 #include <asm/u-boot.h>
105 Variable names, preprocessor constants etc. shall be either based on
106 the string "u_boot" or on "U_BOOT". Example:
108 U_BOOT_VERSION u_boot_logo
109 IH_OS_U_BOOT u_boot_hush_start
115 Starting with the release in October 2008, the names of the releases
116 were changed from numerical release numbers without deeper meaning
117 into a time stamp based numbering. Regular releases are identified by
118 names consisting of the calendar year and month of the release date.
119 Additional fields (if present) indicate release candidates or bug fix
120 releases in "stable" maintenance trees.
123 U-Boot v2009.11 - Release November 2009
124 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
125 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
131 /arch Architecture-specific files
132 /arc Files generic to ARC architecture
133 /arm Files generic to ARM architecture
134 /m68k Files generic to m68k architecture
135 /microblaze Files generic to microblaze architecture
136 /mips Files generic to MIPS architecture
137 /nds32 Files generic to NDS32 architecture
138 /nios2 Files generic to Altera NIOS2 architecture
139 /powerpc Files generic to PowerPC architecture
140 /riscv Files generic to RISC-V architecture
141 /sandbox Files generic to HW-independent "sandbox"
142 /sh Files generic to SH architecture
143 /x86 Files generic to x86 architecture
144 /xtensa Files generic to Xtensa architecture
145 /api Machine/arch-independent API for external apps
146 /board Board-dependent files
147 /boot Support for images and booting
148 /cmd U-Boot commands functions
149 /common Misc architecture-independent functions
150 /configs Board default configuration files
151 /disk Code for disk drive partition handling
152 /doc Documentation (a mix of ReST and READMEs)
153 /drivers Device drivers
154 /dts Makefile for building internal U-Boot fdt.
155 /env Environment support
156 /examples Example code for standalone applications, etc.
157 /fs Filesystem code (cramfs, ext2, jffs2, etc.)
158 /include Header Files
159 /lib Library routines generic to all architectures
160 /Licenses Various license files
162 /post Power On Self Test
163 /scripts Various build scripts and Makefiles
164 /test Various unit test files
165 /tools Tools to build and sign FIT images, etc.
167 Software Configuration:
168 =======================
170 Configuration is usually done using C preprocessor defines; the
171 rationale behind that is to avoid dead code whenever possible.
173 There are two classes of configuration variables:
175 * Configuration _OPTIONS_:
176 These are selectable by the user and have names beginning with
179 * Configuration _SETTINGS_:
180 These depend on the hardware etc. and should not be meddled with if
181 you don't know what you're doing; they have names beginning with
184 Previously, all configuration was done by hand, which involved creating
185 symbolic links and editing configuration files manually. More recently,
186 U-Boot has added the Kbuild infrastructure used by the Linux kernel,
187 allowing you to use the "make menuconfig" command to configure your
191 Selection of Processor Architecture and Board Type:
192 ---------------------------------------------------
194 For all supported boards there are ready-to-use default
195 configurations available; just type "make <board_name>_defconfig".
197 Example: For a TQM823L module type:
200 make TQM823L_defconfig
202 Note: If you're looking for the default configuration file for a board
203 you're sure used to be there but is now missing, check the file
204 doc/README.scrapyard for a list of no longer supported boards.
209 U-Boot can be built natively to run on a Linux host using the 'sandbox'
210 board. This allows feature development which is not board- or architecture-
211 specific to be undertaken on a native platform. The sandbox is also used to
212 run some of U-Boot's tests.
214 See doc/arch/sandbox.rst for more details.
217 Board Initialisation Flow:
218 --------------------------
220 This is the intended start-up flow for boards. This should apply for both
221 SPL and U-Boot proper (i.e. they both follow the same rules).
223 Note: "SPL" stands for "Secondary Program Loader," which is explained in
224 more detail later in this file.
226 At present, SPL mostly uses a separate code path, but the function names
227 and roles of each function are the same. Some boards or architectures
228 may not conform to this. At least most ARM boards which use
229 CONFIG_SPL_FRAMEWORK conform to this.
231 Execution typically starts with an architecture-specific (and possibly
232 CPU-specific) start.S file, such as:
234 - arch/arm/cpu/armv7/start.S
235 - arch/powerpc/cpu/mpc83xx/start.S
236 - arch/mips/cpu/start.S
238 and so on. From there, three functions are called; the purpose and
239 limitations of each of these functions are described below.
242 - purpose: essential init to permit execution to reach board_init_f()
243 - no global_data or BSS
244 - there is no stack (ARMv7 may have one but it will soon be removed)
245 - must not set up SDRAM or use console
246 - must only do the bare minimum to allow execution to continue to
248 - this is almost never needed
249 - return normally from this function
252 - purpose: set up the machine ready for running board_init_r():
253 i.e. SDRAM and serial UART
254 - global_data is available
256 - BSS is not available, so you cannot use global/static variables,
257 only stack variables and global_data
259 Non-SPL-specific notes:
260 - dram_init() is called to set up DRAM. If already done in SPL this
264 - you can override the entire board_init_f() function with your own
266 - preloader_console_init() can be called here in extremis
267 - should set up SDRAM, and anything needed to make the UART work
268 - there is no need to clear BSS, it will be done by crt0.S
269 - for specific scenarios on certain architectures an early BSS *can*
270 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
271 of BSS prior to entering board_init_f()) but doing so is discouraged.
272 Instead it is strongly recommended to architect any code changes
273 or additions such to not depend on the availability of BSS during
274 board_init_f() as indicated in other sections of this README to
275 maintain compatibility and consistency across the entire code base.
276 - must return normally from this function (don't call board_init_r()
279 Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
280 this point the stack and global_data are relocated to below
281 CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
285 - purpose: main execution, common code
286 - global_data is available
288 - BSS is available, all static/global variables can be used
289 - execution eventually continues to main_loop()
291 Non-SPL-specific notes:
292 - U-Boot is relocated to the top of memory and is now running from
296 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
297 CONFIG_SPL_STACK_R_ADDR points into SDRAM
298 - preloader_console_init() can be called here - typically this is
299 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
300 spl_board_init() function containing this call
301 - loads U-Boot or (in falcon mode) Linux
304 Configuration Options:
305 ----------------------
307 Configuration depends on the combination of board and CPU type; all
308 such information is kept in a configuration file
309 "include/configs/<board_name>.h".
311 Example: For a TQM823L module, all configuration settings are in
312 "include/configs/TQM823L.h".
315 Many of the options are named exactly as the corresponding Linux
316 kernel configuration options. The intention is to make it easier to
317 build a config tool - later.
319 - ARM Platform Bus Type(CCI):
320 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
321 provides full cache coherency between two clusters of multi-core
322 CPUs and I/O coherency for devices and I/O masters
324 CONFIG_SYS_FSL_HAS_CCI400
326 Defined For SoC that has cache coherent interconnect
329 CONFIG_SYS_FSL_HAS_CCN504
331 Defined for SoC that has cache coherent interconnect CCN-504
333 The following options need to be configured:
335 - CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
337 - Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
342 Specifies that the core is a 64-bit PowerPC implementation (implements
343 the "64" category of the Power ISA). This is necessary for ePAPR
344 compliance, among other possible reasons.
346 CONFIG_SYS_FSL_TBCLK_DIV
348 Defines the core time base clock divider ratio compared to the
349 system clock. On most PQ3 devices this is 8, on newer QorIQ
350 devices it can be 16 or 32. The ratio varies from SoC to Soc.
352 CONFIG_SYS_FSL_PCIE_COMPAT
354 Defines the string to utilize when trying to match PCIe device
355 tree nodes for the given platform.
357 CONFIG_SYS_FSL_ERRATUM_A004510
359 Enables a workaround for erratum A004510. If set,
360 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
361 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
363 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
364 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
366 Defines one or two SoC revisions (low 8 bits of SVR)
367 for which the A004510 workaround should be applied.
369 The rest of SVR is either not relevant to the decision
370 of whether the erratum is present (e.g. p2040 versus
371 p2041) or is implied by the build target, which controls
372 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
374 See Freescale App Note 4493 for more information about
377 CONFIG_A003399_NOR_WORKAROUND
378 Enables a workaround for IFC erratum A003399. It is only
379 required during NOR boot.
381 CONFIG_A008044_WORKAROUND
382 Enables a workaround for T1040/T1042 erratum A008044. It is only
383 required during NAND boot and valid for Rev 1.0 SoC revision
385 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
387 This is the value to write into CCSR offset 0x18600
388 according to the A004510 workaround.
390 CONFIG_SYS_FSL_DSP_DDR_ADDR
391 This value denotes start offset of DDR memory which is
392 connected exclusively to the DSP cores.
394 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
395 This value denotes start offset of M2 memory
396 which is directly connected to the DSP core.
398 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
399 This value denotes start offset of M3 memory which is directly
400 connected to the DSP core.
402 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
403 This value denotes start offset of DSP CCSR space.
405 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
406 Single Source Clock is clocking mode present in some of FSL SoC's.
407 In this mode, a single differential clock is used to supply
408 clocks to the sysclock, ddrclock and usbclock.
410 CONFIG_SYS_CPC_REINIT_F
411 This CONFIG is defined when the CPC is configured as SRAM at the
412 time of U-Boot entry and is required to be re-initialized.
415 Indicates this SoC supports deep sleep feature. If deep sleep is
416 supported, core will start to execute uboot when wakes up.
418 - Generic CPU options:
419 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
421 Defines the endianess of the CPU. Implementation of those
422 values is arch specific.
425 Freescale DDR driver in use. This type of DDR controller is
426 found in mpc83xx, mpc85xx as well as some ARM core SoCs.
428 CONFIG_SYS_FSL_DDR_ADDR
429 Freescale DDR memory-mapped register base.
431 CONFIG_SYS_FSL_DDR_EMU
432 Specify emulator support for DDR. Some DDR features such as
433 deskew training are not available.
435 CONFIG_SYS_FSL_DDRC_GEN1
436 Freescale DDR1 controller.
438 CONFIG_SYS_FSL_DDRC_GEN2
439 Freescale DDR2 controller.
441 CONFIG_SYS_FSL_DDRC_GEN3
442 Freescale DDR3 controller.
444 CONFIG_SYS_FSL_DDRC_GEN4
445 Freescale DDR4 controller.
447 CONFIG_SYS_FSL_DDRC_ARM_GEN3
448 Freescale DDR3 controller for ARM-based SoCs.
451 Board config to use DDR1. It can be enabled for SoCs with
452 Freescale DDR1 or DDR2 controllers, depending on the board
456 Board config to use DDR2. It can be enabled for SoCs with
457 Freescale DDR2 or DDR3 controllers, depending on the board
461 Board config to use DDR3. It can be enabled for SoCs with
462 Freescale DDR3 or DDR3L controllers.
465 Board config to use DDR3L. It can be enabled for SoCs with
468 CONFIG_SYS_FSL_IFC_BE
469 Defines the IFC controller register space as Big Endian
471 CONFIG_SYS_FSL_IFC_LE
472 Defines the IFC controller register space as Little Endian
474 CONFIG_SYS_FSL_IFC_CLK_DIV
475 Defines divider of platform clock(clock input to IFC controller).
477 CONFIG_SYS_FSL_LBC_CLK_DIV
478 Defines divider of platform clock(clock input to eLBC controller).
480 CONFIG_SYS_FSL_DDR_BE
481 Defines the DDR controller register space as Big Endian
483 CONFIG_SYS_FSL_DDR_LE
484 Defines the DDR controller register space as Little Endian
486 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
487 Physical address from the view of DDR controllers. It is the
488 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
489 it could be different for ARM SoCs.
491 CONFIG_SYS_FSL_DDR_INTLV_256B
492 DDR controller interleaving on 256-byte. This is a special
493 interleaving mode, handled by Dickens for Freescale layerscape
496 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
497 Number of controllers used as main memory.
499 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
500 Number of controllers used for other than main memory.
502 CONFIG_SYS_FSL_HAS_DP_DDR
503 Defines the SoC has DP-DDR used for DPAA.
505 CONFIG_SYS_FSL_SEC_BE
506 Defines the SEC controller register space as Big Endian
508 CONFIG_SYS_FSL_SEC_LE
509 Defines the SEC controller register space as Little Endian
512 CONFIG_SYS_INIT_SP_OFFSET
514 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
515 pointer. This is needed for the temporary stack before
518 CONFIG_XWAY_SWAP_BYTES
520 Enable compilation of tools/xway-swap-bytes needed for Lantiq
521 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
522 be swapped if a flash programmer is used.
525 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
527 Select high exception vectors of the ARM core, e.g., do not
528 clear the V bit of the c1 register of CP15.
531 Generic timer clock source frequency.
533 COUNTER_FREQUENCY_REAL
534 Generic timer clock source frequency if the real clock is
535 different from COUNTER_FREQUENCY, and can only be determined
539 CONFIG_TEGRA_SUPPORT_NON_SECURE
541 Support executing U-Boot in non-secure (NS) mode. Certain
542 impossible actions will be skipped if the CPU is in NS mode,
543 such as ARM architectural timer initialization.
545 - Linux Kernel Interface:
546 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
548 When transferring memsize parameter to Linux, some versions
549 expect it to be in bytes, others in MB.
550 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
554 New kernel versions are expecting firmware settings to be
555 passed using flattened device trees (based on open firmware
559 * New libfdt-based support
560 * Adds the "fdt" command
561 * The bootm command automatically updates the fdt
563 OF_TBCLK - The timebase frequency.
565 boards with QUICC Engines require OF_QE to set UCC MAC
568 CONFIG_OF_SYSTEM_SETUP
570 Other code has addition modification that it wants to make
571 to the flat device tree before handing it off to the kernel.
572 This causes ft_system_setup() to be called before booting
577 U-Boot can detect if an IDE device is present or not.
578 If not, and this new config option is activated, U-Boot
579 removes the ATA node from the DTS before booting Linux,
580 so the Linux IDE driver does not probe the device and
581 crash. This is needed for buggy hardware (uc101) where
582 no pull down resistor is connected to the signal IDE5V_DD7.
584 - vxWorks boot parameters:
586 bootvx constructs a valid bootline using the following
587 environments variables: bootdev, bootfile, ipaddr, netmask,
588 serverip, gatewayip, hostname, othbootargs.
589 It loads the vxWorks image pointed bootfile.
591 Note: If a "bootargs" environment is defined, it will override
592 the defaults discussed just above.
594 - Cache Configuration for ARM:
595 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
597 CONFIG_SYS_PL310_BASE - Physical base address of PL310
598 controller register space
603 If you have Amba PrimeCell PL011 UARTs, set this variable to
604 the clock speed of the UARTs.
608 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
609 define this to a list of base addresses for each (supported)
610 port. See e.g. include/configs/versatile.h
612 CONFIG_SERIAL_HW_FLOW_CONTROL
614 Define this variable to enable hw flow control in serial driver.
615 Current user of this option is drivers/serial/nsl16550.c driver
617 - Serial Download Echo Mode:
619 If defined to 1, all characters received during a
620 serial download (using the "loads" command) are
621 echoed back. This might be needed by some terminal
622 emulations (like "cu"), but may as well just take
623 time on others. This setting #define's the initial
624 value of the "loads_echo" environment variable.
626 - Removal of commands
627 If no commands are needed to boot, you can disable
628 CONFIG_CMDLINE to remove them. In this case, the command line
629 will not be available, and when U-Boot wants to execute the
630 boot command (on start-up) it will call board_run_command()
631 instead. This can reduce image size significantly for very
632 simple boot procedures.
634 - Regular expression support:
636 If this variable is defined, U-Boot is linked against
637 the SLRE (Super Light Regular Expression) library,
638 which adds regex support to some commands, as for
639 example "env grep" and "setexpr".
642 CONFIG_SYS_WATCHDOG_FREQ
643 Some platforms automatically call WATCHDOG_RESET()
644 from the timer interrupt handler every
645 CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
646 board configuration file, a default of CONFIG_SYS_HZ/2
647 (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
648 to 0 disables calling WATCHDOG_RESET() from the timer
653 When CONFIG_CMD_DATE is selected, the type of the RTC
654 has to be selected, too. Define exactly one of the
657 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
658 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
659 CONFIG_RTC_MC146818 - use MC146818 RTC
660 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
661 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
662 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
663 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
664 CONFIG_RTC_DS164x - use Dallas DS164x RTC
665 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
666 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
667 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
668 CONFIG_SYS_RV3029_TCR - enable trickle charger on
671 Note that if the RTC uses I2C, then the I2C interface
672 must also be configured. See I2C Support, below.
675 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
677 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
678 chip-ngpio pairs that tell the PCA953X driver the number of
679 pins supported by a particular chip.
681 Note that if the GPIO device uses I2C, then the I2C interface
682 must also be configured. See I2C Support, below.
685 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
686 accesses and can checksum them or write a list of them out
687 to memory. See the 'iotrace' command for details. This is
688 useful for testing device drivers since it can confirm that
689 the driver behaves the same way before and after a code
690 change. Currently this is supported on sandbox and arm. To
691 add support for your architecture, add '#include <iotrace.h>'
692 to the bottom of arch/<arch>/include/asm/io.h and test.
694 Example output from the 'iotrace stats' command is below.
695 Note that if the trace buffer is exhausted, the checksum will
696 still continue to operate.
699 Start: 10000000 (buffer start address)
700 Size: 00010000 (buffer size)
701 Offset: 00000120 (current buffer offset)
702 Output: 10000120 (start + offset)
703 Count: 00000018 (number of trace records)
704 CRC32: 9526fb66 (CRC32 of all trace records)
708 When CONFIG_TIMESTAMP is selected, the timestamp
709 (date and time) of an image is printed by image
710 commands like bootm or iminfo. This option is
711 automatically enabled when you select CONFIG_CMD_DATE .
713 - Partition Labels (disklabels) Supported:
714 Zero or more of the following:
715 CONFIG_MAC_PARTITION Apple's MacOS partition table.
716 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
717 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
718 bootloader. Note 2TB partition limit; see
720 CONFIG_SCSI) you must configure support for at
721 least one non-MTD partition type as well.
724 CONFIG_IDE_RESET - is this is defined, IDE Reset will
725 be performed by calling the function
726 ide_set_reset(int reset)
727 which has to be defined in a board specific file
732 Set this to enable ATAPI support.
737 Set this to enable support for disks larger than 137GB
738 Also look at CONFIG_SYS_64BIT_LBA.
739 Whithout these , LBA48 support uses 32bit variables and will 'only'
740 support disks up to 2.1TB.
742 CONFIG_SYS_64BIT_LBA:
743 When enabled, makes the IDE subsystem use 64bit sector addresses.
747 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
748 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
749 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
750 maximum numbers of LUNs, SCSI ID's and target
753 The environment variable 'scsidevs' is set to the number of
754 SCSI devices found during the last scan.
756 - NETWORK Support (PCI):
758 Utility code for direct access to the SPI bus on Intel 8257x.
759 This does not do anything useful unless you set at least one
760 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
763 Support for National dp83815 chips.
766 Support for National dp8382[01] gigabit chips.
768 - NETWORK Support (other):
770 Support for the Calxeda XGMAC device
773 Support for SMSC's LAN91C96 chips.
775 CONFIG_LAN91C96_USE_32_BIT
776 Define this to enable 32 bit addressing
779 Support for SMSC's LAN91C111 chip
782 Define this to hold the physical address
783 of the device (I/O space)
785 CONFIG_SMC_USE_32_BIT
786 Define this if data bus is 32 bits
788 CONFIG_SMC_USE_IOFUNCS
789 Define this to use i/o functions instead of macros
790 (some hardware wont work with macros)
792 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
793 Define this if you have more then 3 PHYs.
796 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
798 CONFIG_FTGMAC100_EGIGA
799 Define this to use GE link update with gigabit PHY.
800 Define this if FTGMAC100 is connected to gigabit PHY.
801 If your system has 10/100 PHY only, it might not occur
802 wrong behavior. Because PHY usually return timeout or
803 useless data when polling gigabit status and gigabit
804 control registers. This behavior won't affect the
805 correctnessof 10/100 link speed update.
808 Support for Renesas on-chip Ethernet controller
810 CONFIG_SH_ETHER_USE_PORT
811 Define the number of ports to be used
813 CONFIG_SH_ETHER_PHY_ADDR
814 Define the ETH PHY's address
816 CONFIG_SH_ETHER_CACHE_WRITEBACK
817 If this option is set, the driver enables cache flush.
823 CONFIG_TPM_TIS_INFINEON
824 Support for Infineon i2c bus TPM devices. Only one device
825 per system is supported at this time.
827 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
828 Define the burst count bytes upper limit
831 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
833 CONFIG_TPM_ST33ZP24_I2C
834 Support for STMicroelectronics ST33ZP24 I2C devices.
835 Requires TPM_ST33ZP24 and I2C.
837 CONFIG_TPM_ST33ZP24_SPI
838 Support for STMicroelectronics ST33ZP24 SPI devices.
839 Requires TPM_ST33ZP24 and SPI.
842 Support for Atmel TWI TPM device. Requires I2C support.
845 Support for generic parallel port TPM devices. Only one device
846 per system is supported at this time.
848 CONFIG_TPM_TIS_BASE_ADDRESS
849 Base address where the generic TPM device is mapped
850 to. Contemporary x86 systems usually map it at
854 Define this to enable the TPM support library which provides
855 functional interfaces to some TPM commands.
856 Requires support for a TPM device.
858 CONFIG_TPM_AUTH_SESSIONS
859 Define this to enable authorized functions in the TPM library.
860 Requires CONFIG_TPM and CONFIG_SHA1.
863 At the moment only the UHCI host controller is
864 supported (PIP405, MIP405); define
865 CONFIG_USB_UHCI to enable it.
866 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
867 and define CONFIG_USB_STORAGE to enable the USB
870 Supported are USB Keyboards and USB Floppy drives
873 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
874 txfilltuning field in the EHCI controller on reset.
876 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
880 Define the below if you wish to use the USB console.
881 Once firmware is rebuilt from a serial console issue the
882 command "setenv stdin usbtty; setenv stdout usbtty" and
883 attach your USB cable. The Unix command "dmesg" should print
884 it has found a new device. The environment variable usbtty
885 can be set to gserial or cdc_acm to enable your device to
886 appear to a USB host as a Linux gserial device or a
887 Common Device Class Abstract Control Model serial device.
888 If you select usbtty = gserial you should be able to enumerate
890 # modprobe usbserial vendor=0xVendorID product=0xProductID
891 else if using cdc_acm, simply setting the environment
892 variable usbtty to be cdc_acm should suffice. The following
893 might be defined in YourBoardName.h
896 Define this to build a UDC device
899 Define this to have a tty type of device available to
900 talk to the UDC device
903 Define this to enable the high speed support for usb
904 device and usbtty. If this feature is enabled, a routine
905 int is_usbd_high_speed(void)
906 also needs to be defined by the driver to dynamically poll
907 whether the enumeration has succeded at high speed or full
910 If you have a USB-IF assigned VendorID then you may wish to
911 define your own vendor specific values either in BoardName.h
912 or directly in usbd_vendor_info.h. If you don't define
913 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
914 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
915 should pretend to be a Linux device to it's target host.
917 CONFIG_USBD_MANUFACTURER
918 Define this string as the name of your company for
919 - CONFIG_USBD_MANUFACTURER "my company"
921 CONFIG_USBD_PRODUCT_NAME
922 Define this string as the name of your product
923 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
926 Define this as your assigned Vendor ID from the USB
927 Implementors Forum. This *must* be a genuine Vendor ID
928 to avoid polluting the USB namespace.
929 - CONFIG_USBD_VENDORID 0xFFFF
931 CONFIG_USBD_PRODUCTID
932 Define this as the unique Product ID
934 - CONFIG_USBD_PRODUCTID 0xFFFF
936 - ULPI Layer Support:
937 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
938 the generic ULPI layer. The generic layer accesses the ULPI PHY
939 via the platform viewport, so you need both the genric layer and
940 the viewport enabled. Currently only Chipidea/ARC based
941 viewport is supported.
942 To enable the ULPI layer support, define CONFIG_USB_ULPI and
943 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
944 If your ULPI phy needs a different reference clock than the
945 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
946 the appropriate value in Hz.
949 The MMC controller on the Intel PXA is supported. To
950 enable this define CONFIG_MMC. The MMC can be
951 accessed from the boot prompt by mapping the device
952 to physical memory similar to flash. Command line is
953 enabled with CONFIG_CMD_MMC. The MMC driver also works with
954 the FAT fs. This is enabled with CONFIG_CMD_FAT.
957 Support for Renesas on-chip MMCIF controller
960 Define the base address of MMCIF registers
963 Define the clock frequency for MMCIF
965 - USB Device Firmware Update (DFU) class support:
967 This enables the USB portion of the DFU USB class
970 This enables support for exposing NAND devices via DFU.
973 This enables support for exposing RAM via DFU.
974 Note: DFU spec refer to non-volatile memory usage, but
975 allow usages beyond the scope of spec - here RAM usage,
976 one that would help mostly the developer.
978 CONFIG_SYS_DFU_DATA_BUF_SIZE
979 Dfu transfer uses a buffer before writing data to the
980 raw storage device. Make the size (in bytes) of this buffer
981 configurable. The size of this buffer is also configurable
982 through the "dfu_bufsiz" environment variable.
984 CONFIG_SYS_DFU_MAX_FILE_SIZE
985 When updating files rather than the raw storage device,
986 we use a static buffer to copy the file into and then write
987 the buffer once we've been given the whole file. Define
988 this to the maximum filesize (in bytes) for the buffer.
989 Default is 4 MiB if undefined.
991 DFU_DEFAULT_POLL_TIMEOUT
992 Poll timeout [ms], is the timeout a device can send to the
993 host. The host must wait for this timeout before sending
994 a subsequent DFU_GET_STATUS request to the device.
996 DFU_MANIFEST_POLL_TIMEOUT
997 Poll timeout [ms], which the device sends to the host when
998 entering dfuMANIFEST state. Host waits this timeout, before
999 sending again an USB request to the device.
1001 - Journaling Flash filesystem support:
1002 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1003 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1004 Define these for a default partition on a NOR device
1007 See Kconfig help for available keyboard drivers.
1011 Enable the Freescale DIU video driver. Reference boards for
1012 SOCs that have a DIU should define this macro to enable DIU
1013 support, and should also define these other macros:
1018 CONFIG_VIDEO_SW_CURSOR
1019 CONFIG_VGA_AS_SINGLE_DEVICE
1020 CONFIG_VIDEO_BMP_LOGO
1022 The DIU driver will look for the 'video-mode' environment
1023 variable, and if defined, enable the DIU as a console during
1024 boot. See the documentation file doc/README.video for a
1025 description of this variable.
1027 - LCD Support: CONFIG_LCD
1029 Define this to enable LCD support (for output to LCD
1030 display); also select one of the supported displays
1031 by defining one of these:
1035 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1037 CONFIG_NEC_NL6448AC33:
1039 NEC NL6448AC33-18. Active, color, single scan.
1041 CONFIG_NEC_NL6448BC20
1043 NEC NL6448BC20-08. 6.5", 640x480.
1044 Active, color, single scan.
1046 CONFIG_NEC_NL6448BC33_54
1048 NEC NL6448BC33-54. 10.4", 640x480.
1049 Active, color, single scan.
1053 Sharp 320x240. Active, color, single scan.
1054 It isn't 16x9, and I am not sure what it is.
1056 CONFIG_SHARP_LQ64D341
1058 Sharp LQ64D341 display, 640x480.
1059 Active, color, single scan.
1063 HLD1045 display, 640x480.
1064 Active, color, single scan.
1068 Optrex CBL50840-2 NF-FW 99 22 M5
1070 Hitachi LMG6912RPFC-00T
1074 320x240. Black & white.
1076 CONFIG_LCD_ALIGNMENT
1078 Normally the LCD is page-aligned (typically 4KB). If this is
1079 defined then the LCD will be aligned to this value instead.
1080 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1081 here, since it is cheaper to change data cache settings on
1082 a per-section basis.
1087 Sometimes, for example if the display is mounted in portrait
1088 mode or even if it's mounted landscape but rotated by 180degree,
1089 we need to rotate our content of the display relative to the
1090 framebuffer, so that user can read the messages which are
1092 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1093 initialized with a given rotation from "vl_rot" out of
1094 "vidinfo_t" which is provided by the board specific code.
1095 The value for vl_rot is coded as following (matching to
1096 fbcon=rotate:<n> linux-kernel commandline):
1097 0 = no rotation respectively 0 degree
1098 1 = 90 degree rotation
1099 2 = 180 degree rotation
1100 3 = 270 degree rotation
1102 If CONFIG_LCD_ROTATION is not defined, the console will be
1103 initialized with 0degree rotation.
1107 Support drawing of RLE8-compressed bitmaps on the LCD.
1110 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1112 The clock frequency of the MII bus
1114 CONFIG_PHY_RESET_DELAY
1116 Some PHY like Intel LXT971A need extra delay after
1117 reset before any MII register access is possible.
1118 For such PHY, set this option to the usec delay
1119 required. (minimum 300usec for LXT971A)
1121 CONFIG_PHY_CMD_DELAY (ppc4xx)
1123 Some PHY like Intel LXT971A need extra delay after
1124 command issued before MII status register can be read
1129 Define a default value for the IP address to use for
1130 the default Ethernet interface, in case this is not
1131 determined through e.g. bootp.
1132 (Environment variable "ipaddr")
1134 - Server IP address:
1137 Defines a default value for the IP address of a TFTP
1138 server to contact when using the "tftboot" command.
1139 (Environment variable "serverip")
1141 - Gateway IP address:
1144 Defines a default value for the IP address of the
1145 default router where packets to other networks are
1147 (Environment variable "gatewayip")
1152 Defines a default value for the subnet mask (or
1153 routing prefix) which is used to determine if an IP
1154 address belongs to the local subnet or needs to be
1155 forwarded through a router.
1156 (Environment variable "netmask")
1158 - BOOTP Recovery Mode:
1159 CONFIG_BOOTP_RANDOM_DELAY
1161 If you have many targets in a network that try to
1162 boot using BOOTP, you may want to avoid that all
1163 systems send out BOOTP requests at precisely the same
1164 moment (which would happen for instance at recovery
1165 from a power failure, when all systems will try to
1166 boot, thus flooding the BOOTP server. Defining
1167 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1168 inserted before sending out BOOTP requests. The
1169 following delays are inserted then:
1171 1st BOOTP request: delay 0 ... 1 sec
1172 2nd BOOTP request: delay 0 ... 2 sec
1173 3rd BOOTP request: delay 0 ... 4 sec
1175 BOOTP requests: delay 0 ... 8 sec
1177 CONFIG_BOOTP_ID_CACHE_SIZE
1179 BOOTP packets are uniquely identified using a 32-bit ID. The
1180 server will copy the ID from client requests to responses and
1181 U-Boot will use this to determine if it is the destination of
1182 an incoming response. Some servers will check that addresses
1183 aren't in use before handing them out (usually using an ARP
1184 ping) and therefore take up to a few hundred milliseconds to
1185 respond. Network congestion may also influence the time it
1186 takes for a response to make it back to the client. If that
1187 time is too long, U-Boot will retransmit requests. In order
1188 to allow earlier responses to still be accepted after these
1189 retransmissions, U-Boot's BOOTP client keeps a small cache of
1190 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1191 cache. The default is to keep IDs for up to four outstanding
1192 requests. Increasing this will allow U-Boot to accept offers
1193 from a BOOTP client in networks with unusually high latency.
1195 - DHCP Advanced Options:
1196 You can fine tune the DHCP functionality by defining
1197 CONFIG_BOOTP_* symbols:
1199 CONFIG_BOOTP_NISDOMAIN
1200 CONFIG_BOOTP_BOOTFILESIZE
1201 CONFIG_BOOTP_NTPSERVER
1202 CONFIG_BOOTP_TIMEOFFSET
1203 CONFIG_BOOTP_VENDOREX
1204 CONFIG_BOOTP_MAY_FAIL
1206 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1207 after the configured retry count, the call will fail
1208 instead of starting over. This can be used to fail over
1209 to Link-local IP address configuration if the DHCP server
1212 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1214 A 32bit value in microseconds for a delay between
1215 receiving a "DHCP Offer" and sending the "DHCP Request".
1216 This fixes a problem with certain DHCP servers that don't
1217 respond 100% of the time to a "DHCP request". E.g. On an
1218 AT91RM9200 processor running at 180MHz, this delay needed
1219 to be *at least* 15,000 usec before a Windows Server 2003
1220 DHCP server would reply 100% of the time. I recommend at
1221 least 50,000 usec to be safe. The alternative is to hope
1222 that one of the retries will be successful but note that
1223 the DHCP timeout and retry process takes a longer than
1226 - Link-local IP address negotiation:
1227 Negotiate with other link-local clients on the local network
1228 for an address that doesn't require explicit configuration.
1229 This is especially useful if a DHCP server cannot be guaranteed
1230 to exist in all environments that the device must operate.
1232 See doc/README.link-local for more information.
1234 - MAC address from environment variables
1236 FDT_SEQ_MACADDR_FROM_ENV
1238 Fix-up device tree with MAC addresses fetched sequentially from
1239 environment variables. This config work on assumption that
1240 non-usable ethernet node of device-tree are either not present
1241 or their status has been marked as "disabled".
1244 CONFIG_CDP_DEVICE_ID
1246 The device id used in CDP trigger frames.
1248 CONFIG_CDP_DEVICE_ID_PREFIX
1250 A two character string which is prefixed to the MAC address
1255 A printf format string which contains the ascii name of
1256 the port. Normally is set to "eth%d" which sets
1257 eth0 for the first Ethernet, eth1 for the second etc.
1259 CONFIG_CDP_CAPABILITIES
1261 A 32bit integer which indicates the device capabilities;
1262 0x00000010 for a normal host which does not forwards.
1266 An ascii string containing the version of the software.
1270 An ascii string containing the name of the platform.
1274 A 32bit integer sent on the trigger.
1276 CONFIG_CDP_POWER_CONSUMPTION
1278 A 16bit integer containing the power consumption of the
1279 device in .1 of milliwatts.
1281 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1283 A byte containing the id of the VLAN.
1285 - Status LED: CONFIG_LED_STATUS
1287 Several configurations allow to display the current
1288 status using a LED. For instance, the LED will blink
1289 fast while running U-Boot code, stop blinking as
1290 soon as a reply to a BOOTP request was received, and
1291 start blinking slow once the Linux kernel is running
1292 (supported by a status LED driver in the Linux
1293 kernel). Defining CONFIG_LED_STATUS enables this
1298 CONFIG_LED_STATUS_GPIO
1299 The status LED can be connected to a GPIO pin.
1300 In such cases, the gpio_led driver can be used as a
1301 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1302 to include the gpio_led driver in the U-Boot binary.
1304 CONFIG_GPIO_LED_INVERTED_TABLE
1305 Some GPIO connected LEDs may have inverted polarity in which
1306 case the GPIO high value corresponds to LED off state and
1307 GPIO low value corresponds to LED on state.
1308 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1309 with a list of GPIO LEDs that have inverted polarity.
1312 CONFIG_SYS_NUM_I2C_BUSES
1313 Hold the number of i2c buses you want to use.
1315 CONFIG_SYS_I2C_DIRECT_BUS
1316 define this, if you don't use i2c muxes on your hardware.
1317 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1320 CONFIG_SYS_I2C_MAX_HOPS
1321 define how many muxes are maximal consecutively connected
1322 on one i2c bus. If you not use i2c muxes, omit this
1325 CONFIG_SYS_I2C_BUSES
1326 hold a list of buses you want to use, only used if
1327 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1328 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1329 CONFIG_SYS_NUM_I2C_BUSES = 9:
1331 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1332 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1333 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1334 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1335 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1336 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1337 {1, {I2C_NULL_HOP}}, \
1338 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1339 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1343 bus 0 on adapter 0 without a mux
1344 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1345 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1346 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1347 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1348 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
1349 bus 6 on adapter 1 without a mux
1350 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1351 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
1353 If you do not have i2c muxes on your board, omit this define.
1355 - Legacy I2C Support:
1356 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
1357 then the following macros need to be defined (examples are
1358 from include/configs/lwmon.h):
1362 (Optional). Any commands necessary to enable the I2C
1363 controller or configure ports.
1365 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
1369 The code necessary to make the I2C data line active
1370 (driven). If the data line is open collector, this
1373 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1377 The code necessary to make the I2C data line tri-stated
1378 (inactive). If the data line is open collector, this
1381 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1385 Code that returns true if the I2C data line is high,
1388 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1392 If <bit> is true, sets the I2C data line high. If it
1393 is false, it clears it (low).
1395 eg: #define I2C_SDA(bit) \
1396 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
1397 else immr->im_cpm.cp_pbdat &= ~PB_SDA
1401 If <bit> is true, sets the I2C clock line high. If it
1402 is false, it clears it (low).
1404 eg: #define I2C_SCL(bit) \
1405 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
1406 else immr->im_cpm.cp_pbdat &= ~PB_SCL
1410 This delay is invoked four times per clock cycle so this
1411 controls the rate of data transfer. The data rate thus
1412 is 1 / (I2C_DELAY * 4). Often defined to be something
1415 #define I2C_DELAY udelay(2)
1417 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1419 If your arch supports the generic GPIO framework (asm/gpio.h),
1420 then you may alternatively define the two GPIOs that are to be
1421 used as SCL / SDA. Any of the previous I2C_xxx macros will
1422 have GPIO-based defaults assigned to them as appropriate.
1424 You should define these to the GPIO value as given directly to
1425 the generic GPIO functions.
1427 CONFIG_SYS_I2C_INIT_BOARD
1429 When a board is reset during an i2c bus transfer
1430 chips might think that the current transfer is still
1431 in progress. On some boards it is possible to access
1432 the i2c SCLK line directly, either by using the
1433 processor pin as a GPIO or by having a second pin
1434 connected to the bus. If this option is defined a
1435 custom i2c_init_board() routine in boards/xxx/board.c
1436 is run early in the boot sequence.
1438 CONFIG_I2C_MULTI_BUS
1440 This option allows the use of multiple I2C buses, each of which
1441 must have a controller. At any point in time, only one bus is
1442 active. To switch to a different bus, use the 'i2c dev' command.
1443 Note that bus numbering is zero-based.
1445 CONFIG_SYS_I2C_NOPROBES
1447 This option specifies a list of I2C devices that will be skipped
1448 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1449 is set, specify a list of bus-device pairs. Otherwise, specify
1450 a 1D array of device addresses
1453 #undef CONFIG_I2C_MULTI_BUS
1454 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1456 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1458 #define CONFIG_I2C_MULTI_BUS
1459 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1461 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1463 CONFIG_SYS_SPD_BUS_NUM
1465 If defined, then this indicates the I2C bus number for DDR SPD.
1466 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1468 CONFIG_SYS_RTC_BUS_NUM
1470 If defined, then this indicates the I2C bus number for the RTC.
1471 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1473 CONFIG_SOFT_I2C_READ_REPEATED_START
1475 defining this will force the i2c_read() function in
1476 the soft_i2c driver to perform an I2C repeated start
1477 between writing the address pointer and reading the
1478 data. If this define is omitted the default behaviour
1479 of doing a stop-start sequence will be used. Most I2C
1480 devices can use either method, but some require one or
1483 - SPI Support: CONFIG_SPI
1485 Enables SPI driver (so far only tested with
1486 SPI EEPROM, also an instance works with Crystal A/D and
1487 D/As on the SACSng board)
1489 CONFIG_SYS_SPI_MXC_WAIT
1490 Timeout for waiting until spi transfer completed.
1491 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1493 - FPGA Support: CONFIG_FPGA
1495 Enables FPGA subsystem.
1497 CONFIG_FPGA_<vendor>
1499 Enables support for specific chip vendors.
1502 CONFIG_FPGA_<family>
1504 Enables support for FPGA family.
1505 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1509 Specify the number of FPGA devices to support.
1511 CONFIG_SYS_FPGA_PROG_FEEDBACK
1513 Enable printing of hash marks during FPGA configuration.
1515 CONFIG_SYS_FPGA_CHECK_BUSY
1517 Enable checks on FPGA configuration interface busy
1518 status by the configuration function. This option
1519 will require a board or device specific function to
1524 If defined, a function that provides delays in the FPGA
1525 configuration driver.
1527 CONFIG_SYS_FPGA_CHECK_CTRLC
1528 Allow Control-C to interrupt FPGA configuration
1530 CONFIG_SYS_FPGA_CHECK_ERROR
1532 Check for configuration errors during FPGA bitfile
1533 loading. For example, abort during Virtex II
1534 configuration if the INIT_B line goes low (which
1535 indicated a CRC error).
1537 CONFIG_SYS_FPGA_WAIT_INIT
1539 Maximum time to wait for the INIT_B line to de-assert
1540 after PROB_B has been de-asserted during a Virtex II
1541 FPGA configuration sequence. The default time is 500
1544 CONFIG_SYS_FPGA_WAIT_BUSY
1546 Maximum time to wait for BUSY to de-assert during
1547 Virtex II FPGA configuration. The default is 5 ms.
1549 CONFIG_SYS_FPGA_WAIT_CONFIG
1551 Time to wait after FPGA configuration. The default is
1554 - Vendor Parameter Protection:
1556 U-Boot considers the values of the environment
1557 variables "serial#" (Board Serial Number) and
1558 "ethaddr" (Ethernet Address) to be parameters that
1559 are set once by the board vendor / manufacturer, and
1560 protects these variables from casual modification by
1561 the user. Once set, these variables are read-only,
1562 and write or delete attempts are rejected. You can
1563 change this behaviour:
1565 If CONFIG_ENV_OVERWRITE is #defined in your config
1566 file, the write protection for vendor parameters is
1567 completely disabled. Anybody can change or delete
1570 Alternatively, if you define _both_ an ethaddr in the
1571 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1572 Ethernet address is installed in the environment,
1573 which can be changed exactly ONCE by the user. [The
1574 serial# is unaffected by this, i. e. it remains
1577 The same can be accomplished in a more flexible way
1578 for any variable by configuring the type of access
1579 to allow for those variables in the ".flags" variable
1580 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1585 Define this variable to enable the reservation of
1586 "protected RAM", i. e. RAM which is not overwritten
1587 by U-Boot. Define CONFIG_PRAM to hold the number of
1588 kB you want to reserve for pRAM. You can overwrite
1589 this default value by defining an environment
1590 variable "pram" to the number of kB you want to
1591 reserve. Note that the board info structure will
1592 still show the full amount of RAM. If pRAM is
1593 reserved, a new environment variable "mem" will
1594 automatically be defined to hold the amount of
1595 remaining RAM in a form that can be passed as boot
1596 argument to Linux, for instance like that:
1598 setenv bootargs ... mem=\${mem}
1601 This way you can tell Linux not to use this memory,
1602 either, which results in a memory region that will
1603 not be affected by reboots.
1605 *WARNING* If your board configuration uses automatic
1606 detection of the RAM size, you must make sure that
1607 this memory test is non-destructive. So far, the
1608 following board configurations are known to be
1611 IVMS8, IVML24, SPD8xx,
1612 HERMES, IP860, RPXlite, LWMON,
1616 CONFIG_NET_RETRY_COUNT
1618 This variable defines the number of retries for
1619 network operations like ARP, RARP, TFTP, or BOOTP
1620 before giving up the operation. If not defined, a
1621 default value of 5 is used.
1625 Timeout waiting for an ARP reply in milliseconds.
1629 Timeout in milliseconds used in NFS protocol.
1630 If you encounter "ERROR: Cannot umount" in nfs command,
1631 try longer timeout such as
1632 #define CONFIG_NFS_TIMEOUT 10000UL
1636 In the current implementation, the local variables
1637 space and global environment variables space are
1638 separated. Local variables are those you define by
1639 simply typing `name=value'. To access a local
1640 variable later on, you have write `$name' or
1641 `${name}'; to execute the contents of a variable
1642 directly type `$name' at the command prompt.
1644 Global environment variables are those you use
1645 setenv/printenv to work with. To run a command stored
1646 in such a variable, you need to use the run command,
1647 and you must not use the '$' sign to access them.
1649 To store commands and special characters in a
1650 variable, please use double quotation marks
1651 surrounding the whole text of the variable, instead
1652 of the backslashes before semicolons and special
1655 - Command Line Editing and History:
1656 CONFIG_CMDLINE_PS_SUPPORT
1658 Enable support for changing the command prompt string
1659 at run-time. Only static string is supported so far.
1660 The string is obtained from environment variables PS1
1663 - Default Environment:
1664 CONFIG_EXTRA_ENV_SETTINGS
1666 Define this to contain any number of null terminated
1667 strings (variable = value pairs) that will be part of
1668 the default environment compiled into the boot image.
1670 For example, place something like this in your
1671 board's config file:
1673 #define CONFIG_EXTRA_ENV_SETTINGS \
1677 Warning: This method is based on knowledge about the
1678 internal format how the environment is stored by the
1679 U-Boot code. This is NOT an official, exported
1680 interface! Although it is unlikely that this format
1681 will change soon, there is no guarantee either.
1682 You better know what you are doing here.
1684 Note: overly (ab)use of the default environment is
1685 discouraged. Make sure to check other ways to preset
1686 the environment like the "source" command or the
1689 CONFIG_DELAY_ENVIRONMENT
1691 Normally the environment is loaded when the board is
1692 initialised so that it is available to U-Boot. This inhibits
1693 that so that the environment is not available until
1694 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1695 this is instead controlled by the value of
1696 /config/load-environment.
1698 - TFTP Fixed UDP Port:
1701 If this is defined, the environment variable tftpsrcp
1702 is used to supply the TFTP UDP source port value.
1703 If tftpsrcp isn't defined, the normal pseudo-random port
1704 number generator is used.
1706 Also, the environment variable tftpdstp is used to supply
1707 the TFTP UDP destination port value. If tftpdstp isn't
1708 defined, the normal port 69 is used.
1710 The purpose for tftpsrcp is to allow a TFTP server to
1711 blindly start the TFTP transfer using the pre-configured
1712 target IP address and UDP port. This has the effect of
1713 "punching through" the (Windows XP) firewall, allowing
1714 the remainder of the TFTP transfer to proceed normally.
1715 A better solution is to properly configure the firewall,
1716 but sometimes that is not allowed.
1718 CONFIG_STANDALONE_LOAD_ADDR
1720 This option defines a board specific value for the
1721 address where standalone program gets loaded, thus
1722 overwriting the architecture dependent default
1725 - Frame Buffer Address:
1728 Define CONFIG_FB_ADDR if you want to use specific
1729 address for frame buffer. This is typically the case
1730 when using a graphics controller has separate video
1731 memory. U-Boot will then place the frame buffer at
1732 the given address instead of dynamically reserving it
1733 in system RAM by calling lcd_setmem(), which grabs
1734 the memory for the frame buffer depending on the
1735 configured panel size.
1737 Please see board_init_f function.
1739 - Automatic software updates via TFTP server
1741 CONFIG_UPDATE_TFTP_CNT_MAX
1742 CONFIG_UPDATE_TFTP_MSEC_MAX
1744 These options enable and control the auto-update feature;
1745 for a more detailed description refer to doc/README.update.
1747 - MTD Support (mtdparts command, UBI support)
1748 CONFIG_MTD_UBI_WL_THRESHOLD
1749 This parameter defines the maximum difference between the highest
1750 erase counter value and the lowest erase counter value of eraseblocks
1751 of UBI devices. When this threshold is exceeded, UBI starts performing
1752 wear leveling by means of moving data from eraseblock with low erase
1753 counter to eraseblocks with high erase counter.
1755 The default value should be OK for SLC NAND flashes, NOR flashes and
1756 other flashes which have eraseblock life-cycle 100000 or more.
1757 However, in case of MLC NAND flashes which typically have eraseblock
1758 life-cycle less than 10000, the threshold should be lessened (e.g.,
1759 to 128 or 256, although it does not have to be power of 2).
1763 CONFIG_MTD_UBI_BEB_LIMIT
1764 This option specifies the maximum bad physical eraseblocks UBI
1765 expects on the MTD device (per 1024 eraseblocks). If the
1766 underlying flash does not admit of bad eraseblocks (e.g. NOR
1767 flash), this value is ignored.
1769 NAND datasheets often specify the minimum and maximum NVM
1770 (Number of Valid Blocks) for the flashes' endurance lifetime.
1771 The maximum expected bad eraseblocks per 1024 eraseblocks
1772 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1773 which gives 20 for most NANDs (MaxNVB is basically the total
1774 count of eraseblocks on the chip).
1776 To put it differently, if this value is 20, UBI will try to
1777 reserve about 1.9% of physical eraseblocks for bad blocks
1778 handling. And that will be 1.9% of eraseblocks on the entire
1779 NAND chip, not just the MTD partition UBI attaches. This means
1780 that if you have, say, a NAND flash chip admits maximum 40 bad
1781 eraseblocks, and it is split on two MTD partitions of the same
1782 size, UBI will reserve 40 eraseblocks when attaching a
1787 CONFIG_MTD_UBI_FASTMAP
1788 Fastmap is a mechanism which allows attaching an UBI device
1789 in nearly constant time. Instead of scanning the whole MTD device it
1790 only has to locate a checkpoint (called fastmap) on the device.
1791 The on-flash fastmap contains all information needed to attach
1792 the device. Using fastmap makes only sense on large devices where
1793 attaching by scanning takes long. UBI will not automatically install
1794 a fastmap on old images, but you can set the UBI parameter
1795 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1796 that fastmap-enabled images are still usable with UBI implementations
1797 without fastmap support. On typical flash devices the whole fastmap
1798 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1800 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1801 Set this parameter to enable fastmap automatically on images
1805 CONFIG_MTD_UBI_FM_DEBUG
1806 Enable UBI fastmap debug
1811 Enable building of SPL globally.
1813 CONFIG_SPL_MAX_FOOTPRINT
1814 Maximum size in memory allocated to the SPL, BSS included.
1815 When defined, the linker checks that the actual memory
1816 used by SPL from _start to __bss_end does not exceed it.
1817 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
1818 must not be both defined at the same time.
1821 Maximum size of the SPL image (text, data, rodata, and
1822 linker lists sections), BSS excluded.
1823 When defined, the linker checks that the actual size does
1826 CONFIG_SPL_RELOC_TEXT_BASE
1827 Address to relocate to. If unspecified, this is equal to
1828 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
1830 CONFIG_SPL_BSS_START_ADDR
1831 Link address for the BSS within the SPL binary.
1833 CONFIG_SPL_BSS_MAX_SIZE
1834 Maximum size in memory allocated to the SPL BSS.
1835 When defined, the linker checks that the actual memory used
1836 by SPL from __bss_start to __bss_end does not exceed it.
1837 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
1838 must not be both defined at the same time.
1841 Adress of the start of the stack SPL will use
1843 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1844 When defined, SPL will panic() if the image it has
1845 loaded does not have a signature.
1846 Defining this is useful when code which loads images
1847 in SPL cannot guarantee that absolutely all read errors
1849 An example is the LPC32XX MLC NAND driver, which will
1850 consider that a completely unreadable NAND block is bad,
1851 and thus should be skipped silently.
1853 CONFIG_SPL_RELOC_STACK
1854 Adress of the start of the stack SPL will use after
1855 relocation. If unspecified, this is equal to
1858 CONFIG_SYS_SPL_MALLOC_START
1859 Starting address of the malloc pool used in SPL.
1860 When this option is set the full malloc is used in SPL and
1861 it is set up by spl_init() and before that, the simple malloc()
1862 can be used if CONFIG_SYS_MALLOC_F is defined.
1864 CONFIG_SYS_SPL_MALLOC_SIZE
1865 The size of the malloc pool used in SPL.
1867 CONFIG_SPL_DISPLAY_PRINT
1868 For ARM, enable an optional function to print more information
1869 about the running system.
1871 CONFIG_SPL_INIT_MINIMAL
1872 Arch init code should be built for a very small image
1874 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
1875 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
1876 Sector and number of sectors to load kernel argument
1877 parameters from when MMC is being used in raw mode
1880 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
1881 Filename to read to load U-Boot when reading from filesystem
1883 CONFIG_SPL_FS_LOAD_KERNEL_NAME
1884 Filename to read to load kernel uImage when reading
1885 from filesystem (for Falcon mode)
1887 CONFIG_SPL_FS_LOAD_ARGS_NAME
1888 Filename to read to load kernel argument parameters
1889 when reading from filesystem (for Falcon mode)
1891 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
1892 Set this for NAND SPL on PPC mpc83xx targets, so that
1893 start.S waits for the rest of the SPL to load before
1894 continuing (the hardware starts execution after just
1895 loading the first page rather than the full 4K).
1897 CONFIG_SPL_SKIP_RELOCATE
1898 Avoid SPL relocation
1900 CONFIG_SPL_NAND_IDENT
1901 SPL uses the chip ID list to identify the NAND flash.
1902 Requires CONFIG_SPL_NAND_BASE.
1905 Support for a lightweight UBI (fastmap) scanner and
1908 CONFIG_SPL_NAND_RAW_ONLY
1909 Support to boot only raw u-boot.bin images. Use this only
1910 if you need to save space.
1912 CONFIG_SPL_COMMON_INIT_DDR
1913 Set for common ddr init with serial presence detect in
1916 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
1917 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
1918 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
1919 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
1920 CONFIG_SYS_NAND_ECCBYTES
1921 Defines the size and behavior of the NAND that SPL uses
1924 CONFIG_SYS_NAND_U_BOOT_DST
1925 Location in memory to load U-Boot to
1927 CONFIG_SYS_NAND_U_BOOT_SIZE
1928 Size of image to load
1930 CONFIG_SYS_NAND_U_BOOT_START
1931 Entry point in loaded image to jump to
1933 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
1934 Define this if you need to first read the OOB and then the
1935 data. This is used, for example, on davinci platforms.
1937 CONFIG_SPL_RAM_DEVICE
1938 Support for running image already present in ram, in SPL binary
1941 Image offset to which the SPL should be padded before appending
1942 the SPL payload. By default, this is defined as
1943 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
1944 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
1945 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
1948 Final target image containing SPL and payload. Some SPLs
1949 use an arch-specific makefile fragment instead, for
1950 example if more than one image needs to be produced.
1952 CONFIG_SPL_FIT_PRINT
1953 Printing information about a FIT image adds quite a bit of
1954 code to SPL. So this is normally disabled in SPL. Use this
1955 option to re-enable it. This will affect the output of the
1956 bootm command when booting a FIT image.
1960 Enable building of TPL globally.
1963 Image offset to which the TPL should be padded before appending
1964 the TPL payload. By default, this is defined as
1965 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
1966 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
1967 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
1969 - Interrupt support (PPC):
1971 There are common interrupt_init() and timer_interrupt()
1972 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1973 for CPU specific initialization. interrupt_init_cpu()
1974 should set decrementer_count to appropriate value. If
1975 CPU resets decrementer automatically after interrupt
1976 (ppc4xx) it should set decrementer_count to zero.
1977 timer_interrupt() calls timer_interrupt_cpu() for CPU
1978 specific handling. If board has watchdog / status_led
1979 / other_activity_monitor it works automatically from
1980 general timer_interrupt().
1983 Board initialization settings:
1984 ------------------------------
1986 During Initialization u-boot calls a number of board specific functions
1987 to allow the preparation of board specific prerequisites, e.g. pin setup
1988 before drivers are initialized. To enable these callbacks the
1989 following configuration macros have to be defined. Currently this is
1990 architecture specific, so please check arch/your_architecture/lib/board.c
1991 typically in board_init_f() and board_init_r().
1993 - CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
1994 - CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
1995 - CONFIG_BOARD_LATE_INIT: Call board_late_init()
1996 - CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
1998 Configuration Settings:
1999 -----------------------
2001 - MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2002 Optionally it can be defined to support 64-bit memory commands.
2004 - CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2005 undefine this when you're short of memory.
2007 - CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2008 width of the commands listed in the 'help' command output.
2010 - CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
2011 prompt for user input.
2013 - CONFIG_SYS_CBSIZE: Buffer size for input from the Console
2015 - CONFIG_SYS_PBSIZE: Buffer size for Console output
2017 - CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
2019 - CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2020 the application (usually a Linux kernel) when it is
2023 - CONFIG_SYS_BAUDRATE_TABLE:
2024 List of legal baudrate settings for this board.
2026 - CONFIG_SYS_MEM_RESERVE_SECURE
2027 Only implemented for ARMv8 for now.
2028 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2029 is substracted from total RAM and won't be reported to OS.
2030 This memory can be used as secure memory. A variable
2031 gd->arch.secure_ram is used to track the location. In systems
2032 the RAM base is not zero, or RAM is divided into banks,
2033 this variable needs to be recalcuated to get the address.
2035 - CONFIG_SYS_MEM_TOP_HIDE:
2036 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2037 this specified memory area will get subtracted from the top
2038 (end) of RAM and won't get "touched" at all by U-Boot. By
2039 fixing up gd->ram_size the Linux kernel should gets passed
2040 the now "corrected" memory size and won't touch it either.
2041 This should work for arch/ppc and arch/powerpc. Only Linux
2042 board ports in arch/powerpc with bootwrapper support that
2043 recalculate the memory size from the SDRAM controller setup
2044 will have to get fixed in Linux additionally.
2046 This option can be used as a workaround for the 440EPx/GRx
2047 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2050 WARNING: Please make sure that this value is a multiple of
2051 the Linux page size (normally 4k). If this is not the case,
2052 then the end address of the Linux memory will be located at a
2053 non page size aligned address and this could cause major
2056 - CONFIG_SYS_LOADS_BAUD_CHANGE:
2057 Enable temporary baudrate change while serial download
2059 - CONFIG_SYS_SDRAM_BASE:
2060 Physical start address of SDRAM. _Must_ be 0 here.
2062 - CONFIG_SYS_FLASH_BASE:
2063 Physical start address of Flash memory.
2065 - CONFIG_SYS_MONITOR_BASE:
2066 Physical start address of boot monitor code (set by
2067 make config files to be same as the text base address
2068 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
2069 CONFIG_SYS_FLASH_BASE when booting from flash.
2071 - CONFIG_SYS_MONITOR_LEN:
2072 Size of memory reserved for monitor code, used to
2073 determine _at_compile_time_ (!) if the environment is
2074 embedded within the U-Boot image, or in a separate
2077 - CONFIG_SYS_MALLOC_LEN:
2078 Size of DRAM reserved for malloc() use.
2080 - CONFIG_SYS_MALLOC_F_LEN
2081 Size of the malloc() pool for use before relocation. If
2082 this is defined, then a very simple malloc() implementation
2083 will become available before relocation. The address is just
2084 below the global data, and the stack is moved down to make
2087 This feature allocates regions with increasing addresses
2088 within the region. calloc() is supported, but realloc()
2089 is not available. free() is supported but does nothing.
2090 The memory will be freed (or in fact just forgotten) when
2091 U-Boot relocates itself.
2093 - CONFIG_SYS_MALLOC_SIMPLE
2094 Provides a simple and small malloc() and calloc() for those
2095 boards which do not use the full malloc in SPL (which is
2096 enabled with CONFIG_SYS_SPL_MALLOC_START).
2098 - CONFIG_SYS_NONCACHED_MEMORY:
2099 Size of non-cached memory area. This area of memory will be
2100 typically located right below the malloc() area and mapped
2101 uncached in the MMU. This is useful for drivers that would
2102 otherwise require a lot of explicit cache maintenance. For
2103 some drivers it's also impossible to properly maintain the
2104 cache. For example if the regions that need to be flushed
2105 are not a multiple of the cache-line size, *and* padding
2106 cannot be allocated between the regions to align them (i.e.
2107 if the HW requires a contiguous array of regions, and the
2108 size of each region is not cache-aligned), then a flush of
2109 one region may result in overwriting data that hardware has
2110 written to another region in the same cache-line. This can
2111 happen for example in network drivers where descriptors for
2112 buffers are typically smaller than the CPU cache-line (e.g.
2113 16 bytes vs. 32 or 64 bytes).
2115 Non-cached memory is only supported on 32-bit ARM at present.
2117 - CONFIG_SYS_BOOTM_LEN:
2118 Normally compressed uImages are limited to an
2119 uncompressed size of 8 MBytes. If this is not enough,
2120 you can define CONFIG_SYS_BOOTM_LEN in your board config file
2121 to adjust this setting to your needs.
2123 - CONFIG_SYS_BOOTMAPSZ:
2124 Maximum size of memory mapped by the startup code of
2125 the Linux kernel; all data that must be processed by
2126 the Linux kernel (bd_info, boot arguments, FDT blob if
2127 used) must be put below this limit, unless "bootm_low"
2128 environment variable is defined and non-zero. In such case
2129 all data for the Linux kernel must be between "bootm_low"
2130 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
2131 variable "bootm_mapsize" will override the value of
2132 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2133 then the value in "bootm_size" will be used instead.
2135 - CONFIG_SYS_BOOT_RAMDISK_HIGH:
2136 Enable initrd_high functionality. If defined then the
2137 initrd_high feature is enabled and the bootm ramdisk subcommand
2140 - CONFIG_SYS_BOOT_GET_CMDLINE:
2141 Enables allocating and saving kernel cmdline in space between
2142 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2144 - CONFIG_SYS_BOOT_GET_KBD:
2145 Enables allocating and saving a kernel copy of the bd_info in
2146 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2148 - CONFIG_SYS_MAX_FLASH_SECT:
2149 Max number of sectors on a Flash chip
2151 - CONFIG_SYS_FLASH_ERASE_TOUT:
2152 Timeout for Flash erase operations (in ms)
2154 - CONFIG_SYS_FLASH_WRITE_TOUT:
2155 Timeout for Flash write operations (in ms)
2157 - CONFIG_SYS_FLASH_LOCK_TOUT
2158 Timeout for Flash set sector lock bit operation (in ms)
2160 - CONFIG_SYS_FLASH_UNLOCK_TOUT
2161 Timeout for Flash clear lock bits operation (in ms)
2163 - CONFIG_SYS_FLASH_PROTECTION
2164 If defined, hardware flash sectors protection is used
2165 instead of U-Boot software protection.
2167 - CONFIG_SYS_DIRECT_FLASH_TFTP:
2169 Enable TFTP transfers directly to flash memory;
2170 without this option such a download has to be
2171 performed in two steps: (1) download to RAM, and (2)
2172 copy from RAM to flash.
2174 The two-step approach is usually more reliable, since
2175 you can check if the download worked before you erase
2176 the flash, but in some situations (when system RAM is
2177 too limited to allow for a temporary copy of the
2178 downloaded image) this option may be very useful.
2180 - CONFIG_SYS_FLASH_CFI:
2181 Define if the flash driver uses extra elements in the
2182 common flash structure for storing flash geometry.
2184 - CONFIG_FLASH_CFI_DRIVER
2185 This option also enables the building of the cfi_flash driver
2186 in the drivers directory
2188 - CONFIG_FLASH_CFI_MTD
2189 This option enables the building of the cfi_mtd driver
2190 in the drivers directory. The driver exports CFI flash
2193 - CONFIG_SYS_FLASH_USE_BUFFER_WRITE
2194 Use buffered writes to flash.
2196 - CONFIG_FLASH_SPANSION_S29WS_N
2197 s29ws-n MirrorBit flash has non-standard addresses for buffered
2200 - CONFIG_SYS_FLASH_QUIET_TEST
2201 If this option is defined, the common CFI flash doesn't
2202 print it's warning upon not recognized FLASH banks. This
2203 is useful, if some of the configured banks are only
2204 optionally available.
2206 - CONFIG_FLASH_SHOW_PROGRESS
2207 If defined (must be an integer), print out countdown
2208 digits and dots. Recommended value: 45 (9..1) for 80
2209 column displays, 15 (3..1) for 40 column displays.
2211 - CONFIG_FLASH_VERIFY
2212 If defined, the content of the flash (destination) is compared
2213 against the source after the write operation. An error message
2214 will be printed when the contents are not identical.
2215 Please note that this option is useless in nearly all cases,
2216 since such flash programming errors usually are detected earlier
2217 while unprotecting/erasing/programming. Please only enable
2218 this option if you really know what you are doing.
2220 - CONFIG_SYS_RX_ETH_BUFFER:
2221 Defines the number of Ethernet receive buffers. On some
2222 Ethernet controllers it is recommended to set this value
2223 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2224 buffers can be full shortly after enabling the interface
2225 on high Ethernet traffic.
2226 Defaults to 4 if not defined.
2228 - CONFIG_ENV_MAX_ENTRIES
2230 Maximum number of entries in the hash table that is used
2231 internally to store the environment settings. The default
2232 setting is supposed to be generous and should work in most
2233 cases. This setting can be used to tune behaviour; see
2234 lib/hashtable.c for details.
2236 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2237 - CONFIG_ENV_FLAGS_LIST_STATIC
2238 Enable validation of the values given to environment variables when
2239 calling env set. Variables can be restricted to only decimal,
2240 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
2241 the variables can also be restricted to IP address or MAC address.
2243 The format of the list is:
2244 type_attribute = [s|d|x|b|i|m]
2245 access_attribute = [a|r|o|c]
2246 attributes = type_attribute[access_attribute]
2247 entry = variable_name[:attributes]
2250 The type attributes are:
2251 s - String (default)
2254 b - Boolean ([1yYtT|0nNfF])
2258 The access attributes are:
2264 - CONFIG_ENV_FLAGS_LIST_DEFAULT
2265 Define this to a list (string) to define the ".flags"
2266 environment variable in the default or embedded environment.
2268 - CONFIG_ENV_FLAGS_LIST_STATIC
2269 Define this to a list (string) to define validation that
2270 should be done if an entry is not found in the ".flags"
2271 environment variable. To override a setting in the static
2272 list, simply add an entry for the same variable name to the
2275 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
2276 regular expression. This allows multiple variables to define the same
2277 flags without explicitly listing them for each variable.
2279 The following definitions that deal with the placement and management
2280 of environment data (variable area); in general, we support the
2281 following configurations:
2283 - CONFIG_BUILD_ENVCRC:
2285 Builds up envcrc with the target environment so that external utils
2286 may easily extract it and embed it in final U-Boot images.
2288 BE CAREFUL! The first access to the environment happens quite early
2289 in U-Boot initialization (when we try to get the setting of for the
2290 console baudrate). You *MUST* have mapped your NVRAM area then, or
2293 Please note that even with NVRAM we still use a copy of the
2294 environment in RAM: we could work on NVRAM directly, but we want to
2295 keep settings there always unmodified except somebody uses "saveenv"
2296 to save the current settings.
2298 BE CAREFUL! For some special cases, the local device can not use
2299 "saveenv" command. For example, the local device will get the
2300 environment stored in a remote NOR flash by SRIO or PCIE link,
2301 but it can not erase, write this NOR flash by SRIO or PCIE interface.
2303 - CONFIG_NAND_ENV_DST
2305 Defines address in RAM to which the nand_spl code should copy the
2306 environment. If redundant environment is used, it will be copied to
2307 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2309 Please note that the environment is read-only until the monitor
2310 has been relocated to RAM and a RAM copy of the environment has been
2311 created; also, when using EEPROM you will have to use env_get_f()
2312 until then to read environment variables.
2314 The environment is protected by a CRC32 checksum. Before the monitor
2315 is relocated into RAM, as a result of a bad CRC you will be working
2316 with the compiled-in default environment - *silently*!!! [This is
2317 necessary, because the first environment variable we need is the
2318 "baudrate" setting for the console - if we have a bad CRC, we don't
2319 have any device yet where we could complain.]
2321 Note: once the monitor has been relocated, then it will complain if
2322 the default environment is used; a new CRC is computed as soon as you
2323 use the "saveenv" command to store a valid environment.
2325 - CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2326 Echo the inverted Ethernet link state to the fault LED.
2328 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2329 also needs to be defined.
2331 - CONFIG_SYS_FAULT_MII_ADDR:
2332 MII address of the PHY to check for the Ethernet link state.
2334 - CONFIG_NS16550_MIN_FUNCTIONS:
2335 Define this if you desire to only have use of the NS16550_init
2336 and NS16550_putc functions for the serial driver located at
2337 drivers/serial/ns16550.c. This option is useful for saving
2338 space for already greatly restricted images, including but not
2339 limited to NAND_SPL configurations.
2341 - CONFIG_DISPLAY_BOARDINFO
2342 Display information about the board that U-Boot is running on
2343 when U-Boot starts up. The board function checkboard() is called
2346 - CONFIG_DISPLAY_BOARDINFO_LATE
2347 Similar to the previous option, but display this information
2348 later, once stdio is running and output goes to the LCD, if
2351 - CONFIG_BOARD_SIZE_LIMIT:
2352 Maximum size of the U-Boot image. When defined, the
2353 build system checks that the actual size does not
2356 Low Level (hardware related) configuration options:
2357 ---------------------------------------------------
2359 - CONFIG_SYS_CACHELINE_SIZE:
2360 Cache Line Size of the CPU.
2362 - CONFIG_SYS_CCSRBAR_DEFAULT:
2363 Default (power-on reset) physical address of CCSR on Freescale
2366 - CONFIG_SYS_CCSRBAR:
2367 Virtual address of CCSR. On a 32-bit build, this is typically
2368 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2370 - CONFIG_SYS_CCSRBAR_PHYS:
2371 Physical address of CCSR. CCSR can be relocated to a new
2372 physical address, if desired. In this case, this macro should
2373 be set to that address. Otherwise, it should be set to the
2374 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2375 is typically relocated on 36-bit builds. It is recommended
2376 that this macro be defined via the _HIGH and _LOW macros:
2378 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2379 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2381 - CONFIG_SYS_CCSRBAR_PHYS_HIGH:
2382 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2383 either 0 (32-bit build) or 0xF (36-bit build). This macro is
2384 used in assembly code, so it must not contain typecasts or
2385 integer size suffixes (e.g. "ULL").
2387 - CONFIG_SYS_CCSRBAR_PHYS_LOW:
2388 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2389 used in assembly code, so it must not contain typecasts or
2390 integer size suffixes (e.g. "ULL").
2392 - CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2393 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2394 forced to a value that ensures that CCSR is not relocated.
2396 - CONFIG_SYS_IMMR: Physical address of the Internal Memory.
2397 DO NOT CHANGE unless you know exactly what you're
2398 doing! (11-4) [MPC8xx systems only]
2400 - CONFIG_SYS_INIT_RAM_ADDR:
2402 Start address of memory area that can be used for
2403 initial data and stack; please note that this must be
2404 writable memory that is working WITHOUT special
2405 initialization, i. e. you CANNOT use normal RAM which
2406 will become available only after programming the
2407 memory controller and running certain initialization
2410 U-Boot uses the following memory types:
2411 - MPC8xx: IMMR (internal memory of the CPU)
2413 - CONFIG_SYS_GBL_DATA_OFFSET:
2415 Offset of the initial data structure in the memory
2416 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2417 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2418 data is located at the end of the available space
2419 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
2420 GENERATED_GBL_DATA_SIZE), and the initial stack is just
2421 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2422 CONFIG_SYS_GBL_DATA_OFFSET) downward.
2425 On the MPC824X (or other systems that use the data
2426 cache for initial memory) the address chosen for
2427 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2428 point to an otherwise UNUSED address space between
2429 the top of RAM and the start of the PCI space.
2431 - CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
2433 - CONFIG_SYS_OR_TIMING_SDRAM:
2436 - CONFIG_SYS_MAMR_PTA:
2437 periodic timer for refresh
2440 Chip has SRIO or not
2443 Board has SRIO 1 port available
2446 Board has SRIO 2 port available
2448 - CONFIG_SRIO_PCIE_BOOT_MASTER
2449 Board can support master function for Boot from SRIO and PCIE
2451 - CONFIG_SYS_SRIOn_MEM_VIRT:
2452 Virtual Address of SRIO port 'n' memory region
2454 - CONFIG_SYS_SRIOn_MEM_PHYxS:
2455 Physical Address of SRIO port 'n' memory region
2457 - CONFIG_SYS_SRIOn_MEM_SIZE:
2458 Size of SRIO port 'n' memory region
2460 - CONFIG_SYS_NAND_BUSWIDTH_16BIT
2461 Defined to tell the NAND controller that the NAND chip is using
2463 Not all NAND drivers use this symbol.
2464 Example of drivers that use it:
2465 - drivers/mtd/nand/raw/ndfc.c
2466 - drivers/mtd/nand/raw/mxc_nand.c
2468 - CONFIG_SYS_NDFC_EBC0_CFG
2469 Sets the EBC0_CFG register for the NDFC. If not defined
2470 a default value will be used.
2473 Get DDR timing information from an I2C EEPROM. Common
2474 with pluggable memory modules such as SODIMMs
2477 I2C address of the SPD EEPROM
2479 - CONFIG_SYS_SPD_BUS_NUM
2480 If SPD EEPROM is on an I2C bus other than the first
2481 one, specify here. Note that the value must resolve
2482 to something your driver can deal with.
2484 - CONFIG_SYS_DDR_RAW_TIMING
2485 Get DDR timing information from other than SPD. Common with
2486 soldered DDR chips onboard without SPD. DDR raw timing
2487 parameters are extracted from datasheet and hard-coded into
2488 header files or board specific files.
2490 - CONFIG_FSL_DDR_INTERACTIVE
2491 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2493 - CONFIG_FSL_DDR_SYNC_REFRESH
2494 Enable sync of refresh for multiple controllers.
2496 - CONFIG_FSL_DDR_BIST
2497 Enable built-in memory test for Freescale DDR controllers.
2499 - CONFIG_SYS_83XX_DDR_USES_CS0
2500 Only for 83xx systems. If specified, then DDR should
2501 be configured using CS0 and CS1 instead of CS2 and CS3.
2504 Enable RMII mode for all FECs.
2505 Note that this is a global option, we can't
2506 have one FEC in standard MII mode and another in RMII mode.
2508 - CONFIG_CRC32_VERIFY
2509 Add a verify option to the crc32 command.
2512 => crc32 -v <address> <count> <crc32>
2514 Where address/count indicate a memory area
2515 and crc32 is the correct crc32 which the
2519 Add the "loopw" memory command. This only takes effect if
2520 the memory commands are activated globally (CONFIG_CMD_MEMORY).
2522 - CONFIG_CMD_MX_CYCLIC
2523 Add the "mdc" and "mwc" memory commands. These are cyclic
2528 This command will print 4 bytes (10,11,12,13) each 500 ms.
2530 => mwc.l 100 12345678 10
2531 This command will write 12345678 to address 100 all 10 ms.
2533 This only takes effect if the memory commands are activated
2534 globally (CONFIG_CMD_MEMORY).
2537 Set when the currently-running compilation is for an artifact
2538 that will end up in the SPL (as opposed to the TPL or U-Boot
2539 proper). Code that needs stage-specific behavior should check
2543 Set when the currently-running compilation is for an artifact
2544 that will end up in the TPL (as opposed to the SPL or U-Boot
2545 proper). Code that needs stage-specific behavior should check
2548 - CONFIG_SYS_MPC85XX_NO_RESETVEC
2549 Only for 85xx systems. If this variable is specified, the section
2550 .resetvec is not kept and the section .bootpg is placed in the
2551 previous 4k of the .text section.
2553 - CONFIG_ARCH_MAP_SYSMEM
2554 Generally U-Boot (and in particular the md command) uses
2555 effective address. It is therefore not necessary to regard
2556 U-Boot address as virtual addresses that need to be translated
2557 to physical addresses. However, sandbox requires this, since
2558 it maintains its own little RAM buffer which contains all
2559 addressable memory. This option causes some memory accesses
2560 to be mapped through map_sysmem() / unmap_sysmem().
2562 - CONFIG_X86_RESET_VECTOR
2563 If defined, the x86 reset vector code is included. This is not
2564 needed when U-Boot is running from Coreboot.
2566 - CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2567 Option to disable subpage write in NAND driver
2568 driver that uses this:
2569 drivers/mtd/nand/raw/davinci_nand.c
2571 Freescale QE/FMAN Firmware Support:
2572 -----------------------------------
2574 The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2575 loading of "firmware", which is encoded in the QE firmware binary format.
2576 This firmware often needs to be loaded during U-Boot booting, so macros
2577 are used to identify the storage device (NOR flash, SPI, etc) and the address
2580 - CONFIG_SYS_FMAN_FW_ADDR
2581 The address in the storage device where the FMAN microcode is located. The
2582 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
2585 - CONFIG_SYS_QE_FW_ADDR
2586 The address in the storage device where the QE microcode is located. The
2587 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
2590 - CONFIG_SYS_QE_FMAN_FW_LENGTH
2591 The maximum possible size of the firmware. The firmware binary format
2592 has a field that specifies the actual size of the firmware, but it
2593 might not be possible to read any part of the firmware unless some
2594 local storage is allocated to hold the entire firmware first.
2596 - CONFIG_SYS_QE_FMAN_FW_IN_NOR
2597 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2598 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
2599 virtual address in NOR flash.
2601 - CONFIG_SYS_QE_FMAN_FW_IN_NAND
2602 Specifies that QE/FMAN firmware is located in NAND flash.
2603 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2605 - CONFIG_SYS_QE_FMAN_FW_IN_MMC
2606 Specifies that QE/FMAN firmware is located on the primary SD/MMC
2607 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2609 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2610 Specifies that QE/FMAN firmware is located in the remote (master)
2611 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
2612 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2613 window->master inbound window->master LAW->the ucode address in
2614 master's memory space.
2616 Freescale Layerscape Management Complex Firmware Support:
2617 ---------------------------------------------------------
2618 The Freescale Layerscape Management Complex (MC) supports the loading of
2620 This firmware often needs to be loaded during U-Boot booting, so macros
2621 are used to identify the storage device (NOR flash, SPI, etc) and the address
2624 - CONFIG_FSL_MC_ENET
2625 Enable the MC driver for Layerscape SoCs.
2627 Freescale Layerscape Debug Server Support:
2628 -------------------------------------------
2629 The Freescale Layerscape Debug Server Support supports the loading of
2630 "Debug Server firmware" and triggering SP boot-rom.
2631 This firmware often needs to be loaded during U-Boot booting.
2633 - CONFIG_SYS_MC_RSV_MEM_ALIGN
2634 Define alignment of reserved memory MC requires
2639 In order to achieve reproducible builds, timestamps used in the U-Boot build
2640 process have to be set to a fixed value.
2642 This is done using the SOURCE_DATE_EPOCH environment variable.
2643 SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
2644 option for U-Boot or an environment variable in U-Boot.
2646 SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
2648 Building the Software:
2649 ======================
2651 Building U-Boot has been tested in several native build environments
2652 and in many different cross environments. Of course we cannot support
2653 all possibly existing versions of cross development tools in all
2654 (potentially obsolete) versions. In case of tool chain problems we
2655 recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
2656 which is extensively used to build and test U-Boot.
2658 If you are not using a native environment, it is assumed that you
2659 have GNU cross compiling tools available in your path. In this case,
2660 you must set the environment variable CROSS_COMPILE in your shell.
2661 Note that no changes to the Makefile or any other source files are
2662 necessary. For example using the ELDK on a 4xx CPU, please enter:
2664 $ CROSS_COMPILE=ppc_4xx-
2665 $ export CROSS_COMPILE
2667 U-Boot is intended to be simple to build. After installing the
2668 sources you must configure U-Boot for one specific board type. This
2673 where "NAME_defconfig" is the name of one of the existing configu-
2674 rations; see configs/*_defconfig for supported names.
2676 Note: for some boards special configuration names may exist; check if
2677 additional information is available from the board vendor; for
2678 instance, the TQM823L systems are available without (standard)
2679 or with LCD support. You can select such additional "features"
2680 when choosing the configuration, i. e.
2682 make TQM823L_defconfig
2683 - will configure for a plain TQM823L, i. e. no LCD support
2685 make TQM823L_LCD_defconfig
2686 - will configure for a TQM823L with U-Boot console on LCD
2691 Finally, type "make all", and you should get some working U-Boot
2692 images ready for download to / installation on your system:
2694 - "u-boot.bin" is a raw binary image
2695 - "u-boot" is an image in ELF binary format
2696 - "u-boot.srec" is in Motorola S-Record format
2698 By default the build is performed locally and the objects are saved
2699 in the source directory. One of the two methods can be used to change
2700 this behavior and build U-Boot to some external directory:
2702 1. Add O= to the make command line invocations:
2704 make O=/tmp/build distclean
2705 make O=/tmp/build NAME_defconfig
2706 make O=/tmp/build all
2708 2. Set environment variable KBUILD_OUTPUT to point to the desired location:
2710 export KBUILD_OUTPUT=/tmp/build
2715 Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
2718 User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
2719 setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
2720 For example to treat all compiler warnings as errors:
2722 make KCFLAGS=-Werror
2724 Please be aware that the Makefiles assume you are using GNU make, so
2725 for instance on NetBSD you might need to use "gmake" instead of
2729 If the system board that you have is not listed, then you will need
2730 to port U-Boot to your hardware platform. To do this, follow these
2733 1. Create a new directory to hold your board specific code. Add any
2734 files you need. In your board directory, you will need at least
2735 the "Makefile" and a "<board>.c".
2736 2. Create a new configuration file "include/configs/<board>.h" for
2738 3. If you're porting U-Boot to a new CPU, then also create a new
2739 directory to hold your CPU specific code. Add any files you need.
2740 4. Run "make <board>_defconfig" with your new name.
2741 5. Type "make", and you should get a working "u-boot.srec" file
2742 to be installed on your target system.
2743 6. Debug and solve any problems that might arise.
2744 [Of course, this last step is much harder than it sounds.]
2747 Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2748 ==============================================================
2750 If you have modified U-Boot sources (for instance added a new board
2751 or support for new devices, a new CPU, etc.) you are expected to
2752 provide feedback to the other developers. The feedback normally takes
2753 the form of a "patch", i.e. a context diff against a certain (latest
2754 official or latest in the git repository) version of U-Boot sources.
2756 But before you submit such a patch, please verify that your modifi-
2757 cation did not break existing code. At least make sure that *ALL* of
2758 the supported boards compile WITHOUT ANY compiler warnings. To do so,
2759 just run the buildman script (tools/buildman/buildman), which will
2760 configure and build U-Boot for ALL supported system. Be warned, this
2761 will take a while. Please see the buildman README, or run 'buildman -H'
2765 See also "U-Boot Porting Guide" below.
2768 Monitor Commands - Overview:
2769 ============================
2771 go - start application at address 'addr'
2772 run - run commands in an environment variable
2773 bootm - boot application image from memory
2774 bootp - boot image via network using BootP/TFTP protocol
2775 bootz - boot zImage from memory
2776 tftpboot- boot image via network using TFTP protocol
2777 and env variables "ipaddr" and "serverip"
2778 (and eventually "gatewayip")
2779 tftpput - upload a file via network using TFTP protocol
2780 rarpboot- boot image via network using RARP/TFTP protocol
2781 diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2782 loads - load S-Record file over serial line
2783 loadb - load binary file over serial line (kermit mode)
2785 mm - memory modify (auto-incrementing)
2786 nm - memory modify (constant address)
2787 mw - memory write (fill)
2790 cmp - memory compare
2791 crc32 - checksum calculation
2792 i2c - I2C sub-system
2793 sspi - SPI utility commands
2794 base - print or set address offset
2795 printenv- print environment variables
2796 pwm - control pwm channels
2797 setenv - set environment variables
2798 saveenv - save environment variables to persistent storage
2799 protect - enable or disable FLASH write protection
2800 erase - erase FLASH memory
2801 flinfo - print FLASH memory information
2802 nand - NAND memory operations (see doc/README.nand)
2803 bdinfo - print Board Info structure
2804 iminfo - print header information for application image
2805 coninfo - print console devices and informations
2806 ide - IDE sub-system
2807 loop - infinite loop on address range
2808 loopw - infinite write loop on address range
2809 mtest - simple RAM test
2810 icache - enable or disable instruction cache
2811 dcache - enable or disable data cache
2812 reset - Perform RESET of the CPU
2813 echo - echo args to console
2814 version - print monitor version
2815 help - print online help
2816 ? - alias for 'help'
2819 Monitor Commands - Detailed Description:
2820 ========================================
2824 For now: just type "help <command>".
2827 Note for Redundant Ethernet Interfaces:
2828 =======================================
2830 Some boards come with redundant Ethernet interfaces; U-Boot supports
2831 such configurations and is capable of automatic selection of a
2832 "working" interface when needed. MAC assignment works as follows:
2834 Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2835 MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2836 "eth1addr" (=>eth1), "eth2addr", ...
2838 If the network interface stores some valid MAC address (for instance
2839 in SROM), this is used as default address if there is NO correspon-
2840 ding setting in the environment; if the corresponding environment
2841 variable is set, this overrides the settings in the card; that means:
2843 o If the SROM has a valid MAC address, and there is no address in the
2844 environment, the SROM's address is used.
2846 o If there is no valid address in the SROM, and a definition in the
2847 environment exists, then the value from the environment variable is
2850 o If both the SROM and the environment contain a MAC address, and
2851 both addresses are the same, this MAC address is used.
2853 o If both the SROM and the environment contain a MAC address, and the
2854 addresses differ, the value from the environment is used and a
2857 o If neither SROM nor the environment contain a MAC address, an error
2858 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
2859 a random, locally-assigned MAC is used.
2861 If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
2862 will be programmed into hardware as part of the initialization process. This
2863 may be skipped by setting the appropriate 'ethmacskip' environment variable.
2864 The naming convention is as follows:
2865 "ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
2870 U-Boot is capable of booting (and performing other auxiliary operations on)
2871 images in two formats:
2873 New uImage format (FIT)
2874 -----------------------
2876 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
2877 to Flattened Device Tree). It allows the use of images with multiple
2878 components (several kernels, ramdisks, etc.), with contents protected by
2879 SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
2885 Old image format is based on binary files which can be basically anything,
2886 preceded by a special header; see the definitions in include/image.h for
2887 details; basically, the header defines the following image properties:
2889 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2890 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2891 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
2892 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY).
2893 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2894 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2895 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
2896 * Compression Type (uncompressed, gzip, bzip2)
2902 The header is marked by a special Magic Number, and both the header
2903 and the data portions of the image are secured against corruption by
2910 Although U-Boot should support any OS or standalone application
2911 easily, the main focus has always been on Linux during the design of
2914 U-Boot includes many features that so far have been part of some
2915 special "boot loader" code within the Linux kernel. Also, any
2916 "initrd" images to be used are no longer part of one big Linux image;
2917 instead, kernel and "initrd" are separate images. This implementation
2918 serves several purposes:
2920 - the same features can be used for other OS or standalone
2921 applications (for instance: using compressed images to reduce the
2922 Flash memory footprint)
2924 - it becomes much easier to port new Linux kernel versions because
2925 lots of low-level, hardware dependent stuff are done by U-Boot
2927 - the same Linux kernel image can now be used with different "initrd"
2928 images; of course this also means that different kernel images can
2929 be run with the same "initrd". This makes testing easier (you don't
2930 have to build a new "zImage.initrd" Linux image when you just
2931 change a file in your "initrd"). Also, a field-upgrade of the
2932 software is easier now.
2938 Porting Linux to U-Boot based systems:
2939 ---------------------------------------
2941 U-Boot cannot save you from doing all the necessary modifications to
2942 configure the Linux device drivers for use with your target hardware
2943 (no, we don't intend to provide a full virtual machine interface to
2946 But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
2948 Just make sure your machine specific header file (for instance
2949 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2950 Information structure as we define in include/asm-<arch>/u-boot.h,
2951 and make sure that your definition of IMAP_ADDR uses the same value
2952 as your U-Boot configuration in CONFIG_SYS_IMMR.
2954 Note that U-Boot now has a driver model, a unified model for drivers.
2955 If you are adding a new driver, plumb it into driver model. If there
2956 is no uclass available, you are encouraged to create one. See
2960 Configuring the Linux kernel:
2961 -----------------------------
2963 No specific requirements for U-Boot. Make sure you have some root
2964 device (initial ramdisk, NFS) for your target system.
2967 Building a Linux Image:
2968 -----------------------
2970 With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2971 not used. If you use recent kernel source, a new build target
2972 "uImage" will exist which automatically builds an image usable by
2973 U-Boot. Most older kernels also have support for a "pImage" target,
2974 which was introduced for our predecessor project PPCBoot and uses a
2975 100% compatible format.
2979 make TQM850L_defconfig
2984 The "uImage" build target uses a special tool (in 'tools/mkimage') to
2985 encapsulate a compressed Linux kernel image with header information,
2986 CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2988 * build a standard "vmlinux" kernel image (in ELF binary format):
2990 * convert the kernel into a raw binary image:
2992 ${CROSS_COMPILE}-objcopy -O binary \
2993 -R .note -R .comment \
2994 -S vmlinux linux.bin
2996 * compress the binary image:
3000 * package compressed binary image for U-Boot:
3002 mkimage -A ppc -O linux -T kernel -C gzip \
3003 -a 0 -e 0 -n "Linux Kernel Image" \
3004 -d linux.bin.gz uImage
3007 The "mkimage" tool can also be used to create ramdisk images for use
3008 with U-Boot, either separated from the Linux kernel image, or
3009 combined into one file. "mkimage" encapsulates the images with a 64
3010 byte header containing information about target architecture,
3011 operating system, image type, compression method, entry points, time
3012 stamp, CRC32 checksums, etc.
3014 "mkimage" can be called in two ways: to verify existing images and
3015 print the header information, or to build new images.
3017 In the first form (with "-l" option) mkimage lists the information
3018 contained in the header of an existing U-Boot image; this includes
3019 checksum verification:
3021 tools/mkimage -l image
3022 -l ==> list image header information
3024 The second form (with "-d" option) is used to build a U-Boot image
3025 from a "data file" which is used as image payload:
3027 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3028 -n name -d data_file image
3029 -A ==> set architecture to 'arch'
3030 -O ==> set operating system to 'os'
3031 -T ==> set image type to 'type'
3032 -C ==> set compression type 'comp'
3033 -a ==> set load address to 'addr' (hex)
3034 -e ==> set entry point to 'ep' (hex)
3035 -n ==> set image name to 'name'
3036 -d ==> use image data from 'datafile'
3038 Right now, all Linux kernels for PowerPC systems use the same load
3039 address (0x00000000), but the entry point address depends on the
3042 - 2.2.x kernels have the entry point at 0x0000000C,
3043 - 2.3.x and later kernels have the entry point at 0x00000000.
3045 So a typical call to build a U-Boot image would read:
3047 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3048 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3049 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
3050 > examples/uImage.TQM850L
3051 Image Name: 2.4.4 kernel for TQM850L
3052 Created: Wed Jul 19 02:34:59 2000
3053 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3054 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3055 Load Address: 0x00000000
3056 Entry Point: 0x00000000
3058 To verify the contents of the image (or check for corruption):
3060 -> tools/mkimage -l examples/uImage.TQM850L
3061 Image Name: 2.4.4 kernel for TQM850L
3062 Created: Wed Jul 19 02:34:59 2000
3063 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3064 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3065 Load Address: 0x00000000
3066 Entry Point: 0x00000000
3068 NOTE: for embedded systems where boot time is critical you can trade
3069 speed for memory and install an UNCOMPRESSED image instead: this
3070 needs more space in Flash, but boots much faster since it does not
3071 need to be uncompressed:
3073 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
3074 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3075 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3076 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
3077 > examples/uImage.TQM850L-uncompressed
3078 Image Name: 2.4.4 kernel for TQM850L
3079 Created: Wed Jul 19 02:34:59 2000
3080 Image Type: PowerPC Linux Kernel Image (uncompressed)
3081 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3082 Load Address: 0x00000000
3083 Entry Point: 0x00000000
3086 Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3087 when your kernel is intended to use an initial ramdisk:
3089 -> tools/mkimage -n 'Simple Ramdisk Image' \
3090 > -A ppc -O linux -T ramdisk -C gzip \
3091 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3092 Image Name: Simple Ramdisk Image
3093 Created: Wed Jan 12 14:01:50 2000
3094 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3095 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3096 Load Address: 0x00000000
3097 Entry Point: 0x00000000
3099 The "dumpimage" tool can be used to disassemble or list the contents of images
3100 built by mkimage. See dumpimage's help output (-h) for details.
3102 Installing a Linux Image:
3103 -------------------------
3105 To downloading a U-Boot image over the serial (console) interface,
3106 you must convert the image to S-Record format:
3108 objcopy -I binary -O srec examples/image examples/image.srec
3110 The 'objcopy' does not understand the information in the U-Boot
3111 image header, so the resulting S-Record file will be relative to
3112 address 0x00000000. To load it to a given address, you need to
3113 specify the target address as 'offset' parameter with the 'loads'
3116 Example: install the image to address 0x40100000 (which on the
3117 TQM8xxL is in the first Flash bank):
3119 => erase 40100000 401FFFFF
3125 ## Ready for S-Record download ...
3126 ~>examples/image.srec
3127 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3129 15989 15990 15991 15992
3130 [file transfer complete]
3132 ## Start Addr = 0x00000000
3135 You can check the success of the download using the 'iminfo' command;
3136 this includes a checksum verification so you can be sure no data
3137 corruption happened:
3141 ## Checking Image at 40100000 ...
3142 Image Name: 2.2.13 for initrd on TQM850L
3143 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3144 Data Size: 335725 Bytes = 327 kB = 0 MB
3145 Load Address: 00000000
3146 Entry Point: 0000000c
3147 Verifying Checksum ... OK
3153 The "bootm" command is used to boot an application that is stored in
3154 memory (RAM or Flash). In case of a Linux kernel image, the contents
3155 of the "bootargs" environment variable is passed to the kernel as
3156 parameters. You can check and modify this variable using the
3157 "printenv" and "setenv" commands:
3160 => printenv bootargs
3161 bootargs=root=/dev/ram
3163 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3165 => printenv bootargs
3166 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3169 ## Booting Linux kernel at 40020000 ...
3170 Image Name: 2.2.13 for NFS on TQM850L
3171 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3172 Data Size: 381681 Bytes = 372 kB = 0 MB
3173 Load Address: 00000000
3174 Entry Point: 0000000c
3175 Verifying Checksum ... OK
3176 Uncompressing Kernel Image ... OK
3177 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
3178 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3179 time_init: decrementer frequency = 187500000/60
3180 Calibrating delay loop... 49.77 BogoMIPS
3181 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3184 If you want to boot a Linux kernel with initial RAM disk, you pass
3185 the memory addresses of both the kernel and the initrd image (PPBCOOT
3186 format!) to the "bootm" command:
3188 => imi 40100000 40200000
3190 ## Checking Image at 40100000 ...
3191 Image Name: 2.2.13 for initrd on TQM850L
3192 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3193 Data Size: 335725 Bytes = 327 kB = 0 MB
3194 Load Address: 00000000
3195 Entry Point: 0000000c
3196 Verifying Checksum ... OK
3198 ## Checking Image at 40200000 ...
3199 Image Name: Simple Ramdisk Image
3200 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3201 Data Size: 566530 Bytes = 553 kB = 0 MB
3202 Load Address: 00000000
3203 Entry Point: 00000000
3204 Verifying Checksum ... OK
3206 => bootm 40100000 40200000
3207 ## Booting Linux kernel at 40100000 ...
3208 Image Name: 2.2.13 for initrd on TQM850L
3209 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3210 Data Size: 335725 Bytes = 327 kB = 0 MB
3211 Load Address: 00000000
3212 Entry Point: 0000000c
3213 Verifying Checksum ... OK
3214 Uncompressing Kernel Image ... OK
3215 ## Loading RAMDisk Image at 40200000 ...
3216 Image Name: Simple Ramdisk Image
3217 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3218 Data Size: 566530 Bytes = 553 kB = 0 MB
3219 Load Address: 00000000
3220 Entry Point: 00000000
3221 Verifying Checksum ... OK
3222 Loading Ramdisk ... OK
3223 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
3224 Boot arguments: root=/dev/ram
3225 time_init: decrementer frequency = 187500000/60
3226 Calibrating delay loop... 49.77 BogoMIPS
3228 RAMDISK: Compressed image found at block 0
3229 VFS: Mounted root (ext2 filesystem).
3233 Boot Linux and pass a flat device tree:
3236 First, U-Boot must be compiled with the appropriate defines. See the section
3237 titled "Linux Kernel Interface" above for a more in depth explanation. The
3238 following is an example of how to start a kernel and pass an updated
3244 oft=oftrees/mpc8540ads.dtb
3245 => tftp $oftaddr $oft
3246 Speed: 1000, full duplex
3248 TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3249 Filename 'oftrees/mpc8540ads.dtb'.
3250 Load address: 0x300000
3253 Bytes transferred = 4106 (100a hex)
3254 => tftp $loadaddr $bootfile
3255 Speed: 1000, full duplex
3257 TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3259 Load address: 0x200000
3260 Loading:############
3262 Bytes transferred = 1029407 (fb51f hex)
3267 => bootm $loadaddr - $oftaddr
3268 ## Booting image at 00200000 ...
3269 Image Name: Linux-2.6.17-dirty
3270 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3271 Data Size: 1029343 Bytes = 1005.2 kB
3272 Load Address: 00000000
3273 Entry Point: 00000000
3274 Verifying Checksum ... OK
3275 Uncompressing Kernel Image ... OK
3276 Booting using flat device tree at 0x300000
3277 Using MPC85xx ADS machine description
3278 Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3282 More About U-Boot Image Types:
3283 ------------------------------
3285 U-Boot supports the following image types:
3287 "Standalone Programs" are directly runnable in the environment
3288 provided by U-Boot; it is expected that (if they behave
3289 well) you can continue to work in U-Boot after return from
3290 the Standalone Program.
3291 "OS Kernel Images" are usually images of some Embedded OS which
3292 will take over control completely. Usually these programs
3293 will install their own set of exception handlers, device
3294 drivers, set up the MMU, etc. - this means, that you cannot
3295 expect to re-enter U-Boot except by resetting the CPU.
3296 "RAMDisk Images" are more or less just data blocks, and their
3297 parameters (address, size) are passed to an OS kernel that is
3299 "Multi-File Images" contain several images, typically an OS
3300 (Linux) kernel image and one or more data images like
3301 RAMDisks. This construct is useful for instance when you want
3302 to boot over the network using BOOTP etc., where the boot
3303 server provides just a single image file, but you want to get
3304 for instance an OS kernel and a RAMDisk image.
3306 "Multi-File Images" start with a list of image sizes, each
3307 image size (in bytes) specified by an "uint32_t" in network
3308 byte order. This list is terminated by an "(uint32_t)0".
3309 Immediately after the terminating 0 follow the images, one by
3310 one, all aligned on "uint32_t" boundaries (size rounded up to
3311 a multiple of 4 bytes).
3313 "Firmware Images" are binary images containing firmware (like
3314 U-Boot or FPGA images) which usually will be programmed to
3317 "Script files" are command sequences that will be executed by
3318 U-Boot's command interpreter; this feature is especially
3319 useful when you configure U-Boot to use a real shell (hush)
3320 as command interpreter.
3322 Booting the Linux zImage:
3323 -------------------------
3325 On some platforms, it's possible to boot Linux zImage. This is done
3326 using the "bootz" command. The syntax of "bootz" command is the same
3327 as the syntax of "bootm" command.
3329 Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
3330 kernel with raw initrd images. The syntax is slightly different, the
3331 address of the initrd must be augmented by it's size, in the following
3332 format: "<initrd addres>:<initrd size>".
3338 One of the features of U-Boot is that you can dynamically load and
3339 run "standalone" applications, which can use some resources of
3340 U-Boot like console I/O functions or interrupt services.
3342 Two simple examples are included with the sources:
3347 'examples/hello_world.c' contains a small "Hello World" Demo
3348 application; it is automatically compiled when you build U-Boot.
3349 It's configured to run at address 0x00040004, so you can play with it
3353 ## Ready for S-Record download ...
3354 ~>examples/hello_world.srec
3355 1 2 3 4 5 6 7 8 9 10 11 ...
3356 [file transfer complete]
3358 ## Start Addr = 0x00040004
3360 => go 40004 Hello World! This is a test.
3361 ## Starting application at 0x00040004 ...
3372 Hit any key to exit ...
3374 ## Application terminated, rc = 0x0
3376 Another example, which demonstrates how to register a CPM interrupt
3377 handler with the U-Boot code, can be found in 'examples/timer.c'.
3378 Here, a CPM timer is set up to generate an interrupt every second.
3379 The interrupt service routine is trivial, just printing a '.'
3380 character, but this is just a demo program. The application can be
3381 controlled by the following keys:
3383 ? - print current values og the CPM Timer registers
3384 b - enable interrupts and start timer
3385 e - stop timer and disable interrupts
3386 q - quit application
3389 ## Ready for S-Record download ...
3390 ~>examples/timer.srec
3391 1 2 3 4 5 6 7 8 9 10 11 ...
3392 [file transfer complete]
3394 ## Start Addr = 0x00040004
3397 ## Starting application at 0x00040004 ...
3400 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3403 [q, b, e, ?] Set interval 1000000 us
3406 [q, b, e, ?] ........
3407 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3410 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3413 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3416 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3418 [q, b, e, ?] ...Stopping timer
3420 [q, b, e, ?] ## Application terminated, rc = 0x0
3426 Over time, many people have reported problems when trying to use the
3427 "minicom" terminal emulation program for serial download. I (wd)
3428 consider minicom to be broken, and recommend not to use it. Under
3429 Unix, I recommend to use C-Kermit for general purpose use (and
3430 especially for kermit binary protocol download ("loadb" command), and
3431 use "cu" for S-Record download ("loads" command). See
3432 https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
3433 for help with kermit.
3436 Nevertheless, if you absolutely want to use it try adding this
3437 configuration to your "File transfer protocols" section:
3439 Name Program Name U/D FullScr IO-Red. Multi
3440 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3441 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
3447 Starting at version 0.9.2, U-Boot supports NetBSD both as host
3448 (build U-Boot) and target system (boots NetBSD/mpc8xx).
3450 Building requires a cross environment; it is known to work on
3451 NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3452 need gmake since the Makefiles are not compatible with BSD make).
3453 Note that the cross-powerpc package does not install include files;
3454 attempting to build U-Boot will fail because <machine/ansi.h> is
3455 missing. This file has to be installed and patched manually:
3457 # cd /usr/pkg/cross/powerpc-netbsd/include
3459 # ln -s powerpc machine
3460 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3461 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
3463 Native builds *don't* work due to incompatibilities between native
3464 and U-Boot include files.
3466 Booting assumes that (the first part of) the image booted is a
3467 stage-2 loader which in turn loads and then invokes the kernel
3468 proper. Loader sources will eventually appear in the NetBSD source
3469 tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
3470 meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3473 Implementation Internals:
3474 =========================
3476 The following is not intended to be a complete description of every
3477 implementation detail. However, it should help to understand the
3478 inner workings of U-Boot and make it easier to port it to custom
3482 Initial Stack, Global Data:
3483 ---------------------------
3485 The implementation of U-Boot is complicated by the fact that U-Boot
3486 starts running out of ROM (flash memory), usually without access to
3487 system RAM (because the memory controller is not initialized yet).
3488 This means that we don't have writable Data or BSS segments, and BSS
3489 is not initialized as zero. To be able to get a C environment working
3490 at all, we have to allocate at least a minimal stack. Implementation
3491 options for this are defined and restricted by the CPU used: Some CPU
3492 models provide on-chip memory (like the IMMR area on MPC8xx and
3493 MPC826x processors), on others (parts of) the data cache can be
3494 locked as (mis-) used as memory, etc.
3496 Chris Hallinan posted a good summary of these issues to the
3497 U-Boot mailing list:
3499 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3500 From: "Chris Hallinan" <clh@net1plus.com>
3501 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3504 Correct me if I'm wrong, folks, but the way I understand it
3505 is this: Using DCACHE as initial RAM for Stack, etc, does not
3506 require any physical RAM backing up the cache. The cleverness
3507 is that the cache is being used as a temporary supply of
3508 necessary storage before the SDRAM controller is setup. It's
3509 beyond the scope of this list to explain the details, but you
3510 can see how this works by studying the cache architecture and
3511 operation in the architecture and processor-specific manuals.
3513 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3514 is another option for the system designer to use as an
3515 initial stack/RAM area prior to SDRAM being available. Either
3516 option should work for you. Using CS 4 should be fine if your
3517 board designers haven't used it for something that would
3518 cause you grief during the initial boot! It is frequently not
3521 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
3522 with your processor/board/system design. The default value
3523 you will find in any recent u-boot distribution in
3524 walnut.h should work for you. I'd set it to a value larger
3525 than your SDRAM module. If you have a 64MB SDRAM module, set
3526 it above 400_0000. Just make sure your board has no resources
3527 that are supposed to respond to that address! That code in
3528 start.S has been around a while and should work as is when
3529 you get the config right.
3534 It is essential to remember this, since it has some impact on the C
3535 code for the initialization procedures:
3537 * Initialized global data (data segment) is read-only. Do not attempt
3540 * Do not use any uninitialized global data (or implicitly initialized
3541 as zero data - BSS segment) at all - this is undefined, initiali-
3542 zation is performed later (when relocating to RAM).
3544 * Stack space is very limited. Avoid big data buffers or things like
3547 Having only the stack as writable memory limits means we cannot use
3548 normal global data to share information between the code. But it
3549 turned out that the implementation of U-Boot can be greatly
3550 simplified by making a global data structure (gd_t) available to all
3551 functions. We could pass a pointer to this data as argument to _all_
3552 functions, but this would bloat the code. Instead we use a feature of
3553 the GCC compiler (Global Register Variables) to share the data: we
3554 place a pointer (gd) to the global data into a register which we
3555 reserve for this purpose.
3557 When choosing a register for such a purpose we are restricted by the
3558 relevant (E)ABI specifications for the current architecture, and by
3559 GCC's implementation.
3561 For PowerPC, the following registers have specific use:
3563 R2: reserved for system use
3564 R3-R4: parameter passing and return values
3565 R5-R10: parameter passing
3566 R13: small data area pointer
3570 (U-Boot also uses R12 as internal GOT pointer. r12
3571 is a volatile register so r12 needs to be reset when
3572 going back and forth between asm and C)
3574 ==> U-Boot will use R2 to hold a pointer to the global data
3576 Note: on PPC, we could use a static initializer (since the
3577 address of the global data structure is known at compile time),
3578 but it turned out that reserving a register results in somewhat
3579 smaller code - although the code savings are not that big (on
3580 average for all boards 752 bytes for the whole U-Boot image,
3581 624 text + 127 data).
3583 On ARM, the following registers are used:
3585 R0: function argument word/integer result
3586 R1-R3: function argument word
3587 R9: platform specific
3588 R10: stack limit (used only if stack checking is enabled)
3589 R11: argument (frame) pointer
3590 R12: temporary workspace
3593 R15: program counter
3595 ==> U-Boot will use R9 to hold a pointer to the global data
3597 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
3599 On Nios II, the ABI is documented here:
3600 https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
3602 ==> U-Boot will use gp to hold a pointer to the global data
3604 Note: on Nios II, we give "-G0" option to gcc and don't use gp
3605 to access small data sections, so gp is free.
3607 On NDS32, the following registers are used:
3609 R0-R1: argument/return
3611 R15: temporary register for assembler
3612 R16: trampoline register
3613 R28: frame pointer (FP)
3614 R29: global pointer (GP)
3615 R30: link register (LP)
3616 R31: stack pointer (SP)
3617 PC: program counter (PC)
3619 ==> U-Boot will use R10 to hold a pointer to the global data
3621 NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3622 or current versions of GCC may "optimize" the code too much.
3624 On RISC-V, the following registers are used:
3626 x0: hard-wired zero (zero)
3627 x1: return address (ra)
3628 x2: stack pointer (sp)
3629 x3: global pointer (gp)
3630 x4: thread pointer (tp)
3631 x5: link register (t0)
3632 x8: frame pointer (fp)
3633 x10-x11: arguments/return values (a0-1)
3634 x12-x17: arguments (a2-7)
3635 x28-31: temporaries (t3-6)
3636 pc: program counter (pc)
3638 ==> U-Boot will use gp to hold a pointer to the global data
3643 U-Boot runs in system state and uses physical addresses, i.e. the
3644 MMU is not used either for address mapping nor for memory protection.
3646 The available memory is mapped to fixed addresses using the memory
3647 controller. In this process, a contiguous block is formed for each
3648 memory type (Flash, SDRAM, SRAM), even when it consists of several
3649 physical memory banks.
3651 U-Boot is installed in the first 128 kB of the first Flash bank (on
3652 TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3653 booting and sizing and initializing DRAM, the code relocates itself
3654 to the upper end of DRAM. Immediately below the U-Boot code some
3655 memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
3656 configuration setting]. Below that, a structure with global Board
3657 Info data is placed, followed by the stack (growing downward).
3659 Additionally, some exception handler code is copied to the low 8 kB
3660 of DRAM (0x00000000 ... 0x00001FFF).
3662 So a typical memory configuration with 16 MB of DRAM could look like
3665 0x0000 0000 Exception Vector code
3668 0x0000 2000 Free for Application Use
3674 0x00FB FF20 Monitor Stack (Growing downward)
3675 0x00FB FFAC Board Info Data and permanent copy of global data
3676 0x00FC 0000 Malloc Arena
3679 0x00FE 0000 RAM Copy of Monitor Code
3680 ... eventually: LCD or video framebuffer
3681 ... eventually: pRAM (Protected RAM - unchanged by reset)
3682 0x00FF FFFF [End of RAM]
3685 System Initialization:
3686 ----------------------
3688 In the reset configuration, U-Boot starts at the reset entry point
3689 (on most PowerPC systems at address 0x00000100). Because of the reset
3690 configuration for CS0# this is a mirror of the on board Flash memory.
3691 To be able to re-map memory U-Boot then jumps to its link address.
3692 To be able to implement the initialization code in C, a (small!)
3693 initial stack is set up in the internal Dual Ported RAM (in case CPUs
3694 which provide such a feature like), or in a locked part of the data
3695 cache. After that, U-Boot initializes the CPU core, the caches and
3698 Next, all (potentially) available memory banks are mapped using a
3699 preliminary mapping. For example, we put them on 512 MB boundaries
3700 (multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3701 on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3702 programmed for SDRAM access. Using the temporary configuration, a
3703 simple memory test is run that determines the size of the SDRAM
3706 When there is more than one SDRAM bank, and the banks are of
3707 different size, the largest is mapped first. For equal size, the first
3708 bank (CS2#) is mapped first. The first mapping is always for address
3709 0x00000000, with any additional banks following immediately to create
3710 contiguous memory starting from 0.
3712 Then, the monitor installs itself at the upper end of the SDRAM area
3713 and allocates memory for use by malloc() and for the global Board
3714 Info data; also, the exception vector code is copied to the low RAM
3715 pages, and the final stack is set up.
3717 Only after this relocation will you have a "normal" C environment;
3718 until that you are restricted in several ways, mostly because you are
3719 running from ROM, and because the code will have to be relocated to a
3723 U-Boot Porting Guide:
3724 ----------------------
3726 [Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3730 int main(int argc, char *argv[])
3732 sighandler_t no_more_time;
3734 signal(SIGALRM, no_more_time);
3735 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
3737 if (available_money > available_manpower) {
3738 Pay consultant to port U-Boot;
3742 Download latest U-Boot source;
3744 Subscribe to u-boot mailing list;
3747 email("Hi, I am new to U-Boot, how do I get started?");
3750 Read the README file in the top level directory;
3751 Read https://www.denx.de/wiki/bin/view/DULG/Manual;
3752 Read applicable doc/README.*;
3753 Read the source, Luke;
3754 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
3757 if (available_money > toLocalCurrency ($2500))
3760 Add a lot of aggravation and time;
3762 if (a similar board exists) { /* hopefully... */
3763 cp -a board/<similar> board/<myboard>
3764 cp include/configs/<similar>.h include/configs/<myboard>.h
3766 Create your own board support subdirectory;
3767 Create your own board include/configs/<myboard>.h file;
3769 Edit new board/<myboard> files
3770 Edit new include/configs/<myboard>.h
3775 Add / modify source code;
3779 email("Hi, I am having problems...");
3781 Send patch file to the U-Boot email list;
3782 if (reasonable critiques)
3783 Incorporate improvements from email list code review;
3785 Defend code as written;
3791 void no_more_time (int sig)
3800 All contributions to U-Boot should conform to the Linux kernel
3801 coding style; see the kernel coding style guide at
3802 https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
3803 script "scripts/Lindent" in your Linux kernel source directory.
3805 Source files originating from a different project (for example the
3806 MTD subsystem) are generally exempt from these guidelines and are not
3807 reformatted to ease subsequent migration to newer versions of those
3810 Please note that U-Boot is implemented in C (and to some small parts in
3811 Assembler); no C++ is used, so please do not use C++ style comments (//)
3814 Please also stick to the following formatting rules:
3815 - remove any trailing white space
3816 - use TAB characters for indentation and vertical alignment, not spaces
3817 - make sure NOT to use DOS '\r\n' line feeds
3818 - do not add more than 2 consecutive empty lines to source files
3819 - do not add trailing empty lines to source files
3821 Submissions which do not conform to the standards may be returned
3822 with a request to reformat the changes.
3828 Since the number of patches for U-Boot is growing, we need to
3829 establish some rules. Submissions which do not conform to these rules
3830 may be rejected, even when they contain important and valuable stuff.
3832 Please see https://www.denx.de/wiki/U-Boot/Patches for details.
3834 Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
3835 see https://lists.denx.de/listinfo/u-boot
3837 When you send a patch, please include the following information with
3840 * For bug fixes: a description of the bug and how your patch fixes
3841 this bug. Please try to include a way of demonstrating that the
3842 patch actually fixes something.
3844 * For new features: a description of the feature and your
3847 * For major contributions, add a MAINTAINERS file with your
3848 information and associated file and directory references.
3850 * When you add support for a new board, don't forget to add a
3851 maintainer e-mail address to the boards.cfg file, too.
3853 * If your patch adds new configuration options, don't forget to
3854 document these in the README file.
3856 * The patch itself. If you are using git (which is *strongly*
3857 recommended) you can easily generate the patch using the
3858 "git format-patch". If you then use "git send-email" to send it to
3859 the U-Boot mailing list, you will avoid most of the common problems
3860 with some other mail clients.
3862 If you cannot use git, use "diff -purN OLD NEW". If your version of
3863 diff does not support these options, then get the latest version of
3866 The current directory when running this command shall be the parent
3867 directory of the U-Boot source tree (i. e. please make sure that
3868 your patch includes sufficient directory information for the
3871 We prefer patches as plain text. MIME attachments are discouraged,
3872 and compressed attachments must not be used.
3874 * If one logical set of modifications affects or creates several
3875 files, all these changes shall be submitted in a SINGLE patch file.
3877 * Changesets that contain different, unrelated modifications shall be
3878 submitted as SEPARATE patches, one patch per changeset.
3883 * Before sending the patch, run the buildman script on your patched
3884 source tree and make sure that no errors or warnings are reported
3885 for any of the boards.
3887 * Keep your modifications to the necessary minimum: A patch
3888 containing several unrelated changes or arbitrary reformats will be
3889 returned with a request to re-formatting / split it.
3891 * If you modify existing code, make sure that your new code does not
3892 add to the memory footprint of the code ;-) Small is beautiful!
3893 When adding new features, these should compile conditionally only
3894 (using #ifdef), and the resulting code with the new feature
3895 disabled must not need more memory than the old code without your
3898 * Remember that there is a size limit of 100 kB per message on the
3899 u-boot mailing list. Bigger patches will be moderated. If they are
3900 reasonable and not too big, they will be acknowledged. But patches
3901 bigger than the size limit should be avoided.
projects / platform / kernel / u-boot.git / blob