1c609719bSwdenk# 2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5eca3aeb3SWolfgang Denk# SPDX-License-Identifier: GPL-2.0+ 6c609719bSwdenk# 7c609719bSwdenk 8c609719bSwdenkSummary: 9c609719bSwdenk======== 10c609719bSwdenk 1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 14e86e5a07Swdenkinitialize and test the hardware or to download and run application 15e86e5a07Swdenkcode. 16c609719bSwdenk 17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some 1924ee89b9Swdenkheader files in common, and special provision has been made to 20c609719bSwdenksupport booting of Linux images. 21c609719bSwdenk 22c609719bSwdenkSome attention has been paid to make this software easily 23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 24c609719bSwdenkimplemented with the same call interface, so that it's very easy to 25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 27c609719bSwdenkload and run it dynamically. 28c609719bSwdenk 29c609719bSwdenk 30c609719bSwdenkStatus: 31c609719bSwdenk======= 32c609719bSwdenk 33c609719bSwdenkIn general, all boards for which a configuration option exists in the 34c609719bSwdenkMakefile have been tested to some extent and can be considered 35c609719bSwdenk"working". In fact, many of them are used in production systems. 36c609719bSwdenk 377207b366SRobert P. J. DayIn case of problems see the CHANGELOG file to find out who contributed 387207b366SRobert P. J. Daythe specific port. In addition, there are various MAINTAINERS files 397207b366SRobert P. J. Dayscattered throughout the U-Boot source identifying the people or 407207b366SRobert P. J. Daycompanies responsible for various boards and subsystems. 41c609719bSwdenk 427207b366SRobert P. J. DayNote: As of August, 2010, there is no longer a CHANGELOG file in the 437207b366SRobert P. J. Dayactual U-Boot source tree; however, it can be created dynamically 447207b366SRobert P. J. Dayfrom the Git log using: 45adb9d851SRobert P. J. Day 46adb9d851SRobert P. J. Day make CHANGELOG 47adb9d851SRobert P. J. Day 48c609719bSwdenk 49c609719bSwdenkWhere to get help: 50c609719bSwdenk================== 51c609719bSwdenk 52c609719bSwdenkIn case you have questions about, problems with or contributions for 537207b366SRobert P. J. DayU-Boot, you should send a message to the U-Boot mailing list at 540c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 550c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 560c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 570c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 58c609719bSwdenk 59c609719bSwdenk 60218ca724SWolfgang DenkWhere to get source code: 61218ca724SWolfgang Denk========================= 62218ca724SWolfgang Denk 637207b366SRobert P. J. DayThe U-Boot source code is maintained in the Git repository at 64218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 65218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 66218ca724SWolfgang Denk 67218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 6811ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 69218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 70218ca724SWolfgang Denkdirectory. 71218ca724SWolfgang Denk 72d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 73218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 74218ca724SWolfgang Denk 75218ca724SWolfgang Denk 76c609719bSwdenkWhere we come from: 77c609719bSwdenk=================== 78c609719bSwdenk 79c609719bSwdenk- start from 8xxrom sources 8024ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 81c609719bSwdenk- clean up code 82c609719bSwdenk- make it easier to add custom boards 83c609719bSwdenk- make it possible to add other [PowerPC] CPUs 84c609719bSwdenk- extend functions, especially: 85c609719bSwdenk * Provide extended interface to Linux boot loader 86c609719bSwdenk * S-Record download 87c609719bSwdenk * network boot 8811ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 8924ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 90c609719bSwdenk- add other CPU families (starting with ARM) 9124ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 920d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 9324ee89b9Swdenk 9424ee89b9Swdenk 9524ee89b9SwdenkNames and Spelling: 9624ee89b9Swdenk=================== 9724ee89b9Swdenk 9824ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 9924ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 10024ee89b9Swdenkin source files etc.). Example: 10124ee89b9Swdenk 10224ee89b9Swdenk This is the README file for the U-Boot project. 10324ee89b9Swdenk 10424ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 10524ee89b9Swdenk 10624ee89b9Swdenk include/asm-ppc/u-boot.h 10724ee89b9Swdenk 10824ee89b9Swdenk #include <asm/u-boot.h> 10924ee89b9Swdenk 11024ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 11124ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 11224ee89b9Swdenk 11324ee89b9Swdenk U_BOOT_VERSION u_boot_logo 11424ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 115c609719bSwdenk 116c609719bSwdenk 11793f19cc0SwdenkVersioning: 11893f19cc0Swdenk=========== 11993f19cc0Swdenk 120360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 121360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 122360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 123360d883aSThomas Webernames consisting of the calendar year and month of the release date. 124360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 125360d883aSThomas Weberreleases in "stable" maintenance trees. 12693f19cc0Swdenk 127360d883aSThomas WeberExamples: 128360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 129360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 1300de21ecbSJelle van der Waa U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release 13193f19cc0Swdenk 13293f19cc0Swdenk 133c609719bSwdenkDirectory Hierarchy: 134c609719bSwdenk==================== 135c609719bSwdenk 1368d321b81SPeter Tyser/arch Architecture specific files 1376eae68e4SMasahiro Yamada /arc Files generic to ARC architecture 1388d321b81SPeter Tyser /arm Files generic to ARM architecture 1398d321b81SPeter Tyser /m68k Files generic to m68k architecture 1408d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1418d321b81SPeter Tyser /mips Files generic to MIPS architecture 142afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 1438d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 14433c7731bSRobert P. J. Day /openrisc Files generic to OpenRISC architecture 145a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1467207b366SRobert P. J. Day /sandbox Files generic to HW-independent "sandbox" 1478d321b81SPeter Tyser /sh Files generic to SH architecture 14833c7731bSRobert P. J. Day /x86 Files generic to x86 architecture 1498d321b81SPeter Tyser/api Machine/arch independent API for external apps 1508d321b81SPeter Tyser/board Board dependent files 151740f7e5cSXu Ziyuan/cmd U-Boot commands functions 1528d321b81SPeter Tyser/common Misc architecture independent functions 1537207b366SRobert P. J. Day/configs Board default configuration files 1548d321b81SPeter Tyser/disk Code for disk drive partition handling 1558d321b81SPeter Tyser/doc Documentation (don't expect too much) 1568d321b81SPeter Tyser/drivers Commonly used device drivers 15733c7731bSRobert P. J. Day/dts Contains Makefile for building internal U-Boot fdt. 1588d321b81SPeter Tyser/examples Example code for standalone applications, etc. 1598d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 1608d321b81SPeter Tyser/include Header Files 1617207b366SRobert P. J. Day/lib Library routines generic to all architectures 1627207b366SRobert P. J. Day/Licenses Various license files 1638d321b81SPeter Tyser/net Networking code 1648d321b81SPeter Tyser/post Power On Self Test 1657207b366SRobert P. J. Day/scripts Various build scripts and Makefiles 1667207b366SRobert P. J. Day/test Various unit test files 1678d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 168c609719bSwdenk 169c609719bSwdenkSoftware Configuration: 170c609719bSwdenk======================= 171c609719bSwdenk 172c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 173c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 174c609719bSwdenk 175c609719bSwdenkThere are two classes of configuration variables: 176c609719bSwdenk 177c609719bSwdenk* Configuration _OPTIONS_: 178c609719bSwdenk These are selectable by the user and have names beginning with 179c609719bSwdenk "CONFIG_". 180c609719bSwdenk 181c609719bSwdenk* Configuration _SETTINGS_: 182c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 183c609719bSwdenk you don't know what you're doing; they have names beginning with 1846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 185c609719bSwdenk 1867207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating 1877207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently, 1887207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel, 1897207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your 1907207b366SRobert P. J. Daybuild. 191c609719bSwdenk 192c609719bSwdenk 193c609719bSwdenkSelection of Processor Architecture and Board Type: 194c609719bSwdenk--------------------------------------------------- 195c609719bSwdenk 196c609719bSwdenkFor all supported boards there are ready-to-use default 197ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig". 198c609719bSwdenk 199c609719bSwdenkExample: For a TQM823L module type: 200c609719bSwdenk 201c609719bSwdenk cd u-boot 202ab584d67SHolger Freyther make TQM823L_defconfig 203c609719bSwdenk 2047207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board 2057207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file 2067207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards. 207c609719bSwdenk 20875b3c3aaSSimon GlassSandbox Environment: 20975b3c3aaSSimon Glass-------------------- 21075b3c3aaSSimon Glass 21175b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox' 21275b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture- 21375b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to 21475b3c3aaSSimon Glassrun some of U-Boot's tests. 21575b3c3aaSSimon Glass 2166b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details. 21775b3c3aaSSimon Glass 21875b3c3aaSSimon Glass 219db910353SSimon GlassBoard Initialisation Flow: 220db910353SSimon Glass-------------------------- 221db910353SSimon Glass 222db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both 2237207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules). 224db910353SSimon Glass 2257207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in 2267207b366SRobert P. J. Daymore detail later in this file. 2277207b366SRobert P. J. Day 2287207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names 2297207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures 2307207b366SRobert P. J. Daymay not conform to this. At least most ARM boards which use 2317207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this. 2327207b366SRobert P. J. Day 2337207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly 2347207b366SRobert P. J. DayCPU-specific) start.S file, such as: 2357207b366SRobert P. J. Day 2367207b366SRobert P. J. Day - arch/arm/cpu/armv7/start.S 2377207b366SRobert P. J. Day - arch/powerpc/cpu/mpc83xx/start.S 2387207b366SRobert P. J. Day - arch/mips/cpu/start.S 2397207b366SRobert P. J. Day 2407207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and 2417207b366SRobert P. J. Daylimitations of each of these functions are described below. 242db910353SSimon Glass 243db910353SSimon Glasslowlevel_init(): 244db910353SSimon Glass - purpose: essential init to permit execution to reach board_init_f() 245db910353SSimon Glass - no global_data or BSS 246db910353SSimon Glass - there is no stack (ARMv7 may have one but it will soon be removed) 247db910353SSimon Glass - must not set up SDRAM or use console 248db910353SSimon Glass - must only do the bare minimum to allow execution to continue to 249db910353SSimon Glass board_init_f() 250db910353SSimon Glass - this is almost never needed 251db910353SSimon Glass - return normally from this function 252db910353SSimon Glass 253db910353SSimon Glassboard_init_f(): 254db910353SSimon Glass - purpose: set up the machine ready for running board_init_r(): 255db910353SSimon Glass i.e. SDRAM and serial UART 256db910353SSimon Glass - global_data is available 257db910353SSimon Glass - stack is in SRAM 258db910353SSimon Glass - BSS is not available, so you cannot use global/static variables, 259db910353SSimon Glass only stack variables and global_data 260db910353SSimon Glass 261db910353SSimon Glass Non-SPL-specific notes: 262db910353SSimon Glass - dram_init() is called to set up DRAM. If already done in SPL this 263db910353SSimon Glass can do nothing 264db910353SSimon Glass 265db910353SSimon Glass SPL-specific notes: 266db910353SSimon Glass - you can override the entire board_init_f() function with your own 267db910353SSimon Glass version as needed. 268db910353SSimon Glass - preloader_console_init() can be called here in extremis 269db910353SSimon Glass - should set up SDRAM, and anything needed to make the UART work 270db910353SSimon Glass - these is no need to clear BSS, it will be done by crt0.S 271db910353SSimon Glass - must return normally from this function (don't call board_init_r() 272db910353SSimon Glass directly) 273db910353SSimon Glass 274db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at 275db910353SSimon Glassthis point the stack and global_data are relocated to below 276db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of 277db910353SSimon Glassmemory. 278db910353SSimon Glass 279db910353SSimon Glassboard_init_r(): 280db910353SSimon Glass - purpose: main execution, common code 281db910353SSimon Glass - global_data is available 282db910353SSimon Glass - SDRAM is available 283db910353SSimon Glass - BSS is available, all static/global variables can be used 284db910353SSimon Glass - execution eventually continues to main_loop() 285db910353SSimon Glass 286db910353SSimon Glass Non-SPL-specific notes: 287db910353SSimon Glass - U-Boot is relocated to the top of memory and is now running from 288db910353SSimon Glass there. 289db910353SSimon Glass 290db910353SSimon Glass SPL-specific notes: 291db910353SSimon Glass - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and 292db910353SSimon Glass CONFIG_SPL_STACK_R_ADDR points into SDRAM 293db910353SSimon Glass - preloader_console_init() can be called here - typically this is 2940680f1b1SLey Foon Tan done by selecting CONFIG_SPL_BOARD_INIT and then supplying a 295db910353SSimon Glass spl_board_init() function containing this call 296db910353SSimon Glass - loads U-Boot or (in falcon mode) Linux 297db910353SSimon Glass 298db910353SSimon Glass 299db910353SSimon Glass 300c609719bSwdenkConfiguration Options: 301c609719bSwdenk---------------------- 302c609719bSwdenk 303c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 304c609719bSwdenksuch information is kept in a configuration file 305c609719bSwdenk"include/configs/<board_name>.h". 306c609719bSwdenk 307c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 308c609719bSwdenk"include/configs/TQM823L.h". 309c609719bSwdenk 310c609719bSwdenk 3117f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 3127f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 3137f6c2cbcSwdenkbuild a config tool - later. 3147f6c2cbcSwdenk 3157f6c2cbcSwdenk 316c609719bSwdenkThe following options need to be configured: 317c609719bSwdenk 3182628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 319c609719bSwdenk 3202628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 3216ccec449SWolfgang Denk 322cf946c6dSLei Wen- Marvell Family Member 323cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 324cf946c6dSLei Wen multiple fs option at one time 325cf946c6dSLei Wen for marvell soc family 326cf946c6dSLei Wen 32766412c63SKumar Gala- 85xx CPU Options: 328ffd06e02SYork Sun CONFIG_SYS_PPC64 329ffd06e02SYork Sun 330ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 331ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 332ffd06e02SYork Sun compliance, among other possible reasons. 333ffd06e02SYork Sun 33466412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 33566412c63SKumar Gala 33666412c63SKumar Gala Defines the core time base clock divider ratio compared to the 33766412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 33866412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 33966412c63SKumar Gala 3408f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3418f29084aSKumar Gala 3428f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3438f29084aSKumar Gala tree nodes for the given platform. 3448f29084aSKumar Gala 34533eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 34633eee330SScott Wood 34733eee330SScott Wood Enables a workaround for erratum A004510. If set, 34833eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 34933eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 35033eee330SScott Wood 35133eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 35233eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 35333eee330SScott Wood 35433eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 35533eee330SScott Wood for which the A004510 workaround should be applied. 35633eee330SScott Wood 35733eee330SScott Wood The rest of SVR is either not relevant to the decision 35833eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 35933eee330SScott Wood p2041) or is implied by the build target, which controls 36033eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 36133eee330SScott Wood 36233eee330SScott Wood See Freescale App Note 4493 for more information about 36333eee330SScott Wood this erratum. 36433eee330SScott Wood 36574fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 36674fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 367b445bbb4SJeremiah Mahler required during NOR boot. 36874fa22edSPrabhakar Kushwaha 3699f074e67SPrabhakar Kushwaha CONFIG_A008044_WORKAROUND 3709f074e67SPrabhakar Kushwaha Enables a workaround for T1040/T1042 erratum A008044. It is only 371b445bbb4SJeremiah Mahler required during NAND boot and valid for Rev 1.0 SoC revision 3729f074e67SPrabhakar Kushwaha 37333eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 37433eee330SScott Wood 37533eee330SScott Wood This is the value to write into CCSR offset 0x18600 37633eee330SScott Wood according to the A004510 workaround. 37733eee330SScott Wood 37864501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 37964501c66SPriyanka Jain This value denotes start offset of DDR memory which is 38064501c66SPriyanka Jain connected exclusively to the DSP cores. 38164501c66SPriyanka Jain 382765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 383765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 384765b0bdbSPriyanka Jain which is directly connected to the DSP core. 385765b0bdbSPriyanka Jain 38664501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 38764501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 38864501c66SPriyanka Jain connected to the DSP core. 38964501c66SPriyanka Jain 390765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 391765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 392765b0bdbSPriyanka Jain 393b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 394b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 395b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 396b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 397b135991aSPriyanka Jain 398fb4a2409SAneesh Bansal CONFIG_SYS_CPC_REINIT_F 399fb4a2409SAneesh Bansal This CONFIG is defined when the CPC is configured as SRAM at the 400a187559eSBin Meng time of U-Boot entry and is required to be re-initialized. 401fb4a2409SAneesh Bansal 402aade2004STang Yuantian CONFIG_DEEP_SLEEP 403b445bbb4SJeremiah Mahler Indicates this SoC supports deep sleep feature. If deep sleep is 404aade2004STang Yuantian supported, core will start to execute uboot when wakes up. 405aade2004STang Yuantian 4066cb461b4SDaniel Schwierzeck- Generic CPU options: 4076cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4086cb461b4SDaniel Schwierzeck 4096cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4106cb461b4SDaniel Schwierzeck values is arch specific. 4116cb461b4SDaniel Schwierzeck 4125614e71bSYork Sun CONFIG_SYS_FSL_DDR 4135614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4145614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4155614e71bSYork Sun SoCs. 4165614e71bSYork Sun 4175614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4185614e71bSYork Sun Freescale DDR memory-mapped register base. 4195614e71bSYork Sun 4205614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4215614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4225614e71bSYork Sun deskew training are not available. 4235614e71bSYork Sun 4245614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4255614e71bSYork Sun Freescale DDR1 controller. 4265614e71bSYork Sun 4275614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4285614e71bSYork Sun Freescale DDR2 controller. 4295614e71bSYork Sun 4305614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 4315614e71bSYork Sun Freescale DDR3 controller. 4325614e71bSYork Sun 43334e026f9SYork Sun CONFIG_SYS_FSL_DDRC_GEN4 43434e026f9SYork Sun Freescale DDR4 controller. 43534e026f9SYork Sun 4369ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 4379ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 4389ac4ffbdSYork Sun 4395614e71bSYork Sun CONFIG_SYS_FSL_DDR1 4405614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 4415614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 4425614e71bSYork Sun implemetation. 4435614e71bSYork Sun 4445614e71bSYork Sun CONFIG_SYS_FSL_DDR2 44562a3b7ddSRobert P. J. Day Board config to use DDR2. It can be enabled for SoCs with 4465614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 4475614e71bSYork Sun implementation. 4485614e71bSYork Sun 4495614e71bSYork Sun CONFIG_SYS_FSL_DDR3 4505614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 45134e026f9SYork Sun Freescale DDR3 or DDR3L controllers. 45234e026f9SYork Sun 45334e026f9SYork Sun CONFIG_SYS_FSL_DDR3L 45434e026f9SYork Sun Board config to use DDR3L. It can be enabled for SoCs with 45534e026f9SYork Sun DDR3L controllers. 45634e026f9SYork Sun 45734e026f9SYork Sun CONFIG_SYS_FSL_DDR4 45834e026f9SYork Sun Board config to use DDR4. It can be enabled for SoCs with 45934e026f9SYork Sun DDR4 controllers. 4605614e71bSYork Sun 4611b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_BE 4621b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Big Endian 4631b4175d6SPrabhakar Kushwaha 4641b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_LE 4651b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Little Endian 4661b4175d6SPrabhakar Kushwaha 4671c40707eSPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_CLK_DIV 4681c40707eSPrabhakar Kushwaha Defines divider of platform clock(clock input to IFC controller). 4691c40707eSPrabhakar Kushwaha 470add63f94SPrabhakar Kushwaha CONFIG_SYS_FSL_LBC_CLK_DIV 471add63f94SPrabhakar Kushwaha Defines divider of platform clock(clock input to eLBC controller). 472add63f94SPrabhakar Kushwaha 473690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_PBI 474690e4258SPrabhakar Kushwaha It enables addition of RCW (Power on reset configuration) in built image. 475690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 476690e4258SPrabhakar Kushwaha 477690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_RCW 478690e4258SPrabhakar Kushwaha It adds PBI(pre-boot instructions) commands in u-boot build image. 479690e4258SPrabhakar Kushwaha PBI commands can be used to configure SoC before it starts the execution. 480690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 481690e4258SPrabhakar Kushwaha 48289ad7be8SPrabhakar Kushwaha CONFIG_SPL_FSL_PBL 48389ad7be8SPrabhakar Kushwaha It adds a target to create boot binary having SPL binary in PBI format 48489ad7be8SPrabhakar Kushwaha concatenated with u-boot binary. 48589ad7be8SPrabhakar Kushwaha 4864e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_BE 4874e5b1bd0SYork Sun Defines the DDR controller register space as Big Endian 4884e5b1bd0SYork Sun 4894e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_LE 4904e5b1bd0SYork Sun Defines the DDR controller register space as Little Endian 4914e5b1bd0SYork Sun 4926b9e309aSYork Sun CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 4936b9e309aSYork Sun Physical address from the view of DDR controllers. It is the 4946b9e309aSYork Sun same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 4956b9e309aSYork Sun it could be different for ARM SoCs. 4966b9e309aSYork Sun 4976b1e1254SYork Sun CONFIG_SYS_FSL_DDR_INTLV_256B 4986b1e1254SYork Sun DDR controller interleaving on 256-byte. This is a special 4996b1e1254SYork Sun interleaving mode, handled by Dickens for Freescale layerscape 5006b1e1254SYork Sun SoCs with ARM core. 5016b1e1254SYork Sun 5021d71efbbSYork Sun CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS 5031d71efbbSYork Sun Number of controllers used as main memory. 5041d71efbbSYork Sun 5051d71efbbSYork Sun CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS 5061d71efbbSYork Sun Number of controllers used for other than main memory. 5071d71efbbSYork Sun 50844937214SPrabhakar Kushwaha CONFIG_SYS_FSL_HAS_DP_DDR 50944937214SPrabhakar Kushwaha Defines the SoC has DP-DDR used for DPAA. 51044937214SPrabhakar Kushwaha 511028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_BE 512028dbb8dSRuchika Gupta Defines the SEC controller register space as Big Endian 513028dbb8dSRuchika Gupta 514028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_LE 515028dbb8dSRuchika Gupta Defines the SEC controller register space as Little Endian 516028dbb8dSRuchika Gupta 51792bbd64eSDaniel Schwierzeck- MIPS CPU options: 51892bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 51992bbd64eSDaniel Schwierzeck 52092bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 52192bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 52292bbd64eSDaniel Schwierzeck relocation. 52392bbd64eSDaniel Schwierzeck 52492bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 52592bbd64eSDaniel Schwierzeck 52692bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 52792bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 52892bbd64eSDaniel Schwierzeck Possible values are: 52992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 53092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 53192bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 53292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 53392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 53492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 53592bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 53692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 53792bbd64eSDaniel Schwierzeck 53892bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 53992bbd64eSDaniel Schwierzeck 54092bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 54192bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 54292bbd64eSDaniel Schwierzeck 54392bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 54492bbd64eSDaniel Schwierzeck 54592bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 54692bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 54792bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 54892bbd64eSDaniel Schwierzeck 549b67d8816SChristian Riesch- ARM options: 550b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 551b67d8816SChristian Riesch 552b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 553b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 554b67d8816SChristian Riesch 555207774b2SYork Sun COUNTER_FREQUENCY 556207774b2SYork Sun Generic timer clock source frequency. 557207774b2SYork Sun 558207774b2SYork Sun COUNTER_FREQUENCY_REAL 559207774b2SYork Sun Generic timer clock source frequency if the real clock is 560207774b2SYork Sun different from COUNTER_FREQUENCY, and can only be determined 561207774b2SYork Sun at run time. 562207774b2SYork Sun 56373c38934SStephen Warren- Tegra SoC options: 56473c38934SStephen Warren CONFIG_TEGRA_SUPPORT_NON_SECURE 56573c38934SStephen Warren 56673c38934SStephen Warren Support executing U-Boot in non-secure (NS) mode. Certain 56773c38934SStephen Warren impossible actions will be skipped if the CPU is in NS mode, 56873c38934SStephen Warren such as ARM architectural timer initialization. 56973c38934SStephen Warren 5705da627a4Swdenk- Linux Kernel Interface: 571c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 572c609719bSwdenk 573c609719bSwdenk U-Boot stores all clock information in Hz 574c609719bSwdenk internally. For binary compatibility with older Linux 575c609719bSwdenk kernels (which expect the clocks passed in the 576c609719bSwdenk bd_info data to be in MHz) the environment variable 577c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 578c609719bSwdenk converts clock data to MHZ before passing it to the 579c609719bSwdenk Linux kernel. 580c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 581c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 582c609719bSwdenk default environment. 583c609719bSwdenk 5845da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 5855da627a4Swdenk 586b445bbb4SJeremiah Mahler When transferring memsize parameter to Linux, some versions 5875da627a4Swdenk expect it to be in bytes, others in MB. 5885da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 5895da627a4Swdenk 590fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 591f57f70aaSWolfgang Denk 592f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 593213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 594213bf8c8SGerald Van Baren concepts). 595213bf8c8SGerald Van Baren 596213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 597213bf8c8SGerald Van Baren * New libfdt-based support 598213bf8c8SGerald Van Baren * Adds the "fdt" command 5993bb342fcSKim Phillips * The bootm command automatically updates the fdt 600213bf8c8SGerald Van Baren 601f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 602c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 603f57f70aaSWolfgang Denk 60411ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 60511ccc33fSMarcel Ziswiler addresses 6063bb342fcSKim Phillips 6074e253137SKumar Gala CONFIG_OF_BOARD_SETUP 6084e253137SKumar Gala 6094e253137SKumar Gala Board code has addition modification that it wants to make 6104e253137SKumar Gala to the flat device tree before handing it off to the kernel 6116705d81eSwdenk 612c654b517SSimon Glass CONFIG_OF_SYSTEM_SETUP 613c654b517SSimon Glass 614c654b517SSimon Glass Other code has addition modification that it wants to make 615c654b517SSimon Glass to the flat device tree before handing it off to the kernel. 616c654b517SSimon Glass This causes ft_system_setup() to be called before booting 617c654b517SSimon Glass the kernel. 618c654b517SSimon Glass 6193887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 6203887c3fbSHeiko Schocher 6213887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 6223887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 6233887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 6243887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 6253887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 6263887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 6273887c3fbSHeiko Schocher 6287eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 6297eb29398SIgor Grinberg 6307eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 6317eb29398SIgor Grinberg machine type and must be used to specify the machine type 6327eb29398SIgor Grinberg number as it appears in the ARM machine registry 6337eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 6347eb29398SIgor Grinberg Only boards that have multiple machine types supported 6357eb29398SIgor Grinberg in a single configuration file and the machine type is 6367eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 6377eb29398SIgor Grinberg 6380b2f4ecaSNiklaus Giger- vxWorks boot parameters: 6390b2f4ecaSNiklaus Giger 6400b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 6419e98b7e3SBin Meng environments variables: bootdev, bootfile, ipaddr, netmask, 6429e98b7e3SBin Meng serverip, gatewayip, hostname, othbootargs. 6430b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 6440b2f4ecaSNiklaus Giger 6450b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 6460b2f4ecaSNiklaus Giger the defaults discussed just above. 6470b2f4ecaSNiklaus Giger 6482c451f78SAneesh V- Cache Configuration: 6492c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 6502c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 6512c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 6522c451f78SAneesh V 65393bc2193SAneesh V- Cache Configuration for ARM: 65493bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 65593bc2193SAneesh V controller 65693bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 65793bc2193SAneesh V controller register space 65893bc2193SAneesh V 6596705d81eSwdenk- Serial Ports: 66048d0192fSAndreas Engel CONFIG_PL010_SERIAL 6616705d81eSwdenk 6626705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 6636705d81eSwdenk 66448d0192fSAndreas Engel CONFIG_PL011_SERIAL 6656705d81eSwdenk 6666705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 6676705d81eSwdenk 6686705d81eSwdenk CONFIG_PL011_CLOCK 6696705d81eSwdenk 6706705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 6716705d81eSwdenk the clock speed of the UARTs. 6726705d81eSwdenk 6736705d81eSwdenk CONFIG_PL01x_PORTS 6746705d81eSwdenk 6756705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 6766705d81eSwdenk define this to a list of base addresses for each (supported) 6776705d81eSwdenk port. See e.g. include/configs/versatile.h 6786705d81eSwdenk 679d57dee57SKaricheri, Muralidharan CONFIG_SERIAL_HW_FLOW_CONTROL 680d57dee57SKaricheri, Muralidharan 681d57dee57SKaricheri, Muralidharan Define this variable to enable hw flow control in serial driver. 682d57dee57SKaricheri, Muralidharan Current user of this option is drivers/serial/nsl16550.c driver 6836705d81eSwdenk 684c609719bSwdenk- Console Baudrate: 685c609719bSwdenk CONFIG_BAUDRATE - in bps 686c609719bSwdenk Select one of the baudrates listed in 6876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 688c609719bSwdenk 689c609719bSwdenk- Autoboot Command: 690c609719bSwdenk CONFIG_BOOTCOMMAND 691c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 692c609719bSwdenk define a command string that is automatically executed 693c609719bSwdenk when no character is read on the console interface 694c609719bSwdenk within "Boot Delay" after reset. 695c609719bSwdenk 696c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 697c609719bSwdenk The value of these goes into the environment as 698c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 699c609719bSwdenk as a convenience, when switching between booting from 70011ccc33fSMarcel Ziswiler RAM and NFS. 701c609719bSwdenk 702eda0ba38SHeiko Schocher- Bootcount: 703eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 704eda0ba38SHeiko Schocher Implements a mechanism for detecting a repeating reboot 705eda0ba38SHeiko Schocher cycle, see: 706eda0ba38SHeiko Schocher http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 707eda0ba38SHeiko Schocher 708eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_ENV 709eda0ba38SHeiko Schocher If no softreset save registers are found on the hardware 710eda0ba38SHeiko Schocher "bootcount" is stored in the environment. To prevent a 711eda0ba38SHeiko Schocher saveenv on all reboots, the environment variable 712eda0ba38SHeiko Schocher "upgrade_available" is used. If "upgrade_available" is 713eda0ba38SHeiko Schocher 0, "bootcount" is always 0, if "upgrade_available" is 714eda0ba38SHeiko Schocher 1 "bootcount" is incremented in the environment. 715eda0ba38SHeiko Schocher So the Userspace Applikation must set the "upgrade_available" 716eda0ba38SHeiko Schocher and "bootcount" variable to 0, if a boot was successfully. 717eda0ba38SHeiko Schocher 718c609719bSwdenk- Pre-Boot Commands: 719c609719bSwdenk CONFIG_PREBOOT 720c609719bSwdenk 721c609719bSwdenk When this option is #defined, the existence of the 722c609719bSwdenk environment variable "preboot" will be checked 723c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 724c609719bSwdenk countdown and/or running the auto-boot command resp. 725c609719bSwdenk entering interactive mode. 726c609719bSwdenk 727c609719bSwdenk This feature is especially useful when "preboot" is 728c609719bSwdenk automatically generated or modified. For an example 729c609719bSwdenk see the LWMON board specific code: here "preboot" is 730c609719bSwdenk modified when the user holds down a certain 731c609719bSwdenk combination of keys on the (special) keyboard when 732c609719bSwdenk booting the systems 733c609719bSwdenk 734c609719bSwdenk- Serial Download Echo Mode: 735c609719bSwdenk CONFIG_LOADS_ECHO 736c609719bSwdenk If defined to 1, all characters received during a 737c609719bSwdenk serial download (using the "loads" command) are 738c609719bSwdenk echoed back. This might be needed by some terminal 739c609719bSwdenk emulations (like "cu"), but may as well just take 740c609719bSwdenk time on others. This setting #define's the initial 741c609719bSwdenk value of the "loads_echo" environment variable. 742c609719bSwdenk 743602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 744c609719bSwdenk CONFIG_KGDB_BAUDRATE 745c609719bSwdenk Select one of the baudrates listed in 7466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 747c609719bSwdenk 748302a6487SSimon Glass- Removal of commands 749302a6487SSimon Glass If no commands are needed to boot, you can disable 750302a6487SSimon Glass CONFIG_CMDLINE to remove them. In this case, the command line 751302a6487SSimon Glass will not be available, and when U-Boot wants to execute the 752302a6487SSimon Glass boot command (on start-up) it will call board_run_command() 753302a6487SSimon Glass instead. This can reduce image size significantly for very 754302a6487SSimon Glass simple boot procedures. 755302a6487SSimon Glass 756a5ecbe62SWolfgang Denk- Regular expression support: 757a5ecbe62SWolfgang Denk CONFIG_REGEX 758a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 759a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 760a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 761a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 762a5ecbe62SWolfgang Denk 76345ba8077SSimon Glass- Device tree: 76445ba8077SSimon Glass CONFIG_OF_CONTROL 76545ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 76645ba8077SSimon Glass to configure its devices, instead of relying on statically 76745ba8077SSimon Glass compiled #defines in the board file. This option is 76845ba8077SSimon Glass experimental and only available on a few boards. The device 76945ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 77045ba8077SSimon Glass 7712c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 77282f766d1SAlex Deymo be done using one of the three options below: 773bbb0b128SSimon Glass 774bbb0b128SSimon Glass CONFIG_OF_EMBED 775bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 776bbb0b128SSimon Glass binary in its image. This device tree file should be in the 777bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 778bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 779eb3eb602SNobuhiro Iwamatsu the global data structure as gd->fdt_blob. 78045ba8077SSimon Glass 7812c0f79e4SSimon Glass CONFIG_OF_SEPARATE 7822c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 7832c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 7842c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 7852c0f79e4SSimon Glass 7862c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 7872c0f79e4SSimon Glass 7882c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 7892c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 7902c0f79e4SSimon Glass still use the individual files if you need something more 7912c0f79e4SSimon Glass exotic. 7922c0f79e4SSimon Glass 79382f766d1SAlex Deymo CONFIG_OF_BOARD 79482f766d1SAlex Deymo If this variable is defined, U-Boot will use the device tree 79582f766d1SAlex Deymo provided by the board at runtime instead of embedding one with 79682f766d1SAlex Deymo the image. Only boards defining board_fdt_blob_setup() support 79782f766d1SAlex Deymo this option (see include/fdtdec.h file). 79882f766d1SAlex Deymo 799c609719bSwdenk- Watchdog: 800c609719bSwdenk CONFIG_WATCHDOG 801c609719bSwdenk If this variable is defined, it enables watchdog 8026abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 803907208c4SChristophe Leroy specific code for a watchdog. For the 8xx 804907208c4SChristophe Leroy CPUs, the SIU Watchdog feature is enabled in the SYPCR 805907208c4SChristophe Leroy register. When supported for a specific SoC is 806907208c4SChristophe Leroy available, then no further board specific code should 807907208c4SChristophe Leroy be needed to use it. 8086abe6fb6SDetlev Zundel 8096abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 8106abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 8116abe6fb6SDetlev Zundel SoC, then define this variable and provide board 8126abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 813c609719bSwdenk 8147bae0d6fSHeiko Schocher CONFIG_AT91_HW_WDT_TIMEOUT 8157bae0d6fSHeiko Schocher specify the timeout in seconds. default 2 seconds. 8167bae0d6fSHeiko Schocher 817c1551ea8Sstroese- U-Boot Version: 818c1551ea8Sstroese CONFIG_VERSION_VARIABLE 819c1551ea8Sstroese If this variable is defined, an environment variable 820c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 821c1551ea8Sstroese version as printed by the "version" command. 822a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 823a1ea8e51SBenoît Thébaudeau next reset. 824c1551ea8Sstroese 825c609719bSwdenk- Real-Time Clock: 826c609719bSwdenk 827602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 828c609719bSwdenk has to be selected, too. Define exactly one of the 829c609719bSwdenk following options: 830c609719bSwdenk 831c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 8324e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 833c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 8341cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 835c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 8367f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 837412921d2SMarkus Niebel CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC 8383bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 8399536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 8404c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 8412bd3cab3SChris Packham CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 84271d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 84371d19f30SHeiko Schocher RV3029 RTC. 844c609719bSwdenk 845b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 846b37c7e5eSwdenk must also be configured. See I2C Support, below. 847b37c7e5eSwdenk 848e92739d3SPeter Tyser- GPIO Support: 849e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 850e92739d3SPeter Tyser 8515dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 8525dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 8535dec49caSChris Packham pins supported by a particular chip. 8545dec49caSChris Packham 855e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 856e92739d3SPeter Tyser must also be configured. See I2C Support, below. 857e92739d3SPeter Tyser 858aa53233aSSimon Glass- I/O tracing: 859aa53233aSSimon Glass When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O 860aa53233aSSimon Glass accesses and can checksum them or write a list of them out 861aa53233aSSimon Glass to memory. See the 'iotrace' command for details. This is 862aa53233aSSimon Glass useful for testing device drivers since it can confirm that 863aa53233aSSimon Glass the driver behaves the same way before and after a code 864aa53233aSSimon Glass change. Currently this is supported on sandbox and arm. To 865aa53233aSSimon Glass add support for your architecture, add '#include <iotrace.h>' 866aa53233aSSimon Glass to the bottom of arch/<arch>/include/asm/io.h and test. 867aa53233aSSimon Glass 868aa53233aSSimon Glass Example output from the 'iotrace stats' command is below. 869aa53233aSSimon Glass Note that if the trace buffer is exhausted, the checksum will 870aa53233aSSimon Glass still continue to operate. 871aa53233aSSimon Glass 872aa53233aSSimon Glass iotrace is enabled 873aa53233aSSimon Glass Start: 10000000 (buffer start address) 874aa53233aSSimon Glass Size: 00010000 (buffer size) 875aa53233aSSimon Glass Offset: 00000120 (current buffer offset) 876aa53233aSSimon Glass Output: 10000120 (start + offset) 877aa53233aSSimon Glass Count: 00000018 (number of trace records) 878aa53233aSSimon Glass CRC32: 9526fb66 (CRC32 of all trace records) 879aa53233aSSimon Glass 880c609719bSwdenk- Timestamp Support: 881c609719bSwdenk 882c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 883c609719bSwdenk (date and time) of an image is printed by image 884c609719bSwdenk commands like bootm or iminfo. This option is 885602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 886c609719bSwdenk 887923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 888923c46f9SKarl O. Pinc Zero or more of the following: 889923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 890923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 891923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 892923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 893923c46f9SKarl O. Pinc disk/part_efi.c 894923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 895c609719bSwdenk 896fc843a02SSimon Glass If IDE or SCSI support is enabled (CONFIG_IDE or 897c649e3c9SSimon Glass CONFIG_SCSI) you must configure support for at 898923c46f9SKarl O. Pinc least one non-MTD partition type as well. 899c609719bSwdenk 900c609719bSwdenk- IDE Reset method: 9014d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 9024d13cbadSwdenk board configurations files but used nowhere! 903c609719bSwdenk 9044d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 9054d13cbadSwdenk be performed by calling the function 9064d13cbadSwdenk ide_set_reset(int reset) 9074d13cbadSwdenk which has to be defined in a board specific file 908c609719bSwdenk 909c609719bSwdenk- ATAPI Support: 910c609719bSwdenk CONFIG_ATAPI 911c609719bSwdenk 912c609719bSwdenk Set this to enable ATAPI support. 913c609719bSwdenk 914c40b2956Swdenk- LBA48 Support 915c40b2956Swdenk CONFIG_LBA48 916c40b2956Swdenk 917c40b2956Swdenk Set this to enable support for disks larger than 137GB 9184b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 919c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 920c40b2956Swdenk support disks up to 2.1TB. 921c40b2956Swdenk 9226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 923c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 924c40b2956Swdenk Default is 32bit. 925c40b2956Swdenk 926c609719bSwdenk- SCSI Support: 9276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 9286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 9296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 930c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 931c609719bSwdenk devices. 932c609719bSwdenk 933447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 934447c031bSStefan Reinauer SCSI devices found during the last scan. 935447c031bSStefan Reinauer 936c609719bSwdenk- NETWORK Support (PCI): 937682011ffSwdenk CONFIG_E1000 938ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 939ce5207e1SKyle Moffett 940ce5207e1SKyle Moffett CONFIG_E1000_SPI 941ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 942ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 943ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 944ce5207e1SKyle Moffett 945ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 946ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 947ce5207e1SKyle Moffett example with the "sspi" command. 948ce5207e1SKyle Moffett 949c609719bSwdenk CONFIG_EEPRO100 950c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 95111ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 952c609719bSwdenk write routine for first time initialisation. 953c609719bSwdenk 954c609719bSwdenk CONFIG_TULIP 955c609719bSwdenk Support for Digital 2114x chips. 956c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 957c609719bSwdenk modem chip initialisation (KS8761/QS6611). 958c609719bSwdenk 959c609719bSwdenk CONFIG_NATSEMI 960c609719bSwdenk Support for National dp83815 chips. 961c609719bSwdenk 962c609719bSwdenk CONFIG_NS8382X 963c609719bSwdenk Support for National dp8382[01] gigabit chips. 964c609719bSwdenk 96545219c46Swdenk- NETWORK Support (other): 96645219c46Swdenk 967c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 968c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 969c041e9d2SJens Scharsig 970c041e9d2SJens Scharsig CONFIG_RMII 971c041e9d2SJens Scharsig Define this to use reduced MII inteface 972c041e9d2SJens Scharsig 973c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 974c041e9d2SJens Scharsig If this defined, the driver is quiet. 975c041e9d2SJens Scharsig The driver doen't show link status messages. 976c041e9d2SJens Scharsig 977efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 978efdd7319SRob Herring Support for the Calxeda XGMAC device 979efdd7319SRob Herring 9803bb46d23SAshok CONFIG_LAN91C96 98145219c46Swdenk Support for SMSC's LAN91C96 chips. 98245219c46Swdenk 98345219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 98445219c46Swdenk Define this to enable 32 bit addressing 98545219c46Swdenk 9863bb46d23SAshok CONFIG_SMC91111 987f39748aeSwdenk Support for SMSC's LAN91C111 chip 988f39748aeSwdenk 989f39748aeSwdenk CONFIG_SMC91111_BASE 990f39748aeSwdenk Define this to hold the physical address 991f39748aeSwdenk of the device (I/O space) 992f39748aeSwdenk 993f39748aeSwdenk CONFIG_SMC_USE_32_BIT 994f39748aeSwdenk Define this if data bus is 32 bits 995f39748aeSwdenk 996f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 997f39748aeSwdenk Define this to use i/o functions instead of macros 998f39748aeSwdenk (some hardware wont work with macros) 999f39748aeSwdenk 1000dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1001dc02badaSHeiko Schocher Support for davinci emac 1002dc02badaSHeiko Schocher 1003dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1004dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1005dc02badaSHeiko Schocher 1006b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1007b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1008b3dbf4a5SMacpaul Lin 1009b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1010b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1011b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1012b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1013b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1014b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1015b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1016b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1017b3dbf4a5SMacpaul Lin 1018c2fff331SMike Rapoport CONFIG_SMC911X 1019557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1020557b377dSJens Gehrlein 1021c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1022557b377dSJens Gehrlein Define this to hold the physical address 1023557b377dSJens Gehrlein of the device (I/O space) 1024557b377dSJens Gehrlein 1025c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1026557b377dSJens Gehrlein Define this if data bus is 32 bits 1027557b377dSJens Gehrlein 1028c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1029557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1030557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1031c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1032557b377dSJens Gehrlein 10333d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 10343d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 10353d0075faSYoshihiro Shimoda 10363d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 10373d0075faSYoshihiro Shimoda Define the number of ports to be used 10383d0075faSYoshihiro Shimoda 10393d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 10403d0075faSYoshihiro Shimoda Define the ETH PHY's address 10413d0075faSYoshihiro Shimoda 104268260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 104368260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 104468260aabSYoshihiro Shimoda 1045b2f97cf2SHeiko Schocher- PWM Support: 1046b2f97cf2SHeiko Schocher CONFIG_PWM_IMX 10475052e819SRobert P. J. Day Support for PWM module on the imx6. 1048b2f97cf2SHeiko Schocher 10495e124724SVadim Bendebury- TPM Support: 105090899cc0SChe-liang Chiou CONFIG_TPM 105190899cc0SChe-liang Chiou Support TPM devices. 105290899cc0SChe-liang Chiou 10530766ad2fSChristophe Ricard CONFIG_TPM_TIS_INFINEON 10540766ad2fSChristophe Ricard Support for Infineon i2c bus TPM devices. Only one device 10551b393db5STom Wai-Hong Tam per system is supported at this time. 10561b393db5STom Wai-Hong Tam 10571b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 10581b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 10591b393db5STom Wai-Hong Tam 10603aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24 10613aa74088SChristophe Ricard Support for STMicroelectronics TPM devices. Requires DM_TPM support. 10623aa74088SChristophe Ricard 10633aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24_I2C 10643aa74088SChristophe Ricard Support for STMicroelectronics ST33ZP24 I2C devices. 10653aa74088SChristophe Ricard Requires TPM_ST33ZP24 and I2C. 10663aa74088SChristophe Ricard 1067b75fdc11SChristophe Ricard CONFIG_TPM_ST33ZP24_SPI 1068b75fdc11SChristophe Ricard Support for STMicroelectronics ST33ZP24 SPI devices. 1069b75fdc11SChristophe Ricard Requires TPM_ST33ZP24 and SPI. 1070b75fdc11SChristophe Ricard 1071c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1072c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1073c01939c7SDirk Eibach 107490899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 10755e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 10765e124724SVadim Bendebury per system is supported at this time. 10775e124724SVadim Bendebury 10785e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 10795e124724SVadim Bendebury Base address where the generic TPM device is mapped 10805e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 10815e124724SVadim Bendebury 0xfed40000. 10825e124724SVadim Bendebury 1083be6c1529SReinhard Pfau CONFIG_TPM 1084be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1085be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1086be6c1529SReinhard Pfau Requires support for a TPM device. 1087be6c1529SReinhard Pfau 1088be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1089be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1090be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1091be6c1529SReinhard Pfau 1092c609719bSwdenk- USB Support: 1093c609719bSwdenk At the moment only the UHCI host controller is 1094064b55cfSHeiko Schocher supported (PIP405, MIP405); define 1095c609719bSwdenk CONFIG_USB_UHCI to enable it. 1096c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 109730d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1098c609719bSwdenk storage devices. 1099c609719bSwdenk Note: 1100c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1101c609719bSwdenk (TEAC FD-05PUB). 11024d13cbadSwdenk 11039ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 11049ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 11059ab4ce22SSimon Glass 11066e9e0626SOleksandr Tymoshenko CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 11076e9e0626SOleksandr Tymoshenko HW module registers. 11086e9e0626SOleksandr Tymoshenko 110916c8d5e7SWolfgang Denk- USB Device: 111016c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 111116c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 111216c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 111311ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 111416c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 111516c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 111616c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 111716c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 111816c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 111916c8d5e7SWolfgang Denk a Linux host by 112016c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 112116c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 112216c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 112316c8d5e7SWolfgang Denk might be defined in YourBoardName.h 112416c8d5e7SWolfgang Denk 112516c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 112616c8d5e7SWolfgang Denk Define this to build a UDC device 112716c8d5e7SWolfgang Denk 112816c8d5e7SWolfgang Denk CONFIG_USB_TTY 112916c8d5e7SWolfgang Denk Define this to have a tty type of device available to 113016c8d5e7SWolfgang Denk talk to the UDC device 113116c8d5e7SWolfgang Denk 1132f9da0f89SVipin KUMAR CONFIG_USBD_HS 1133f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1134f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1135f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1136f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1137f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1138f9da0f89SVipin KUMAR speed. 1139f9da0f89SVipin KUMAR 11406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 114116c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 114216c8d5e7SWolfgang Denk be set to usbtty. 114316c8d5e7SWolfgang Denk 114416c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 114516c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 114616c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 114716c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 114816c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 114916c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 115016c8d5e7SWolfgang Denk 115116c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 115216c8d5e7SWolfgang Denk Define this string as the name of your company for 115316c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 115416c8d5e7SWolfgang Denk 115516c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 115616c8d5e7SWolfgang Denk Define this string as the name of your product 115716c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 115816c8d5e7SWolfgang Denk 115916c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 116016c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 116116c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 116216c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 116316c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 116416c8d5e7SWolfgang Denk 116516c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 116616c8d5e7SWolfgang Denk Define this as the unique Product ID 116716c8d5e7SWolfgang Denk for your device 116816c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1169c609719bSwdenk 1170d70a560fSIgor Grinberg- ULPI Layer Support: 1171d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1172d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1173d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1174d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1175d70a560fSIgor Grinberg viewport is supported. 1176d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1177d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 11786d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 11796d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 11806d365ea0SLucas Stach the appropriate value in Hz. 1181c609719bSwdenk 1182c609719bSwdenk- MMC Support: 1183c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1184c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1185c609719bSwdenk accessed from the boot prompt by mapping the device 1186c609719bSwdenk to physical memory similar to flash. Command line is 1187602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1188602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1189c609719bSwdenk 1190afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1191afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1192afb35666SYoshihiro Shimoda 1193afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1194afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1195afb35666SYoshihiro Shimoda 1196afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1197afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1198afb35666SYoshihiro Shimoda 11991fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_BOOT 12001fd93c6eSPierre Aubert Enable some additional features of the eMMC boot partitions. 12011fd93c6eSPierre Aubert 12021fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_RPMB 12031fd93c6eSPierre Aubert Enable the commands for reading, writing and programming the 12041fd93c6eSPierre Aubert key for the Replay Protection Memory Block partition in eMMC. 12051fd93c6eSPierre Aubert 1206b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 120701acd6abSPaul Kocialkowski CONFIG_USB_FUNCTION_DFU 1208b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1209b3ba6e94STom Rini 1210b3ba6e94STom Rini CONFIG_DFU_MMC 1211b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1212b3ba6e94STom Rini 1213c6631764SPantelis Antoniou CONFIG_DFU_NAND 1214c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1215c6631764SPantelis Antoniou 1216a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1217a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1218a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1219a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1220a9479f04SAfzal Mohammed one that would help mostly the developer. 1221a9479f04SAfzal Mohammed 1222e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1223e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1224e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1225e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1226e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1227e7e75c70SHeiko Schocher 1228ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1229ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1230ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1231ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1232ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1233ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1234ea2453d5SPantelis Antoniou 1235001a8319SHeiko Schocher DFU_DEFAULT_POLL_TIMEOUT 1236001a8319SHeiko Schocher Poll timeout [ms], is the timeout a device can send to the 1237001a8319SHeiko Schocher host. The host must wait for this timeout before sending 1238001a8319SHeiko Schocher a subsequent DFU_GET_STATUS request to the device. 1239001a8319SHeiko Schocher 1240001a8319SHeiko Schocher DFU_MANIFEST_POLL_TIMEOUT 1241001a8319SHeiko Schocher Poll timeout [ms], which the device sends to the host when 1242001a8319SHeiko Schocher entering dfuMANIFEST state. Host waits this timeout, before 1243001a8319SHeiko Schocher sending again an USB request to the device. 1244001a8319SHeiko Schocher 124567dac674SAlex Deymo- Android Bootloader support: 124606f4a874SAlex Deymo CONFIG_CMD_BOOT_ANDROID 124706f4a874SAlex Deymo This enables the command "boot_android" which executes the 124806f4a874SAlex Deymo Android Bootloader flow. Enabling CONFIG_CMD_FASTBOOT is 124906f4a874SAlex Deymo recommended to support the Android Fastboot protocol as part 125006f4a874SAlex Deymo of the bootloader. 125106f4a874SAlex Deymo 125267dac674SAlex Deymo CONFIG_ANDROID_BOOTLOADER 125367dac674SAlex Deymo This enables support for the Android bootloader flow. Android 125467dac674SAlex Deymo devices can boot in normal mode, recovery mode or bootloader 125567dac674SAlex Deymo mode. The normal mode is the most common boot mode, but 125667dac674SAlex Deymo recovery mode is often used to perform factory reset and OTA 125767dac674SAlex Deymo (over-the-air) updates in the legacy updater. Also it is 125867dac674SAlex Deymo possible for an Android system to request a reboot to the 125967dac674SAlex Deymo "bootloader", which often means reboot to fastboot but may also 126067dac674SAlex Deymo include a UI with a menu. 126167dac674SAlex Deymo 126267dac674SAlex Deymo CONFIG_ANDROID_BOOT_IMAGE 126367dac674SAlex Deymo This enables support for booting images which use the Android 126467dac674SAlex Deymo image format header. 126567dac674SAlex Deymo 126667dac674SAlex Deymo- USB Device Android Fastboot support: 126767dac674SAlex Deymo CONFIG_USB_FUNCTION_FASTBOOT 126867dac674SAlex Deymo This enables the USB part of the fastboot gadget 126967dac674SAlex Deymo 127067dac674SAlex Deymo CONFIG_CMD_FASTBOOT 127167dac674SAlex Deymo This enables the command "fastboot" which enables the Android 127267dac674SAlex Deymo fastboot mode for the platform's USB device. Fastboot is a USB 127367dac674SAlex Deymo protocol for downloading images, flashing and device control 127467dac674SAlex Deymo used on Android devices. 127567dac674SAlex Deymo See doc/README.android-fastboot for more information. 127667dac674SAlex Deymo 127767dac674SAlex Deymo CONFIG_FASTBOOT_BUF_ADDR 127867dac674SAlex Deymo The fastboot protocol requires a large memory buffer for 127967dac674SAlex Deymo downloads. Define this to the starting RAM address to use for 128067dac674SAlex Deymo downloaded images. 128167dac674SAlex Deymo 128267dac674SAlex Deymo CONFIG_FASTBOOT_BUF_SIZE 128367dac674SAlex Deymo The fastboot protocol requires a large memory buffer for 128467dac674SAlex Deymo downloads. This buffer should be as large as possible for a 128567dac674SAlex Deymo platform. Define this to the size available RAM for fastboot. 128667dac674SAlex Deymo 128767dac674SAlex Deymo CONFIG_FASTBOOT_FLASH 128867dac674SAlex Deymo The fastboot protocol includes a "flash" command for writing 128967dac674SAlex Deymo the downloaded image to a non-volatile storage device. Define 129067dac674SAlex Deymo this to enable the "fastboot flash" command. 129167dac674SAlex Deymo 129267dac674SAlex Deymo CONFIG_FASTBOOT_FLASH_MMC_DEV 129367dac674SAlex Deymo The fastboot "flash" command requires additional information 129467dac674SAlex Deymo regarding the non-volatile storage device. Define this to 129567dac674SAlex Deymo the eMMC device that fastboot should use to store the image. 129667dac674SAlex Deymo 129767dac674SAlex Deymo CONFIG_FASTBOOT_GPT_NAME 129867dac674SAlex Deymo The fastboot "flash" command supports writing the downloaded 129967dac674SAlex Deymo image to the Protective MBR and the Primary GUID Partition 130067dac674SAlex Deymo Table. (Additionally, this downloaded image is post-processed 130167dac674SAlex Deymo to generate and write the Backup GUID Partition Table.) 130267dac674SAlex Deymo This occurs when the specified "partition name" on the 130367dac674SAlex Deymo "fastboot flash" command line matches this value. 130467dac674SAlex Deymo The default is "gpt" if undefined. 130567dac674SAlex Deymo 130667dac674SAlex Deymo CONFIG_FASTBOOT_MBR_NAME 130767dac674SAlex Deymo The fastboot "flash" command supports writing the downloaded 130867dac674SAlex Deymo image to DOS MBR. 130967dac674SAlex Deymo This occurs when the "partition name" specified on the 131067dac674SAlex Deymo "fastboot flash" command line matches this value. 131167dac674SAlex Deymo If not defined the default value "mbr" is used. 131267dac674SAlex Deymo 13136705d81eSwdenk- Journaling Flash filesystem support: 1314b2482dffSSimon Glass CONFIG_JFFS2_NAND 13156705d81eSwdenk Define these for a default partition on a NAND device 13166705d81eSwdenk 13176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 13186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 13196705d81eSwdenk Define these for a default partition on a NOR device 13206705d81eSwdenk 1321c609719bSwdenk- Keyboard Support: 132239f615edSSimon Glass See Kconfig help for available keyboard drivers. 132339f615edSSimon Glass 132439f615edSSimon Glass CONFIG_KEYBOARD 132539f615edSSimon Glass 132639f615edSSimon Glass Define this to enable a custom keyboard support. 132739f615edSSimon Glass This simply calls drv_keyboard_init() which must be 132839f615edSSimon Glass defined in your board-specific files. This option is deprecated 132939f615edSSimon Glass and is only used by novena. For new boards, use driver model 133039f615edSSimon Glass instead. 1331c609719bSwdenk 1332c609719bSwdenk- Video support: 13337d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 13347d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 13357d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 13367d3053fbSTimur Tabi support, and should also define these other macros: 13377d3053fbSTimur Tabi 13387d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 13397d3053fbSTimur Tabi CONFIG_VIDEO 13407d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 13417d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 13427d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 13437d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 13447d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 13457d3053fbSTimur Tabi 1346ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1347ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 13488eca9439SFabio Estevam boot. See the documentation file doc/README.video for a 1349ba8e76bdSTimur Tabi description of this variable. 13507d3053fbSTimur Tabi 1351c609719bSwdenk- LCD Support: CONFIG_LCD 1352c609719bSwdenk 1353c609719bSwdenk Define this to enable LCD support (for output to LCD 1354c609719bSwdenk display); also select one of the supported displays 1355c609719bSwdenk by defining one of these: 1356c609719bSwdenk 135739cf4804SStelian Pop CONFIG_ATMEL_LCD: 135839cf4804SStelian Pop 135939cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 136039cf4804SStelian Pop 1361fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1362c609719bSwdenk 1363fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1364c609719bSwdenk 1365fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1366c609719bSwdenk 1367fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1368fd3103bbSwdenk Active, color, single scan. 1369fd3103bbSwdenk 1370fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1371fd3103bbSwdenk 1372fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1373c609719bSwdenk Active, color, single scan. 1374c609719bSwdenk 1375c609719bSwdenk CONFIG_SHARP_16x9 1376c609719bSwdenk 1377c609719bSwdenk Sharp 320x240. Active, color, single scan. 1378c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1379c609719bSwdenk 1380c609719bSwdenk CONFIG_SHARP_LQ64D341 1381c609719bSwdenk 1382c609719bSwdenk Sharp LQ64D341 display, 640x480. 1383c609719bSwdenk Active, color, single scan. 1384c609719bSwdenk 1385c609719bSwdenk CONFIG_HLD1045 1386c609719bSwdenk 1387c609719bSwdenk HLD1045 display, 640x480. 1388c609719bSwdenk Active, color, single scan. 1389c609719bSwdenk 1390c609719bSwdenk CONFIG_OPTREX_BW 1391c609719bSwdenk 1392c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1393c609719bSwdenk or 1394c609719bSwdenk Hitachi LMG6912RPFC-00T 1395c609719bSwdenk or 1396c609719bSwdenk Hitachi SP14Q002 1397c609719bSwdenk 1398c609719bSwdenk 320x240. Black & white. 1399c609719bSwdenk 1400676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1401676d319eSSimon Glass 1402b445bbb4SJeremiah Mahler Normally the LCD is page-aligned (typically 4KB). If this is 1403676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1404676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1405676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1406676d319eSSimon Glass a per-section basis. 1407676d319eSSimon Glass 1408676d319eSSimon Glass 1409604c7d4aSHannes Petermaier CONFIG_LCD_ROTATION 1410604c7d4aSHannes Petermaier 1411604c7d4aSHannes Petermaier Sometimes, for example if the display is mounted in portrait 1412604c7d4aSHannes Petermaier mode or even if it's mounted landscape but rotated by 180degree, 1413604c7d4aSHannes Petermaier we need to rotate our content of the display relative to the 1414604c7d4aSHannes Petermaier framebuffer, so that user can read the messages which are 1415604c7d4aSHannes Petermaier printed out. 1416604c7d4aSHannes Petermaier Once CONFIG_LCD_ROTATION is defined, the lcd_console will be 1417604c7d4aSHannes Petermaier initialized with a given rotation from "vl_rot" out of 1418604c7d4aSHannes Petermaier "vidinfo_t" which is provided by the board specific code. 1419604c7d4aSHannes Petermaier The value for vl_rot is coded as following (matching to 1420604c7d4aSHannes Petermaier fbcon=rotate:<n> linux-kernel commandline): 1421604c7d4aSHannes Petermaier 0 = no rotation respectively 0 degree 1422604c7d4aSHannes Petermaier 1 = 90 degree rotation 1423604c7d4aSHannes Petermaier 2 = 180 degree rotation 1424604c7d4aSHannes Petermaier 3 = 270 degree rotation 1425604c7d4aSHannes Petermaier 1426604c7d4aSHannes Petermaier If CONFIG_LCD_ROTATION is not defined, the console will be 1427604c7d4aSHannes Petermaier initialized with 0degree rotation. 1428604c7d4aSHannes Petermaier 142945d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 143045d7f525STom Wai-Hong Tam 143145d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 143245d7f525STom Wai-Hong Tam 1433735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1434735987c5STom Wai-Hong Tam 1435735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1436735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1437735987c5STom Wai-Hong Tam 14387152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1439d791b1dcSwdenk 1440d791b1dcSwdenk If this option is set, the environment is checked for 1441d791b1dcSwdenk a variable "splashimage". If found, the usual display 1442d791b1dcSwdenk of logo, copyright and system information on the LCD 1443e94d2cd9Swdenk is suppressed and the BMP image at the address 1444d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1445d791b1dcSwdenk console is redirected to the "nulldev", too. This 1446d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1447d791b1dcSwdenk loaded very quickly after power-on. 1448d791b1dcSwdenk 1449c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1450c0880485SNikita Kiryanov 1451c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1452c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1453ab5645f1SFabio Estevam (see doc/README.displaying-bmps). 1454c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1455c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1456c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1457c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1458c0880485SNikita Kiryanov there is no need to set this option. 1459c0880485SNikita Kiryanov 14601ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 14611ca298ceSMatthias Weisser 14621ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 14631ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 14641ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 14651ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 14661ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 14671ca298ceSMatthias Weisser specify 'm' for centering the image. 14681ca298ceSMatthias Weisser 14691ca298ceSMatthias Weisser Example: 14701ca298ceSMatthias Weisser setenv splashpos m,m 14711ca298ceSMatthias Weisser => image at center of screen 14721ca298ceSMatthias Weisser 14731ca298ceSMatthias Weisser setenv splashpos 30,20 14741ca298ceSMatthias Weisser => image at x = 30 and y = 20 14751ca298ceSMatthias Weisser 14761ca298ceSMatthias Weisser setenv splashpos -10,m 14771ca298ceSMatthias Weisser => vertically centered image 14781ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 14791ca298ceSMatthias Weisser 148098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 148198f4a3dfSStefan Roese 148298f4a3dfSStefan Roese If this option is set, additionally to standard BMP 148398f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 148498f4a3dfSStefan Roese splashscreen support or the bmp command. 148598f4a3dfSStefan Roese 1486d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1487d5011762SAnatolij Gustschin 1488d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1489d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1490d5011762SAnatolij Gustschin bmp command. 1491d5011762SAnatolij Gustschin 1492c29fdfc1Swdenk- Compression support: 14938ef70478SKees Cook CONFIG_GZIP 14948ef70478SKees Cook 14958ef70478SKees Cook Enabled by default to support gzip compressed images. 14968ef70478SKees Cook 1497c29fdfc1Swdenk CONFIG_BZIP2 1498c29fdfc1Swdenk 1499c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1500c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1501c29fdfc1Swdenk compressed images are supported. 1502c29fdfc1Swdenk 1503c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 15046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1505c29fdfc1Swdenk be at least 4MB. 1506d791b1dcSwdenk 150717ea1177Swdenk- MII/PHY support: 150817ea1177Swdenk CONFIG_PHY_ADDR 150917ea1177Swdenk 151017ea1177Swdenk The address of PHY on MII bus. 151117ea1177Swdenk 151217ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 151317ea1177Swdenk 151417ea1177Swdenk The clock frequency of the MII bus 151517ea1177Swdenk 151617ea1177Swdenk CONFIG_PHY_RESET_DELAY 151717ea1177Swdenk 151817ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 151917ea1177Swdenk reset before any MII register access is possible. 152017ea1177Swdenk For such PHY, set this option to the usec delay 152117ea1177Swdenk required. (minimum 300usec for LXT971A) 152217ea1177Swdenk 152317ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 152417ea1177Swdenk 152517ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 152617ea1177Swdenk command issued before MII status register can be read 152717ea1177Swdenk 1528c609719bSwdenk- IP address: 1529c609719bSwdenk CONFIG_IPADDR 1530c609719bSwdenk 1531c609719bSwdenk Define a default value for the IP address to use for 153211ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1533c609719bSwdenk determined through e.g. bootp. 15341ebcd654SWolfgang Denk (Environment variable "ipaddr") 1535c609719bSwdenk 1536c609719bSwdenk- Server IP address: 1537c609719bSwdenk CONFIG_SERVERIP 1538c609719bSwdenk 1539c609719bSwdenk Defines a default value for the IP address of a TFTP 1540c609719bSwdenk server to contact when using the "tftboot" command. 15411ebcd654SWolfgang Denk (Environment variable "serverip") 1542c609719bSwdenk 154397cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 154497cfe861SRobin Getz 154597cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 154697cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 154797cfe861SRobin Getz 15481ebcd654SWolfgang Denk- Gateway IP address: 15491ebcd654SWolfgang Denk CONFIG_GATEWAYIP 15501ebcd654SWolfgang Denk 15511ebcd654SWolfgang Denk Defines a default value for the IP address of the 15521ebcd654SWolfgang Denk default router where packets to other networks are 15531ebcd654SWolfgang Denk sent to. 15541ebcd654SWolfgang Denk (Environment variable "gatewayip") 15551ebcd654SWolfgang Denk 15561ebcd654SWolfgang Denk- Subnet mask: 15571ebcd654SWolfgang Denk CONFIG_NETMASK 15581ebcd654SWolfgang Denk 15591ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 15601ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 15611ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 15621ebcd654SWolfgang Denk forwarded through a router. 15631ebcd654SWolfgang Denk (Environment variable "netmask") 15641ebcd654SWolfgang Denk 156553a5c424SDavid Updegraff- Multicast TFTP Mode: 156653a5c424SDavid Updegraff CONFIG_MCAST_TFTP 156753a5c424SDavid Updegraff 156853a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 156953a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 157011ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 157153a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 157253a5c424SDavid Updegraff multicast group. 157353a5c424SDavid Updegraff 1574c609719bSwdenk- BOOTP Recovery Mode: 1575c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1576c609719bSwdenk 1577c609719bSwdenk If you have many targets in a network that try to 1578c609719bSwdenk boot using BOOTP, you may want to avoid that all 1579c609719bSwdenk systems send out BOOTP requests at precisely the same 1580c609719bSwdenk moment (which would happen for instance at recovery 1581c609719bSwdenk from a power failure, when all systems will try to 1582c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1583c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1584c609719bSwdenk inserted before sending out BOOTP requests. The 15856c33c785SWolfgang Denk following delays are inserted then: 1586c609719bSwdenk 1587c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1588c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1589c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1590c609719bSwdenk 4th and following 1591c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1592c609719bSwdenk 159392ac8accSThierry Reding CONFIG_BOOTP_ID_CACHE_SIZE 159492ac8accSThierry Reding 159592ac8accSThierry Reding BOOTP packets are uniquely identified using a 32-bit ID. The 159692ac8accSThierry Reding server will copy the ID from client requests to responses and 159792ac8accSThierry Reding U-Boot will use this to determine if it is the destination of 159892ac8accSThierry Reding an incoming response. Some servers will check that addresses 159992ac8accSThierry Reding aren't in use before handing them out (usually using an ARP 160092ac8accSThierry Reding ping) and therefore take up to a few hundred milliseconds to 160192ac8accSThierry Reding respond. Network congestion may also influence the time it 160292ac8accSThierry Reding takes for a response to make it back to the client. If that 160392ac8accSThierry Reding time is too long, U-Boot will retransmit requests. In order 160492ac8accSThierry Reding to allow earlier responses to still be accepted after these 160592ac8accSThierry Reding retransmissions, U-Boot's BOOTP client keeps a small cache of 160692ac8accSThierry Reding IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this 160792ac8accSThierry Reding cache. The default is to keep IDs for up to four outstanding 160892ac8accSThierry Reding requests. Increasing this will allow U-Boot to accept offers 160992ac8accSThierry Reding from a BOOTP client in networks with unusually high latency. 161092ac8accSThierry Reding 1611fe389a82Sstroese- DHCP Advanced Options: 16121fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 16131fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1614fe389a82Sstroese 16151fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 16161fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 16171fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 16181fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 16191fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 16201fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 16211fe80d79SJon Loeliger CONFIG_BOOTP_DNS 16221fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 16231fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 16241fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 16251fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 16261fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 16272c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1628fe389a82Sstroese 16295d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 16305d110f0aSWilson Callan environment variable, not the BOOTP server. 1631fe389a82Sstroese 16322c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 16332c00e099SJoe Hershberger after the configured retry count, the call will fail 16342c00e099SJoe Hershberger instead of starting over. This can be used to fail over 16352c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 16362c00e099SJoe Hershberger is not available. 16372c00e099SJoe Hershberger 1638fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1639fe389a82Sstroese serverip from a DHCP server, it is possible that more 1640fe389a82Sstroese than one DNS serverip is offered to the client. 1641fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1642fe389a82Sstroese serverip will be stored in the additional environment 1643fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1644fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 16451fe80d79SJon Loeliger is defined. 1646fe389a82Sstroese 1647fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1648fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1649fe389a82Sstroese need the hostname of the DHCP requester. 16505d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 16511fe80d79SJon Loeliger of the "hostname" environment variable is passed as 16521fe80d79SJon Loeliger option 12 to the DHCP server. 1653fe389a82Sstroese 1654d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1655d9a2f416SAras Vaichas 1656d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1657d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1658d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1659d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1660d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1661d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1662d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1663d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1664d9a2f416SAras Vaichas that one of the retries will be successful but note that 1665d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1666d9a2f416SAras Vaichas this delay. 1667d9a2f416SAras Vaichas 1668d22c338eSJoe Hershberger - Link-local IP address negotiation: 1669d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1670d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1671d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1672d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1673d22c338eSJoe Hershberger 1674d22c338eSJoe Hershberger See doc/README.link-local for more information. 1675d22c338eSJoe Hershberger 16761ae99f24SPrabhakar Kushwaha - MAC address from environment variables 16771ae99f24SPrabhakar Kushwaha 16781ae99f24SPrabhakar Kushwaha FDT_SEQ_MACADDR_FROM_ENV 16791ae99f24SPrabhakar Kushwaha 16801ae99f24SPrabhakar Kushwaha Fix-up device tree with MAC addresses fetched sequentially from 16811ae99f24SPrabhakar Kushwaha environment variables. This config work on assumption that 16821ae99f24SPrabhakar Kushwaha non-usable ethernet node of device-tree are either not present 16831ae99f24SPrabhakar Kushwaha or their status has been marked as "disabled". 16841ae99f24SPrabhakar Kushwaha 1685a3d991bdSwdenk - CDP Options: 1686a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1687a3d991bdSwdenk 1688a3d991bdSwdenk The device id used in CDP trigger frames. 1689a3d991bdSwdenk 1690a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1691a3d991bdSwdenk 1692a3d991bdSwdenk A two character string which is prefixed to the MAC address 1693a3d991bdSwdenk of the device. 1694a3d991bdSwdenk 1695a3d991bdSwdenk CONFIG_CDP_PORT_ID 1696a3d991bdSwdenk 1697a3d991bdSwdenk A printf format string which contains the ascii name of 1698a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 169911ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1700a3d991bdSwdenk 1701a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1702a3d991bdSwdenk 1703a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1704a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1705a3d991bdSwdenk 1706a3d991bdSwdenk CONFIG_CDP_VERSION 1707a3d991bdSwdenk 1708a3d991bdSwdenk An ascii string containing the version of the software. 1709a3d991bdSwdenk 1710a3d991bdSwdenk CONFIG_CDP_PLATFORM 1711a3d991bdSwdenk 1712a3d991bdSwdenk An ascii string containing the name of the platform. 1713a3d991bdSwdenk 1714a3d991bdSwdenk CONFIG_CDP_TRIGGER 1715a3d991bdSwdenk 1716a3d991bdSwdenk A 32bit integer sent on the trigger. 1717a3d991bdSwdenk 1718a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1719a3d991bdSwdenk 1720a3d991bdSwdenk A 16bit integer containing the power consumption of the 1721a3d991bdSwdenk device in .1 of milliwatts. 1722a3d991bdSwdenk 1723a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1724a3d991bdSwdenk 1725a3d991bdSwdenk A byte containing the id of the VLAN. 1726a3d991bdSwdenk 172779267eddSUri Mashiach- Status LED: CONFIG_LED_STATUS 1728c609719bSwdenk 1729c609719bSwdenk Several configurations allow to display the current 1730c609719bSwdenk status using a LED. For instance, the LED will blink 1731c609719bSwdenk fast while running U-Boot code, stop blinking as 1732c609719bSwdenk soon as a reply to a BOOTP request was received, and 1733c609719bSwdenk start blinking slow once the Linux kernel is running 1734c609719bSwdenk (supported by a status LED driver in the Linux 173579267eddSUri Mashiach kernel). Defining CONFIG_LED_STATUS enables this 1736c609719bSwdenk feature in U-Boot. 1737c609719bSwdenk 17381df7bbbaSIgor Grinberg Additional options: 17391df7bbbaSIgor Grinberg 174079267eddSUri Mashiach CONFIG_LED_STATUS_GPIO 17411df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 17421df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 174379267eddSUri Mashiach status LED backend implementation. Define CONFIG_LED_STATUS_GPIO 17441df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 17451df7bbbaSIgor Grinberg 17469dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 17479dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 17489dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 17499dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 17509dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 17519dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 17529dfdcdfeSIgor Grinberg 17533f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 1754c609719bSwdenk 17553f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 17563f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 17573f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 17583f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 17593f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 17603f4978c7SHeiko Schocher interface. 17613f4978c7SHeiko Schocher 17623f4978c7SHeiko Schocher ported i2c driver to the new framework: 1763ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 1764ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 1765ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 1766ea818dbbSHeiko Schocher for defining speed and slave address 1767ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 1768ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 1769ea818dbbSHeiko Schocher for defining speed and slave address 1770ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 1771ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 1772ea818dbbSHeiko Schocher for defining speed and slave address 1773ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 1774ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 1775ea818dbbSHeiko Schocher for defining speed and slave address 17763f4978c7SHeiko Schocher 177700f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 177800f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 177900f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 178000f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 178100f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 178200f792e0SHeiko Schocher bus. 178300f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 178400f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 178500f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 178600f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 178700f792e0SHeiko Schocher second bus. 178800f792e0SHeiko Schocher 17891f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 17901f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 17911f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 17921f2ba722SSimon Glass 100000 and the slave addr 0! 17931f2ba722SSimon Glass 1794880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 1795880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 1796880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 1797880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 1798880540deSDirk Eibach 1799fac96408Strem - drivers/i2c/i2c_mxc.c 1800fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 180103544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 180203544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 180303544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 180403544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 1805fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 1806fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 1807fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 1808fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 1809fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 1810fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 181103544c66SAlbert ARIBAUD \\(3ADEV\\) - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED 181203544c66SAlbert ARIBAUD \\(3ADEV\\) - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE 1813b445bbb4SJeremiah Mahler If those defines are not set, default value is 100000 1814fac96408Strem for speed, and 0 for slave. 1815fac96408Strem 18161086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 18171086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 18181086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 18191086bfa9SNobuhiro Iwamatsu 18201086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 18211086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 18221086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 18231086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 18241086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 18251086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 18261086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 18271086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 18281086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 18291086bfa9SNobuhiro Iwamatsu 18302035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 18312035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 18322035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 18332035d77dSNobuhiro Iwamatsu 18342035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 18352035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 18362035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 18372035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 18382035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 18392035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 18402035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 18412035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 18422035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 18432035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 1844b445bbb4SJeremiah Mahler - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses 18452035d77dSNobuhiro Iwamatsu 18466789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 18476789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 18486789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 18496789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 18506789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 18516789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 18526789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 18536789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 18546789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 18556789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 18566789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 18576789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 18586789e84eSHeiko Schocher 18590bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 18600bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 18610bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 18620bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 18630bdffe71SHeiko Schocher 1864e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 1865e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 1866e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 1867e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 1868e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 1869e717fc6dSNaveen Krishna Ch 1870b46226bdSDirk Eibach - drivers/i2c/ihs_i2c.c 1871b46226bdSDirk Eibach - activate this driver with CONFIG_SYS_I2C_IHS 1872b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 1873b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 1874b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 1875b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 1876b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 1877b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 1878b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 1879b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 1880b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 1881b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 1882b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 1883b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 1884071be896SDirk Eibach - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL 1885071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 1886071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 1887071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 1888071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 1889071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 1890071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 1891071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 1892071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 1893b46226bdSDirk Eibach 18943f4978c7SHeiko Schocher additional defines: 18953f4978c7SHeiko Schocher 18963f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 1897945a18e6SSimon Glass Hold the number of i2c buses you want to use. 18983f4978c7SHeiko Schocher 18993f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 19003f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 19013f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 19023f4978c7SHeiko Schocher omit this define. 19033f4978c7SHeiko Schocher 19043f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 19053f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 19063f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 19073f4978c7SHeiko Schocher define. 19083f4978c7SHeiko Schocher 19093f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 1910b445bbb4SJeremiah Mahler hold a list of buses you want to use, only used if 19113f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 19123f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 19133f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 19143f4978c7SHeiko Schocher 19153f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 19163f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 19173f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 19183f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 19193f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 19203f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 19213f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 19223f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 19233f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 19243f4978c7SHeiko Schocher } 19253f4978c7SHeiko Schocher 19263f4978c7SHeiko Schocher which defines 19273f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 1928ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 1929ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 1930ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 1931ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 1932ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 19333f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 1934ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 1935ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 19363f4978c7SHeiko Schocher 19373f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 19383f4978c7SHeiko Schocher 1939ce3b5d69SSimon Glass- Legacy I2C Support: 1940ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 1941b37c7e5eSwdenk then the following macros need to be defined (examples are 1942b37c7e5eSwdenk from include/configs/lwmon.h): 1943c609719bSwdenk 1944c609719bSwdenk I2C_INIT 1945c609719bSwdenk 1946b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1947c609719bSwdenk controller or configure ports. 1948c609719bSwdenk 1949b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1950b37c7e5eSwdenk 1951c609719bSwdenk I2C_ACTIVE 1952c609719bSwdenk 1953c609719bSwdenk The code necessary to make the I2C data line active 1954c609719bSwdenk (driven). If the data line is open collector, this 1955c609719bSwdenk define can be null. 1956c609719bSwdenk 1957b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1958b37c7e5eSwdenk 1959c609719bSwdenk I2C_TRISTATE 1960c609719bSwdenk 1961c609719bSwdenk The code necessary to make the I2C data line tri-stated 1962c609719bSwdenk (inactive). If the data line is open collector, this 1963c609719bSwdenk define can be null. 1964c609719bSwdenk 1965b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1966b37c7e5eSwdenk 1967c609719bSwdenk I2C_READ 1968c609719bSwdenk 1969472d5460SYork Sun Code that returns true if the I2C data line is high, 1970472d5460SYork Sun false if it is low. 1971c609719bSwdenk 1972b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1973b37c7e5eSwdenk 1974c609719bSwdenk I2C_SDA(bit) 1975c609719bSwdenk 1976472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 1977472d5460SYork Sun is false, it clears it (low). 1978c609719bSwdenk 1979b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1980b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1981b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1982b37c7e5eSwdenk 1983c609719bSwdenk I2C_SCL(bit) 1984c609719bSwdenk 1985472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 1986472d5460SYork Sun is false, it clears it (low). 1987c609719bSwdenk 1988b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1989b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1990b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1991b37c7e5eSwdenk 1992c609719bSwdenk I2C_DELAY 1993c609719bSwdenk 1994c609719bSwdenk This delay is invoked four times per clock cycle so this 1995c609719bSwdenk controls the rate of data transfer. The data rate thus 1996b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1997b37c7e5eSwdenk like: 1998b37c7e5eSwdenk 1999b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2000c609719bSwdenk 2001793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2002793b5726SMike Frysinger 2003793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2004793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2005793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2006793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2007793b5726SMike Frysinger 2008793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2009793b5726SMike Frysinger the generic GPIO functions. 2010793b5726SMike Frysinger 20116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 201247cd00faSwdenk 201347cd00faSwdenk When a board is reset during an i2c bus transfer 201447cd00faSwdenk chips might think that the current transfer is still 201547cd00faSwdenk in progress. On some boards it is possible to access 201647cd00faSwdenk the i2c SCLK line directly, either by using the 201747cd00faSwdenk processor pin as a GPIO or by having a second pin 201847cd00faSwdenk connected to the bus. If this option is defined a 201947cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 202047cd00faSwdenk is run early in the boot sequence. 202147cd00faSwdenk 2022bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2023bb99ad6dSBen Warren 2024bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2025bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2026bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2027bb99ad6dSBen Warren Note that bus numbering is zero-based. 2028bb99ad6dSBen Warren 20296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2030bb99ad6dSBen Warren 2031bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 20320f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 20330f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 20340f89c54bSPeter Tyser a 1D array of device addresses 2035bb99ad6dSBen Warren 2036bb99ad6dSBen Warren e.g. 2037bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 20386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2039bb99ad6dSBen Warren 2040bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2041bb99ad6dSBen Warren 2042bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 2043945a18e6SSimon Glass #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2044bb99ad6dSBen Warren 2045bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2046bb99ad6dSBen Warren 20476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2048be5e6181STimur Tabi 2049be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2050be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2051be5e6181STimur Tabi 20526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 20530dc018ecSStefan Roese 20540dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 20550dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 20560dc018ecSStefan Roese 20572ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 20582ac6985aSAndrew Dyer 20592ac6985aSAndrew Dyer defining this will force the i2c_read() function in 20602ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 20612ac6985aSAndrew Dyer between writing the address pointer and reading the 20622ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 20632ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 20642ac6985aSAndrew Dyer devices can use either method, but some require one or 20652ac6985aSAndrew Dyer the other. 2066be5e6181STimur Tabi 2067c609719bSwdenk- SPI Support: CONFIG_SPI 2068c609719bSwdenk 2069c609719bSwdenk Enables SPI driver (so far only tested with 2070c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2071c609719bSwdenk D/As on the SACSng board) 2072c609719bSwdenk 20736639562eSYoshihiro Shimoda CONFIG_SH_SPI 20746639562eSYoshihiro Shimoda 20756639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 20766639562eSYoshihiro Shimoda only SH7757 is supported. 20776639562eSYoshihiro Shimoda 2078c609719bSwdenk CONFIG_SOFT_SPI 2079c609719bSwdenk 2080c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2081c609719bSwdenk using hardware support. This is a general purpose 2082c609719bSwdenk driver that only requires three general I/O port pins 2083c609719bSwdenk (two outputs, one input) to function. If this is 2084c609719bSwdenk defined, the board configuration must define several 2085c609719bSwdenk SPI configuration items (port pins to use, etc). For 2086c609719bSwdenk an example, see include/configs/sacsng.h. 2087c609719bSwdenk 208804a9e118SBen Warren CONFIG_HARD_SPI 208904a9e118SBen Warren 209004a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 209104a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 209204a9e118SBen Warren must define a list of chip-select function pointers. 209304a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 209404a9e118SBen Warren example, see include/configs/mpc8349emds.h. 209504a9e118SBen Warren 209638254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 209738254f45SGuennadi Liakhovetski 209838254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 20992e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 210038254f45SGuennadi Liakhovetski 2101f659b573SHeiko Schocher CONFIG_SYS_SPI_MXC_WAIT 2102f659b573SHeiko Schocher Timeout for waiting until spi transfer completed. 2103f659b573SHeiko Schocher default: (CONFIG_SYS_HZ/100) /* 10 ms */ 2104f659b573SHeiko Schocher 21050133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 21060133502eSMatthias Fuchs 21070133502eSMatthias Fuchs Enables FPGA subsystem. 21080133502eSMatthias Fuchs 21090133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 21100133502eSMatthias Fuchs 21110133502eSMatthias Fuchs Enables support for specific chip vendors. 21120133502eSMatthias Fuchs (ALTERA, XILINX) 21130133502eSMatthias Fuchs 21140133502eSMatthias Fuchs CONFIG_FPGA_<family> 21150133502eSMatthias Fuchs 21160133502eSMatthias Fuchs Enables support for FPGA family. 21170133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 21180133502eSMatthias Fuchs 21190133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2120c609719bSwdenk 2121c609719bSwdenk Specify the number of FPGA devices to support. 2122c609719bSwdenk 21236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2124c609719bSwdenk 2125c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2126c609719bSwdenk 21276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2128c609719bSwdenk 2129c609719bSwdenk Enable checks on FPGA configuration interface busy 2130c609719bSwdenk status by the configuration function. This option 2131c609719bSwdenk will require a board or device specific function to 2132c609719bSwdenk be written. 2133c609719bSwdenk 2134c609719bSwdenk CONFIG_FPGA_DELAY 2135c609719bSwdenk 2136c609719bSwdenk If defined, a function that provides delays in the FPGA 2137c609719bSwdenk configuration driver. 2138c609719bSwdenk 21396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2140c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2141c609719bSwdenk 21426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2143c609719bSwdenk 2144c609719bSwdenk Check for configuration errors during FPGA bitfile 2145c609719bSwdenk loading. For example, abort during Virtex II 2146c609719bSwdenk configuration if the INIT_B line goes low (which 2147c609719bSwdenk indicated a CRC error). 2148c609719bSwdenk 21496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2150c609719bSwdenk 2151b445bbb4SJeremiah Mahler Maximum time to wait for the INIT_B line to de-assert 2152b445bbb4SJeremiah Mahler after PROB_B has been de-asserted during a Virtex II 2153c609719bSwdenk FPGA configuration sequence. The default time is 500 215411ccc33fSMarcel Ziswiler ms. 2155c609719bSwdenk 21566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2157c609719bSwdenk 2158b445bbb4SJeremiah Mahler Maximum time to wait for BUSY to de-assert during 215911ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2160c609719bSwdenk 21616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2162c609719bSwdenk 2163c609719bSwdenk Time to wait after FPGA configuration. The default is 216411ccc33fSMarcel Ziswiler 200 ms. 2165c609719bSwdenk 2166c609719bSwdenk- Configuration Management: 2167b2b8a696SStefan Roese CONFIG_BUILD_TARGET 2168b2b8a696SStefan Roese 2169b2b8a696SStefan Roese Some SoCs need special image types (e.g. U-Boot binary 2170b2b8a696SStefan Roese with a special header) as build targets. By defining 2171b2b8a696SStefan Roese CONFIG_BUILD_TARGET in the SoC / board header, this 2172b2b8a696SStefan Roese special image will be automatically built upon calling 21736de80f21SSimon Glass make / buildman. 2174b2b8a696SStefan Roese 2175c609719bSwdenk CONFIG_IDENT_STRING 2176c609719bSwdenk 2177c609719bSwdenk If defined, this string will be added to the U-Boot 2178c609719bSwdenk version information (U_BOOT_VERSION) 2179c609719bSwdenk 2180c609719bSwdenk- Vendor Parameter Protection: 2181c609719bSwdenk 2182c609719bSwdenk U-Boot considers the values of the environment 2183c609719bSwdenk variables "serial#" (Board Serial Number) and 21847152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2185c609719bSwdenk are set once by the board vendor / manufacturer, and 2186c609719bSwdenk protects these variables from casual modification by 2187c609719bSwdenk the user. Once set, these variables are read-only, 2188c609719bSwdenk and write or delete attempts are rejected. You can 218911ccc33fSMarcel Ziswiler change this behaviour: 2190c609719bSwdenk 2191c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2192c609719bSwdenk file, the write protection for vendor parameters is 219347cd00faSwdenk completely disabled. Anybody can change or delete 2194c609719bSwdenk these parameters. 2195c609719bSwdenk 219692ac5208SJoe Hershberger Alternatively, if you define _both_ an ethaddr in the 219792ac5208SJoe Hershberger default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 219811ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2199c609719bSwdenk which can be changed exactly ONCE by the user. [The 2200c609719bSwdenk serial# is unaffected by this, i. e. it remains 2201c609719bSwdenk read-only.] 2202c609719bSwdenk 22032598090bSJoe Hershberger The same can be accomplished in a more flexible way 22042598090bSJoe Hershberger for any variable by configuring the type of access 22052598090bSJoe Hershberger to allow for those variables in the ".flags" variable 22062598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 22072598090bSJoe Hershberger 2208c609719bSwdenk- Protected RAM: 2209c609719bSwdenk CONFIG_PRAM 2210c609719bSwdenk 2211c609719bSwdenk Define this variable to enable the reservation of 2212c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2213c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2214c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2215c609719bSwdenk this default value by defining an environment 2216c609719bSwdenk variable "pram" to the number of kB you want to 2217c609719bSwdenk reserve. Note that the board info structure will 2218c609719bSwdenk still show the full amount of RAM. If pRAM is 2219c609719bSwdenk reserved, a new environment variable "mem" will 2220c609719bSwdenk automatically be defined to hold the amount of 2221c609719bSwdenk remaining RAM in a form that can be passed as boot 2222c609719bSwdenk argument to Linux, for instance like that: 2223c609719bSwdenk 2224fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2225c609719bSwdenk saveenv 2226c609719bSwdenk 2227c609719bSwdenk This way you can tell Linux not to use this memory, 2228c609719bSwdenk either, which results in a memory region that will 2229c609719bSwdenk not be affected by reboots. 2230c609719bSwdenk 2231c609719bSwdenk *WARNING* If your board configuration uses automatic 2232c609719bSwdenk detection of the RAM size, you must make sure that 2233c609719bSwdenk this memory test is non-destructive. So far, the 2234c609719bSwdenk following board configurations are known to be 2235c609719bSwdenk "pRAM-clean": 2236c609719bSwdenk 22375b8e76c3SHeiko Schocher IVMS8, IVML24, SPD8xx, 22381b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 22392eb48ff7SHeiko Schocher FLAGADM 2240c609719bSwdenk 224140fef049SGabe Black- Access to physical memory region (> 4GB) 224240fef049SGabe Black Some basic support is provided for operations on memory not 224340fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 224440fef049SGabe Black support access to more than 4GB of memory on 32-bit 224540fef049SGabe Black machines using physical address extension or similar. 224640fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 224740fef049SGabe Black currently only supports clearing the memory. 224840fef049SGabe Black 2249c609719bSwdenk- Error Recovery: 2250c609719bSwdenk CONFIG_NET_RETRY_COUNT 2251c609719bSwdenk 2252c609719bSwdenk This variable defines the number of retries for 2253c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2254c609719bSwdenk before giving up the operation. If not defined, a 2255c609719bSwdenk default value of 5 is used. 2256c609719bSwdenk 225740cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 225840cb90eeSGuennadi Liakhovetski 225940cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 226040cb90eeSGuennadi Liakhovetski 226148a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 226248a3e999STetsuyuki Kobayashi 226348a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 226448a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 226548a3e999STetsuyuki Kobayashi try longer timeout such as 226648a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 226748a3e999STetsuyuki Kobayashi 2268c609719bSwdenk- Command Interpreter: 22698078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 227004a85b3bSwdenk 227104a85b3bSwdenk Enable auto completion of commands using TAB. 227204a85b3bSwdenk 22736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2274c609719bSwdenk 2275c609719bSwdenk This defines the secondary prompt string, which is 2276c609719bSwdenk printed when the command interpreter needs more input 2277c609719bSwdenk to complete a command. Usually "> ". 2278c609719bSwdenk 2279c609719bSwdenk Note: 2280c609719bSwdenk 2281c609719bSwdenk In the current implementation, the local variables 2282c609719bSwdenk space and global environment variables space are 2283c609719bSwdenk separated. Local variables are those you define by 22843b57fe0aSwdenk simply typing `name=value'. To access a local 2285c609719bSwdenk variable later on, you have write `$name' or 22863b57fe0aSwdenk `${name}'; to execute the contents of a variable 22873b57fe0aSwdenk directly type `$name' at the command prompt. 2288c609719bSwdenk 2289c609719bSwdenk Global environment variables are those you use 2290c609719bSwdenk setenv/printenv to work with. To run a command stored 2291c609719bSwdenk in such a variable, you need to use the run command, 2292c609719bSwdenk and you must not use the '$' sign to access them. 2293c609719bSwdenk 2294c609719bSwdenk To store commands and special characters in a 2295c609719bSwdenk variable, please use double quotation marks 2296c609719bSwdenk surrounding the whole text of the variable, instead 2297c609719bSwdenk of the backslashes before semicolons and special 2298c609719bSwdenk symbols. 2299c609719bSwdenk 2300b445bbb4SJeremiah Mahler- Command Line Editing and History: 2301aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2302aa0c71acSWolfgang Denk 230311ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2304aa0c71acSWolfgang Denk command line input operations 2305aa0c71acSWolfgang Denk 2306f3b267b3SMarek Vasut- Command Line PS1/PS2 support: 2307f3b267b3SMarek Vasut CONFIG_CMDLINE_PS_SUPPORT 2308f3b267b3SMarek Vasut 2309f3b267b3SMarek Vasut Enable support for changing the command prompt string 2310f3b267b3SMarek Vasut at run-time. Only static string is supported so far. 2311f3b267b3SMarek Vasut The string is obtained from environment variables PS1 2312f3b267b3SMarek Vasut and PS2. 2313f3b267b3SMarek Vasut 2314a8c7c708Swdenk- Default Environment: 2315c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2316c609719bSwdenk 2317c609719bSwdenk Define this to contain any number of null terminated 2318c609719bSwdenk strings (variable = value pairs) that will be part of 23197152b1d0Swdenk the default environment compiled into the boot image. 23202262cfeeSwdenk 2321c609719bSwdenk For example, place something like this in your 2322c609719bSwdenk board's config file: 2323c609719bSwdenk 2324c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2325c609719bSwdenk "myvar1=value1\0" \ 2326c609719bSwdenk "myvar2=value2\0" 2327c609719bSwdenk 2328c609719bSwdenk Warning: This method is based on knowledge about the 2329c609719bSwdenk internal format how the environment is stored by the 23302262cfeeSwdenk U-Boot code. This is NOT an official, exported 2331c609719bSwdenk interface! Although it is unlikely that this format 23327152b1d0Swdenk will change soon, there is no guarantee either. 2333c609719bSwdenk You better know what you are doing here. 2334c609719bSwdenk 2335c609719bSwdenk Note: overly (ab)use of the default environment is 2336c609719bSwdenk discouraged. Make sure to check other ways to preset 233774de7aefSWolfgang Denk the environment like the "source" command or the 2338c609719bSwdenk boot command first. 2339c609719bSwdenk 23405e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 23415e724ca2SStephen Warren 23425e724ca2SStephen Warren Define this in order to add variables describing the 23435e724ca2SStephen Warren U-Boot build configuration to the default environment. 23445e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 23455e724ca2SStephen Warren 23465e724ca2SStephen Warren Enabling this option will cause the following to be defined: 23475e724ca2SStephen Warren 23485e724ca2SStephen Warren - CONFIG_SYS_ARCH 23495e724ca2SStephen Warren - CONFIG_SYS_CPU 23505e724ca2SStephen Warren - CONFIG_SYS_BOARD 23515e724ca2SStephen Warren - CONFIG_SYS_VENDOR 23525e724ca2SStephen Warren - CONFIG_SYS_SOC 23535e724ca2SStephen Warren 23547e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 23557e27f89fSTom Rini 23567e27f89fSTom Rini Define this in order to add variables describing certain 23577e27f89fSTom Rini run-time determined information about the hardware to the 23587e27f89fSTom Rini environment. These will be named board_name, board_rev. 23597e27f89fSTom Rini 236006fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 236106fd8538SSimon Glass 236206fd8538SSimon Glass Normally the environment is loaded when the board is 2363b445bbb4SJeremiah Mahler initialised so that it is available to U-Boot. This inhibits 236406fd8538SSimon Glass that so that the environment is not available until 236506fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 236606fd8538SSimon Glass this is instead controlled by the value of 236706fd8538SSimon Glass /config/load-environment. 236806fd8538SSimon Glass 2369f61ec45eSEric Nelson- Serial Flash support 237000fd59ddSSimon Glass Usage requires an initial 'sf probe' to define the serial 2371f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2372f61ec45eSEric Nelson commands. 2373f61ec45eSEric Nelson 2374f61ec45eSEric Nelson The following defaults may be provided by the platform 2375f61ec45eSEric Nelson to handle the common case when only a single serial 2376f61ec45eSEric Nelson flash is present on the system. 2377f61ec45eSEric Nelson 2378f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2379f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2380f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2381f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2382f61ec45eSEric Nelson 23833f85ce27Swdenk CONFIG_SYSTEMACE 23843f85ce27Swdenk 23853f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 23863f85ce27Swdenk chips attached via some sort of local bus. The address 238711ccc33fSMarcel Ziswiler of the chip must also be defined in the 23886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 23893f85ce27Swdenk 23903f85ce27Swdenk #define CONFIG_SYSTEMACE 23916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 23923f85ce27Swdenk 23933f85ce27Swdenk When SystemACE support is added, the "ace" device type 23943f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 23953f85ce27Swdenk 2396ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2397ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2398ecb0ccd9SWolfgang Denk 239928cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2400ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 240128cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2402ecb0ccd9SWolfgang Denk number generator is used. 2403ecb0ccd9SWolfgang Denk 240428cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 240528cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 240628cb9375SWolfgang Denk defined, the normal port 69 is used. 240728cb9375SWolfgang Denk 240828cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2409ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2410ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2411ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2412ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2413ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2414ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2415ecb0ccd9SWolfgang Denk 24169e50c406SHeiko Schocher- bootcount support: 24179e50c406SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 24189e50c406SHeiko Schocher 24199e50c406SHeiko Schocher This enables the bootcounter support, see: 24209e50c406SHeiko Schocher http://www.denx.de/wiki/DULG/UBootBootCountLimit 24219e50c406SHeiko Schocher 24229e50c406SHeiko Schocher CONFIG_AT91SAM9XE 24239e50c406SHeiko Schocher enable special bootcounter support on at91sam9xe based boards. 24249e50c406SHeiko Schocher CONFIG_SOC_DA8XX 24259e50c406SHeiko Schocher enable special bootcounter support on da850 based boards. 24269e50c406SHeiko Schocher CONFIG_BOOTCOUNT_RAM 24279e50c406SHeiko Schocher enable support for the bootcounter in RAM 24289e50c406SHeiko Schocher CONFIG_BOOTCOUNT_I2C 24299e50c406SHeiko Schocher enable support for the bootcounter on an i2c (like RTC) device. 24309e50c406SHeiko Schocher CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 24319e50c406SHeiko Schocher CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 24329e50c406SHeiko Schocher the bootcounter. 24339e50c406SHeiko Schocher CONFIG_BOOTCOUNT_ALEN = address len 24348427a524SIan Ray CONFIG_BOOTCOUNT_EXT 24358427a524SIan Ray enable support for the bootcounter in EXT filesystem 24368427a524SIan Ray CONFIG_SYS_BOOTCOUNT_ADDR = RAM address used for read 24378427a524SIan Ray and write. 24388427a524SIan Ray CONFIG_SYS_BOOTCOUNT_EXT_INTERFACE = interface 24398427a524SIan Ray CONFIG_SYS_BOOTCOUNT_EXT_DEVPART = device and part 24408427a524SIan Ray CONFIG_SYS_BOOTCOUNT_EXT_NAME = filename 244119c402afSSimon Glass 2442a8c7c708Swdenk- Show boot progress: 2443c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2444c609719bSwdenk 2445c609719bSwdenk Defining this option allows to add some board- 2446c609719bSwdenk specific code (calling a user-provided function 2447c609719bSwdenk "show_boot_progress(int)") that enables you to show 2448c609719bSwdenk the system's boot progress on some display (for 2449c609719bSwdenk example, some LED's) on your board. At the moment, 2450c609719bSwdenk the following checkpoints are implemented: 2451c609719bSwdenk 245294fd1316SSimon Glass 24531372cce2SMarian BalakowiczLegacy uImage format: 24541372cce2SMarian Balakowicz 2455c609719bSwdenk Arg Where When 2456c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2457c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2458c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2459c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2460c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2461c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2462c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2463c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2464c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 24651372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2466c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2467c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2468c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2469c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 24701372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2471c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 24721372cce2SMarian Balakowicz 24731372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 24741372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 24751372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 24761372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 24771372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 24781372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 24791372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 248011ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 24811372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 24821372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 24831372cce2SMarian Balakowicz 2484ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2485c609719bSwdenk 2486a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 248763e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 248863e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 248963e73c9aSwdenk 2490566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2491566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2492566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2493566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2494566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2495566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2496566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2497566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2498566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2499566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2500566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2501566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2502566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2503566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2504566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2505566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2506566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2507566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2508566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2509566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2510566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2511566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2512566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2513566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2514566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2515566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2516566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2517566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2518566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2519566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2520566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2521566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2522566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2523566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2524566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2525566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2526566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2527566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2528566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2529566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2530566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2531566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2532566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2533566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2534566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2535566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2536566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2537c609719bSwdenk 2538566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2539c609719bSwdenk 2540566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2541566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2542566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2543206c60cbSwdenk 2544566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2545bc0571fcSJoe Hershberger 80 common/cmd_net.c before calling net_loop() 2546bc0571fcSJoe Hershberger -81 common/cmd_net.c some error in net_loop() occurred 2547bc0571fcSJoe Hershberger 81 common/cmd_net.c net_loop() back without error 2548566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2549566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 255074de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 255174de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2552566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2553c609719bSwdenk 25541372cce2SMarian BalakowiczFIT uImage format: 25551372cce2SMarian Balakowicz 25561372cce2SMarian Balakowicz Arg Where When 25571372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 25581372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 25591372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 25601372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 25611372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 25621372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2563f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 25641372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 25651372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 25661372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 25671372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 25681372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 256911ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 257011ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 25711372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 25721372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 25731372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 25741372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 25751372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 25761372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 25771372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 25781372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 25791372cce2SMarian Balakowicz 25801372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 25811372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 25821372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 258311ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 25841372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 25851372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 25861372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 25871372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 25881372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 25891372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 25901372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 25911372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 25921372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 25931372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 25941372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 25951372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 25961372cce2SMarian Balakowicz 259711ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 25981372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 25991372cce2SMarian Balakowicz 260011ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 26011372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 26021372cce2SMarian Balakowicz 260311ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 26041372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 26051372cce2SMarian Balakowicz 260621d29f7fSHeiko Schocher- legacy image format: 260721d29f7fSHeiko Schocher CONFIG_IMAGE_FORMAT_LEGACY 260821d29f7fSHeiko Schocher enables the legacy image format support in U-Boot. 260921d29f7fSHeiko Schocher 261021d29f7fSHeiko Schocher Default: 261121d29f7fSHeiko Schocher enabled if CONFIG_FIT_SIGNATURE is not defined. 261221d29f7fSHeiko Schocher 261321d29f7fSHeiko Schocher CONFIG_DISABLE_IMAGE_LEGACY 261421d29f7fSHeiko Schocher disable the legacy image format 261521d29f7fSHeiko Schocher 261621d29f7fSHeiko Schocher This define is introduced, as the legacy image format is 261721d29f7fSHeiko Schocher enabled per default for backward compatibility. 261821d29f7fSHeiko Schocher 26194cf2609bSWolfgang Denk- Standalone program support: 26204cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 26214cf2609bSWolfgang Denk 26226feff899SWolfgang Denk This option defines a board specific value for the 26236feff899SWolfgang Denk address where standalone program gets loaded, thus 26246feff899SWolfgang Denk overwriting the architecture dependent default 26254cf2609bSWolfgang Denk settings. 26264cf2609bSWolfgang Denk 26274cf2609bSWolfgang Denk- Frame Buffer Address: 26284cf2609bSWolfgang Denk CONFIG_FB_ADDR 26294cf2609bSWolfgang Denk 26304cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 263144a53b57SWolfgang Denk address for frame buffer. This is typically the case 263244a53b57SWolfgang Denk when using a graphics controller has separate video 263344a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 263444a53b57SWolfgang Denk the given address instead of dynamically reserving it 263544a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 263644a53b57SWolfgang Denk the memory for the frame buffer depending on the 263744a53b57SWolfgang Denk configured panel size. 26384cf2609bSWolfgang Denk 26394cf2609bSWolfgang Denk Please see board_init_f function. 26404cf2609bSWolfgang Denk 2641cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2642cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2643cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2644cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2645cccfc2abSDetlev Zundel 2646cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2647cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2648cccfc2abSDetlev Zundel 2649cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2650cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2651cccfc2abSDetlev Zundel 2652cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2653cccfc2abSDetlev Zundel Needed for mtdparts command support. 2654cccfc2abSDetlev Zundel 2655cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2656cccfc2abSDetlev Zundel 2657cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2658cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2659cccfc2abSDetlev Zundel 266070c219cdSJoe Hershberger- UBI support 2661ff94bc40SHeiko Schocher CONFIG_MTD_UBI_WL_THRESHOLD 2662ff94bc40SHeiko Schocher This parameter defines the maximum difference between the highest 2663ff94bc40SHeiko Schocher erase counter value and the lowest erase counter value of eraseblocks 2664ff94bc40SHeiko Schocher of UBI devices. When this threshold is exceeded, UBI starts performing 2665ff94bc40SHeiko Schocher wear leveling by means of moving data from eraseblock with low erase 2666ff94bc40SHeiko Schocher counter to eraseblocks with high erase counter. 2667ff94bc40SHeiko Schocher 2668ff94bc40SHeiko Schocher The default value should be OK for SLC NAND flashes, NOR flashes and 2669ff94bc40SHeiko Schocher other flashes which have eraseblock life-cycle 100000 or more. 2670ff94bc40SHeiko Schocher However, in case of MLC NAND flashes which typically have eraseblock 2671ff94bc40SHeiko Schocher life-cycle less than 10000, the threshold should be lessened (e.g., 2672ff94bc40SHeiko Schocher to 128 or 256, although it does not have to be power of 2). 2673ff94bc40SHeiko Schocher 2674ff94bc40SHeiko Schocher default: 4096 2675ff94bc40SHeiko Schocher 2676ff94bc40SHeiko Schocher CONFIG_MTD_UBI_BEB_LIMIT 2677ff94bc40SHeiko Schocher This option specifies the maximum bad physical eraseblocks UBI 2678ff94bc40SHeiko Schocher expects on the MTD device (per 1024 eraseblocks). If the 2679ff94bc40SHeiko Schocher underlying flash does not admit of bad eraseblocks (e.g. NOR 2680ff94bc40SHeiko Schocher flash), this value is ignored. 2681ff94bc40SHeiko Schocher 2682ff94bc40SHeiko Schocher NAND datasheets often specify the minimum and maximum NVM 2683ff94bc40SHeiko Schocher (Number of Valid Blocks) for the flashes' endurance lifetime. 2684ff94bc40SHeiko Schocher The maximum expected bad eraseblocks per 1024 eraseblocks 2685ff94bc40SHeiko Schocher then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", 2686ff94bc40SHeiko Schocher which gives 20 for most NANDs (MaxNVB is basically the total 2687ff94bc40SHeiko Schocher count of eraseblocks on the chip). 2688ff94bc40SHeiko Schocher 2689ff94bc40SHeiko Schocher To put it differently, if this value is 20, UBI will try to 2690ff94bc40SHeiko Schocher reserve about 1.9% of physical eraseblocks for bad blocks 2691ff94bc40SHeiko Schocher handling. And that will be 1.9% of eraseblocks on the entire 2692ff94bc40SHeiko Schocher NAND chip, not just the MTD partition UBI attaches. This means 2693ff94bc40SHeiko Schocher that if you have, say, a NAND flash chip admits maximum 40 bad 2694ff94bc40SHeiko Schocher eraseblocks, and it is split on two MTD partitions of the same 2695ff94bc40SHeiko Schocher size, UBI will reserve 40 eraseblocks when attaching a 2696ff94bc40SHeiko Schocher partition. 2697ff94bc40SHeiko Schocher 2698ff94bc40SHeiko Schocher default: 20 2699ff94bc40SHeiko Schocher 2700ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP 2701ff94bc40SHeiko Schocher Fastmap is a mechanism which allows attaching an UBI device 2702ff94bc40SHeiko Schocher in nearly constant time. Instead of scanning the whole MTD device it 2703ff94bc40SHeiko Schocher only has to locate a checkpoint (called fastmap) on the device. 2704ff94bc40SHeiko Schocher The on-flash fastmap contains all information needed to attach 2705ff94bc40SHeiko Schocher the device. Using fastmap makes only sense on large devices where 2706ff94bc40SHeiko Schocher attaching by scanning takes long. UBI will not automatically install 2707ff94bc40SHeiko Schocher a fastmap on old images, but you can set the UBI parameter 2708ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note 2709ff94bc40SHeiko Schocher that fastmap-enabled images are still usable with UBI implementations 2710ff94bc40SHeiko Schocher without fastmap support. On typical flash devices the whole fastmap 2711ff94bc40SHeiko Schocher fits into one PEB. UBI will reserve PEBs to hold two fastmaps. 2712ff94bc40SHeiko Schocher 2713ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT 2714ff94bc40SHeiko Schocher Set this parameter to enable fastmap automatically on images 2715ff94bc40SHeiko Schocher without a fastmap. 2716ff94bc40SHeiko Schocher default: 0 2717ff94bc40SHeiko Schocher 27180195a7bbSHeiko Schocher CONFIG_MTD_UBI_FM_DEBUG 27190195a7bbSHeiko Schocher Enable UBI fastmap debug 27200195a7bbSHeiko Schocher default: 0 27210195a7bbSHeiko Schocher 272270c219cdSJoe Hershberger- UBIFS support 2723147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 2724147162daSJoe Hershberger 2725147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 2726147162daSJoe Hershberger warnings and errors enabled. 2727147162daSJoe Hershberger 27286a11cf48SDaniel Schwierzeck- SPL framework 27296a11cf48SDaniel Schwierzeck CONFIG_SPL 27306a11cf48SDaniel Schwierzeck Enable building of SPL globally. 27316a11cf48SDaniel Schwierzeck 273295579793STom Rini CONFIG_SPL_LDSCRIPT 273395579793STom Rini LDSCRIPT for linking the SPL binary. 273495579793STom Rini 27356ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 27366ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 27376ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 27386ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 27398960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 27406ebc3461SAlbert ARIBAUD must not be both defined at the same time. 27416ebc3461SAlbert ARIBAUD 274295579793STom Rini CONFIG_SPL_MAX_SIZE 27436ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 27446ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 27456ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 27466ebc3461SAlbert ARIBAUD not exceed it. 274795579793STom Rini 27486a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 27496a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 27506a11cf48SDaniel Schwierzeck 275194a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 275294a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 275394a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 275494a45bb1SScott Wood 275595579793STom Rini CONFIG_SPL_BSS_START_ADDR 275695579793STom Rini Link address for the BSS within the SPL binary. 275795579793STom Rini 275895579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 27596ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 27606ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 27616ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 27628960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 27636ebc3461SAlbert ARIBAUD must not be both defined at the same time. 276495579793STom Rini 276595579793STom Rini CONFIG_SPL_STACK 276695579793STom Rini Adress of the start of the stack SPL will use 276795579793STom Rini 27688c80eb3bSAlbert ARIBAUD \(3ADEV\) CONFIG_SPL_PANIC_ON_RAW_IMAGE 27698c80eb3bSAlbert ARIBAUD \(3ADEV\) When defined, SPL will panic() if the image it has 27708c80eb3bSAlbert ARIBAUD \(3ADEV\) loaded does not have a signature. 27718c80eb3bSAlbert ARIBAUD \(3ADEV\) Defining this is useful when code which loads images 27728c80eb3bSAlbert ARIBAUD \(3ADEV\) in SPL cannot guarantee that absolutely all read errors 27738c80eb3bSAlbert ARIBAUD \(3ADEV\) will be caught. 27748c80eb3bSAlbert ARIBAUD \(3ADEV\) An example is the LPC32XX MLC NAND driver, which will 27758c80eb3bSAlbert ARIBAUD \(3ADEV\) consider that a completely unreadable NAND block is bad, 27768c80eb3bSAlbert ARIBAUD \(3ADEV\) and thus should be skipped silently. 27778c80eb3bSAlbert ARIBAUD \(3ADEV\) 277894a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 277994a45bb1SScott Wood Adress of the start of the stack SPL will use after 278094a45bb1SScott Wood relocation. If unspecified, this is equal to 278194a45bb1SScott Wood CONFIG_SPL_STACK. 278294a45bb1SScott Wood 278395579793STom Rini CONFIG_SYS_SPL_MALLOC_START 278495579793STom Rini Starting address of the malloc pool used in SPL. 27859ac4fc82SFabio Estevam When this option is set the full malloc is used in SPL and 27869ac4fc82SFabio Estevam it is set up by spl_init() and before that, the simple malloc() 27879ac4fc82SFabio Estevam can be used if CONFIG_SYS_MALLOC_F is defined. 278895579793STom Rini 278995579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 279095579793STom Rini The size of the malloc pool used in SPL. 27916a11cf48SDaniel Schwierzeck 279247f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 279347f7bcaeSTom Rini Enable the SPL framework under common/. This framework 279447f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 279547f7bcaeSTom Rini NAND loading of the Linux Kernel. 279647f7bcaeSTom Rini 27979607faf2STom Rini CONFIG_SPL_OS_BOOT 27989607faf2STom Rini Enable booting directly to an OS from SPL. 27999607faf2STom Rini See also: doc/README.falcon 28009607faf2STom Rini 2801861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 2802861a86f4STom Rini For ARM, enable an optional function to print more information 2803861a86f4STom Rini about the running system. 2804861a86f4STom Rini 28054b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 28064b919725SScott Wood Arch init code should be built for a very small image 28074b919725SScott Wood 2808b97300b6SPaul Kocialkowski CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION 2809b97300b6SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 2810b97300b6SPaul Kocialkowski used in raw mode 2811b97300b6SPaul Kocialkowski 28122b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 28132b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 28142b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 28152b75b0adSPeter Korsgaard 28162b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 28172b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 28182b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 28192b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 28202b75b0adSPeter Korsgaard (for falcon mode) 28212b75b0adSPeter Korsgaard 2822e2ccdf89SPaul Kocialkowski CONFIG_SYS_MMCSD_FS_BOOT_PARTITION 2823e2ccdf89SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 2824e2ccdf89SPaul Kocialkowski used in fs mode 2825e2ccdf89SPaul Kocialkowski 2826fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_PAYLOAD_NAME 2827fae81c72SGuillaume GARDET Filename to read to load U-Boot when reading from filesystem 2828fae81c72SGuillaume GARDET 2829fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_KERNEL_NAME 28307ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 2831fae81c72SGuillaume GARDET from filesystem (for Falcon mode) 28327ad2cc79SPeter Korsgaard 2833fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_ARGS_NAME 28347ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 2835fae81c72SGuillaume GARDET when reading from filesystem (for Falcon mode) 28367ad2cc79SPeter Korsgaard 283706f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 283806f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 283906f60ae3SScott Wood start.S waits for the rest of the SPL to load before 284006f60ae3SScott Wood continuing (the hardware starts execution after just 284106f60ae3SScott Wood loading the first page rather than the full 4K). 284206f60ae3SScott Wood 2843651fcf60SPrabhakar Kushwaha CONFIG_SPL_SKIP_RELOCATE 2844651fcf60SPrabhakar Kushwaha Avoid SPL relocation 2845651fcf60SPrabhakar Kushwaha 28466f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 28476f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 28486f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 28496f2f01b9SScott Wood 28506f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 28516f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 28526f2f01b9SScott Wood 2853*a564ed3aSJörg Krause CONFIG_SPL_NAND_IDENT 2854*a564ed3aSJörg Krause SPL uses the chip ID list to identify the NAND flash. 2855*a564ed3aSJörg Krause Requires CONFIG_SPL_NAND_BASE. 2856*a564ed3aSJörg Krause 28576f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 28586f2f01b9SScott Wood Include standard software ECC in the SPL 28596f2f01b9SScott Wood 286095579793STom Rini CONFIG_SPL_NAND_SIMPLE 28617d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 28627d4b7955SScott Wood expose the cmd_ctrl() interface. 286395579793STom Rini 28646f4e7d3cSThomas Gleixner CONFIG_SPL_UBI 28656f4e7d3cSThomas Gleixner Support for a lightweight UBI (fastmap) scanner and 28666f4e7d3cSThomas Gleixner loader 28676f4e7d3cSThomas Gleixner 28680c3117b1SHeiko Schocher CONFIG_SPL_NAND_RAW_ONLY 28690c3117b1SHeiko Schocher Support to boot only raw u-boot.bin images. Use this only 28700c3117b1SHeiko Schocher if you need to save space. 28710c3117b1SHeiko Schocher 28727c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 28737c8eea59SYing Zhang Set for common ddr init with serial presence detect in 28747c8eea59SYing Zhang SPL binary. 28757c8eea59SYing Zhang 287695579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 287795579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 287895579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 287995579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 288095579793STom Rini CONFIG_SYS_NAND_ECCBYTES 288195579793STom Rini Defines the size and behavior of the NAND that SPL uses 28827d4b7955SScott Wood to read U-Boot 288395579793STom Rini 2884fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 2885fbe76ae4SPrabhakar Kushwaha Add support NAND boot 2886fbe76ae4SPrabhakar Kushwaha 288795579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 28887d4b7955SScott Wood Location in NAND to read U-Boot from 28897d4b7955SScott Wood 28907d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 28917d4b7955SScott Wood Location in memory to load U-Boot to 28927d4b7955SScott Wood 28937d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 28947d4b7955SScott Wood Size of image to load 289595579793STom Rini 289695579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 28977d4b7955SScott Wood Entry point in loaded image to jump to 289895579793STom Rini 289995579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 290095579793STom Rini Define this if you need to first read the OOB and then the 2901b445bbb4SJeremiah Mahler data. This is used, for example, on davinci platforms. 290295579793STom Rini 2903c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 2904c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 2905c57b953dSPavel Machek 290674752baaSScott Wood CONFIG_SPL_PAD_TO 29076113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 29086113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 29096113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 29106113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 29116113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 291274752baaSScott Wood 2913ca2fca22SScott Wood CONFIG_SPL_TARGET 2914ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 2915ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 2916ca2fca22SScott Wood example if more than one image needs to be produced. 2917ca2fca22SScott Wood 291887ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 291987ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 292087ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 292187ebee39SSimon Glass option to re-enable it. This will affect the output of the 292287ebee39SSimon Glass bootm command when booting a FIT image. 292387ebee39SSimon Glass 29243aa29de0SYing Zhang- TPL framework 29253aa29de0SYing Zhang CONFIG_TPL 29263aa29de0SYing Zhang Enable building of TPL globally. 29273aa29de0SYing Zhang 29283aa29de0SYing Zhang CONFIG_TPL_PAD_TO 29293aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 29303aa29de0SYing Zhang the TPL payload. By default, this is defined as 29313aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 29323aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 29333aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 29343aa29de0SYing Zhang 2935a8c7c708Swdenk- Interrupt support (PPC): 2936a8c7c708Swdenk 2937a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2938a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 293911ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2940a8c7c708Swdenk should set decrementer_count to appropriate value. If 294111ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2942a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 294311ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2944a8c7c708Swdenk specific handling. If board has watchdog / status_led 2945a8c7c708Swdenk / other_activity_monitor it works automatically from 2946a8c7c708Swdenk general timer_interrupt(). 2947a8c7c708Swdenk 2948c609719bSwdenk 29499660e442SHelmut RaigerBoard initialization settings: 29509660e442SHelmut Raiger------------------------------ 29519660e442SHelmut Raiger 29529660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 29539660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 29549660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 29559660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 29569660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 29579660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 29589660e442SHelmut Raiger 29599660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 29609660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 29619660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 29629660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 2963c609719bSwdenk 2964c609719bSwdenkConfiguration Settings: 2965c609719bSwdenk----------------------- 2966c609719bSwdenk 29674d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 29684d1fd7f1SYork Sun Optionally it can be defined to support 64-bit memory commands. 29694d1fd7f1SYork Sun 29706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2971c609719bSwdenk undefine this when you're short of memory. 2972c609719bSwdenk 29732fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 29742fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 29752fb2604dSPeter Tyser 29766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2977c609719bSwdenk prompt for user input. 2978c609719bSwdenk 29796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2980c609719bSwdenk 29816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2982c609719bSwdenk 29836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2984c609719bSwdenk 29856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2986c609719bSwdenk the application (usually a Linux kernel) when it is 2987c609719bSwdenk booted 2988c609719bSwdenk 29896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2990c609719bSwdenk List of legal baudrate settings for this board. 2991c609719bSwdenk 29926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2993c609719bSwdenk Begin and End addresses of the area used by the 2994c609719bSwdenk simple memory test. 2995c609719bSwdenk 29966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2997c609719bSwdenk Enable an alternate, more extensive memory test. 2998c609719bSwdenk 29996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 30005f535fe1Swdenk Scratch address used by the alternate memory test 30015f535fe1Swdenk You only need to set this if address zero isn't writeable 30025f535fe1Swdenk 3003e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE 3004e61a7534SYork Sun Only implemented for ARMv8 for now. 3005e8149522SYork Sun If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory 3006e8149522SYork Sun is substracted from total RAM and won't be reported to OS. 3007e8149522SYork Sun This memory can be used as secure memory. A variable 3008e61a7534SYork Sun gd->arch.secure_ram is used to track the location. In systems 3009e8149522SYork Sun the RAM base is not zero, or RAM is divided into banks, 3010e8149522SYork Sun this variable needs to be recalcuated to get the address. 3011e8149522SYork Sun 3012aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE: 30136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 301414f73ca6SStefan Roese this specified memory area will get subtracted from the top 301511ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 301614f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 301714f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 301814f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 30195e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 302014f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 30215e12e75dSStefan Roese will have to get fixed in Linux additionally. 302214f73ca6SStefan Roese 302314f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 302414f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 302514f73ca6SStefan Roese be touched. 302614f73ca6SStefan Roese 302714f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 302814f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 302914f73ca6SStefan Roese then the end address of the Linux memory will be located at a 303014f73ca6SStefan Roese non page size aligned address and this could cause major 303114f73ca6SStefan Roese problems. 303214f73ca6SStefan Roese 30336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3034c609719bSwdenk Enable temporary baudrate change while serial download 3035c609719bSwdenk 30366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3037c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3038c609719bSwdenk 30396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3040c609719bSwdenk Physical start address of Flash memory. 3041c609719bSwdenk 30426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3043c609719bSwdenk Physical start address of boot monitor code (set by 3044c609719bSwdenk make config files to be same as the text base address 304514d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 30466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3047c609719bSwdenk 30486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 30493b57fe0aSwdenk Size of memory reserved for monitor code, used to 30503b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 30513b57fe0aSwdenk embedded within the U-Boot image, or in a separate 30523b57fe0aSwdenk flash sector. 3053c609719bSwdenk 30546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3055c609719bSwdenk Size of DRAM reserved for malloc() use. 3056c609719bSwdenk 3057d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN 3058d59476b6SSimon Glass Size of the malloc() pool for use before relocation. If 3059d59476b6SSimon Glass this is defined, then a very simple malloc() implementation 3060d59476b6SSimon Glass will become available before relocation. The address is just 3061d59476b6SSimon Glass below the global data, and the stack is moved down to make 3062d59476b6SSimon Glass space. 3063d59476b6SSimon Glass 3064d59476b6SSimon Glass This feature allocates regions with increasing addresses 3065d59476b6SSimon Glass within the region. calloc() is supported, but realloc() 3066d59476b6SSimon Glass is not available. free() is supported but does nothing. 3067b445bbb4SJeremiah Mahler The memory will be freed (or in fact just forgotten) when 3068d59476b6SSimon Glass U-Boot relocates itself. 3069d59476b6SSimon Glass 307038687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE 307138687ae6SSimon Glass Provides a simple and small malloc() and calloc() for those 307238687ae6SSimon Glass boards which do not use the full malloc in SPL (which is 307338687ae6SSimon Glass enabled with CONFIG_SYS_SPL_MALLOC_START). 307438687ae6SSimon Glass 30751dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY: 30761dfdd9baSThierry Reding Size of non-cached memory area. This area of memory will be 30771dfdd9baSThierry Reding typically located right below the malloc() area and mapped 30781dfdd9baSThierry Reding uncached in the MMU. This is useful for drivers that would 30791dfdd9baSThierry Reding otherwise require a lot of explicit cache maintenance. For 30801dfdd9baSThierry Reding some drivers it's also impossible to properly maintain the 30811dfdd9baSThierry Reding cache. For example if the regions that need to be flushed 30821dfdd9baSThierry Reding are not a multiple of the cache-line size, *and* padding 30831dfdd9baSThierry Reding cannot be allocated between the regions to align them (i.e. 30841dfdd9baSThierry Reding if the HW requires a contiguous array of regions, and the 30851dfdd9baSThierry Reding size of each region is not cache-aligned), then a flush of 30861dfdd9baSThierry Reding one region may result in overwriting data that hardware has 30871dfdd9baSThierry Reding written to another region in the same cache-line. This can 30881dfdd9baSThierry Reding happen for example in network drivers where descriptors for 30891dfdd9baSThierry Reding buffers are typically smaller than the CPU cache-line (e.g. 30901dfdd9baSThierry Reding 16 bytes vs. 32 or 64 bytes). 30911dfdd9baSThierry Reding 30921dfdd9baSThierry Reding Non-cached memory is only supported on 32-bit ARM at present. 30931dfdd9baSThierry Reding 30946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 309515940c9aSStefan Roese Normally compressed uImages are limited to an 309615940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 30976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 309815940c9aSStefan Roese to adjust this setting to your needs. 3099c609719bSwdenk 31006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3101c609719bSwdenk Maximum size of memory mapped by the startup code of 3102c609719bSwdenk the Linux kernel; all data that must be processed by 31037d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 31047d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 31051bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 31067d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3107c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3108c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3109c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3110c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3111c609719bSwdenk 3112fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3113fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3114fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3115fca43cc8SJohn Rigby is enabled. 3116fca43cc8SJohn Rigby 3117fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3118fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3119fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3120fca43cc8SJohn Rigby 3121fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3122fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3123fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3124fca43cc8SJohn Rigby 31256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3126c609719bSwdenk Max number of Flash memory banks 3127c609719bSwdenk 31286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3129c609719bSwdenk Max number of sectors on a Flash chip 3130c609719bSwdenk 31316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3132c609719bSwdenk Timeout for Flash erase operations (in ms) 3133c609719bSwdenk 31346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3135c609719bSwdenk Timeout for Flash write operations (in ms) 3136c609719bSwdenk 31376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 31388564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 31398564acf9Swdenk 31406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 31418564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 31428564acf9Swdenk 31436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 31448564acf9Swdenk If defined, hardware flash sectors protection is used 31458564acf9Swdenk instead of U-Boot software protection. 31468564acf9Swdenk 31476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3148c609719bSwdenk 3149c609719bSwdenk Enable TFTP transfers directly to flash memory; 3150c609719bSwdenk without this option such a download has to be 3151c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3152c609719bSwdenk copy from RAM to flash. 3153c609719bSwdenk 3154c609719bSwdenk The two-step approach is usually more reliable, since 3155c609719bSwdenk you can check if the download worked before you erase 315611ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 315711ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3158c609719bSwdenk downloaded image) this option may be very useful. 3159c609719bSwdenk 31606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3161c609719bSwdenk Define if the flash driver uses extra elements in the 31625653fc33Swdenk common flash structure for storing flash geometry. 31635653fc33Swdenk 316400b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 31655653fc33Swdenk This option also enables the building of the cfi_flash driver 31665653fc33Swdenk in the drivers directory 316753cf9435Sstroese 316891809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 316991809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 317091809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 317191809ed5SPiotr Ziecik to the MTD layer. 317291809ed5SPiotr Ziecik 31736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 317496ef831fSGuennadi Liakhovetski Use buffered writes to flash. 317596ef831fSGuennadi Liakhovetski 317696ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 317796ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 317896ef831fSGuennadi Liakhovetski write commands. 317996ef831fSGuennadi Liakhovetski 31806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 31815568e613SStefan Roese If this option is defined, the common CFI flash doesn't 31825568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 31835568e613SStefan Roese is useful, if some of the configured banks are only 31845568e613SStefan Roese optionally available. 31855568e613SStefan Roese 31869a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 31879a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 31889a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 31899a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 31909a042e9cSJerry Van Baren 3191352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3192352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3193352ef3f1SStefan Roese against the source after the write operation. An error message 3194352ef3f1SStefan Roese will be printed when the contents are not identical. 3195352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3196352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3197352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3198352ef3f1SStefan Roese this option if you really know what you are doing. 3199352ef3f1SStefan Roese 32006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 320111ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 320211ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 320353cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 320453cf9435Sstroese buffers can be full shortly after enabling the interface 320511ccc33fSMarcel Ziswiler on high Ethernet traffic. 320653cf9435Sstroese Defaults to 4 if not defined. 3207c609719bSwdenk 3208ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3209ea882bafSWolfgang Denk 3210ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3211ea882bafSWolfgang Denk internally to store the environment settings. The default 3212ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3213ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3214ea882bafSWolfgang Denk lib/hashtable.c for details. 3215ea882bafSWolfgang Denk 32162598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 32172598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 32181bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 32192598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 32202598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 32212598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 32222598090bSJoe Hershberger 32232598090bSJoe Hershberger The format of the list is: 32242598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3225b445bbb4SJeremiah Mahler access_attribute = [a|r|o|c] 3226b445bbb4SJeremiah Mahler attributes = type_attribute[access_attribute] 32272598090bSJoe Hershberger entry = variable_name[:attributes] 32282598090bSJoe Hershberger list = entry[,list] 32292598090bSJoe Hershberger 32302598090bSJoe Hershberger The type attributes are: 32312598090bSJoe Hershberger s - String (default) 32322598090bSJoe Hershberger d - Decimal 32332598090bSJoe Hershberger x - Hexadecimal 32342598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 32352598090bSJoe Hershberger i - IP address 32362598090bSJoe Hershberger m - MAC address 32372598090bSJoe Hershberger 3238267541f7SJoe Hershberger The access attributes are: 3239267541f7SJoe Hershberger a - Any (default) 3240267541f7SJoe Hershberger r - Read-only 3241267541f7SJoe Hershberger o - Write-once 3242267541f7SJoe Hershberger c - Change-default 3243267541f7SJoe Hershberger 32442598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 32452598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 3246b445bbb4SJeremiah Mahler environment variable in the default or embedded environment. 32472598090bSJoe Hershberger 32482598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 32492598090bSJoe Hershberger Define this to a list (string) to define validation that 32502598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 32512598090bSJoe Hershberger environment variable. To override a setting in the static 32522598090bSJoe Hershberger list, simply add an entry for the same variable name to the 32532598090bSJoe Hershberger ".flags" variable. 32542598090bSJoe Hershberger 3255bdf1fe4eSJoe Hershberger If CONFIG_REGEX is defined, the variable_name above is evaluated as a 3256bdf1fe4eSJoe Hershberger regular expression. This allows multiple variables to define the same 3257bdf1fe4eSJoe Hershberger flags without explicitly listing them for each variable. 3258bdf1fe4eSJoe Hershberger 3259267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3260267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3261267541f7SJoe Hershberger access flags. 3262267541f7SJoe Hershberger 32630d296cc2SGabe Black- CONFIG_USE_STDINT 32640d296cc2SGabe Black If stdint.h is available with your toolchain you can define this 32650d296cc2SGabe Black option to enable it. You can provide option 'USE_STDINT=1' when 32660d296cc2SGabe Black building U-Boot to enable this. 32670d296cc2SGabe Black 3268c609719bSwdenkThe following definitions that deal with the placement and management 3269c609719bSwdenkof environment data (variable area); in general, we support the 3270c609719bSwdenkfollowing configurations: 3271c609719bSwdenk 3272c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3273c3eb3fe4SMike Frysinger 3274c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3275c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3276c3eb3fe4SMike Frysinger 3277c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3278b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the 327911ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3280c609719bSwdenkU-Boot will hang. 3281c609719bSwdenk 3282c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3283c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3284c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3285c609719bSwdenkto save the current settings. 3286c609719bSwdenk 32870a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 32880a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3289fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3290fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 32910a85a9e7SLiu Gang 3292b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3293b74ab737SGuennadi Liakhovetski 3294b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3295b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3296b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3297b74ab737SGuennadi Liakhovetski 3298e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3299c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 330000caae6dSSimon Glasscreated; also, when using EEPROM you will have to use env_get_f() 3301c609719bSwdenkuntil then to read environment variables. 3302c609719bSwdenk 330385ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 330485ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 330585ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 330685ec0bccSwdenknecessary, because the first environment variable we need is the 330785ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 330885ec0bccSwdenkhave any device yet where we could complain.] 3309c609719bSwdenk 3310c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3311c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 331285ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3313c609719bSwdenk 33146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3315fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3316fc3e2165Swdenk 33176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3318fc3e2165Swdenk also needs to be defined. 3319fc3e2165Swdenk 33206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3321fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3322c609719bSwdenk 3323f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 3324f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 3325f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 3326f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 3327f5675aa5SRon Madrid space for already greatly restricted images, including but not 3328f5675aa5SRon Madrid limited to NAND_SPL configurations. 3329f5675aa5SRon Madrid 3330b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 3331b2b92f53SSimon Glass Display information about the board that U-Boot is running on 3332b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 3333b2b92f53SSimon Glass to do this. 3334b2b92f53SSimon Glass 3335e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 3336e2e3e2b1SSimon Glass Similar to the previous option, but display this information 3337e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 3338e2e3e2b1SSimon Glass present. 3339e2e3e2b1SSimon Glass 3340feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT: 3341feb85801SSascha Silbe Maximum size of the U-Boot image. When defined, the 3342feb85801SSascha Silbe build system checks that the actual size does not 3343feb85801SSascha Silbe exceed it. 3344feb85801SSascha Silbe 3345c609719bSwdenkLow Level (hardware related) configuration options: 3346dc7c9a1aSwdenk--------------------------------------------------- 3347c609719bSwdenk 33486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 3349c609719bSwdenk Cache Line Size of the CPU. 3350c609719bSwdenk 3351e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 3352e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 3353e46fedfeSTimur Tabi PowerPC SOCs. 3354e46fedfeSTimur Tabi 3355e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3356e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3357e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3358e46fedfeSTimur Tabi 3359e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3360e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3361e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3362e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3363e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3364e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3365e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3366e46fedfeSTimur Tabi 3367e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3368e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3369e46fedfeSTimur Tabi 3370e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3371e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3372e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3373e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3374e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3375e46fedfeSTimur Tabi 3376e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3377e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3378e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3379e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3380e46fedfeSTimur Tabi 3381e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3382e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3383e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3384e46fedfeSTimur Tabi 33857f6c2cbcSwdenk- Floppy Disk Support: 33866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 33877f6c2cbcSwdenk 33887f6c2cbcSwdenk the default drive number (default value 0) 33897f6c2cbcSwdenk 33906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 33917f6c2cbcSwdenk 339211ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 33937f6c2cbcSwdenk (default value 1) 33947f6c2cbcSwdenk 33956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 33967f6c2cbcSwdenk 33977f6c2cbcSwdenk defines the offset of register from address. It 33987f6c2cbcSwdenk depends on which part of the data bus is connected to 339911ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 34007f6c2cbcSwdenk 34016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 34026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 34037f6c2cbcSwdenk default value. 34047f6c2cbcSwdenk 34056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 34067f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 34077f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 3408b445bbb4SJeremiah Mahler source code. It is used to make hardware-dependent 34097f6c2cbcSwdenk initializations. 34107f6c2cbcSwdenk 34110abddf82SMacpaul Lin- CONFIG_IDE_AHB: 34120abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 34130abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 34140abddf82SMacpaul Lin When software is doing ATA command and data transfer to 34150abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 34160abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 3417b445bbb4SJeremiah Mahler is required. 34180abddf82SMacpaul Lin 34196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 342025d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 3421907208c4SChristophe Leroy doing! (11-4) [MPC8xx systems only] 3422c609719bSwdenk 34236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3424c609719bSwdenk 34257152b1d0Swdenk Start address of memory area that can be used for 3426c609719bSwdenk initial data and stack; please note that this must be 3427c609719bSwdenk writable memory that is working WITHOUT special 3428c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3429c609719bSwdenk will become available only after programming the 3430c609719bSwdenk memory controller and running certain initialization 3431c609719bSwdenk sequences. 3432c609719bSwdenk 3433c609719bSwdenk U-Boot uses the following memory types: 3434907208c4SChristophe Leroy - MPC8xx: IMMR (internal memory of the CPU) 3435c609719bSwdenk 34366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3437c609719bSwdenk 3438c609719bSwdenk Offset of the initial data structure in the memory 34396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 34406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3441c609719bSwdenk data is located at the end of the available space 3442553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 3443acd51f9dSSimon Glass GENERATED_GBL_DATA_SIZE), and the initial stack is just 34446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 34456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3446c609719bSwdenk 3447c609719bSwdenk Note: 3448c609719bSwdenk On the MPC824X (or other systems that use the data 3449c609719bSwdenk cache for initial memory) the address chosen for 34506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3451c609719bSwdenk point to an otherwise UNUSED address space between 3452c609719bSwdenk the top of RAM and the start of the PCI space. 3453c609719bSwdenk 34546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3455c609719bSwdenk 34566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3457c609719bSwdenk SDRAM timing 3458c609719bSwdenk 34596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3460c609719bSwdenk periodic timer for refresh 3461c609719bSwdenk 34626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 34636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 34646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 34656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3466c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3467c609719bSwdenk 3468c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 34696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 34706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3471c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3472c609719bSwdenk 347369fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 3474b445bbb4SJeremiah Mahler Only scan through and get the devices on the buses. 347569fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 347669fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 347769fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 347869fd2d3bSAndrew Sharp by coreboot or similar. 347969fd2d3bSAndrew Sharp 3480842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 3481842033e6SGabor Juhos Enable support for indirect PCI bridges. 3482842033e6SGabor Juhos 3483a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3484a09b9b68SKumar Gala Chip has SRIO or not 3485a09b9b68SKumar Gala 3486a09b9b68SKumar Gala- CONFIG_SRIO1: 3487a09b9b68SKumar Gala Board has SRIO 1 port available 3488a09b9b68SKumar Gala 3489a09b9b68SKumar Gala- CONFIG_SRIO2: 3490a09b9b68SKumar Gala Board has SRIO 2 port available 3491a09b9b68SKumar Gala 3492c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 3493c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 3494c8b28152SLiu Gang 3495a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3496a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3497a09b9b68SKumar Gala 3498a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3499a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3500a09b9b68SKumar Gala 3501a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3502a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3503a09b9b68SKumar Gala 350466bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 350566bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 350666bd1846SFabio Estevam a 16 bit bus. 350766bd1846SFabio Estevam Not all NAND drivers use this symbol. 3508a430e916SFabio Estevam Example of drivers that use it: 350966bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 3510a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 3511eced4626SAlex Waterman 3512eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3513eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3514eced4626SAlex Waterman a default value will be used. 3515eced4626SAlex Waterman 3516bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3517218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3518218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3519218ca724SWolfgang Denk 3520bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3521bb99ad6dSBen Warren I2C address of the SPD EEPROM 3522bb99ad6dSBen Warren 35236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 3524218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 3525218ca724SWolfgang Denk one, specify here. Note that the value must resolve 3526218ca724SWolfgang Denk to something your driver can deal with. 3527bb99ad6dSBen Warren 35281b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 35291b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 35301b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 35311b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 35321b3e3c4fSYork Sun header files or board specific files. 35331b3e3c4fSYork Sun 35346f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 35356f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 35366f5e1dc5SYork Sun 3537e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH 3538e32d59a2SYork Sun Enable sync of refresh for multiple controllers. 3539e32d59a2SYork Sun 35404516ff81SYork Sun- CONFIG_FSL_DDR_BIST 35414516ff81SYork Sun Enable built-in memory test for Freescale DDR controllers. 35424516ff81SYork Sun 35436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 3544218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 3545218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 35462ad6b513STimur Tabi 3547c26e454dSwdenk- CONFIG_RMII 3548c26e454dSwdenk Enable RMII mode for all FECs. 3549c26e454dSwdenk Note that this is a global option, we can't 3550c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 3551c26e454dSwdenk 35525cf91d6bSwdenk- CONFIG_CRC32_VERIFY 35535cf91d6bSwdenk Add a verify option to the crc32 command. 35545cf91d6bSwdenk The syntax is: 35555cf91d6bSwdenk 35565cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 35575cf91d6bSwdenk 35585cf91d6bSwdenk Where address/count indicate a memory area 35595cf91d6bSwdenk and crc32 is the correct crc32 which the 35605cf91d6bSwdenk area should have. 35615cf91d6bSwdenk 356256523f12Swdenk- CONFIG_LOOPW 356356523f12Swdenk Add the "loopw" memory command. This only takes effect if 3564493f420eSSimon Glass the memory commands are activated globally (CONFIG_CMD_MEMORY). 356556523f12Swdenk 35667b466641Sstroese- CONFIG_MX_CYCLIC 35677b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 35687b466641Sstroese "md/mw" commands. 35697b466641Sstroese Examples: 35707b466641Sstroese 35717b466641Sstroese => mdc.b 10 4 500 35727b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 35737b466641Sstroese 35747b466641Sstroese => mwc.l 100 12345678 10 35757b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 35767b466641Sstroese 35777b466641Sstroese This only takes effect if the memory commands are activated 3578493f420eSSimon Glass globally (CONFIG_CMD_MEMORY). 35797b466641Sstroese 35808aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 3581afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 3582e03f3169SWolfgang Denk low level initializations (like setting up the memory 3583e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3584e03f3169SWolfgang Denk relocate itself into RAM. 35858aa1a2d1Swdenk 3586e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3587e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3588e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3589e03f3169SWolfgang Denk these initializations itself. 35908aa1a2d1Swdenk 3591b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY 3592b5bd0982SSimon Glass [ARM926EJ-S only] This allows just the call to lowlevel_init() 359390211f77Syeongjun Kim to be skipped. The normal CP15 init (such as enabling the 3594b5bd0982SSimon Glass instruction cache) is still performed. 3595b5bd0982SSimon Glass 3596401bb30bSAneesh V- CONFIG_SPL_BUILD 3597df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3598df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3599df81238bSMagnus Lilja compiling a NAND SPL. 3600400558b5Swdenk 36013aa29de0SYing Zhang- CONFIG_TPL_BUILD 36023aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 36033aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 36043aa29de0SYing Zhang It is loaded by the SPL. 36053aa29de0SYing Zhang 36065df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 36075df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 36085df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 36095df572f0SYing Zhang previous 4k of the .text section. 36105df572f0SYing Zhang 36114213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 36124213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 36134213fc29SSimon Glass effective address. It is therefore not necessary to regard 36144213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 36154213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 36164213fc29SSimon Glass it maintains its own little RAM buffer which contains all 36174213fc29SSimon Glass addressable memory. This option causes some memory accesses 36184213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 36194213fc29SSimon Glass 3620588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 3621588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 3622588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 3623b16f521aSGabe Black 362416678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 362516678eb4SHeiko Schocher Enables the RTC32K OSC on AM33xx based plattforms 362616678eb4SHeiko Schocher 3627999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 3628999d7d32SKaricheri, Muralidharan Option to disable subpage write in NAND driver 3629999d7d32SKaricheri, Muralidharan driver that uses this: 3630999d7d32SKaricheri, Muralidharan drivers/mtd/nand/davinci_nand.c 3631999d7d32SKaricheri, Muralidharan 3632f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 3633f2717b47STimur Tabi----------------------------------- 3634f2717b47STimur Tabi 3635f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 3636f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 3637f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 3638f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 3639f2717b47STimur Tabiwithin that device. 3640f2717b47STimur Tabi 3641dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR 3642dcf1d774SZhao Qiang The address in the storage device where the FMAN microcode is located. The 3643dcf1d774SZhao Qiang meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3644dcf1d774SZhao Qiang is also specified. 3645dcf1d774SZhao Qiang 3646dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR 3647dcf1d774SZhao Qiang The address in the storage device where the QE microcode is located. The 3648f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3649f2717b47STimur Tabi is also specified. 3650f2717b47STimur Tabi 3651f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 3652f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 3653f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 3654f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 3655f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 3656f2717b47STimur Tabi 3657f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 3658f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 3659f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 3660f2717b47STimur Tabi virtual address in NOR flash. 3661f2717b47STimur Tabi 3662f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 3663f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 3664f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 3665f2717b47STimur Tabi 3666f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 3667f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 3668f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3669f2717b47STimur Tabi 3670292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 3671292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 3672292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 3673fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 3674fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 3675fc54c7faSLiu Gang master's memory space. 3676f2717b47STimur Tabi 3677b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support: 3678b940ca64SJ. German Rivera--------------------------------------------------------- 3679b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of 3680b940ca64SJ. German Rivera"firmware". 3681b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros 3682b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address 3683b940ca64SJ. German Riverawithin that device. 3684b940ca64SJ. German Rivera 3685b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET 3686b940ca64SJ. German Rivera Enable the MC driver for Layerscape SoCs. 3687b940ca64SJ. German Rivera 36885c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support: 36895c055089SPrabhakar Kushwaha------------------------------------------- 36905c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of 36915c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom. 36925c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting. 36935c055089SPrabhakar Kushwaha 3694c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN 3695c0492141SYork Sun Define alignment of reserved memory MC requires 36965c055089SPrabhakar Kushwaha 3697f3f431a7SPaul KocialkowskiReproducible builds 3698f3f431a7SPaul Kocialkowski------------------- 3699f3f431a7SPaul Kocialkowski 3700f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build 3701f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value. 3702f3f431a7SPaul Kocialkowski 3703f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable. 3704f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration 3705f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot. 3706f3f431a7SPaul Kocialkowski 3707f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. 3708f3f431a7SPaul Kocialkowski 3709c609719bSwdenkBuilding the Software: 3710c609719bSwdenk====================== 3711c609719bSwdenk 3712218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 3713218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 3714218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 3715218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 3716218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3717218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 3718c609719bSwdenk 3719218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 3720218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 3721218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 3722218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 3723218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 3724c609719bSwdenk 3725218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 3726218ca724SWolfgang Denk $ export CROSS_COMPILE 3727c609719bSwdenk 37282f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 37292f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 37302f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 37312f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 37322f8d396bSPeter Tyser 37332f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 37342f8d396bSPeter Tyser 37352f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 37362f8d396bSPeter Tyser be executed on computers running Windows. 37372f8d396bSPeter Tyser 3738c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3739c609719bSwdenksources you must configure U-Boot for one specific board type. This 3740c609719bSwdenkis done by typing: 3741c609719bSwdenk 3742ab584d67SHolger Freyther make NAME_defconfig 3743c609719bSwdenk 3744ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu- 37454d675ae6SMichael Jonesrations; see boards.cfg for supported names. 374654387ac9Swdenk 3747c609719bSwdenkNote: for some board special configuration names may exist; check if 3748c609719bSwdenk additional information is available from the board vendor; for 37492729af9dSwdenk instance, the TQM823L systems are available without (standard) 37502729af9dSwdenk or with LCD support. You can select such additional "features" 375111ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3752c609719bSwdenk 3753ab584d67SHolger Freyther make TQM823L_defconfig 37542729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3755c609719bSwdenk 3756ab584d67SHolger Freyther make TQM823L_LCD_defconfig 3757c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3758c609719bSwdenk 3759c609719bSwdenk etc. 3760c609719bSwdenk 3761c609719bSwdenk 3762c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 37637152b1d0Swdenkimages ready for download to / installation on your system: 3764c609719bSwdenk 3765c609719bSwdenk- "u-boot.bin" is a raw binary image 3766c609719bSwdenk- "u-boot" is an image in ELF binary format 3767c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3768c609719bSwdenk 3769baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3770baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3771baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3772baf31249SMarian Balakowicz 3773baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3774baf31249SMarian Balakowicz 3775baf31249SMarian Balakowicz make O=/tmp/build distclean 3776ab584d67SHolger Freyther make O=/tmp/build NAME_defconfig 3777baf31249SMarian Balakowicz make O=/tmp/build all 3778baf31249SMarian Balakowicz 3779adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location: 3780baf31249SMarian Balakowicz 3781adbba996STimo Ketola export KBUILD_OUTPUT=/tmp/build 3782baf31249SMarian Balakowicz make distclean 3783ab584d67SHolger Freyther make NAME_defconfig 3784baf31249SMarian Balakowicz make all 3785baf31249SMarian Balakowicz 3786adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment 3787baf31249SMarian Balakowiczvariable. 3788baf31249SMarian Balakowicz 3789c609719bSwdenk 3790c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3791c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3792c609719bSwdenknative "make". 3793c609719bSwdenk 3794c609719bSwdenk 3795c609719bSwdenkIf the system board that you have is not listed, then you will need 3796c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3797c609719bSwdenksteps: 3798c609719bSwdenk 37993c1496cdSPhil Sutter1. Create a new directory to hold your board specific code. Add any 380085ec0bccSwdenk files you need. In your board directory, you will need at least 38013c1496cdSPhil Sutter the "Makefile" and a "<board>.c". 38023c1496cdSPhil Sutter2. Create a new configuration file "include/configs/<board>.h" for 38033c1496cdSPhil Sutter your board. 3804c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3805c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 3806ab584d67SHolger Freyther4. Run "make <board>_defconfig" with your new name. 3807c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3808c609719bSwdenk to be installed on your target system. 380985ec0bccSwdenk6. Debug and solve any problems that might arise. 3810c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3811c609719bSwdenk 3812c609719bSwdenk 3813c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3814c609719bSwdenk============================================================== 3815c609719bSwdenk 3816c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3817c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3818c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3819c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3820218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3821c609719bSwdenk 3822c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3823c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3824c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 38256de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will 38266de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this 38276de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H' 38286de80f21SSimon Glassfor documentation. 3829baf31249SMarian Balakowicz 3830baf31249SMarian Balakowicz 3831c609719bSwdenkSee also "U-Boot Porting Guide" below. 3832c609719bSwdenk 3833c609719bSwdenk 3834c609719bSwdenkMonitor Commands - Overview: 3835c609719bSwdenk============================ 3836c609719bSwdenk 3837c609719bSwdenkgo - start application at address 'addr' 3838c609719bSwdenkrun - run commands in an environment variable 3839c609719bSwdenkbootm - boot application image from memory 3840c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 384144f074c7SMarek Vasutbootz - boot zImage from memory 3842c609719bSwdenktftpboot- boot image via network using TFTP protocol 3843c609719bSwdenk and env variables "ipaddr" and "serverip" 3844c609719bSwdenk (and eventually "gatewayip") 38451fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 3846c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3847c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3848c609719bSwdenkloads - load S-Record file over serial line 3849c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3850c609719bSwdenkmd - memory display 3851c609719bSwdenkmm - memory modify (auto-incrementing) 3852c609719bSwdenknm - memory modify (constant address) 3853c609719bSwdenkmw - memory write (fill) 3854c609719bSwdenkcp - memory copy 3855c609719bSwdenkcmp - memory compare 3856c609719bSwdenkcrc32 - checksum calculation 38570f89c54bSPeter Tyseri2c - I2C sub-system 3858c609719bSwdenksspi - SPI utility commands 3859c609719bSwdenkbase - print or set address offset 3860c609719bSwdenkprintenv- print environment variables 3861c609719bSwdenksetenv - set environment variables 3862c609719bSwdenksaveenv - save environment variables to persistent storage 3863c609719bSwdenkprotect - enable or disable FLASH write protection 3864c609719bSwdenkerase - erase FLASH memory 3865c609719bSwdenkflinfo - print FLASH memory information 386610635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 3867c609719bSwdenkbdinfo - print Board Info structure 3868c609719bSwdenkiminfo - print header information for application image 3869c609719bSwdenkconinfo - print console devices and informations 3870c609719bSwdenkide - IDE sub-system 3871c609719bSwdenkloop - infinite loop on address range 387256523f12Swdenkloopw - infinite write loop on address range 3873c609719bSwdenkmtest - simple RAM test 3874c609719bSwdenkicache - enable or disable instruction cache 3875c609719bSwdenkdcache - enable or disable data cache 3876c609719bSwdenkreset - Perform RESET of the CPU 3877c609719bSwdenkecho - echo args to console 3878c609719bSwdenkversion - print monitor version 3879c609719bSwdenkhelp - print online help 3880c609719bSwdenk? - alias for 'help' 3881c609719bSwdenk 3882c609719bSwdenk 3883c609719bSwdenkMonitor Commands - Detailed Description: 3884c609719bSwdenk======================================== 3885c609719bSwdenk 3886c609719bSwdenkTODO. 3887c609719bSwdenk 3888c609719bSwdenkFor now: just type "help <command>". 3889c609719bSwdenk 3890c609719bSwdenk 3891c609719bSwdenkEnvironment Variables: 3892c609719bSwdenk====================== 3893c609719bSwdenk 3894c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3895c609719bSwdenkcan be made persistent by saving to Flash memory. 3896c609719bSwdenk 3897c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3898c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3899c609719bSwdenkwithout a value can be used to delete a variable from the 3900c609719bSwdenkenvironment. As long as you don't save the environment you are 3901c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3902c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3903c609719bSwdenk 3904c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3905c96f86eeSWolfgang Denk 3906c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3907c609719bSwdenk 3908c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3909c609719bSwdenk 3910c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3911c609719bSwdenk 3912c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3913c609719bSwdenk 3914c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3915c609719bSwdenk 3916c609719bSwdenk bootfile - Name of the image to load with TFTP 3917c609719bSwdenk 39187d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 39197d721e34SBartlomiej Sieka command can be restricted. This variable is given as 39207d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 39217d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 39227d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 39237d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 3924c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3925c3624e6eSGrant Likely bootm_mapsize. 3926c3624e6eSGrant Likely 3927c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3928c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 3929c3624e6eSGrant Likely defines the size of the memory region starting at base 3930c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 3931c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3932c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 3933c3624e6eSGrant Likely used otherwise. 39347d721e34SBartlomiej Sieka 39357d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 39367d721e34SBartlomiej Sieka command can be restricted. This variable is given as 39377d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 39387d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 39397d721e34SBartlomiej Sieka environment variable. 39407d721e34SBartlomiej Sieka 39414bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 39424bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 39434bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 39444bae9090SBartlomiej Sieka 3945c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3946c609719bSwdenk "bootp" will just load perform a lookup of the 3947c609719bSwdenk configuration from the BOOTP server, but not try to 3948c609719bSwdenk load any image using TFTP 3949c609719bSwdenk 3950c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3951c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3952c609719bSwdenk be automatically started (by internally calling 3953c609719bSwdenk "bootm") 3954c609719bSwdenk 39554a6fd34bSwdenk If set to "no", a standalone image passed to the 39564a6fd34bSwdenk "bootm" command will be copied to the load address 39574a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 39584a6fd34bSwdenk This can be used to load and uncompress arbitrary 39594a6fd34bSwdenk data. 39604a6fd34bSwdenk 3961a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 3962a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 3963fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 3964fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 3965fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 3966fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 3967fa34f6b2SShawn Guo device tree blob be copied to the maximum address 3968fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 3969fa34f6b2SShawn Guo access it during the boot procedure. 3970fa34f6b2SShawn Guo 3971a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 3972a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 3973a28afca5SDavid A. Long to work it must reside in writable memory, have 3974a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 3975a28afca5SDavid A. Long add the information it needs into it, and the memory 3976a28afca5SDavid A. Long must be accessible by the kernel. 3977a28afca5SDavid A. Long 3978eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 3979eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 3980eea63e05SSimon Glass defined. 3981eea63e05SSimon Glass 398217ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 398317ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 398417ea1177Swdenk mode (400kHZ). This environment variable is used in 398517ea1177Swdenk initialization code. So, for changes to be effective 398617ea1177Swdenk it must be saved and board must be reset. 398717ea1177Swdenk 3988c609719bSwdenk initrd_high - restrict positioning of initrd images: 3989c609719bSwdenk If this variable is not set, initrd images will be 3990c609719bSwdenk copied to the highest possible address in RAM; this 3991c609719bSwdenk is usually what you want since it allows for 3992c609719bSwdenk maximum initrd size. If for some reason you want to 3993c609719bSwdenk make sure that the initrd image is loaded below the 39946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3995c609719bSwdenk variable to a value of "no" or "off" or "0". 3996c609719bSwdenk Alternatively, you can set it to a maximum upper 3997c609719bSwdenk address to use (U-Boot will still check that it 3998c609719bSwdenk does not overwrite the U-Boot stack and data). 3999c609719bSwdenk 4000c609719bSwdenk For instance, when you have a system with 16 MB 40017152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4002c609719bSwdenk you can do this by adding "mem=12M" to the value of 4003c609719bSwdenk the "bootargs" variable. However, now you must make 40047152b1d0Swdenk sure that the initrd image is placed in the first 4005c609719bSwdenk 12 MB as well - this can be done with 4006c609719bSwdenk 4007c609719bSwdenk setenv initrd_high 00c00000 4008c609719bSwdenk 400938b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 401038b99261Swdenk indication to U-Boot that all addresses are legal 401138b99261Swdenk for the Linux kernel, including addresses in flash 401238b99261Swdenk memory. In this case U-Boot will NOT COPY the 401338b99261Swdenk ramdisk at all. This may be useful to reduce the 401438b99261Swdenk boot time on your system, but requires that this 401538b99261Swdenk feature is supported by your Linux kernel. 401638b99261Swdenk 4017c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4018c609719bSwdenk 4019c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4020dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4021c609719bSwdenk 4022c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 4023c609719bSwdenk 4024c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 4025c609719bSwdenk 4026c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 4027c609719bSwdenk 4028c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4029c609719bSwdenk 4030c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4031c609719bSwdenk 4032e2a53458SMike Frysinger ethprime - controls which interface is used first. 4033a3d991bdSwdenk 4034e2a53458SMike Frysinger ethact - controls which interface is currently active. 4035e2a53458SMike Frysinger For example you can do the following 4036a3d991bdSwdenk 403748690d80SHeiko Schocher => setenv ethact FEC 403848690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 403948690d80SHeiko Schocher => setenv ethact SCC 404048690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 4041a3d991bdSwdenk 4042e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4043e1692577SMatthias Fuchs available network interfaces. 4044e1692577SMatthias Fuchs It just stays at the currently selected interface. 4045e1692577SMatthias Fuchs 4046a3d991bdSwdenk netretry - When set to "no" each network operation will 4047a3d991bdSwdenk either succeed or fail without retrying. 40486e592385Swdenk When set to "once" the network operation will 40496e592385Swdenk fail when all the available network interfaces 40506e592385Swdenk are tried once without success. 4051a3d991bdSwdenk Useful on scripts which control the retry operation 4052a3d991bdSwdenk themselves. 4053a3d991bdSwdenk 4054b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4055a1cf027aSJean-Christophe PLAGNIOL-VILLARD 4056b445bbb4SJeremiah Mahler silent_linux - If set then Linux will be told to boot silently, by 40578d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 40588d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 40598d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 40608d51aacdSSimon Glass is silent. 40618d51aacdSSimon Glass 4062f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpsrcp - If this is set, the value is used for TFTP's 4063ecb0ccd9SWolfgang Denk UDP source port. 4064ecb0ccd9SWolfgang Denk 4065f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpdstp - If this is set, the value is used for TFTP's UDP 406628cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 406728cb9375SWolfgang Denk 4068c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4069c96f86eeSWolfgang Denk we use the TFTP server's default block size 4070c96f86eeSWolfgang Denk 4071c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4072c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4073c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4074c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4075c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4076c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4077c96f86eeSWolfgang Denk with unreliable TFTP servers. 4078c96f86eeSWolfgang Denk 4079f5fb7346SAlbert ARIBAUD \(3ADEV\) tftptimeoutcountmax - maximum count of TFTP timeouts (no 4080f5fb7346SAlbert ARIBAUD \(3ADEV\) unit, minimum value = 0). Defines how many timeouts 4081f5fb7346SAlbert ARIBAUD \(3ADEV\) can happen during a single file transfer before that 4082f5fb7346SAlbert ARIBAUD \(3ADEV\) transfer is aborted. The default is 10, and 0 means 4083f5fb7346SAlbert ARIBAUD \(3ADEV\) 'no timeouts allowed'. Increasing this value may help 4084f5fb7346SAlbert ARIBAUD \(3ADEV\) downloads succeed with high packet loss rates, or with 4085f5fb7346SAlbert ARIBAUD \(3ADEV\) unreliable TFTP servers or client hardware. 4086f5fb7346SAlbert ARIBAUD \(3ADEV\) 4087a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 408811ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4089a3d991bdSwdenk VLAN tagged frames. 4090c609719bSwdenk 409150768f5bSAlexandre Messier bootpretryperiod - Period during which BOOTP/DHCP sends retries. 409250768f5bSAlexandre Messier Unsigned value, in milliseconds. If not set, the period will 409350768f5bSAlexandre Messier be either the default (28000), or a value based on 409450768f5bSAlexandre Messier CONFIG_NET_RETRY_COUNT, if defined. This value has 409550768f5bSAlexandre Messier precedence over the valu based on CONFIG_NET_RETRY_COUNT. 409650768f5bSAlexandre Messier 4097dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4098dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4099dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4100dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4101dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4102dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4103dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4104dc0b7b0eSJason Hobbs 4105dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4106aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some 4107dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4108dc0b7b0eSJason Hobbs 4109dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4110dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4111dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4112dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4113dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4114dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4115dc0b7b0eSJason Hobbs 4116c609719bSwdenkThe following environment variables may be used and automatically 4117c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4118c609719bSwdenkdepending the information provided by your boot server: 4119c609719bSwdenk 4120c609719bSwdenk bootfile - see above 4121c609719bSwdenk dnsip - IP address of your Domain Name Server 4122fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4123c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4124c609719bSwdenk hostname - Target hostname 4125c609719bSwdenk ipaddr - see above 4126c609719bSwdenk netmask - Subnet Mask 4127c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4128c609719bSwdenk serverip - see above 4129c609719bSwdenk 4130c609719bSwdenk 4131c609719bSwdenkThere are two special Environment Variables: 4132c609719bSwdenk 4133c609719bSwdenk serial# - contains hardware identification information such 4134c609719bSwdenk as type string and/or serial number 4135c609719bSwdenk ethaddr - Ethernet address 4136c609719bSwdenk 4137c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4138c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4139c609719bSwdenkonce they have been set once. 4140c609719bSwdenk 4141c609719bSwdenk 4142c1551ea8SstroeseFurther special Environment Variables: 4143c1551ea8Sstroese 4144c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4145c1551ea8Sstroese with the "version" command. This variable is 4146c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4147c1551ea8Sstroese 4148c1551ea8Sstroese 4149c609719bSwdenkPlease note that changes to some configuration parameters may take 4150c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4151c609719bSwdenk 4152c609719bSwdenk 4153170ab110SJoe HershbergerCallback functions for environment variables: 4154170ab110SJoe Hershberger--------------------------------------------- 4155170ab110SJoe Hershberger 4156170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 4157b445bbb4SJeremiah Mahlerwhen their values are changed. This functionality allows functions to 4158170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 4159170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 4160170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 4161170ab110SJoe Hershberger 4162170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 4163170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 4164170ab110SJoe Hershberger 4165170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 4166170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4167170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 4168170ab110SJoe Hershbergerassociations. The list must be in the following format: 4169170ab110SJoe Hershberger 4170170ab110SJoe Hershberger entry = variable_name[:callback_name] 4171170ab110SJoe Hershberger list = entry[,list] 4172170ab110SJoe Hershberger 4173170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 4174170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 4175170ab110SJoe Hershberger 4176170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 4177170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 4178170ab110SJoe Hershbergeroverride any association in the static list. You can define 4179170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 4180b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment. 4181170ab110SJoe Hershberger 4182bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a 4183bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to 4184bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out. 4185bdf1fe4eSJoe Hershberger 4186170ab110SJoe Hershberger 4187f07771ccSwdenkCommand Line Parsing: 4188f07771ccSwdenk===================== 4189f07771ccSwdenk 4190f07771ccSwdenkThere are two different command line parsers available with U-Boot: 41917152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 4192f07771ccSwdenk 4193f07771ccSwdenkOld, simple command line parser: 4194f07771ccSwdenk-------------------------------- 4195f07771ccSwdenk 4196f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 4197f07771ccSwdenk- several commands on one line, separated by ';' 4198fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 4199f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 4200f07771ccSwdenk for example: 4201fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 4202f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 4203f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4204f07771ccSwdenk 4205f07771ccSwdenkHush shell: 4206f07771ccSwdenk----------- 4207f07771ccSwdenk 4208f07771ccSwdenk- similar to Bourne shell, with control structures like 4209f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 4210f07771ccSwdenk until...do...done, ... 4211f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 4212f07771ccSwdenk commands) and local shell variables (through standard shell syntax 4213f07771ccSwdenk "name=value"); only environment variables can be used with "run" 4214f07771ccSwdenk command 4215f07771ccSwdenk 4216f07771ccSwdenkGeneral rules: 4217f07771ccSwdenk-------------- 4218f07771ccSwdenk 4219f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 4220f07771ccSwdenk command) contains several commands separated by semicolon, and 4221f07771ccSwdenk one of these commands fails, then the remaining commands will be 4222f07771ccSwdenk executed anyway. 4223f07771ccSwdenk 4224f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 422511ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4226f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4227f07771ccSwdenk variables are not executed. 4228f07771ccSwdenk 4229c609719bSwdenkNote for Redundant Ethernet Interfaces: 4230c609719bSwdenk======================================= 4231c609719bSwdenk 423211ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 4233c609719bSwdenksuch configurations and is capable of automatic selection of a 42347152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 4235c609719bSwdenk 4236c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 4237c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4238c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 4239c609719bSwdenk 4240c609719bSwdenkIf the network interface stores some valid MAC address (for instance 4241c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 4242c609719bSwdenkding setting in the environment; if the corresponding environment 4243c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 4244c609719bSwdenk 4245c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 4246c609719bSwdenk environment, the SROM's address is used. 4247c609719bSwdenk 4248c609719bSwdenko If there is no valid address in the SROM, and a definition in the 4249c609719bSwdenk environment exists, then the value from the environment variable is 4250c609719bSwdenk used. 4251c609719bSwdenk 4252c609719bSwdenko If both the SROM and the environment contain a MAC address, and 4253c609719bSwdenk both addresses are the same, this MAC address is used. 4254c609719bSwdenk 4255c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 4256c609719bSwdenk addresses differ, the value from the environment is used and a 4257c609719bSwdenk warning is printed. 4258c609719bSwdenk 4259c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 4260bef1014bSJoe Hershberger is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case 4261bef1014bSJoe Hershberger a random, locally-assigned MAC is used. 4262c609719bSwdenk 4263ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4264ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 4265ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 4266ecee9324SBen WarrenThe naming convention is as follows: 4267ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4268c609719bSwdenk 4269c609719bSwdenkImage Formats: 4270c609719bSwdenk============== 4271c609719bSwdenk 42723310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 42733310c549SMarian Balakowiczimages in two formats: 42743310c549SMarian Balakowicz 42753310c549SMarian BalakowiczNew uImage format (FIT) 42763310c549SMarian Balakowicz----------------------- 42773310c549SMarian Balakowicz 42783310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 42793310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 42803310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 42813310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 42823310c549SMarian Balakowicz 42833310c549SMarian Balakowicz 42843310c549SMarian BalakowiczOld uImage format 42853310c549SMarian Balakowicz----------------- 42863310c549SMarian Balakowicz 42873310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 42883310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 42893310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 4290c609719bSwdenk 4291c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 4292c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 4293f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 4294f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 4295f5ed9e39SPeter Tyser INTEGRITY). 4296daab59acSAndy Shevchenko* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86, 4297afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 4298daab59acSAndy Shevchenko Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC). 4299c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 4300c609719bSwdenk* Load Address 4301c609719bSwdenk* Entry Point 4302c609719bSwdenk* Image Name 4303c609719bSwdenk* Image Timestamp 4304c609719bSwdenk 4305c609719bSwdenkThe header is marked by a special Magic Number, and both the header 4306c609719bSwdenkand the data portions of the image are secured against corruption by 4307c609719bSwdenkCRC32 checksums. 4308c609719bSwdenk 4309c609719bSwdenk 4310c609719bSwdenkLinux Support: 4311c609719bSwdenk============== 4312c609719bSwdenk 4313c609719bSwdenkAlthough U-Boot should support any OS or standalone application 43147152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 4315c609719bSwdenkU-Boot. 4316c609719bSwdenk 4317c609719bSwdenkU-Boot includes many features that so far have been part of some 4318c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 4319c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 4320c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 43217152b1d0Swdenkserves several purposes: 4322c609719bSwdenk 4323c609719bSwdenk- the same features can be used for other OS or standalone 4324c609719bSwdenk applications (for instance: using compressed images to reduce the 4325c609719bSwdenk Flash memory footprint) 4326c609719bSwdenk 4327c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 43287152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 4329c609719bSwdenk 4330c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 4331c609719bSwdenk images; of course this also means that different kernel images can 4332c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 4333c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 4334c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 4335c609719bSwdenk software is easier now. 4336c609719bSwdenk 4337c609719bSwdenk 4338c609719bSwdenkLinux HOWTO: 4339c609719bSwdenk============ 4340c609719bSwdenk 4341c609719bSwdenkPorting Linux to U-Boot based systems: 4342c609719bSwdenk--------------------------------------- 4343c609719bSwdenk 4344c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 4345c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 4346c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 4347c609719bSwdenkLinux :-). 4348c609719bSwdenk 4349a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4350c609719bSwdenk 4351c609719bSwdenkJust make sure your machine specific header file (for instance 4352c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 43531dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 43541dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 43556d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 4356c609719bSwdenk 43572eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers. 43582eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there 43592eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See 43602eb31b13SSimon Glassdoc/driver-model. 43612eb31b13SSimon Glass 4362c609719bSwdenk 4363c609719bSwdenkConfiguring the Linux kernel: 4364c609719bSwdenk----------------------------- 4365c609719bSwdenk 4366c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 4367c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 4368c609719bSwdenk 4369c609719bSwdenk 4370c609719bSwdenkBuilding a Linux Image: 4371c609719bSwdenk----------------------- 4372c609719bSwdenk 437324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 437424ee89b9Swdenknot used. If you use recent kernel source, a new build target 437524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 437624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 437724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 437824ee89b9Swdenk100% compatible format. 4379c609719bSwdenk 4380c609719bSwdenkExample: 4381c609719bSwdenk 4382ab584d67SHolger Freyther make TQM850L_defconfig 4383c609719bSwdenk make oldconfig 4384c609719bSwdenk make dep 438524ee89b9Swdenk make uImage 4386c609719bSwdenk 438724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 438824ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 438924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 4390c609719bSwdenk 439124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 439224ee89b9Swdenk 439324ee89b9Swdenk* convert the kernel into a raw binary image: 439424ee89b9Swdenk 439524ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 439624ee89b9Swdenk -R .note -R .comment \ 439724ee89b9Swdenk -S vmlinux linux.bin 439824ee89b9Swdenk 439924ee89b9Swdenk* compress the binary image: 440024ee89b9Swdenk 440124ee89b9Swdenk gzip -9 linux.bin 440224ee89b9Swdenk 440324ee89b9Swdenk* package compressed binary image for U-Boot: 440424ee89b9Swdenk 440524ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 440624ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 440724ee89b9Swdenk -d linux.bin.gz uImage 440824ee89b9Swdenk 440924ee89b9Swdenk 441024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 441124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 441224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 441324ee89b9Swdenkbyte header containing information about target architecture, 441424ee89b9Swdenkoperating system, image type, compression method, entry points, time 441524ee89b9Swdenkstamp, CRC32 checksums, etc. 441624ee89b9Swdenk 441724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 441824ee89b9Swdenkprint the header information, or to build new images. 4419c609719bSwdenk 4420c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4421c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4422c609719bSwdenkchecksum verification: 4423c609719bSwdenk 4424c609719bSwdenk tools/mkimage -l image 4425c609719bSwdenk -l ==> list image header information 4426c609719bSwdenk 4427c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4428c609719bSwdenkfrom a "data file" which is used as image payload: 4429c609719bSwdenk 4430c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4431c609719bSwdenk -n name -d data_file image 4432c609719bSwdenk -A ==> set architecture to 'arch' 4433c609719bSwdenk -O ==> set operating system to 'os' 4434c609719bSwdenk -T ==> set image type to 'type' 4435c609719bSwdenk -C ==> set compression type 'comp' 4436c609719bSwdenk -a ==> set load address to 'addr' (hex) 4437c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4438c609719bSwdenk -n ==> set image name to 'name' 4439c609719bSwdenk -d ==> use image data from 'datafile' 4440c609719bSwdenk 444169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 444269459791Swdenkaddress (0x00000000), but the entry point address depends on the 444369459791Swdenkkernel version: 4444c609719bSwdenk 4445c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 444624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4447c609719bSwdenk 4448c609719bSwdenkSo a typical call to build a U-Boot image would read: 4449c609719bSwdenk 445024ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 445124ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4452a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 445324ee89b9Swdenk > examples/uImage.TQM850L 445424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4455c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4456c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4457c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4458c609719bSwdenk Load Address: 0x00000000 445924ee89b9Swdenk Entry Point: 0x00000000 4460c609719bSwdenk 4461c609719bSwdenkTo verify the contents of the image (or check for corruption): 4462c609719bSwdenk 446324ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 446424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4465c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4466c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4467c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4468c609719bSwdenk Load Address: 0x00000000 446924ee89b9Swdenk Entry Point: 0x00000000 4470c609719bSwdenk 4471c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 4472c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 4473c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 4474c609719bSwdenkneed to be uncompressed: 4475c609719bSwdenk 4476a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 447724ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 447824ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4479a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 448024ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 448124ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4482c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4483c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4484c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4485c609719bSwdenk Load Address: 0x00000000 448624ee89b9Swdenk Entry Point: 0x00000000 4487c609719bSwdenk 4488c609719bSwdenk 4489c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4490c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4491c609719bSwdenk 4492c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4493c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4494c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4495c609719bSwdenk Image Name: Simple Ramdisk Image 4496c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4497c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4498c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4499c609719bSwdenk Load Address: 0x00000000 4500c609719bSwdenk Entry Point: 0x00000000 4501c609719bSwdenk 4502a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 4503a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 4504a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 4505a804b5ceSGuilherme Maciel Ferreirafrom the image: 4506a804b5ceSGuilherme Maciel Ferreira 4507f41f5b7cSGuilherme Maciel Ferreira tools/dumpimage -i image -T type -p position data_file 4508f41f5b7cSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file' 4509f41f5b7cSGuilherme Maciel Ferreira -T ==> set image type to 'type' 4510f41f5b7cSGuilherme Maciel Ferreira -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' 4511a804b5ceSGuilherme Maciel Ferreira 4512c609719bSwdenk 4513c609719bSwdenkInstalling a Linux Image: 4514c609719bSwdenk------------------------- 4515c609719bSwdenk 4516c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4517c609719bSwdenkyou must convert the image to S-Record format: 4518c609719bSwdenk 4519c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4520c609719bSwdenk 4521c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4522c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4523c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4524c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4525c609719bSwdenkcommand. 4526c609719bSwdenk 4527c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4528c609719bSwdenkTQM8xxL is in the first Flash bank): 4529c609719bSwdenk 4530c609719bSwdenk => erase 40100000 401FFFFF 4531c609719bSwdenk 4532c609719bSwdenk .......... done 4533c609719bSwdenk Erased 8 sectors 4534c609719bSwdenk 4535c609719bSwdenk => loads 40100000 4536c609719bSwdenk ## Ready for S-Record download ... 4537c609719bSwdenk ~>examples/image.srec 4538c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4539c609719bSwdenk ... 4540c609719bSwdenk 15989 15990 15991 15992 4541c609719bSwdenk [file transfer complete] 4542c609719bSwdenk [connected] 4543c609719bSwdenk ## Start Addr = 0x00000000 4544c609719bSwdenk 4545c609719bSwdenk 4546c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4547c609719bSwdenkthis includes a checksum verification so you can be sure no data 4548c609719bSwdenkcorruption happened: 4549c609719bSwdenk 4550c609719bSwdenk => imi 40100000 4551c609719bSwdenk 4552c609719bSwdenk ## Checking Image at 40100000 ... 4553c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4554c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4555c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4556c609719bSwdenk Load Address: 00000000 4557c609719bSwdenk Entry Point: 0000000c 4558c609719bSwdenk Verifying Checksum ... OK 4559c609719bSwdenk 4560c609719bSwdenk 4561c609719bSwdenkBoot Linux: 4562c609719bSwdenk----------- 4563c609719bSwdenk 4564c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4565c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4566c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4567c609719bSwdenkparameters. You can check and modify this variable using the 4568c609719bSwdenk"printenv" and "setenv" commands: 4569c609719bSwdenk 4570c609719bSwdenk 4571c609719bSwdenk => printenv bootargs 4572c609719bSwdenk bootargs=root=/dev/ram 4573c609719bSwdenk 4574c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4575c609719bSwdenk 4576c609719bSwdenk => printenv bootargs 4577c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4578c609719bSwdenk 4579c609719bSwdenk => bootm 40020000 4580c609719bSwdenk ## Booting Linux kernel at 40020000 ... 4581c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 4582c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4583c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 4584c609719bSwdenk Load Address: 00000000 4585c609719bSwdenk Entry Point: 0000000c 4586c609719bSwdenk Verifying Checksum ... OK 4587c609719bSwdenk Uncompressing Kernel Image ... OK 4588c609719bSwdenk 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 4589c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4590c609719bSwdenk time_init: decrementer frequency = 187500000/60 4591c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4592c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4593c609719bSwdenk ... 4594c609719bSwdenk 459511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 45967152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 4597c609719bSwdenkformat!) to the "bootm" command: 4598c609719bSwdenk 4599c609719bSwdenk => imi 40100000 40200000 4600c609719bSwdenk 4601c609719bSwdenk ## Checking Image at 40100000 ... 4602c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4603c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4604c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4605c609719bSwdenk Load Address: 00000000 4606c609719bSwdenk Entry Point: 0000000c 4607c609719bSwdenk Verifying Checksum ... OK 4608c609719bSwdenk 4609c609719bSwdenk ## Checking Image at 40200000 ... 4610c609719bSwdenk Image Name: Simple Ramdisk Image 4611c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4612c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4613c609719bSwdenk Load Address: 00000000 4614c609719bSwdenk Entry Point: 00000000 4615c609719bSwdenk Verifying Checksum ... OK 4616c609719bSwdenk 4617c609719bSwdenk => bootm 40100000 40200000 4618c609719bSwdenk ## Booting Linux kernel at 40100000 ... 4619c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4620c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4621c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4622c609719bSwdenk Load Address: 00000000 4623c609719bSwdenk Entry Point: 0000000c 4624c609719bSwdenk Verifying Checksum ... OK 4625c609719bSwdenk Uncompressing Kernel Image ... OK 4626c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 4627c609719bSwdenk Image Name: Simple Ramdisk Image 4628c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4629c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4630c609719bSwdenk Load Address: 00000000 4631c609719bSwdenk Entry Point: 00000000 4632c609719bSwdenk Verifying Checksum ... OK 4633c609719bSwdenk Loading Ramdisk ... OK 4634c609719bSwdenk 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 4635c609719bSwdenk Boot arguments: root=/dev/ram 4636c609719bSwdenk time_init: decrementer frequency = 187500000/60 4637c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4638c609719bSwdenk ... 4639c609719bSwdenk RAMDISK: Compressed image found at block 0 4640c609719bSwdenk VFS: Mounted root (ext2 filesystem). 4641c609719bSwdenk 4642c609719bSwdenk bash# 4643c609719bSwdenk 46440267768eSMatthew McClintockBoot Linux and pass a flat device tree: 46450267768eSMatthew McClintock----------- 46460267768eSMatthew McClintock 46470267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 46480267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 46490267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 46500267768eSMatthew McClintockflat device tree: 46510267768eSMatthew McClintock 46520267768eSMatthew McClintock=> print oftaddr 46530267768eSMatthew McClintockoftaddr=0x300000 46540267768eSMatthew McClintock=> print oft 46550267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 46560267768eSMatthew McClintock=> tftp $oftaddr $oft 46570267768eSMatthew McClintockSpeed: 1000, full duplex 46580267768eSMatthew McClintockUsing TSEC0 device 46590267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 46600267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 46610267768eSMatthew McClintockLoad address: 0x300000 46620267768eSMatthew McClintockLoading: # 46630267768eSMatthew McClintockdone 46640267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 46650267768eSMatthew McClintock=> tftp $loadaddr $bootfile 46660267768eSMatthew McClintockSpeed: 1000, full duplex 46670267768eSMatthew McClintockUsing TSEC0 device 46680267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 46690267768eSMatthew McClintockFilename 'uImage'. 46700267768eSMatthew McClintockLoad address: 0x200000 46710267768eSMatthew McClintockLoading:############ 46720267768eSMatthew McClintockdone 46730267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 46740267768eSMatthew McClintock=> print loadaddr 46750267768eSMatthew McClintockloadaddr=200000 46760267768eSMatthew McClintock=> print oftaddr 46770267768eSMatthew McClintockoftaddr=0x300000 46780267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 46790267768eSMatthew McClintock## Booting image at 00200000 ... 46800267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 46810267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 46820267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 46830267768eSMatthew McClintock Load Address: 00000000 46840267768eSMatthew McClintock Entry Point: 00000000 46850267768eSMatthew McClintock Verifying Checksum ... OK 46860267768eSMatthew McClintock Uncompressing Kernel Image ... OK 46870267768eSMatthew McClintockBooting using flat device tree at 0x300000 46880267768eSMatthew McClintockUsing MPC85xx ADS machine description 46890267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 46900267768eSMatthew McClintock[snip] 46910267768eSMatthew McClintock 46920267768eSMatthew McClintock 46936069ff26SwdenkMore About U-Boot Image Types: 46946069ff26Swdenk------------------------------ 46956069ff26Swdenk 46966069ff26SwdenkU-Boot supports the following image types: 46976069ff26Swdenk 46986069ff26Swdenk "Standalone Programs" are directly runnable in the environment 46996069ff26Swdenk provided by U-Boot; it is expected that (if they behave 47006069ff26Swdenk well) you can continue to work in U-Boot after return from 47016069ff26Swdenk the Standalone Program. 47026069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 47036069ff26Swdenk will take over control completely. Usually these programs 47046069ff26Swdenk will install their own set of exception handlers, device 47056069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 47066069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 47076069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 47086069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 47096069ff26Swdenk being started. 47106069ff26Swdenk "Multi-File Images" contain several images, typically an OS 47116069ff26Swdenk (Linux) kernel image and one or more data images like 47126069ff26Swdenk RAMDisks. This construct is useful for instance when you want 47136069ff26Swdenk to boot over the network using BOOTP etc., where the boot 47146069ff26Swdenk server provides just a single image file, but you want to get 47156069ff26Swdenk for instance an OS kernel and a RAMDisk image. 47166069ff26Swdenk 47176069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 47186069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 47196069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 47206069ff26Swdenk Immediately after the terminating 0 follow the images, one by 47216069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 47226069ff26Swdenk a multiple of 4 bytes). 47236069ff26Swdenk 47246069ff26Swdenk "Firmware Images" are binary images containing firmware (like 47256069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 47266069ff26Swdenk flash memory. 47276069ff26Swdenk 47286069ff26Swdenk "Script files" are command sequences that will be executed by 47296069ff26Swdenk U-Boot's command interpreter; this feature is especially 47306069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 47316069ff26Swdenk as command interpreter. 47326069ff26Swdenk 473344f074c7SMarek VasutBooting the Linux zImage: 473444f074c7SMarek Vasut------------------------- 473544f074c7SMarek Vasut 473644f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 473744f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 473844f074c7SMarek Vasutas the syntax of "bootm" command. 473944f074c7SMarek Vasut 47408ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 4741017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 4742017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 4743017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 4744017e1f3fSMarek Vasut 4745c609719bSwdenk 4746c609719bSwdenkStandalone HOWTO: 4747c609719bSwdenk================= 4748c609719bSwdenk 4749c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 4750c609719bSwdenkrun "standalone" applications, which can use some resources of 4751c609719bSwdenkU-Boot like console I/O functions or interrupt services. 4752c609719bSwdenk 4753c609719bSwdenkTwo simple examples are included with the sources: 4754c609719bSwdenk 4755c609719bSwdenk"Hello World" Demo: 4756c609719bSwdenk------------------- 4757c609719bSwdenk 4758c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 4759c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 4760c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 4761c609719bSwdenklike that: 4762c609719bSwdenk 4763c609719bSwdenk => loads 4764c609719bSwdenk ## Ready for S-Record download ... 4765c609719bSwdenk ~>examples/hello_world.srec 4766c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4767c609719bSwdenk [file transfer complete] 4768c609719bSwdenk [connected] 4769c609719bSwdenk ## Start Addr = 0x00040004 4770c609719bSwdenk 4771c609719bSwdenk => go 40004 Hello World! This is a test. 4772c609719bSwdenk ## Starting application at 0x00040004 ... 4773c609719bSwdenk Hello World 4774c609719bSwdenk argc = 7 4775c609719bSwdenk argv[0] = "40004" 4776c609719bSwdenk argv[1] = "Hello" 4777c609719bSwdenk argv[2] = "World!" 4778c609719bSwdenk argv[3] = "This" 4779c609719bSwdenk argv[4] = "is" 4780c609719bSwdenk argv[5] = "a" 4781c609719bSwdenk argv[6] = "test." 4782c609719bSwdenk argv[7] = "<NULL>" 4783c609719bSwdenk Hit any key to exit ... 4784c609719bSwdenk 4785c609719bSwdenk ## Application terminated, rc = 0x0 4786c609719bSwdenk 4787c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 4788c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 4789c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 4790c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 4791c609719bSwdenkcharacter, but this is just a demo program. The application can be 4792c609719bSwdenkcontrolled by the following keys: 4793c609719bSwdenk 4794c609719bSwdenk ? - print current values og the CPM Timer registers 4795c609719bSwdenk b - enable interrupts and start timer 4796c609719bSwdenk e - stop timer and disable interrupts 4797c609719bSwdenk q - quit application 4798c609719bSwdenk 4799c609719bSwdenk => loads 4800c609719bSwdenk ## Ready for S-Record download ... 4801c609719bSwdenk ~>examples/timer.srec 4802c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4803c609719bSwdenk [file transfer complete] 4804c609719bSwdenk [connected] 4805c609719bSwdenk ## Start Addr = 0x00040004 4806c609719bSwdenk 4807c609719bSwdenk => go 40004 4808c609719bSwdenk ## Starting application at 0x00040004 ... 4809c609719bSwdenk TIMERS=0xfff00980 4810c609719bSwdenk Using timer 1 4811c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4812c609719bSwdenk 4813c609719bSwdenkHit 'b': 4814c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 4815c609719bSwdenk Enabling timer 4816c609719bSwdenkHit '?': 4817c609719bSwdenk [q, b, e, ?] ........ 4818c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4819c609719bSwdenkHit '?': 4820c609719bSwdenk [q, b, e, ?] . 4821c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4822c609719bSwdenkHit '?': 4823c609719bSwdenk [q, b, e, ?] . 4824c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4825c609719bSwdenkHit '?': 4826c609719bSwdenk [q, b, e, ?] . 4827c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4828c609719bSwdenkHit 'e': 4829c609719bSwdenk [q, b, e, ?] ...Stopping timer 4830c609719bSwdenkHit 'q': 4831c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4832c609719bSwdenk 4833c609719bSwdenk 483485ec0bccSwdenkMinicom warning: 483585ec0bccSwdenk================ 483685ec0bccSwdenk 48377152b1d0SwdenkOver time, many people have reported problems when trying to use the 483885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 483985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4840f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 484185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 4842e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 4843e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 4844e53515a2SKarl O. Pincfor help with kermit. 4845e53515a2SKarl O. Pinc 484685ec0bccSwdenk 484752f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 484852f52c14Swdenkconfiguration to your "File transfer protocols" section: 484952f52c14Swdenk 485052f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 485152f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 485252f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 485352f52c14Swdenk 485452f52c14Swdenk 4855c609719bSwdenkNetBSD Notes: 4856c609719bSwdenk============= 4857c609719bSwdenk 4858c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4859c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4860c609719bSwdenk 4861c609719bSwdenkBuilding requires a cross environment; it is known to work on 4862c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4863c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4864c609719bSwdenkNote that the cross-powerpc package does not install include files; 4865c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4866c609719bSwdenkmissing. This file has to be installed and patched manually: 4867c609719bSwdenk 4868c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4869c609719bSwdenk # mkdir powerpc 4870c609719bSwdenk # ln -s powerpc machine 4871c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4872c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4873c609719bSwdenk 4874c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4875c609719bSwdenkand U-Boot include files. 4876c609719bSwdenk 4877c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4878c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4879c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4880c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 48812a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4882c609719bSwdenk 4883c609719bSwdenk 4884c609719bSwdenkImplementation Internals: 4885c609719bSwdenk========================= 4886c609719bSwdenk 4887c609719bSwdenkThe following is not intended to be a complete description of every 4888c609719bSwdenkimplementation detail. However, it should help to understand the 4889c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4890c609719bSwdenkhardware. 4891c609719bSwdenk 4892c609719bSwdenk 4893c609719bSwdenkInitial Stack, Global Data: 4894c609719bSwdenk--------------------------- 4895c609719bSwdenk 4896c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4897c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4898c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4899c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4900c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4901c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4902c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4903c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4904c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4905c609719bSwdenklocked as (mis-) used as memory, etc. 4906c609719bSwdenk 49077152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 49080668236bSWolfgang Denk U-Boot mailing list: 490943d9616cSwdenk 491043d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 491143d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 491243d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 491343d9616cSwdenk ... 491443d9616cSwdenk 491543d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 491643d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 491743d9616cSwdenk require any physical RAM backing up the cache. The cleverness 491843d9616cSwdenk is that the cache is being used as a temporary supply of 491943d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 492011ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 492143d9616cSwdenk can see how this works by studying the cache architecture and 492243d9616cSwdenk operation in the architecture and processor-specific manuals. 492343d9616cSwdenk 492443d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 492543d9616cSwdenk is another option for the system designer to use as an 492611ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 492743d9616cSwdenk option should work for you. Using CS 4 should be fine if your 492843d9616cSwdenk board designers haven't used it for something that would 492943d9616cSwdenk cause you grief during the initial boot! It is frequently not 493043d9616cSwdenk used. 493143d9616cSwdenk 49326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 493343d9616cSwdenk with your processor/board/system design. The default value 493443d9616cSwdenk you will find in any recent u-boot distribution in 49358a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 493643d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 493743d9616cSwdenk it above 400_0000. Just make sure your board has no resources 493843d9616cSwdenk that are supposed to respond to that address! That code in 493943d9616cSwdenk start.S has been around a while and should work as is when 494043d9616cSwdenk you get the config right. 494143d9616cSwdenk 494243d9616cSwdenk -Chris Hallinan 494343d9616cSwdenk DS4.COM, Inc. 494443d9616cSwdenk 4945c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4946c609719bSwdenkcode for the initialization procedures: 4947c609719bSwdenk 4948c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4949c609719bSwdenk to write it. 4950c609719bSwdenk 4951b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized 4952c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 49537152b1d0Swdenk zation is performed later (when relocating to RAM). 4954c609719bSwdenk 4955c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4956c609719bSwdenk that. 4957c609719bSwdenk 4958c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4959b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it 4960c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4961c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4962c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4963c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4964c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4965c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4966c609719bSwdenkreserve for this purpose. 4967c609719bSwdenk 49687152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4969c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4970c609719bSwdenkGCC's implementation. 4971c609719bSwdenk 4972c609719bSwdenkFor PowerPC, the following registers have specific use: 4973c609719bSwdenk R1: stack pointer 4974e7670f6cSWolfgang Denk R2: reserved for system use 4975c609719bSwdenk R3-R4: parameter passing and return values 4976c609719bSwdenk R5-R10: parameter passing 4977c609719bSwdenk R13: small data area pointer 4978c609719bSwdenk R30: GOT pointer 4979c609719bSwdenk R31: frame pointer 4980c609719bSwdenk 4981e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4982e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4983e6bee808SJoakim Tjernlund going back and forth between asm and C) 4984c609719bSwdenk 4985e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4986c609719bSwdenk 4987c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4988c609719bSwdenk address of the global data structure is known at compile time), 4989c609719bSwdenk but it turned out that reserving a register results in somewhat 4990c609719bSwdenk smaller code - although the code savings are not that big (on 4991c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4992c609719bSwdenk 624 text + 127 data). 4993c609719bSwdenk 4994c609719bSwdenkOn ARM, the following registers are used: 4995c609719bSwdenk 4996c609719bSwdenk R0: function argument word/integer result 4997c609719bSwdenk R1-R3: function argument word 499812eba1b4SJeroen Hofstee R9: platform specific 499912eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 5000c609719bSwdenk R11: argument (frame) pointer 5001c609719bSwdenk R12: temporary workspace 5002c609719bSwdenk R13: stack pointer 5003c609719bSwdenk R14: link register 5004c609719bSwdenk R15: program counter 5005c609719bSwdenk 500612eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 500712eba1b4SJeroen Hofstee 500812eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 5009c609719bSwdenk 50100df01fd3SThomas ChouOn Nios II, the ABI is documented here: 50110df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 50120df01fd3SThomas Chou 50130df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 50140df01fd3SThomas Chou 50150df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 50160df01fd3SThomas Chou to access small data sections, so gp is free. 50170df01fd3SThomas Chou 5018afc1ce82SMacpaul LinOn NDS32, the following registers are used: 5019afc1ce82SMacpaul Lin 5020afc1ce82SMacpaul Lin R0-R1: argument/return 5021afc1ce82SMacpaul Lin R2-R5: argument 5022afc1ce82SMacpaul Lin R15: temporary register for assembler 5023afc1ce82SMacpaul Lin R16: trampoline register 5024afc1ce82SMacpaul Lin R28: frame pointer (FP) 5025afc1ce82SMacpaul Lin R29: global pointer (GP) 5026afc1ce82SMacpaul Lin R30: link register (LP) 5027afc1ce82SMacpaul Lin R31: stack pointer (SP) 5028afc1ce82SMacpaul Lin PC: program counter (PC) 5029afc1ce82SMacpaul Lin 5030afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 5031afc1ce82SMacpaul Lin 5032d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5033d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 5034c609719bSwdenk 5035c609719bSwdenkMemory Management: 5036c609719bSwdenk------------------ 5037c609719bSwdenk 5038c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 5039c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 5040c609719bSwdenk 5041c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 5042c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 5043c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 5044c609719bSwdenkphysical memory banks. 5045c609719bSwdenk 5046c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 5047c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5048c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 5049c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 50506d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5051c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 5052c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 5053c609719bSwdenk 5054c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 5055c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 5056c609719bSwdenk 5057c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 5058c609719bSwdenkthis: 5059c609719bSwdenk 5060c609719bSwdenk 0x0000 0000 Exception Vector code 5061c609719bSwdenk : 5062c609719bSwdenk 0x0000 1FFF 5063c609719bSwdenk 0x0000 2000 Free for Application Use 5064c609719bSwdenk : 5065c609719bSwdenk : 5066c609719bSwdenk 5067c609719bSwdenk : 5068c609719bSwdenk : 5069c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 5070c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 5071c609719bSwdenk 0x00FC 0000 Malloc Arena 5072c609719bSwdenk : 5073c609719bSwdenk 0x00FD FFFF 5074c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5075c609719bSwdenk ... eventually: LCD or video framebuffer 5076c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5077c609719bSwdenk 0x00FF FFFF [End of RAM] 5078c609719bSwdenk 5079c609719bSwdenk 5080c609719bSwdenkSystem Initialization: 5081c609719bSwdenk---------------------- 5082c609719bSwdenk 5083c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 508411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5085c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory. 50867152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5087c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5088c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 50892eb48ff7SHeiko Schocherwhich provide such a feature like), or in a locked part of the data 50902eb48ff7SHeiko Schochercache. After that, U-Boot initializes the CPU core, the caches and 50912eb48ff7SHeiko Schocherthe SIU. 5092c609719bSwdenk 5093c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5094c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5095c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5096c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5097c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5098c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5099c609719bSwdenkbanks. 5100c609719bSwdenk 5101c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 51027152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5103c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5104c609719bSwdenk0x00000000, with any additional banks following immediately to create 5105c609719bSwdenkcontiguous memory starting from 0. 5106c609719bSwdenk 5107c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5108c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5109c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5110c609719bSwdenkpages, and the final stack is set up. 5111c609719bSwdenk 5112c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5113c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5114c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5115c609719bSwdenknew address in RAM. 5116c609719bSwdenk 5117c609719bSwdenk 5118c609719bSwdenkU-Boot Porting Guide: 5119c609719bSwdenk---------------------- 5120c609719bSwdenk 5121c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 51226aff3115Swdenklist, October 2002] 5123c609719bSwdenk 5124c609719bSwdenk 5125c609719bSwdenkint main(int argc, char *argv[]) 5126c609719bSwdenk{ 5127c609719bSwdenk sighandler_t no_more_time; 5128c609719bSwdenk 5129c609719bSwdenk signal(SIGALRM, no_more_time); 5130c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5131c609719bSwdenk 5132c609719bSwdenk if (available_money > available_manpower) { 51336c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5134c609719bSwdenk return 0; 5135c609719bSwdenk } 5136c609719bSwdenk 5137c609719bSwdenk Download latest U-Boot source; 5138c609719bSwdenk 51390668236bSWolfgang Denk Subscribe to u-boot mailing list; 51406aff3115Swdenk 51416c3fef28SJerry Van Baren if (clueless) 5142c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5143c609719bSwdenk 5144c609719bSwdenk while (learning) { 5145c609719bSwdenk Read the README file in the top level directory; 51467cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 51476c3fef28SJerry Van Baren Read applicable doc/*.README; 5148c609719bSwdenk Read the source, Luke; 51496c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5150c609719bSwdenk } 5151c609719bSwdenk 51526c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 51536c3fef28SJerry Van Baren Buy a BDI3000; 51546c3fef28SJerry Van Baren else 5155c609719bSwdenk Add a lot of aggravation and time; 5156c609719bSwdenk 51576c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 51586c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 51596c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 51606c3fef28SJerry Van Baren } else { 5161c609719bSwdenk Create your own board support subdirectory; 51626c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 51636c3fef28SJerry Van Baren } 51646c3fef28SJerry Van Baren Edit new board/<myboard> files 51656c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5166c609719bSwdenk 51676c3fef28SJerry Van Baren while (!accepted) { 5168c609719bSwdenk while (!running) { 5169c609719bSwdenk do { 5170c609719bSwdenk Add / modify source code; 5171c609719bSwdenk } until (compiles); 5172c609719bSwdenk Debug; 5173c609719bSwdenk if (clueless) 5174c609719bSwdenk email("Hi, I am having problems..."); 5175c609719bSwdenk } 51766c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 51776c3fef28SJerry Van Baren if (reasonable critiques) 51786c3fef28SJerry Van Baren Incorporate improvements from email list code review; 51796c3fef28SJerry Van Baren else 51806c3fef28SJerry Van Baren Defend code as written; 51816c3fef28SJerry Van Baren } 5182c609719bSwdenk 5183c609719bSwdenk return 0; 5184c609719bSwdenk} 5185c609719bSwdenk 5186c609719bSwdenkvoid no_more_time (int sig) 5187c609719bSwdenk{ 5188c609719bSwdenk hire_a_guru(); 5189c609719bSwdenk} 5190c609719bSwdenk 5191c609719bSwdenk 5192c609719bSwdenkCoding Standards: 5193c609719bSwdenk----------------- 5194c609719bSwdenk 5195c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 51966bb25446SBaruch Siachcoding style; see the kernel coding style guide at 51976bb25446SBaruch Siachhttps://www.kernel.org/doc/html/latest/process/coding-style.html, and the 51986bb25446SBaruch Siachscript "scripts/Lindent" in your Linux kernel source directory. 5199c609719bSwdenk 52002c051651SDetlev ZundelSource files originating from a different project (for example the 52012c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 5202b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those 52032c051651SDetlev Zundelsources. 52042c051651SDetlev Zundel 52052c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 52062c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 52072c051651SDetlev Zundelin your code. 5208c609719bSwdenk 5209c178d3daSwdenkPlease also stick to the following formatting rules: 5210180d3f74Swdenk- remove any trailing white space 52117ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5212180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 52137ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5214180d3f74Swdenk- do not add trailing empty lines to source files 5215180d3f74Swdenk 5216c609719bSwdenkSubmissions which do not conform to the standards may be returned 5217c609719bSwdenkwith a request to reformat the changes. 5218c609719bSwdenk 5219c609719bSwdenk 5220c609719bSwdenkSubmitting Patches: 5221c609719bSwdenk------------------- 5222c609719bSwdenk 5223c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5224c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5225c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5226c609719bSwdenk 52270d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5228218ca724SWolfgang Denk 52290668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 52300fac560fSS. Lockwood-Childssee https://lists.denx.de/listinfo/u-boot 52310668236bSWolfgang Denk 5232c609719bSwdenkWhen you send a patch, please include the following information with 5233c609719bSwdenkit: 5234c609719bSwdenk 5235c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 5236c609719bSwdenk this bug. Please try to include a way of demonstrating that the 5237c609719bSwdenk patch actually fixes something. 5238c609719bSwdenk 5239c609719bSwdenk* For new features: a description of the feature and your 5240c609719bSwdenk implementation. 5241c609719bSwdenk 5242c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 5243c609719bSwdenk 52447207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your 52457207b366SRobert P. J. Day information and associated file and directory references. 5246c609719bSwdenk 524727af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 524827af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 5249c609719bSwdenk 5250c609719bSwdenk* If your patch adds new configuration options, don't forget to 5251c609719bSwdenk document these in the README file. 5252c609719bSwdenk 5253218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 5254218ca724SWolfgang Denk recommended) you can easily generate the patch using the 52557ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 5256218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 5257218ca724SWolfgang Denk with some other mail clients. 5258c609719bSwdenk 5259218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 5260218ca724SWolfgang Denk diff does not support these options, then get the latest version of 5261218ca724SWolfgang Denk GNU diff. 52626dff5529Swdenk 5263218ca724SWolfgang Denk The current directory when running this command shall be the parent 5264218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 5265218ca724SWolfgang Denk your patch includes sufficient directory information for the 5266218ca724SWolfgang Denk affected files). 5267218ca724SWolfgang Denk 5268218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 5269218ca724SWolfgang Denk and compressed attachments must not be used. 5270c609719bSwdenk 527152f52c14Swdenk* If one logical set of modifications affects or creates several 527252f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 527352f52c14Swdenk 527452f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 527552f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 527652f52c14Swdenk 527752f52c14Swdenk 5278c609719bSwdenkNotes: 5279c609719bSwdenk 52806de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched 5281c609719bSwdenk source tree and make sure that no errors or warnings are reported 5282c609719bSwdenk for any of the boards. 5283c609719bSwdenk 5284c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 5285c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 5286c609719bSwdenk returned with a request to re-formatting / split it. 5287c609719bSwdenk 5288c609719bSwdenk* If you modify existing code, make sure that your new code does not 5289c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 5290c609719bSwdenk When adding new features, these should compile conditionally only 5291c609719bSwdenk (using #ifdef), and the resulting code with the new feature 5292c609719bSwdenk disabled must not need more memory than the old code without your 5293c609719bSwdenk modification. 529490dc6704Swdenk 52950668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 52960668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 52970668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 52980668236bSWolfgang Denk bigger than the size limit should be avoided. 5299