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 31563b2316cSAshish Kumar- ARM Platform Bus Type(CCI): 31663b2316cSAshish Kumar CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which 31763b2316cSAshish Kumar provides full cache coherency between two clusters of multi-core 31863b2316cSAshish Kumar CPUs and I/O coherency for devices and I/O masters 31963b2316cSAshish Kumar 32063b2316cSAshish Kumar CONFIG_SYS_FSL_HAS_CCI400 32163b2316cSAshish Kumar 32263b2316cSAshish Kumar Defined For SoC that has cache coherent interconnect 32363b2316cSAshish Kumar CCN-400 3247f6c2cbcSwdenk 325c055cee1SAshish Kumar CONFIG_SYS_FSL_HAS_CCN504 326c055cee1SAshish Kumar 327c055cee1SAshish Kumar Defined for SoC that has cache coherent interconnect CCN-504 328c055cee1SAshish Kumar 329c609719bSwdenkThe following options need to be configured: 330c609719bSwdenk 3312628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 332c609719bSwdenk 3332628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 3346ccec449SWolfgang Denk 335cf946c6dSLei Wen- Marvell Family Member 336cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 337cf946c6dSLei Wen multiple fs option at one time 338cf946c6dSLei Wen for marvell soc family 339cf946c6dSLei Wen 34066412c63SKumar Gala- 85xx CPU Options: 341ffd06e02SYork Sun CONFIG_SYS_PPC64 342ffd06e02SYork Sun 343ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 344ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 345ffd06e02SYork Sun compliance, among other possible reasons. 346ffd06e02SYork Sun 34766412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 34866412c63SKumar Gala 34966412c63SKumar Gala Defines the core time base clock divider ratio compared to the 35066412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 35166412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 35266412c63SKumar Gala 3538f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3548f29084aSKumar Gala 3558f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3568f29084aSKumar Gala tree nodes for the given platform. 3578f29084aSKumar Gala 35833eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 35933eee330SScott Wood 36033eee330SScott Wood Enables a workaround for erratum A004510. If set, 36133eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 36233eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 36333eee330SScott Wood 36433eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 36533eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 36633eee330SScott Wood 36733eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 36833eee330SScott Wood for which the A004510 workaround should be applied. 36933eee330SScott Wood 37033eee330SScott Wood The rest of SVR is either not relevant to the decision 37133eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 37233eee330SScott Wood p2041) or is implied by the build target, which controls 37333eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 37433eee330SScott Wood 37533eee330SScott Wood See Freescale App Note 4493 for more information about 37633eee330SScott Wood this erratum. 37733eee330SScott Wood 37874fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 37974fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 380b445bbb4SJeremiah Mahler required during NOR boot. 38174fa22edSPrabhakar Kushwaha 3829f074e67SPrabhakar Kushwaha CONFIG_A008044_WORKAROUND 3839f074e67SPrabhakar Kushwaha Enables a workaround for T1040/T1042 erratum A008044. It is only 384b445bbb4SJeremiah Mahler required during NAND boot and valid for Rev 1.0 SoC revision 3859f074e67SPrabhakar Kushwaha 38633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 38733eee330SScott Wood 38833eee330SScott Wood This is the value to write into CCSR offset 0x18600 38933eee330SScott Wood according to the A004510 workaround. 39033eee330SScott Wood 39164501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 39264501c66SPriyanka Jain This value denotes start offset of DDR memory which is 39364501c66SPriyanka Jain connected exclusively to the DSP cores. 39464501c66SPriyanka Jain 395765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 396765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 397765b0bdbSPriyanka Jain which is directly connected to the DSP core. 398765b0bdbSPriyanka Jain 39964501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 40064501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 40164501c66SPriyanka Jain connected to the DSP core. 40264501c66SPriyanka Jain 403765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 404765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 405765b0bdbSPriyanka Jain 406b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 407b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 408b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 409b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 410b135991aSPriyanka Jain 411fb4a2409SAneesh Bansal CONFIG_SYS_CPC_REINIT_F 412fb4a2409SAneesh Bansal This CONFIG is defined when the CPC is configured as SRAM at the 413a187559eSBin Meng time of U-Boot entry and is required to be re-initialized. 414fb4a2409SAneesh Bansal 415aade2004STang Yuantian CONFIG_DEEP_SLEEP 416b445bbb4SJeremiah Mahler Indicates this SoC supports deep sleep feature. If deep sleep is 417aade2004STang Yuantian supported, core will start to execute uboot when wakes up. 418aade2004STang Yuantian 4196cb461b4SDaniel Schwierzeck- Generic CPU options: 4206cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4216cb461b4SDaniel Schwierzeck 4226cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4236cb461b4SDaniel Schwierzeck values is arch specific. 4246cb461b4SDaniel Schwierzeck 4255614e71bSYork Sun CONFIG_SYS_FSL_DDR 4265614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4275614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4285614e71bSYork Sun SoCs. 4295614e71bSYork Sun 4305614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4315614e71bSYork Sun Freescale DDR memory-mapped register base. 4325614e71bSYork Sun 4335614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4345614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4355614e71bSYork Sun deskew training are not available. 4365614e71bSYork Sun 4375614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4385614e71bSYork Sun Freescale DDR1 controller. 4395614e71bSYork Sun 4405614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4415614e71bSYork Sun Freescale DDR2 controller. 4425614e71bSYork Sun 4435614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 4445614e71bSYork Sun Freescale DDR3 controller. 4455614e71bSYork Sun 44634e026f9SYork Sun CONFIG_SYS_FSL_DDRC_GEN4 44734e026f9SYork Sun Freescale DDR4 controller. 44834e026f9SYork Sun 4499ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 4509ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 4519ac4ffbdSYork Sun 4525614e71bSYork Sun CONFIG_SYS_FSL_DDR1 4535614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 4545614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 4555614e71bSYork Sun implemetation. 4565614e71bSYork Sun 4575614e71bSYork Sun CONFIG_SYS_FSL_DDR2 45862a3b7ddSRobert P. J. Day Board config to use DDR2. It can be enabled for SoCs with 4595614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 4605614e71bSYork Sun implementation. 4615614e71bSYork Sun 4625614e71bSYork Sun CONFIG_SYS_FSL_DDR3 4635614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 46434e026f9SYork Sun Freescale DDR3 or DDR3L controllers. 46534e026f9SYork Sun 46634e026f9SYork Sun CONFIG_SYS_FSL_DDR3L 46734e026f9SYork Sun Board config to use DDR3L. It can be enabled for SoCs with 46834e026f9SYork Sun DDR3L controllers. 46934e026f9SYork Sun 47034e026f9SYork Sun CONFIG_SYS_FSL_DDR4 47134e026f9SYork Sun Board config to use DDR4. It can be enabled for SoCs with 47234e026f9SYork Sun DDR4 controllers. 4735614e71bSYork Sun 4741b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_BE 4751b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Big Endian 4761b4175d6SPrabhakar Kushwaha 4771b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_LE 4781b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Little Endian 4791b4175d6SPrabhakar Kushwaha 4801c40707eSPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_CLK_DIV 4811c40707eSPrabhakar Kushwaha Defines divider of platform clock(clock input to IFC controller). 4821c40707eSPrabhakar Kushwaha 483add63f94SPrabhakar Kushwaha CONFIG_SYS_FSL_LBC_CLK_DIV 484add63f94SPrabhakar Kushwaha Defines divider of platform clock(clock input to eLBC controller). 485add63f94SPrabhakar Kushwaha 486690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_PBI 487690e4258SPrabhakar Kushwaha It enables addition of RCW (Power on reset configuration) in built image. 488690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 489690e4258SPrabhakar Kushwaha 490690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_RCW 491690e4258SPrabhakar Kushwaha It adds PBI(pre-boot instructions) commands in u-boot build image. 492690e4258SPrabhakar Kushwaha PBI commands can be used to configure SoC before it starts the execution. 493690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 494690e4258SPrabhakar Kushwaha 49589ad7be8SPrabhakar Kushwaha CONFIG_SPL_FSL_PBL 49689ad7be8SPrabhakar Kushwaha It adds a target to create boot binary having SPL binary in PBI format 49789ad7be8SPrabhakar Kushwaha concatenated with u-boot binary. 49889ad7be8SPrabhakar Kushwaha 4994e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_BE 5004e5b1bd0SYork Sun Defines the DDR controller register space as Big Endian 5014e5b1bd0SYork Sun 5024e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_LE 5034e5b1bd0SYork Sun Defines the DDR controller register space as Little Endian 5044e5b1bd0SYork Sun 5056b9e309aSYork Sun CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 5066b9e309aSYork Sun Physical address from the view of DDR controllers. It is the 5076b9e309aSYork Sun same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 5086b9e309aSYork Sun it could be different for ARM SoCs. 5096b9e309aSYork Sun 5106b1e1254SYork Sun CONFIG_SYS_FSL_DDR_INTLV_256B 5116b1e1254SYork Sun DDR controller interleaving on 256-byte. This is a special 5126b1e1254SYork Sun interleaving mode, handled by Dickens for Freescale layerscape 5136b1e1254SYork Sun SoCs with ARM core. 5146b1e1254SYork Sun 5151d71efbbSYork Sun CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS 5161d71efbbSYork Sun Number of controllers used as main memory. 5171d71efbbSYork Sun 5181d71efbbSYork Sun CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS 5191d71efbbSYork Sun Number of controllers used for other than main memory. 5201d71efbbSYork Sun 52144937214SPrabhakar Kushwaha CONFIG_SYS_FSL_HAS_DP_DDR 52244937214SPrabhakar Kushwaha Defines the SoC has DP-DDR used for DPAA. 52344937214SPrabhakar Kushwaha 524028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_BE 525028dbb8dSRuchika Gupta Defines the SEC controller register space as Big Endian 526028dbb8dSRuchika Gupta 527028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_LE 528028dbb8dSRuchika Gupta Defines the SEC controller register space as Little Endian 529028dbb8dSRuchika Gupta 53092bbd64eSDaniel Schwierzeck- MIPS CPU options: 53192bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 53292bbd64eSDaniel Schwierzeck 53392bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 53492bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 53592bbd64eSDaniel Schwierzeck relocation. 53692bbd64eSDaniel Schwierzeck 53792bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 53892bbd64eSDaniel Schwierzeck 53992bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 54092bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 54192bbd64eSDaniel Schwierzeck Possible values are: 54292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 54392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 54492bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 54592bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 54692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 54792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 54892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 54992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 55092bbd64eSDaniel Schwierzeck 55192bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 55292bbd64eSDaniel Schwierzeck 55392bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 55492bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 55592bbd64eSDaniel Schwierzeck 55692bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 55792bbd64eSDaniel Schwierzeck 55892bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 55992bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 56092bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 56192bbd64eSDaniel Schwierzeck 562b67d8816SChristian Riesch- ARM options: 563b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 564b67d8816SChristian Riesch 565b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 566b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 567b67d8816SChristian Riesch 568207774b2SYork Sun COUNTER_FREQUENCY 569207774b2SYork Sun Generic timer clock source frequency. 570207774b2SYork Sun 571207774b2SYork Sun COUNTER_FREQUENCY_REAL 572207774b2SYork Sun Generic timer clock source frequency if the real clock is 573207774b2SYork Sun different from COUNTER_FREQUENCY, and can only be determined 574207774b2SYork Sun at run time. 575207774b2SYork Sun 57673c38934SStephen Warren- Tegra SoC options: 57773c38934SStephen Warren CONFIG_TEGRA_SUPPORT_NON_SECURE 57873c38934SStephen Warren 57973c38934SStephen Warren Support executing U-Boot in non-secure (NS) mode. Certain 58073c38934SStephen Warren impossible actions will be skipped if the CPU is in NS mode, 58173c38934SStephen Warren such as ARM architectural timer initialization. 58273c38934SStephen Warren 5835da627a4Swdenk- Linux Kernel Interface: 584c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 585c609719bSwdenk 586c609719bSwdenk U-Boot stores all clock information in Hz 587c609719bSwdenk internally. For binary compatibility with older Linux 588c609719bSwdenk kernels (which expect the clocks passed in the 589c609719bSwdenk bd_info data to be in MHz) the environment variable 590c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 591c609719bSwdenk converts clock data to MHZ before passing it to the 592c609719bSwdenk Linux kernel. 593c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 594c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 595c609719bSwdenk default environment. 596c609719bSwdenk 5975da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 5985da627a4Swdenk 599b445bbb4SJeremiah Mahler When transferring memsize parameter to Linux, some versions 6005da627a4Swdenk expect it to be in bytes, others in MB. 6015da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 6025da627a4Swdenk 603fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 604f57f70aaSWolfgang Denk 605f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 606213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 607213bf8c8SGerald Van Baren concepts). 608213bf8c8SGerald Van Baren 609213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 610213bf8c8SGerald Van Baren * New libfdt-based support 611213bf8c8SGerald Van Baren * Adds the "fdt" command 6123bb342fcSKim Phillips * The bootm command automatically updates the fdt 613213bf8c8SGerald Van Baren 614f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 615c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 616f57f70aaSWolfgang Denk 61711ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 61811ccc33fSMarcel Ziswiler addresses 6193bb342fcSKim Phillips 6204e253137SKumar Gala CONFIG_OF_BOARD_SETUP 6214e253137SKumar Gala 6224e253137SKumar Gala Board code has addition modification that it wants to make 6234e253137SKumar Gala to the flat device tree before handing it off to the kernel 6246705d81eSwdenk 625c654b517SSimon Glass CONFIG_OF_SYSTEM_SETUP 626c654b517SSimon Glass 627c654b517SSimon Glass Other code has addition modification that it wants to make 628c654b517SSimon Glass to the flat device tree before handing it off to the kernel. 629c654b517SSimon Glass This causes ft_system_setup() to be called before booting 630c654b517SSimon Glass the kernel. 631c654b517SSimon Glass 6323887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 6333887c3fbSHeiko Schocher 6343887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 6353887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 6363887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 6373887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 6383887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 6393887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 6403887c3fbSHeiko Schocher 6417eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 6427eb29398SIgor Grinberg 6437eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 6447eb29398SIgor Grinberg machine type and must be used to specify the machine type 6457eb29398SIgor Grinberg number as it appears in the ARM machine registry 6467eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 6477eb29398SIgor Grinberg Only boards that have multiple machine types supported 6487eb29398SIgor Grinberg in a single configuration file and the machine type is 6497eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 6507eb29398SIgor Grinberg 6510b2f4ecaSNiklaus Giger- vxWorks boot parameters: 6520b2f4ecaSNiklaus Giger 6530b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 6549e98b7e3SBin Meng environments variables: bootdev, bootfile, ipaddr, netmask, 6559e98b7e3SBin Meng serverip, gatewayip, hostname, othbootargs. 6560b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 6570b2f4ecaSNiklaus Giger 6580b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 6590b2f4ecaSNiklaus Giger the defaults discussed just above. 6600b2f4ecaSNiklaus Giger 6612c451f78SAneesh V- Cache Configuration: 6622c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 6632c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 6642c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 6652c451f78SAneesh V 66693bc2193SAneesh V- Cache Configuration for ARM: 66793bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 66893bc2193SAneesh V controller 66993bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 67093bc2193SAneesh V controller register space 67193bc2193SAneesh V 6726705d81eSwdenk- Serial Ports: 67348d0192fSAndreas Engel CONFIG_PL010_SERIAL 6746705d81eSwdenk 6756705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 6766705d81eSwdenk 67748d0192fSAndreas Engel CONFIG_PL011_SERIAL 6786705d81eSwdenk 6796705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 6806705d81eSwdenk 6816705d81eSwdenk CONFIG_PL011_CLOCK 6826705d81eSwdenk 6836705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 6846705d81eSwdenk the clock speed of the UARTs. 6856705d81eSwdenk 6866705d81eSwdenk CONFIG_PL01x_PORTS 6876705d81eSwdenk 6886705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 6896705d81eSwdenk define this to a list of base addresses for each (supported) 6906705d81eSwdenk port. See e.g. include/configs/versatile.h 6916705d81eSwdenk 692d57dee57SKaricheri, Muralidharan CONFIG_SERIAL_HW_FLOW_CONTROL 693d57dee57SKaricheri, Muralidharan 694d57dee57SKaricheri, Muralidharan Define this variable to enable hw flow control in serial driver. 695d57dee57SKaricheri, Muralidharan Current user of this option is drivers/serial/nsl16550.c driver 6966705d81eSwdenk 697c609719bSwdenk- Console Baudrate: 698c609719bSwdenk CONFIG_BAUDRATE - in bps 699c609719bSwdenk Select one of the baudrates listed in 7006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 701c609719bSwdenk 702c609719bSwdenk- Autoboot Command: 703c609719bSwdenk CONFIG_BOOTCOMMAND 704c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 705c609719bSwdenk define a command string that is automatically executed 706c609719bSwdenk when no character is read on the console interface 707c609719bSwdenk within "Boot Delay" after reset. 708c609719bSwdenk 709c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 710c609719bSwdenk The value of these goes into the environment as 711c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 712c609719bSwdenk as a convenience, when switching between booting from 71311ccc33fSMarcel Ziswiler RAM and NFS. 714c609719bSwdenk 715eda0ba38SHeiko Schocher- Bootcount: 716eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 717eda0ba38SHeiko Schocher Implements a mechanism for detecting a repeating reboot 718eda0ba38SHeiko Schocher cycle, see: 719eda0ba38SHeiko Schocher http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 720eda0ba38SHeiko Schocher 721eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_ENV 722eda0ba38SHeiko Schocher If no softreset save registers are found on the hardware 723eda0ba38SHeiko Schocher "bootcount" is stored in the environment. To prevent a 724eda0ba38SHeiko Schocher saveenv on all reboots, the environment variable 725eda0ba38SHeiko Schocher "upgrade_available" is used. If "upgrade_available" is 726eda0ba38SHeiko Schocher 0, "bootcount" is always 0, if "upgrade_available" is 727eda0ba38SHeiko Schocher 1 "bootcount" is incremented in the environment. 728eda0ba38SHeiko Schocher So the Userspace Applikation must set the "upgrade_available" 729eda0ba38SHeiko Schocher and "bootcount" variable to 0, if a boot was successfully. 730eda0ba38SHeiko Schocher 731c609719bSwdenk- Pre-Boot Commands: 732c609719bSwdenk CONFIG_PREBOOT 733c609719bSwdenk 734c609719bSwdenk When this option is #defined, the existence of the 735c609719bSwdenk environment variable "preboot" will be checked 736c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 737c609719bSwdenk countdown and/or running the auto-boot command resp. 738c609719bSwdenk entering interactive mode. 739c609719bSwdenk 740c609719bSwdenk This feature is especially useful when "preboot" is 741c609719bSwdenk automatically generated or modified. For an example 742c609719bSwdenk see the LWMON board specific code: here "preboot" is 743c609719bSwdenk modified when the user holds down a certain 744c609719bSwdenk combination of keys on the (special) keyboard when 745c609719bSwdenk booting the systems 746c609719bSwdenk 747c609719bSwdenk- Serial Download Echo Mode: 748c609719bSwdenk CONFIG_LOADS_ECHO 749c609719bSwdenk If defined to 1, all characters received during a 750c609719bSwdenk serial download (using the "loads" command) are 751c609719bSwdenk echoed back. This might be needed by some terminal 752c609719bSwdenk emulations (like "cu"), but may as well just take 753c609719bSwdenk time on others. This setting #define's the initial 754c609719bSwdenk value of the "loads_echo" environment variable. 755c609719bSwdenk 756602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 757c609719bSwdenk CONFIG_KGDB_BAUDRATE 758c609719bSwdenk Select one of the baudrates listed in 7596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 760c609719bSwdenk 761302a6487SSimon Glass- Removal of commands 762302a6487SSimon Glass If no commands are needed to boot, you can disable 763302a6487SSimon Glass CONFIG_CMDLINE to remove them. In this case, the command line 764302a6487SSimon Glass will not be available, and when U-Boot wants to execute the 765302a6487SSimon Glass boot command (on start-up) it will call board_run_command() 766302a6487SSimon Glass instead. This can reduce image size significantly for very 767302a6487SSimon Glass simple boot procedures. 768302a6487SSimon Glass 769a5ecbe62SWolfgang Denk- Regular expression support: 770a5ecbe62SWolfgang Denk CONFIG_REGEX 771a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 772a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 773a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 774a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 775a5ecbe62SWolfgang Denk 77645ba8077SSimon Glass- Device tree: 77745ba8077SSimon Glass CONFIG_OF_CONTROL 77845ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 77945ba8077SSimon Glass to configure its devices, instead of relying on statically 78045ba8077SSimon Glass compiled #defines in the board file. This option is 78145ba8077SSimon Glass experimental and only available on a few boards. The device 78245ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 78345ba8077SSimon Glass 7842c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 78582f766d1SAlex Deymo be done using one of the three options below: 786bbb0b128SSimon Glass 787bbb0b128SSimon Glass CONFIG_OF_EMBED 788bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 789bbb0b128SSimon Glass binary in its image. This device tree file should be in the 790bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 791bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 792eb3eb602SNobuhiro Iwamatsu the global data structure as gd->fdt_blob. 79345ba8077SSimon Glass 7942c0f79e4SSimon Glass CONFIG_OF_SEPARATE 7952c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 7962c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 7972c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 7982c0f79e4SSimon Glass 7992c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 8002c0f79e4SSimon Glass 8012c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 8022c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 8032c0f79e4SSimon Glass still use the individual files if you need something more 8042c0f79e4SSimon Glass exotic. 8052c0f79e4SSimon Glass 80682f766d1SAlex Deymo CONFIG_OF_BOARD 80782f766d1SAlex Deymo If this variable is defined, U-Boot will use the device tree 80882f766d1SAlex Deymo provided by the board at runtime instead of embedding one with 80982f766d1SAlex Deymo the image. Only boards defining board_fdt_blob_setup() support 81082f766d1SAlex Deymo this option (see include/fdtdec.h file). 81182f766d1SAlex Deymo 812c609719bSwdenk- Watchdog: 813c609719bSwdenk CONFIG_WATCHDOG 814c609719bSwdenk If this variable is defined, it enables watchdog 8156abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 816907208c4SChristophe Leroy specific code for a watchdog. For the 8xx 817907208c4SChristophe Leroy CPUs, the SIU Watchdog feature is enabled in the SYPCR 818907208c4SChristophe Leroy register. When supported for a specific SoC is 819907208c4SChristophe Leroy available, then no further board specific code should 820907208c4SChristophe Leroy be needed to use it. 8216abe6fb6SDetlev Zundel 8226abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 8236abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 8246abe6fb6SDetlev Zundel SoC, then define this variable and provide board 8256abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 826c609719bSwdenk 8277bae0d6fSHeiko Schocher CONFIG_AT91_HW_WDT_TIMEOUT 8287bae0d6fSHeiko Schocher specify the timeout in seconds. default 2 seconds. 8297bae0d6fSHeiko Schocher 830c1551ea8Sstroese- U-Boot Version: 831c1551ea8Sstroese CONFIG_VERSION_VARIABLE 832c1551ea8Sstroese If this variable is defined, an environment variable 833c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 834c1551ea8Sstroese version as printed by the "version" command. 835a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 836a1ea8e51SBenoît Thébaudeau next reset. 837c1551ea8Sstroese 838c609719bSwdenk- Real-Time Clock: 839c609719bSwdenk 840602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 841c609719bSwdenk has to be selected, too. Define exactly one of the 842c609719bSwdenk following options: 843c609719bSwdenk 844c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 8454e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 846c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 8471cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 848c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 8497f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 850412921d2SMarkus Niebel CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC 8513bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 8529536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 8534c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 8542bd3cab3SChris Packham CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 85571d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 85671d19f30SHeiko Schocher RV3029 RTC. 857c609719bSwdenk 858b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 859b37c7e5eSwdenk must also be configured. See I2C Support, below. 860b37c7e5eSwdenk 861e92739d3SPeter Tyser- GPIO Support: 862e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 863e92739d3SPeter Tyser 8645dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 8655dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 8665dec49caSChris Packham pins supported by a particular chip. 8675dec49caSChris Packham 868e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 869e92739d3SPeter Tyser must also be configured. See I2C Support, below. 870e92739d3SPeter Tyser 871aa53233aSSimon Glass- I/O tracing: 872aa53233aSSimon Glass When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O 873aa53233aSSimon Glass accesses and can checksum them or write a list of them out 874aa53233aSSimon Glass to memory. See the 'iotrace' command for details. This is 875aa53233aSSimon Glass useful for testing device drivers since it can confirm that 876aa53233aSSimon Glass the driver behaves the same way before and after a code 877aa53233aSSimon Glass change. Currently this is supported on sandbox and arm. To 878aa53233aSSimon Glass add support for your architecture, add '#include <iotrace.h>' 879aa53233aSSimon Glass to the bottom of arch/<arch>/include/asm/io.h and test. 880aa53233aSSimon Glass 881aa53233aSSimon Glass Example output from the 'iotrace stats' command is below. 882aa53233aSSimon Glass Note that if the trace buffer is exhausted, the checksum will 883aa53233aSSimon Glass still continue to operate. 884aa53233aSSimon Glass 885aa53233aSSimon Glass iotrace is enabled 886aa53233aSSimon Glass Start: 10000000 (buffer start address) 887aa53233aSSimon Glass Size: 00010000 (buffer size) 888aa53233aSSimon Glass Offset: 00000120 (current buffer offset) 889aa53233aSSimon Glass Output: 10000120 (start + offset) 890aa53233aSSimon Glass Count: 00000018 (number of trace records) 891aa53233aSSimon Glass CRC32: 9526fb66 (CRC32 of all trace records) 892aa53233aSSimon Glass 893c609719bSwdenk- Timestamp Support: 894c609719bSwdenk 895c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 896c609719bSwdenk (date and time) of an image is printed by image 897c609719bSwdenk commands like bootm or iminfo. This option is 898602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 899c609719bSwdenk 900923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 901923c46f9SKarl O. Pinc Zero or more of the following: 902923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 903923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 904923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 905923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 906923c46f9SKarl O. Pinc disk/part_efi.c 907923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 908c609719bSwdenk 909fc843a02SSimon Glass If IDE or SCSI support is enabled (CONFIG_IDE or 910c649e3c9SSimon Glass CONFIG_SCSI) you must configure support for at 911923c46f9SKarl O. Pinc least one non-MTD partition type as well. 912c609719bSwdenk 913c609719bSwdenk- IDE Reset method: 9144d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 9154d13cbadSwdenk board configurations files but used nowhere! 916c609719bSwdenk 9174d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 9184d13cbadSwdenk be performed by calling the function 9194d13cbadSwdenk ide_set_reset(int reset) 9204d13cbadSwdenk which has to be defined in a board specific file 921c609719bSwdenk 922c609719bSwdenk- ATAPI Support: 923c609719bSwdenk CONFIG_ATAPI 924c609719bSwdenk 925c609719bSwdenk Set this to enable ATAPI support. 926c609719bSwdenk 927c40b2956Swdenk- LBA48 Support 928c40b2956Swdenk CONFIG_LBA48 929c40b2956Swdenk 930c40b2956Swdenk Set this to enable support for disks larger than 137GB 9314b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 932c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 933c40b2956Swdenk support disks up to 2.1TB. 934c40b2956Swdenk 9356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 936c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 937c40b2956Swdenk Default is 32bit. 938c40b2956Swdenk 939c609719bSwdenk- SCSI Support: 9406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 9416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 9426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 943c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 944c609719bSwdenk devices. 945c609719bSwdenk 946447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 947447c031bSStefan Reinauer SCSI devices found during the last scan. 948447c031bSStefan Reinauer 949c609719bSwdenk- NETWORK Support (PCI): 950682011ffSwdenk CONFIG_E1000 951ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 952ce5207e1SKyle Moffett 953ce5207e1SKyle Moffett CONFIG_E1000_SPI 954ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 955ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 956ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 957ce5207e1SKyle Moffett 958ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 959ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 960ce5207e1SKyle Moffett example with the "sspi" command. 961ce5207e1SKyle Moffett 962c609719bSwdenk CONFIG_EEPRO100 963c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 96411ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 965c609719bSwdenk write routine for first time initialisation. 966c609719bSwdenk 967c609719bSwdenk CONFIG_TULIP 968c609719bSwdenk Support for Digital 2114x chips. 969c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 970c609719bSwdenk modem chip initialisation (KS8761/QS6611). 971c609719bSwdenk 972c609719bSwdenk CONFIG_NATSEMI 973c609719bSwdenk Support for National dp83815 chips. 974c609719bSwdenk 975c609719bSwdenk CONFIG_NS8382X 976c609719bSwdenk Support for National dp8382[01] gigabit chips. 977c609719bSwdenk 97845219c46Swdenk- NETWORK Support (other): 97945219c46Swdenk 980c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 981c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 982c041e9d2SJens Scharsig 983c041e9d2SJens Scharsig CONFIG_RMII 984c041e9d2SJens Scharsig Define this to use reduced MII inteface 985c041e9d2SJens Scharsig 986c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 987c041e9d2SJens Scharsig If this defined, the driver is quiet. 988c041e9d2SJens Scharsig The driver doen't show link status messages. 989c041e9d2SJens Scharsig 990efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 991efdd7319SRob Herring Support for the Calxeda XGMAC device 992efdd7319SRob Herring 9933bb46d23SAshok CONFIG_LAN91C96 99445219c46Swdenk Support for SMSC's LAN91C96 chips. 99545219c46Swdenk 99645219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 99745219c46Swdenk Define this to enable 32 bit addressing 99845219c46Swdenk 9993bb46d23SAshok CONFIG_SMC91111 1000f39748aeSwdenk Support for SMSC's LAN91C111 chip 1001f39748aeSwdenk 1002f39748aeSwdenk CONFIG_SMC91111_BASE 1003f39748aeSwdenk Define this to hold the physical address 1004f39748aeSwdenk of the device (I/O space) 1005f39748aeSwdenk 1006f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1007f39748aeSwdenk Define this if data bus is 32 bits 1008f39748aeSwdenk 1009f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1010f39748aeSwdenk Define this to use i/o functions instead of macros 1011f39748aeSwdenk (some hardware wont work with macros) 1012f39748aeSwdenk 1013dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1014dc02badaSHeiko Schocher Support for davinci emac 1015dc02badaSHeiko Schocher 1016dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1017dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1018dc02badaSHeiko Schocher 1019b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1020b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1021b3dbf4a5SMacpaul Lin 1022b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1023b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1024b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1025b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1026b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1027b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1028b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1029b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1030b3dbf4a5SMacpaul Lin 10313d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 10323d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 10333d0075faSYoshihiro Shimoda 10343d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 10353d0075faSYoshihiro Shimoda Define the number of ports to be used 10363d0075faSYoshihiro Shimoda 10373d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 10383d0075faSYoshihiro Shimoda Define the ETH PHY's address 10393d0075faSYoshihiro Shimoda 104068260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 104168260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 104268260aabSYoshihiro Shimoda 1043b2f97cf2SHeiko Schocher- PWM Support: 1044b2f97cf2SHeiko Schocher CONFIG_PWM_IMX 10455052e819SRobert P. J. Day Support for PWM module on the imx6. 1046b2f97cf2SHeiko Schocher 10475e124724SVadim Bendebury- TPM Support: 104890899cc0SChe-liang Chiou CONFIG_TPM 104990899cc0SChe-liang Chiou Support TPM devices. 105090899cc0SChe-liang Chiou 10510766ad2fSChristophe Ricard CONFIG_TPM_TIS_INFINEON 10520766ad2fSChristophe Ricard Support for Infineon i2c bus TPM devices. Only one device 10531b393db5STom Wai-Hong Tam per system is supported at this time. 10541b393db5STom Wai-Hong Tam 10551b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 10561b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 10571b393db5STom Wai-Hong Tam 10583aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24 10593aa74088SChristophe Ricard Support for STMicroelectronics TPM devices. Requires DM_TPM support. 10603aa74088SChristophe Ricard 10613aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24_I2C 10623aa74088SChristophe Ricard Support for STMicroelectronics ST33ZP24 I2C devices. 10633aa74088SChristophe Ricard Requires TPM_ST33ZP24 and I2C. 10643aa74088SChristophe Ricard 1065b75fdc11SChristophe Ricard CONFIG_TPM_ST33ZP24_SPI 1066b75fdc11SChristophe Ricard Support for STMicroelectronics ST33ZP24 SPI devices. 1067b75fdc11SChristophe Ricard Requires TPM_ST33ZP24 and SPI. 1068b75fdc11SChristophe Ricard 1069c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1070c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1071c01939c7SDirk Eibach 107290899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 10735e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 10745e124724SVadim Bendebury per system is supported at this time. 10755e124724SVadim Bendebury 10765e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 10775e124724SVadim Bendebury Base address where the generic TPM device is mapped 10785e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 10795e124724SVadim Bendebury 0xfed40000. 10805e124724SVadim Bendebury 1081be6c1529SReinhard Pfau CONFIG_TPM 1082be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1083be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1084be6c1529SReinhard Pfau Requires support for a TPM device. 1085be6c1529SReinhard Pfau 1086be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1087be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1088be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1089be6c1529SReinhard Pfau 1090c609719bSwdenk- USB Support: 1091c609719bSwdenk At the moment only the UHCI host controller is 1092064b55cfSHeiko Schocher supported (PIP405, MIP405); define 1093c609719bSwdenk CONFIG_USB_UHCI to enable it. 1094c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 109530d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1096c609719bSwdenk storage devices. 1097c609719bSwdenk Note: 1098c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1099c609719bSwdenk (TEAC FD-05PUB). 11004d13cbadSwdenk 11019ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 11029ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 11039ab4ce22SSimon Glass 11046e9e0626SOleksandr Tymoshenko CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 11056e9e0626SOleksandr Tymoshenko HW module registers. 11066e9e0626SOleksandr Tymoshenko 110716c8d5e7SWolfgang Denk- USB Device: 110816c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 110916c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 111016c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 111111ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 111216c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 111316c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 111416c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 111516c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 111616c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 111716c8d5e7SWolfgang Denk a Linux host by 111816c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 111916c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 112016c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 112116c8d5e7SWolfgang Denk might be defined in YourBoardName.h 112216c8d5e7SWolfgang Denk 112316c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 112416c8d5e7SWolfgang Denk Define this to build a UDC device 112516c8d5e7SWolfgang Denk 112616c8d5e7SWolfgang Denk CONFIG_USB_TTY 112716c8d5e7SWolfgang Denk Define this to have a tty type of device available to 112816c8d5e7SWolfgang Denk talk to the UDC device 112916c8d5e7SWolfgang Denk 1130f9da0f89SVipin KUMAR CONFIG_USBD_HS 1131f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1132f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1133f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1134f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1135f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1136f9da0f89SVipin KUMAR speed. 1137f9da0f89SVipin KUMAR 11386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 113916c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 114016c8d5e7SWolfgang Denk be set to usbtty. 114116c8d5e7SWolfgang Denk 114216c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 114316c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 114416c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 114516c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 114616c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 114716c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 114816c8d5e7SWolfgang Denk 114916c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 115016c8d5e7SWolfgang Denk Define this string as the name of your company for 115116c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 115216c8d5e7SWolfgang Denk 115316c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 115416c8d5e7SWolfgang Denk Define this string as the name of your product 115516c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 115616c8d5e7SWolfgang Denk 115716c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 115816c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 115916c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 116016c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 116116c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 116216c8d5e7SWolfgang Denk 116316c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 116416c8d5e7SWolfgang Denk Define this as the unique Product ID 116516c8d5e7SWolfgang Denk for your device 116616c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1167c609719bSwdenk 1168d70a560fSIgor Grinberg- ULPI Layer Support: 1169d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1170d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1171d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1172d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1173d70a560fSIgor Grinberg viewport is supported. 1174d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1175d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 11766d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 11776d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 11786d365ea0SLucas Stach the appropriate value in Hz. 1179c609719bSwdenk 1180c609719bSwdenk- MMC Support: 1181c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1182c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1183c609719bSwdenk accessed from the boot prompt by mapping the device 1184c609719bSwdenk to physical memory similar to flash. Command line is 1185602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1186602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1187c609719bSwdenk 1188afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1189afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1190afb35666SYoshihiro Shimoda 1191afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1192afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1193afb35666SYoshihiro Shimoda 1194afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1195afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1196afb35666SYoshihiro Shimoda 11971fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_BOOT 11981fd93c6eSPierre Aubert Enable some additional features of the eMMC boot partitions. 11991fd93c6eSPierre Aubert 12001fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_RPMB 12011fd93c6eSPierre Aubert Enable the commands for reading, writing and programming the 12021fd93c6eSPierre Aubert key for the Replay Protection Memory Block partition in eMMC. 12031fd93c6eSPierre Aubert 1204b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 120501acd6abSPaul Kocialkowski CONFIG_USB_FUNCTION_DFU 1206b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1207b3ba6e94STom Rini 1208b3ba6e94STom Rini CONFIG_DFU_MMC 1209b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1210b3ba6e94STom Rini 1211c6631764SPantelis Antoniou CONFIG_DFU_NAND 1212c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1213c6631764SPantelis Antoniou 1214a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1215a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1216a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1217a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1218a9479f04SAfzal Mohammed one that would help mostly the developer. 1219a9479f04SAfzal Mohammed 1220e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1221e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1222e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1223e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1224e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1225e7e75c70SHeiko Schocher 1226ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1227ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1228ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1229ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1230ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1231ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1232ea2453d5SPantelis Antoniou 1233001a8319SHeiko Schocher DFU_DEFAULT_POLL_TIMEOUT 1234001a8319SHeiko Schocher Poll timeout [ms], is the timeout a device can send to the 1235001a8319SHeiko Schocher host. The host must wait for this timeout before sending 1236001a8319SHeiko Schocher a subsequent DFU_GET_STATUS request to the device. 1237001a8319SHeiko Schocher 1238001a8319SHeiko Schocher DFU_MANIFEST_POLL_TIMEOUT 1239001a8319SHeiko Schocher Poll timeout [ms], which the device sends to the host when 1240001a8319SHeiko Schocher entering dfuMANIFEST state. Host waits this timeout, before 1241001a8319SHeiko Schocher sending again an USB request to the device. 1242001a8319SHeiko Schocher 12436705d81eSwdenk- Journaling Flash filesystem support: 1244b2482dffSSimon Glass CONFIG_JFFS2_NAND 12456705d81eSwdenk Define these for a default partition on a NAND device 12466705d81eSwdenk 12476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 12486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 12496705d81eSwdenk Define these for a default partition on a NOR device 12506705d81eSwdenk 1251c609719bSwdenk- Keyboard Support: 125239f615edSSimon Glass See Kconfig help for available keyboard drivers. 125339f615edSSimon Glass 125439f615edSSimon Glass CONFIG_KEYBOARD 125539f615edSSimon Glass 125639f615edSSimon Glass Define this to enable a custom keyboard support. 125739f615edSSimon Glass This simply calls drv_keyboard_init() which must be 125839f615edSSimon Glass defined in your board-specific files. This option is deprecated 125939f615edSSimon Glass and is only used by novena. For new boards, use driver model 126039f615edSSimon Glass instead. 1261c609719bSwdenk 1262c609719bSwdenk- Video support: 12637d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 12647d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 12657d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 12667d3053fbSTimur Tabi support, and should also define these other macros: 12677d3053fbSTimur Tabi 12687d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 12697d3053fbSTimur Tabi CONFIG_VIDEO 12707d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 12717d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 12727d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 12737d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 12747d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 12757d3053fbSTimur Tabi 1276ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1277ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 12788eca9439SFabio Estevam boot. See the documentation file doc/README.video for a 1279ba8e76bdSTimur Tabi description of this variable. 12807d3053fbSTimur Tabi 1281c609719bSwdenk- LCD Support: CONFIG_LCD 1282c609719bSwdenk 1283c609719bSwdenk Define this to enable LCD support (for output to LCD 1284c609719bSwdenk display); also select one of the supported displays 1285c609719bSwdenk by defining one of these: 1286c609719bSwdenk 128739cf4804SStelian Pop CONFIG_ATMEL_LCD: 128839cf4804SStelian Pop 128939cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 129039cf4804SStelian Pop 1291fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1292c609719bSwdenk 1293fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1294c609719bSwdenk 1295fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1296c609719bSwdenk 1297fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1298fd3103bbSwdenk Active, color, single scan. 1299fd3103bbSwdenk 1300fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1301fd3103bbSwdenk 1302fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1303c609719bSwdenk Active, color, single scan. 1304c609719bSwdenk 1305c609719bSwdenk CONFIG_SHARP_16x9 1306c609719bSwdenk 1307c609719bSwdenk Sharp 320x240. Active, color, single scan. 1308c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1309c609719bSwdenk 1310c609719bSwdenk CONFIG_SHARP_LQ64D341 1311c609719bSwdenk 1312c609719bSwdenk Sharp LQ64D341 display, 640x480. 1313c609719bSwdenk Active, color, single scan. 1314c609719bSwdenk 1315c609719bSwdenk CONFIG_HLD1045 1316c609719bSwdenk 1317c609719bSwdenk HLD1045 display, 640x480. 1318c609719bSwdenk Active, color, single scan. 1319c609719bSwdenk 1320c609719bSwdenk CONFIG_OPTREX_BW 1321c609719bSwdenk 1322c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1323c609719bSwdenk or 1324c609719bSwdenk Hitachi LMG6912RPFC-00T 1325c609719bSwdenk or 1326c609719bSwdenk Hitachi SP14Q002 1327c609719bSwdenk 1328c609719bSwdenk 320x240. Black & white. 1329c609719bSwdenk 1330676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1331676d319eSSimon Glass 1332b445bbb4SJeremiah Mahler Normally the LCD is page-aligned (typically 4KB). If this is 1333676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1334676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1335676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1336676d319eSSimon Glass a per-section basis. 1337676d319eSSimon Glass 1338676d319eSSimon Glass 1339604c7d4aSHannes Petermaier CONFIG_LCD_ROTATION 1340604c7d4aSHannes Petermaier 1341604c7d4aSHannes Petermaier Sometimes, for example if the display is mounted in portrait 1342604c7d4aSHannes Petermaier mode or even if it's mounted landscape but rotated by 180degree, 1343604c7d4aSHannes Petermaier we need to rotate our content of the display relative to the 1344604c7d4aSHannes Petermaier framebuffer, so that user can read the messages which are 1345604c7d4aSHannes Petermaier printed out. 1346604c7d4aSHannes Petermaier Once CONFIG_LCD_ROTATION is defined, the lcd_console will be 1347604c7d4aSHannes Petermaier initialized with a given rotation from "vl_rot" out of 1348604c7d4aSHannes Petermaier "vidinfo_t" which is provided by the board specific code. 1349604c7d4aSHannes Petermaier The value for vl_rot is coded as following (matching to 1350604c7d4aSHannes Petermaier fbcon=rotate:<n> linux-kernel commandline): 1351604c7d4aSHannes Petermaier 0 = no rotation respectively 0 degree 1352604c7d4aSHannes Petermaier 1 = 90 degree rotation 1353604c7d4aSHannes Petermaier 2 = 180 degree rotation 1354604c7d4aSHannes Petermaier 3 = 270 degree rotation 1355604c7d4aSHannes Petermaier 1356604c7d4aSHannes Petermaier If CONFIG_LCD_ROTATION is not defined, the console will be 1357604c7d4aSHannes Petermaier initialized with 0degree rotation. 1358604c7d4aSHannes Petermaier 135945d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 136045d7f525STom Wai-Hong Tam 136145d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 136245d7f525STom Wai-Hong Tam 1363735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1364735987c5STom Wai-Hong Tam 1365735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1366735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1367735987c5STom Wai-Hong Tam 13687152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1369d791b1dcSwdenk 1370d791b1dcSwdenk If this option is set, the environment is checked for 1371d791b1dcSwdenk a variable "splashimage". If found, the usual display 1372d791b1dcSwdenk of logo, copyright and system information on the LCD 1373e94d2cd9Swdenk is suppressed and the BMP image at the address 1374d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1375d791b1dcSwdenk console is redirected to the "nulldev", too. This 1376d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1377d791b1dcSwdenk loaded very quickly after power-on. 1378d791b1dcSwdenk 1379c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1380c0880485SNikita Kiryanov 1381c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1382c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1383ab5645f1SFabio Estevam (see doc/README.displaying-bmps). 1384c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1385c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1386c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1387c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1388c0880485SNikita Kiryanov there is no need to set this option. 1389c0880485SNikita Kiryanov 13901ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 13911ca298ceSMatthias Weisser 13921ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 13931ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 13941ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 13951ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 13961ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 13971ca298ceSMatthias Weisser specify 'm' for centering the image. 13981ca298ceSMatthias Weisser 13991ca298ceSMatthias Weisser Example: 14001ca298ceSMatthias Weisser setenv splashpos m,m 14011ca298ceSMatthias Weisser => image at center of screen 14021ca298ceSMatthias Weisser 14031ca298ceSMatthias Weisser setenv splashpos 30,20 14041ca298ceSMatthias Weisser => image at x = 30 and y = 20 14051ca298ceSMatthias Weisser 14061ca298ceSMatthias Weisser setenv splashpos -10,m 14071ca298ceSMatthias Weisser => vertically centered image 14081ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 14091ca298ceSMatthias Weisser 141098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 141198f4a3dfSStefan Roese 141298f4a3dfSStefan Roese If this option is set, additionally to standard BMP 141398f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 141498f4a3dfSStefan Roese splashscreen support or the bmp command. 141598f4a3dfSStefan Roese 1416d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1417d5011762SAnatolij Gustschin 1418d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1419d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1420d5011762SAnatolij Gustschin bmp command. 1421d5011762SAnatolij Gustschin 1422c29fdfc1Swdenk- Compression support: 14238ef70478SKees Cook CONFIG_GZIP 14248ef70478SKees Cook 14258ef70478SKees Cook Enabled by default to support gzip compressed images. 14268ef70478SKees Cook 1427c29fdfc1Swdenk CONFIG_BZIP2 1428c29fdfc1Swdenk 1429c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1430c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1431c29fdfc1Swdenk compressed images are supported. 1432c29fdfc1Swdenk 1433c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 14346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1435c29fdfc1Swdenk be at least 4MB. 1436d791b1dcSwdenk 143717ea1177Swdenk- MII/PHY support: 143817ea1177Swdenk CONFIG_PHY_ADDR 143917ea1177Swdenk 144017ea1177Swdenk The address of PHY on MII bus. 144117ea1177Swdenk 144217ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 144317ea1177Swdenk 144417ea1177Swdenk The clock frequency of the MII bus 144517ea1177Swdenk 144617ea1177Swdenk CONFIG_PHY_RESET_DELAY 144717ea1177Swdenk 144817ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 144917ea1177Swdenk reset before any MII register access is possible. 145017ea1177Swdenk For such PHY, set this option to the usec delay 145117ea1177Swdenk required. (minimum 300usec for LXT971A) 145217ea1177Swdenk 145317ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 145417ea1177Swdenk 145517ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 145617ea1177Swdenk command issued before MII status register can be read 145717ea1177Swdenk 1458c609719bSwdenk- IP address: 1459c609719bSwdenk CONFIG_IPADDR 1460c609719bSwdenk 1461c609719bSwdenk Define a default value for the IP address to use for 146211ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1463c609719bSwdenk determined through e.g. bootp. 14641ebcd654SWolfgang Denk (Environment variable "ipaddr") 1465c609719bSwdenk 1466c609719bSwdenk- Server IP address: 1467c609719bSwdenk CONFIG_SERVERIP 1468c609719bSwdenk 1469c609719bSwdenk Defines a default value for the IP address of a TFTP 1470c609719bSwdenk server to contact when using the "tftboot" command. 14711ebcd654SWolfgang Denk (Environment variable "serverip") 1472c609719bSwdenk 147397cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 147497cfe861SRobin Getz 147597cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 147697cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 147797cfe861SRobin Getz 14781ebcd654SWolfgang Denk- Gateway IP address: 14791ebcd654SWolfgang Denk CONFIG_GATEWAYIP 14801ebcd654SWolfgang Denk 14811ebcd654SWolfgang Denk Defines a default value for the IP address of the 14821ebcd654SWolfgang Denk default router where packets to other networks are 14831ebcd654SWolfgang Denk sent to. 14841ebcd654SWolfgang Denk (Environment variable "gatewayip") 14851ebcd654SWolfgang Denk 14861ebcd654SWolfgang Denk- Subnet mask: 14871ebcd654SWolfgang Denk CONFIG_NETMASK 14881ebcd654SWolfgang Denk 14891ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 14901ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 14911ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 14921ebcd654SWolfgang Denk forwarded through a router. 14931ebcd654SWolfgang Denk (Environment variable "netmask") 14941ebcd654SWolfgang Denk 149553a5c424SDavid Updegraff- Multicast TFTP Mode: 149653a5c424SDavid Updegraff CONFIG_MCAST_TFTP 149753a5c424SDavid Updegraff 149853a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 149953a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 150011ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 150153a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 150253a5c424SDavid Updegraff multicast group. 150353a5c424SDavid Updegraff 1504c609719bSwdenk- BOOTP Recovery Mode: 1505c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1506c609719bSwdenk 1507c609719bSwdenk If you have many targets in a network that try to 1508c609719bSwdenk boot using BOOTP, you may want to avoid that all 1509c609719bSwdenk systems send out BOOTP requests at precisely the same 1510c609719bSwdenk moment (which would happen for instance at recovery 1511c609719bSwdenk from a power failure, when all systems will try to 1512c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1513c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1514c609719bSwdenk inserted before sending out BOOTP requests. The 15156c33c785SWolfgang Denk following delays are inserted then: 1516c609719bSwdenk 1517c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1518c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1519c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1520c609719bSwdenk 4th and following 1521c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1522c609719bSwdenk 152392ac8accSThierry Reding CONFIG_BOOTP_ID_CACHE_SIZE 152492ac8accSThierry Reding 152592ac8accSThierry Reding BOOTP packets are uniquely identified using a 32-bit ID. The 152692ac8accSThierry Reding server will copy the ID from client requests to responses and 152792ac8accSThierry Reding U-Boot will use this to determine if it is the destination of 152892ac8accSThierry Reding an incoming response. Some servers will check that addresses 152992ac8accSThierry Reding aren't in use before handing them out (usually using an ARP 153092ac8accSThierry Reding ping) and therefore take up to a few hundred milliseconds to 153192ac8accSThierry Reding respond. Network congestion may also influence the time it 153292ac8accSThierry Reding takes for a response to make it back to the client. If that 153392ac8accSThierry Reding time is too long, U-Boot will retransmit requests. In order 153492ac8accSThierry Reding to allow earlier responses to still be accepted after these 153592ac8accSThierry Reding retransmissions, U-Boot's BOOTP client keeps a small cache of 153692ac8accSThierry Reding IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this 153792ac8accSThierry Reding cache. The default is to keep IDs for up to four outstanding 153892ac8accSThierry Reding requests. Increasing this will allow U-Boot to accept offers 153992ac8accSThierry Reding from a BOOTP client in networks with unusually high latency. 154092ac8accSThierry Reding 1541fe389a82Sstroese- DHCP Advanced Options: 15421fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 15431fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1544fe389a82Sstroese 15451fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 15461fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 15471fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 15481fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 15491fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 15501fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 15511fe80d79SJon Loeliger CONFIG_BOOTP_DNS 15521fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 15531fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 15541fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 15551fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 15561fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 15572c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1558fe389a82Sstroese 15595d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 15605d110f0aSWilson Callan environment variable, not the BOOTP server. 1561fe389a82Sstroese 15622c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 15632c00e099SJoe Hershberger after the configured retry count, the call will fail 15642c00e099SJoe Hershberger instead of starting over. This can be used to fail over 15652c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 15662c00e099SJoe Hershberger is not available. 15672c00e099SJoe Hershberger 1568fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1569fe389a82Sstroese serverip from a DHCP server, it is possible that more 1570fe389a82Sstroese than one DNS serverip is offered to the client. 1571fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1572fe389a82Sstroese serverip will be stored in the additional environment 1573fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1574fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 15751fe80d79SJon Loeliger is defined. 1576fe389a82Sstroese 1577fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1578fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1579fe389a82Sstroese need the hostname of the DHCP requester. 15805d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 15811fe80d79SJon Loeliger of the "hostname" environment variable is passed as 15821fe80d79SJon Loeliger option 12 to the DHCP server. 1583fe389a82Sstroese 1584d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1585d9a2f416SAras Vaichas 1586d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1587d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1588d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1589d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1590d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1591d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1592d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1593d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1594d9a2f416SAras Vaichas that one of the retries will be successful but note that 1595d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1596d9a2f416SAras Vaichas this delay. 1597d9a2f416SAras Vaichas 1598d22c338eSJoe Hershberger - Link-local IP address negotiation: 1599d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1600d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1601d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1602d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1603d22c338eSJoe Hershberger 1604d22c338eSJoe Hershberger See doc/README.link-local for more information. 1605d22c338eSJoe Hershberger 1606a3d991bdSwdenk - CDP Options: 1607a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1608a3d991bdSwdenk 1609a3d991bdSwdenk The device id used in CDP trigger frames. 1610a3d991bdSwdenk 1611a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1612a3d991bdSwdenk 1613a3d991bdSwdenk A two character string which is prefixed to the MAC address 1614a3d991bdSwdenk of the device. 1615a3d991bdSwdenk 1616a3d991bdSwdenk CONFIG_CDP_PORT_ID 1617a3d991bdSwdenk 1618a3d991bdSwdenk A printf format string which contains the ascii name of 1619a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 162011ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1621a3d991bdSwdenk 1622a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1623a3d991bdSwdenk 1624a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1625a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1626a3d991bdSwdenk 1627a3d991bdSwdenk CONFIG_CDP_VERSION 1628a3d991bdSwdenk 1629a3d991bdSwdenk An ascii string containing the version of the software. 1630a3d991bdSwdenk 1631a3d991bdSwdenk CONFIG_CDP_PLATFORM 1632a3d991bdSwdenk 1633a3d991bdSwdenk An ascii string containing the name of the platform. 1634a3d991bdSwdenk 1635a3d991bdSwdenk CONFIG_CDP_TRIGGER 1636a3d991bdSwdenk 1637a3d991bdSwdenk A 32bit integer sent on the trigger. 1638a3d991bdSwdenk 1639a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1640a3d991bdSwdenk 1641a3d991bdSwdenk A 16bit integer containing the power consumption of the 1642a3d991bdSwdenk device in .1 of milliwatts. 1643a3d991bdSwdenk 1644a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1645a3d991bdSwdenk 1646a3d991bdSwdenk A byte containing the id of the VLAN. 1647a3d991bdSwdenk 164879267eddSUri Mashiach- Status LED: CONFIG_LED_STATUS 1649c609719bSwdenk 1650c609719bSwdenk Several configurations allow to display the current 1651c609719bSwdenk status using a LED. For instance, the LED will blink 1652c609719bSwdenk fast while running U-Boot code, stop blinking as 1653c609719bSwdenk soon as a reply to a BOOTP request was received, and 1654c609719bSwdenk start blinking slow once the Linux kernel is running 1655c609719bSwdenk (supported by a status LED driver in the Linux 165679267eddSUri Mashiach kernel). Defining CONFIG_LED_STATUS enables this 1657c609719bSwdenk feature in U-Boot. 1658c609719bSwdenk 16591df7bbbaSIgor Grinberg Additional options: 16601df7bbbaSIgor Grinberg 166179267eddSUri Mashiach CONFIG_LED_STATUS_GPIO 16621df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 16631df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 166479267eddSUri Mashiach status LED backend implementation. Define CONFIG_LED_STATUS_GPIO 16651df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 16661df7bbbaSIgor Grinberg 16679dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 16689dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 16699dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 16709dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 16719dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 16729dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 16739dfdcdfeSIgor Grinberg 16743f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 1675c609719bSwdenk 16763f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 16773f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 16783f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 16793f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 16803f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 16813f4978c7SHeiko Schocher interface. 16823f4978c7SHeiko Schocher 16833f4978c7SHeiko Schocher ported i2c driver to the new framework: 1684ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 1685ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 1686ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 1687ea818dbbSHeiko Schocher for defining speed and slave address 1688ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 1689ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 1690ea818dbbSHeiko Schocher for defining speed and slave address 1691ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 1692ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 1693ea818dbbSHeiko Schocher for defining speed and slave address 1694ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 1695ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 1696ea818dbbSHeiko Schocher for defining speed and slave address 16973f4978c7SHeiko Schocher 169800f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 169900f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 170000f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 170100f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 170200f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 170300f792e0SHeiko Schocher bus. 170400f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 170500f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 170600f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 170700f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 170800f792e0SHeiko Schocher second bus. 170900f792e0SHeiko Schocher 17101f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 17111f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 17121f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 17131f2ba722SSimon Glass 100000 and the slave addr 0! 17141f2ba722SSimon Glass 1715880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 1716880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 1717880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 1718880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 1719880540deSDirk Eibach 1720fac96408Strem - drivers/i2c/i2c_mxc.c 1721fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 172203544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 172303544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 172403544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 172503544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 1726fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 1727fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 1728fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 1729fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 1730fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 1731fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 173203544c66SAlbert ARIBAUD \\(3ADEV\\) - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED 173303544c66SAlbert ARIBAUD \\(3ADEV\\) - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE 1734b445bbb4SJeremiah Mahler If those defines are not set, default value is 100000 1735fac96408Strem for speed, and 0 for slave. 1736fac96408Strem 17371086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 17381086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 17391086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 17401086bfa9SNobuhiro Iwamatsu 17411086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 17421086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 17431086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 17441086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 17451086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 17461086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 17471086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 17481086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 17491086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 17501086bfa9SNobuhiro Iwamatsu 17512035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 17522035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 17532035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 17542035d77dSNobuhiro Iwamatsu 17552035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 17562035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 17572035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 17582035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 17592035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 17602035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 17612035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 17622035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 17632035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 17642035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 1765b445bbb4SJeremiah Mahler - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses 17662035d77dSNobuhiro Iwamatsu 17676789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 17686789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 17696789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 17706789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 17716789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 17726789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 17736789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 17746789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 17756789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 17766789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 17776789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 17786789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 17796789e84eSHeiko Schocher 17800bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 17810bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 17820bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 17830bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 17840bdffe71SHeiko Schocher 1785e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 1786e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 1787e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 1788e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 1789e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 1790e717fc6dSNaveen Krishna Ch 1791b46226bdSDirk Eibach - drivers/i2c/ihs_i2c.c 1792b46226bdSDirk Eibach - activate this driver with CONFIG_SYS_I2C_IHS 1793b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 1794b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 1795b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 1796b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 1797b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 1798b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 1799b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 1800b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 1801b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 1802b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 1803b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 1804b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 1805071be896SDirk Eibach - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL 1806071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 1807071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 1808071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 1809071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 1810071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 1811071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 1812071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 1813071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 1814b46226bdSDirk Eibach 18153f4978c7SHeiko Schocher additional defines: 18163f4978c7SHeiko Schocher 18173f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 1818945a18e6SSimon Glass Hold the number of i2c buses you want to use. 18193f4978c7SHeiko Schocher 18203f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 18213f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 18223f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 18233f4978c7SHeiko Schocher omit this define. 18243f4978c7SHeiko Schocher 18253f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 18263f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 18273f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 18283f4978c7SHeiko Schocher define. 18293f4978c7SHeiko Schocher 18303f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 1831b445bbb4SJeremiah Mahler hold a list of buses you want to use, only used if 18323f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 18333f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 18343f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 18353f4978c7SHeiko Schocher 18363f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 18373f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 18383f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 18393f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 18403f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 18413f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 18423f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 18433f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 18443f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 18453f4978c7SHeiko Schocher } 18463f4978c7SHeiko Schocher 18473f4978c7SHeiko Schocher which defines 18483f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 1849ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 1850ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 1851ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 1852ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 1853ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 18543f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 1855ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 1856ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 18573f4978c7SHeiko Schocher 18583f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 18593f4978c7SHeiko Schocher 1860ce3b5d69SSimon Glass- Legacy I2C Support: 1861ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 1862b37c7e5eSwdenk then the following macros need to be defined (examples are 1863b37c7e5eSwdenk from include/configs/lwmon.h): 1864c609719bSwdenk 1865c609719bSwdenk I2C_INIT 1866c609719bSwdenk 1867b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1868c609719bSwdenk controller or configure ports. 1869c609719bSwdenk 1870b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1871b37c7e5eSwdenk 1872c609719bSwdenk I2C_ACTIVE 1873c609719bSwdenk 1874c609719bSwdenk The code necessary to make the I2C data line active 1875c609719bSwdenk (driven). If the data line is open collector, this 1876c609719bSwdenk define can be null. 1877c609719bSwdenk 1878b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1879b37c7e5eSwdenk 1880c609719bSwdenk I2C_TRISTATE 1881c609719bSwdenk 1882c609719bSwdenk The code necessary to make the I2C data line tri-stated 1883c609719bSwdenk (inactive). If the data line is open collector, this 1884c609719bSwdenk define can be null. 1885c609719bSwdenk 1886b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1887b37c7e5eSwdenk 1888c609719bSwdenk I2C_READ 1889c609719bSwdenk 1890472d5460SYork Sun Code that returns true if the I2C data line is high, 1891472d5460SYork Sun false if it is low. 1892c609719bSwdenk 1893b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1894b37c7e5eSwdenk 1895c609719bSwdenk I2C_SDA(bit) 1896c609719bSwdenk 1897472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 1898472d5460SYork Sun is false, it clears it (low). 1899c609719bSwdenk 1900b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1901b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1902b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1903b37c7e5eSwdenk 1904c609719bSwdenk I2C_SCL(bit) 1905c609719bSwdenk 1906472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 1907472d5460SYork Sun is false, it clears it (low). 1908c609719bSwdenk 1909b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1910b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1911b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1912b37c7e5eSwdenk 1913c609719bSwdenk I2C_DELAY 1914c609719bSwdenk 1915c609719bSwdenk This delay is invoked four times per clock cycle so this 1916c609719bSwdenk controls the rate of data transfer. The data rate thus 1917b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1918b37c7e5eSwdenk like: 1919b37c7e5eSwdenk 1920b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1921c609719bSwdenk 1922793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1923793b5726SMike Frysinger 1924793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1925793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1926793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1927793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1928793b5726SMike Frysinger 1929793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1930793b5726SMike Frysinger the generic GPIO functions. 1931793b5726SMike Frysinger 19326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 193347cd00faSwdenk 193447cd00faSwdenk When a board is reset during an i2c bus transfer 193547cd00faSwdenk chips might think that the current transfer is still 193647cd00faSwdenk in progress. On some boards it is possible to access 193747cd00faSwdenk the i2c SCLK line directly, either by using the 193847cd00faSwdenk processor pin as a GPIO or by having a second pin 193947cd00faSwdenk connected to the bus. If this option is defined a 194047cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 194147cd00faSwdenk is run early in the boot sequence. 194247cd00faSwdenk 1943bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1944bb99ad6dSBen Warren 1945bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1946bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1947bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1948bb99ad6dSBen Warren Note that bus numbering is zero-based. 1949bb99ad6dSBen Warren 19506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1951bb99ad6dSBen Warren 1952bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 19530f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 19540f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 19550f89c54bSPeter Tyser a 1D array of device addresses 1956bb99ad6dSBen Warren 1957bb99ad6dSBen Warren e.g. 1958bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 19596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1960bb99ad6dSBen Warren 1961bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1962bb99ad6dSBen Warren 1963bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 1964945a18e6SSimon Glass #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1965bb99ad6dSBen Warren 1966bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1967bb99ad6dSBen Warren 19686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1969be5e6181STimur Tabi 1970be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1971be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1972be5e6181STimur Tabi 19736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 19740dc018ecSStefan Roese 19750dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 19760dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 19770dc018ecSStefan Roese 19782ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 19792ac6985aSAndrew Dyer 19802ac6985aSAndrew Dyer defining this will force the i2c_read() function in 19812ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 19822ac6985aSAndrew Dyer between writing the address pointer and reading the 19832ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 19842ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 19852ac6985aSAndrew Dyer devices can use either method, but some require one or 19862ac6985aSAndrew Dyer the other. 1987be5e6181STimur Tabi 1988c609719bSwdenk- SPI Support: CONFIG_SPI 1989c609719bSwdenk 1990c609719bSwdenk Enables SPI driver (so far only tested with 1991c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1992c609719bSwdenk D/As on the SACSng board) 1993c609719bSwdenk 19946639562eSYoshihiro Shimoda CONFIG_SH_SPI 19956639562eSYoshihiro Shimoda 19966639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 19976639562eSYoshihiro Shimoda only SH7757 is supported. 19986639562eSYoshihiro Shimoda 1999c609719bSwdenk CONFIG_SOFT_SPI 2000c609719bSwdenk 2001c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2002c609719bSwdenk using hardware support. This is a general purpose 2003c609719bSwdenk driver that only requires three general I/O port pins 2004c609719bSwdenk (two outputs, one input) to function. If this is 2005c609719bSwdenk defined, the board configuration must define several 2006c609719bSwdenk SPI configuration items (port pins to use, etc). For 2007c609719bSwdenk an example, see include/configs/sacsng.h. 2008c609719bSwdenk 200904a9e118SBen Warren CONFIG_HARD_SPI 201004a9e118SBen Warren 201104a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 201204a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 201304a9e118SBen Warren must define a list of chip-select function pointers. 201404a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 201504a9e118SBen Warren example, see include/configs/mpc8349emds.h. 201604a9e118SBen Warren 201738254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 201838254f45SGuennadi Liakhovetski 201938254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 20202e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 202138254f45SGuennadi Liakhovetski 2022f659b573SHeiko Schocher CONFIG_SYS_SPI_MXC_WAIT 2023f659b573SHeiko Schocher Timeout for waiting until spi transfer completed. 2024f659b573SHeiko Schocher default: (CONFIG_SYS_HZ/100) /* 10 ms */ 2025f659b573SHeiko Schocher 20260133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 20270133502eSMatthias Fuchs 20280133502eSMatthias Fuchs Enables FPGA subsystem. 20290133502eSMatthias Fuchs 20300133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 20310133502eSMatthias Fuchs 20320133502eSMatthias Fuchs Enables support for specific chip vendors. 20330133502eSMatthias Fuchs (ALTERA, XILINX) 20340133502eSMatthias Fuchs 20350133502eSMatthias Fuchs CONFIG_FPGA_<family> 20360133502eSMatthias Fuchs 20370133502eSMatthias Fuchs Enables support for FPGA family. 20380133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 20390133502eSMatthias Fuchs 20400133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2041c609719bSwdenk 2042c609719bSwdenk Specify the number of FPGA devices to support. 2043c609719bSwdenk 20446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2045c609719bSwdenk 2046c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2047c609719bSwdenk 20486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2049c609719bSwdenk 2050c609719bSwdenk Enable checks on FPGA configuration interface busy 2051c609719bSwdenk status by the configuration function. This option 2052c609719bSwdenk will require a board or device specific function to 2053c609719bSwdenk be written. 2054c609719bSwdenk 2055c609719bSwdenk CONFIG_FPGA_DELAY 2056c609719bSwdenk 2057c609719bSwdenk If defined, a function that provides delays in the FPGA 2058c609719bSwdenk configuration driver. 2059c609719bSwdenk 20606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2061c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2062c609719bSwdenk 20636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2064c609719bSwdenk 2065c609719bSwdenk Check for configuration errors during FPGA bitfile 2066c609719bSwdenk loading. For example, abort during Virtex II 2067c609719bSwdenk configuration if the INIT_B line goes low (which 2068c609719bSwdenk indicated a CRC error). 2069c609719bSwdenk 20706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2071c609719bSwdenk 2072b445bbb4SJeremiah Mahler Maximum time to wait for the INIT_B line to de-assert 2073b445bbb4SJeremiah Mahler after PROB_B has been de-asserted during a Virtex II 2074c609719bSwdenk FPGA configuration sequence. The default time is 500 207511ccc33fSMarcel Ziswiler ms. 2076c609719bSwdenk 20776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2078c609719bSwdenk 2079b445bbb4SJeremiah Mahler Maximum time to wait for BUSY to de-assert during 208011ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2081c609719bSwdenk 20826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2083c609719bSwdenk 2084c609719bSwdenk Time to wait after FPGA configuration. The default is 208511ccc33fSMarcel Ziswiler 200 ms. 2086c609719bSwdenk 2087c609719bSwdenk- Configuration Management: 2088b2b8a696SStefan Roese CONFIG_BUILD_TARGET 2089b2b8a696SStefan Roese 2090b2b8a696SStefan Roese Some SoCs need special image types (e.g. U-Boot binary 2091b2b8a696SStefan Roese with a special header) as build targets. By defining 2092b2b8a696SStefan Roese CONFIG_BUILD_TARGET in the SoC / board header, this 2093b2b8a696SStefan Roese special image will be automatically built upon calling 20946de80f21SSimon Glass make / buildman. 2095b2b8a696SStefan Roese 2096c609719bSwdenk CONFIG_IDENT_STRING 2097c609719bSwdenk 2098c609719bSwdenk If defined, this string will be added to the U-Boot 2099c609719bSwdenk version information (U_BOOT_VERSION) 2100c609719bSwdenk 2101c609719bSwdenk- Vendor Parameter Protection: 2102c609719bSwdenk 2103c609719bSwdenk U-Boot considers the values of the environment 2104c609719bSwdenk variables "serial#" (Board Serial Number) and 21057152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2106c609719bSwdenk are set once by the board vendor / manufacturer, and 2107c609719bSwdenk protects these variables from casual modification by 2108c609719bSwdenk the user. Once set, these variables are read-only, 2109c609719bSwdenk and write or delete attempts are rejected. You can 211011ccc33fSMarcel Ziswiler change this behaviour: 2111c609719bSwdenk 2112c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2113c609719bSwdenk file, the write protection for vendor parameters is 211447cd00faSwdenk completely disabled. Anybody can change or delete 2115c609719bSwdenk these parameters. 2116c609719bSwdenk 211792ac5208SJoe Hershberger Alternatively, if you define _both_ an ethaddr in the 211892ac5208SJoe Hershberger default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 211911ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2120c609719bSwdenk which can be changed exactly ONCE by the user. [The 2121c609719bSwdenk serial# is unaffected by this, i. e. it remains 2122c609719bSwdenk read-only.] 2123c609719bSwdenk 21242598090bSJoe Hershberger The same can be accomplished in a more flexible way 21252598090bSJoe Hershberger for any variable by configuring the type of access 21262598090bSJoe Hershberger to allow for those variables in the ".flags" variable 21272598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 21282598090bSJoe Hershberger 2129c609719bSwdenk- Protected RAM: 2130c609719bSwdenk CONFIG_PRAM 2131c609719bSwdenk 2132c609719bSwdenk Define this variable to enable the reservation of 2133c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2134c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2135c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2136c609719bSwdenk this default value by defining an environment 2137c609719bSwdenk variable "pram" to the number of kB you want to 2138c609719bSwdenk reserve. Note that the board info structure will 2139c609719bSwdenk still show the full amount of RAM. If pRAM is 2140c609719bSwdenk reserved, a new environment variable "mem" will 2141c609719bSwdenk automatically be defined to hold the amount of 2142c609719bSwdenk remaining RAM in a form that can be passed as boot 2143c609719bSwdenk argument to Linux, for instance like that: 2144c609719bSwdenk 2145fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2146c609719bSwdenk saveenv 2147c609719bSwdenk 2148c609719bSwdenk This way you can tell Linux not to use this memory, 2149c609719bSwdenk either, which results in a memory region that will 2150c609719bSwdenk not be affected by reboots. 2151c609719bSwdenk 2152c609719bSwdenk *WARNING* If your board configuration uses automatic 2153c609719bSwdenk detection of the RAM size, you must make sure that 2154c609719bSwdenk this memory test is non-destructive. So far, the 2155c609719bSwdenk following board configurations are known to be 2156c609719bSwdenk "pRAM-clean": 2157c609719bSwdenk 21585b8e76c3SHeiko Schocher IVMS8, IVML24, SPD8xx, 21591b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 21602eb48ff7SHeiko Schocher FLAGADM 2161c609719bSwdenk 216240fef049SGabe Black- Access to physical memory region (> 4GB) 216340fef049SGabe Black Some basic support is provided for operations on memory not 216440fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 216540fef049SGabe Black support access to more than 4GB of memory on 32-bit 216640fef049SGabe Black machines using physical address extension or similar. 216740fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 216840fef049SGabe Black currently only supports clearing the memory. 216940fef049SGabe Black 2170c609719bSwdenk- Error Recovery: 2171c609719bSwdenk CONFIG_PANIC_HANG 2172c609719bSwdenk 2173c609719bSwdenk Define this variable to stop the system in case of a 2174c609719bSwdenk fatal error, so that you have to reset it manually. 2175c609719bSwdenk This is probably NOT a good idea for an embedded 217611ccc33fSMarcel Ziswiler system where you want the system to reboot 2177c609719bSwdenk automatically as fast as possible, but it may be 2178c609719bSwdenk useful during development since you can try to debug 2179c609719bSwdenk the conditions that lead to the situation. 2180c609719bSwdenk 2181c609719bSwdenk CONFIG_NET_RETRY_COUNT 2182c609719bSwdenk 2183c609719bSwdenk This variable defines the number of retries for 2184c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2185c609719bSwdenk before giving up the operation. If not defined, a 2186c609719bSwdenk default value of 5 is used. 2187c609719bSwdenk 218840cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 218940cb90eeSGuennadi Liakhovetski 219040cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 219140cb90eeSGuennadi Liakhovetski 219248a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 219348a3e999STetsuyuki Kobayashi 219448a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 219548a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 219648a3e999STetsuyuki Kobayashi try longer timeout such as 219748a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 219848a3e999STetsuyuki Kobayashi 2199c609719bSwdenk- Command Interpreter: 22008078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 220104a85b3bSwdenk 220204a85b3bSwdenk Enable auto completion of commands using TAB. 220304a85b3bSwdenk 22046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2205c609719bSwdenk 2206c609719bSwdenk This defines the secondary prompt string, which is 2207c609719bSwdenk printed when the command interpreter needs more input 2208c609719bSwdenk to complete a command. Usually "> ". 2209c609719bSwdenk 2210c609719bSwdenk Note: 2211c609719bSwdenk 2212c609719bSwdenk In the current implementation, the local variables 2213c609719bSwdenk space and global environment variables space are 2214c609719bSwdenk separated. Local variables are those you define by 22153b57fe0aSwdenk simply typing `name=value'. To access a local 2216c609719bSwdenk variable later on, you have write `$name' or 22173b57fe0aSwdenk `${name}'; to execute the contents of a variable 22183b57fe0aSwdenk directly type `$name' at the command prompt. 2219c609719bSwdenk 2220c609719bSwdenk Global environment variables are those you use 2221c609719bSwdenk setenv/printenv to work with. To run a command stored 2222c609719bSwdenk in such a variable, you need to use the run command, 2223c609719bSwdenk and you must not use the '$' sign to access them. 2224c609719bSwdenk 2225c609719bSwdenk To store commands and special characters in a 2226c609719bSwdenk variable, please use double quotation marks 2227c609719bSwdenk surrounding the whole text of the variable, instead 2228c609719bSwdenk of the backslashes before semicolons and special 2229c609719bSwdenk symbols. 2230c609719bSwdenk 2231b445bbb4SJeremiah Mahler- Command Line Editing and History: 2232aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2233aa0c71acSWolfgang Denk 223411ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2235aa0c71acSWolfgang Denk command line input operations 2236aa0c71acSWolfgang Denk 2237f3b267b3SMarek Vasut- Command Line PS1/PS2 support: 2238f3b267b3SMarek Vasut CONFIG_CMDLINE_PS_SUPPORT 2239f3b267b3SMarek Vasut 2240f3b267b3SMarek Vasut Enable support for changing the command prompt string 2241f3b267b3SMarek Vasut at run-time. Only static string is supported so far. 2242f3b267b3SMarek Vasut The string is obtained from environment variables PS1 2243f3b267b3SMarek Vasut and PS2. 2244f3b267b3SMarek Vasut 2245a8c7c708Swdenk- Default Environment: 2246c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2247c609719bSwdenk 2248c609719bSwdenk Define this to contain any number of null terminated 2249c609719bSwdenk strings (variable = value pairs) that will be part of 22507152b1d0Swdenk the default environment compiled into the boot image. 22512262cfeeSwdenk 2252c609719bSwdenk For example, place something like this in your 2253c609719bSwdenk board's config file: 2254c609719bSwdenk 2255c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2256c609719bSwdenk "myvar1=value1\0" \ 2257c609719bSwdenk "myvar2=value2\0" 2258c609719bSwdenk 2259c609719bSwdenk Warning: This method is based on knowledge about the 2260c609719bSwdenk internal format how the environment is stored by the 22612262cfeeSwdenk U-Boot code. This is NOT an official, exported 2262c609719bSwdenk interface! Although it is unlikely that this format 22637152b1d0Swdenk will change soon, there is no guarantee either. 2264c609719bSwdenk You better know what you are doing here. 2265c609719bSwdenk 2266c609719bSwdenk Note: overly (ab)use of the default environment is 2267c609719bSwdenk discouraged. Make sure to check other ways to preset 226874de7aefSWolfgang Denk the environment like the "source" command or the 2269c609719bSwdenk boot command first. 2270c609719bSwdenk 22715e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 22725e724ca2SStephen Warren 22735e724ca2SStephen Warren Define this in order to add variables describing the 22745e724ca2SStephen Warren U-Boot build configuration to the default environment. 22755e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 22765e724ca2SStephen Warren 22775e724ca2SStephen Warren Enabling this option will cause the following to be defined: 22785e724ca2SStephen Warren 22795e724ca2SStephen Warren - CONFIG_SYS_ARCH 22805e724ca2SStephen Warren - CONFIG_SYS_CPU 22815e724ca2SStephen Warren - CONFIG_SYS_BOARD 22825e724ca2SStephen Warren - CONFIG_SYS_VENDOR 22835e724ca2SStephen Warren - CONFIG_SYS_SOC 22845e724ca2SStephen Warren 22857e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 22867e27f89fSTom Rini 22877e27f89fSTom Rini Define this in order to add variables describing certain 22887e27f89fSTom Rini run-time determined information about the hardware to the 22897e27f89fSTom Rini environment. These will be named board_name, board_rev. 22907e27f89fSTom Rini 229106fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 229206fd8538SSimon Glass 229306fd8538SSimon Glass Normally the environment is loaded when the board is 2294b445bbb4SJeremiah Mahler initialised so that it is available to U-Boot. This inhibits 229506fd8538SSimon Glass that so that the environment is not available until 229606fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 229706fd8538SSimon Glass this is instead controlled by the value of 229806fd8538SSimon Glass /config/load-environment. 229906fd8538SSimon Glass 2300f61ec45eSEric Nelson- Serial Flash support 230100fd59ddSSimon Glass Usage requires an initial 'sf probe' to define the serial 2302f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2303f61ec45eSEric Nelson commands. 2304f61ec45eSEric Nelson 2305f61ec45eSEric Nelson The following defaults may be provided by the platform 2306f61ec45eSEric Nelson to handle the common case when only a single serial 2307f61ec45eSEric Nelson flash is present on the system. 2308f61ec45eSEric Nelson 2309f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2310f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2311f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2312f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2313f61ec45eSEric Nelson 23143f85ce27Swdenk CONFIG_SYSTEMACE 23153f85ce27Swdenk 23163f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 23173f85ce27Swdenk chips attached via some sort of local bus. The address 231811ccc33fSMarcel Ziswiler of the chip must also be defined in the 23196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 23203f85ce27Swdenk 23213f85ce27Swdenk #define CONFIG_SYSTEMACE 23226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 23233f85ce27Swdenk 23243f85ce27Swdenk When SystemACE support is added, the "ace" device type 23253f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 23263f85ce27Swdenk 2327ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2328ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2329ecb0ccd9SWolfgang Denk 233028cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2331ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 233228cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2333ecb0ccd9SWolfgang Denk number generator is used. 2334ecb0ccd9SWolfgang Denk 233528cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 233628cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 233728cb9375SWolfgang Denk defined, the normal port 69 is used. 233828cb9375SWolfgang Denk 233928cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2340ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2341ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2342ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2343ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2344ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2345ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2346ecb0ccd9SWolfgang Denk 23479e50c406SHeiko Schocher- bootcount support: 23489e50c406SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 23499e50c406SHeiko Schocher 23509e50c406SHeiko Schocher This enables the bootcounter support, see: 23519e50c406SHeiko Schocher http://www.denx.de/wiki/DULG/UBootBootCountLimit 23529e50c406SHeiko Schocher 23539e50c406SHeiko Schocher CONFIG_AT91SAM9XE 23549e50c406SHeiko Schocher enable special bootcounter support on at91sam9xe based boards. 23559e50c406SHeiko Schocher CONFIG_SOC_DA8XX 23569e50c406SHeiko Schocher enable special bootcounter support on da850 based boards. 23579e50c406SHeiko Schocher CONFIG_BOOTCOUNT_RAM 23589e50c406SHeiko Schocher enable support for the bootcounter in RAM 23599e50c406SHeiko Schocher CONFIG_BOOTCOUNT_I2C 23609e50c406SHeiko Schocher enable support for the bootcounter on an i2c (like RTC) device. 23619e50c406SHeiko Schocher CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 23629e50c406SHeiko Schocher CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 23639e50c406SHeiko Schocher the bootcounter. 23649e50c406SHeiko Schocher CONFIG_BOOTCOUNT_ALEN = address len 236519c402afSSimon Glass 2366a8c7c708Swdenk- Show boot progress: 2367c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2368c609719bSwdenk 2369c609719bSwdenk Defining this option allows to add some board- 2370c609719bSwdenk specific code (calling a user-provided function 2371c609719bSwdenk "show_boot_progress(int)") that enables you to show 2372c609719bSwdenk the system's boot progress on some display (for 2373c609719bSwdenk example, some LED's) on your board. At the moment, 2374c609719bSwdenk the following checkpoints are implemented: 2375c609719bSwdenk 237694fd1316SSimon Glass 23771372cce2SMarian BalakowiczLegacy uImage format: 23781372cce2SMarian Balakowicz 2379c609719bSwdenk Arg Where When 2380c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2381c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2382c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2383c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2384c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2385c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2386c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2387c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2388c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 23891372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2390c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2391c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2392c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2393c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 23941372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2395c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 23961372cce2SMarian Balakowicz 23971372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 23981372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 23991372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 24001372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 24011372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 24021372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 24031372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 240411ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 24051372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 24061372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 24071372cce2SMarian Balakowicz 2408ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2409c609719bSwdenk 2410a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 241163e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 241263e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 241363e73c9aSwdenk 2414566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2415566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2416566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2417566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2418566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2419566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2420566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2421566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2422566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2423566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2424566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2425566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2426566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2427566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2428566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2429566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2430566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2431566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2432566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2433566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2434566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2435566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2436566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2437566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2438566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2439566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2440566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2441566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2442566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2443566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2444566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2445566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2446566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2447566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2448566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2449566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2450566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2451566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2452566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2453566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2454566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2455566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2456566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2457566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2458566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2459566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2460566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2461c609719bSwdenk 2462566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2463c609719bSwdenk 2464566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2465566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2466566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2467206c60cbSwdenk 2468566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2469bc0571fcSJoe Hershberger 80 common/cmd_net.c before calling net_loop() 2470bc0571fcSJoe Hershberger -81 common/cmd_net.c some error in net_loop() occurred 2471bc0571fcSJoe Hershberger 81 common/cmd_net.c net_loop() back without error 2472566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2473566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 247474de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 247574de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2476566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2477c609719bSwdenk 24781372cce2SMarian BalakowiczFIT uImage format: 24791372cce2SMarian Balakowicz 24801372cce2SMarian Balakowicz Arg Where When 24811372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 24821372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 24831372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 24841372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 24851372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 24861372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2487f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 24881372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 24891372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 24901372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 24911372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 24921372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 249311ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 249411ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 24951372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 24961372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 24971372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 24981372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 24991372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 25001372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 25011372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 25021372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 25031372cce2SMarian Balakowicz 25041372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 25051372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 25061372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 250711ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 25081372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 25091372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 25101372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 25111372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 25121372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 25131372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 25141372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 25151372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 25161372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 25171372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 25181372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 25191372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 25201372cce2SMarian Balakowicz 252111ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 25221372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 25231372cce2SMarian Balakowicz 252411ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 25251372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 25261372cce2SMarian Balakowicz 252711ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 25281372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 25291372cce2SMarian Balakowicz 253021d29f7fSHeiko Schocher- legacy image format: 253121d29f7fSHeiko Schocher CONFIG_IMAGE_FORMAT_LEGACY 253221d29f7fSHeiko Schocher enables the legacy image format support in U-Boot. 253321d29f7fSHeiko Schocher 253421d29f7fSHeiko Schocher Default: 253521d29f7fSHeiko Schocher enabled if CONFIG_FIT_SIGNATURE is not defined. 253621d29f7fSHeiko Schocher 253721d29f7fSHeiko Schocher CONFIG_DISABLE_IMAGE_LEGACY 253821d29f7fSHeiko Schocher disable the legacy image format 253921d29f7fSHeiko Schocher 254021d29f7fSHeiko Schocher This define is introduced, as the legacy image format is 254121d29f7fSHeiko Schocher enabled per default for backward compatibility. 254221d29f7fSHeiko Schocher 25434cf2609bSWolfgang Denk- Standalone program support: 25444cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 25454cf2609bSWolfgang Denk 25466feff899SWolfgang Denk This option defines a board specific value for the 25476feff899SWolfgang Denk address where standalone program gets loaded, thus 25486feff899SWolfgang Denk overwriting the architecture dependent default 25494cf2609bSWolfgang Denk settings. 25504cf2609bSWolfgang Denk 25514cf2609bSWolfgang Denk- Frame Buffer Address: 25524cf2609bSWolfgang Denk CONFIG_FB_ADDR 25534cf2609bSWolfgang Denk 25544cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 255544a53b57SWolfgang Denk address for frame buffer. This is typically the case 255644a53b57SWolfgang Denk when using a graphics controller has separate video 255744a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 255844a53b57SWolfgang Denk the given address instead of dynamically reserving it 255944a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 256044a53b57SWolfgang Denk the memory for the frame buffer depending on the 256144a53b57SWolfgang Denk configured panel size. 25624cf2609bSWolfgang Denk 25634cf2609bSWolfgang Denk Please see board_init_f function. 25644cf2609bSWolfgang Denk 2565cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2566cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2567cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2568cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2569cccfc2abSDetlev Zundel 2570cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2571cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2572cccfc2abSDetlev Zundel 2573cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2574cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2575cccfc2abSDetlev Zundel 2576cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2577cccfc2abSDetlev Zundel Needed for mtdparts command support. 2578cccfc2abSDetlev Zundel 2579cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2580cccfc2abSDetlev Zundel 2581cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2582cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2583cccfc2abSDetlev Zundel 258470c219cdSJoe Hershberger- UBI support 2585147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 2586147162daSJoe Hershberger 2587147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 2588147162daSJoe Hershberger warnings and errors enabled. 2589147162daSJoe Hershberger 2590ff94bc40SHeiko Schocher 2591ff94bc40SHeiko Schocher CONFIG_MTD_UBI_WL_THRESHOLD 2592ff94bc40SHeiko Schocher This parameter defines the maximum difference between the highest 2593ff94bc40SHeiko Schocher erase counter value and the lowest erase counter value of eraseblocks 2594ff94bc40SHeiko Schocher of UBI devices. When this threshold is exceeded, UBI starts performing 2595ff94bc40SHeiko Schocher wear leveling by means of moving data from eraseblock with low erase 2596ff94bc40SHeiko Schocher counter to eraseblocks with high erase counter. 2597ff94bc40SHeiko Schocher 2598ff94bc40SHeiko Schocher The default value should be OK for SLC NAND flashes, NOR flashes and 2599ff94bc40SHeiko Schocher other flashes which have eraseblock life-cycle 100000 or more. 2600ff94bc40SHeiko Schocher However, in case of MLC NAND flashes which typically have eraseblock 2601ff94bc40SHeiko Schocher life-cycle less than 10000, the threshold should be lessened (e.g., 2602ff94bc40SHeiko Schocher to 128 or 256, although it does not have to be power of 2). 2603ff94bc40SHeiko Schocher 2604ff94bc40SHeiko Schocher default: 4096 2605ff94bc40SHeiko Schocher 2606ff94bc40SHeiko Schocher CONFIG_MTD_UBI_BEB_LIMIT 2607ff94bc40SHeiko Schocher This option specifies the maximum bad physical eraseblocks UBI 2608ff94bc40SHeiko Schocher expects on the MTD device (per 1024 eraseblocks). If the 2609ff94bc40SHeiko Schocher underlying flash does not admit of bad eraseblocks (e.g. NOR 2610ff94bc40SHeiko Schocher flash), this value is ignored. 2611ff94bc40SHeiko Schocher 2612ff94bc40SHeiko Schocher NAND datasheets often specify the minimum and maximum NVM 2613ff94bc40SHeiko Schocher (Number of Valid Blocks) for the flashes' endurance lifetime. 2614ff94bc40SHeiko Schocher The maximum expected bad eraseblocks per 1024 eraseblocks 2615ff94bc40SHeiko Schocher then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", 2616ff94bc40SHeiko Schocher which gives 20 for most NANDs (MaxNVB is basically the total 2617ff94bc40SHeiko Schocher count of eraseblocks on the chip). 2618ff94bc40SHeiko Schocher 2619ff94bc40SHeiko Schocher To put it differently, if this value is 20, UBI will try to 2620ff94bc40SHeiko Schocher reserve about 1.9% of physical eraseblocks for bad blocks 2621ff94bc40SHeiko Schocher handling. And that will be 1.9% of eraseblocks on the entire 2622ff94bc40SHeiko Schocher NAND chip, not just the MTD partition UBI attaches. This means 2623ff94bc40SHeiko Schocher that if you have, say, a NAND flash chip admits maximum 40 bad 2624ff94bc40SHeiko Schocher eraseblocks, and it is split on two MTD partitions of the same 2625ff94bc40SHeiko Schocher size, UBI will reserve 40 eraseblocks when attaching a 2626ff94bc40SHeiko Schocher partition. 2627ff94bc40SHeiko Schocher 2628ff94bc40SHeiko Schocher default: 20 2629ff94bc40SHeiko Schocher 2630ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP 2631ff94bc40SHeiko Schocher Fastmap is a mechanism which allows attaching an UBI device 2632ff94bc40SHeiko Schocher in nearly constant time. Instead of scanning the whole MTD device it 2633ff94bc40SHeiko Schocher only has to locate a checkpoint (called fastmap) on the device. 2634ff94bc40SHeiko Schocher The on-flash fastmap contains all information needed to attach 2635ff94bc40SHeiko Schocher the device. Using fastmap makes only sense on large devices where 2636ff94bc40SHeiko Schocher attaching by scanning takes long. UBI will not automatically install 2637ff94bc40SHeiko Schocher a fastmap on old images, but you can set the UBI parameter 2638ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note 2639ff94bc40SHeiko Schocher that fastmap-enabled images are still usable with UBI implementations 2640ff94bc40SHeiko Schocher without fastmap support. On typical flash devices the whole fastmap 2641ff94bc40SHeiko Schocher fits into one PEB. UBI will reserve PEBs to hold two fastmaps. 2642ff94bc40SHeiko Schocher 2643ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT 2644ff94bc40SHeiko Schocher Set this parameter to enable fastmap automatically on images 2645ff94bc40SHeiko Schocher without a fastmap. 2646ff94bc40SHeiko Schocher default: 0 2647ff94bc40SHeiko Schocher 26480195a7bbSHeiko Schocher CONFIG_MTD_UBI_FM_DEBUG 26490195a7bbSHeiko Schocher Enable UBI fastmap debug 26500195a7bbSHeiko Schocher default: 0 26510195a7bbSHeiko Schocher 265270c219cdSJoe Hershberger- UBIFS support 2653147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 2654147162daSJoe Hershberger 2655147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 2656147162daSJoe Hershberger warnings and errors enabled. 2657147162daSJoe Hershberger 26586a11cf48SDaniel Schwierzeck- SPL framework 26596a11cf48SDaniel Schwierzeck CONFIG_SPL 26606a11cf48SDaniel Schwierzeck Enable building of SPL globally. 26616a11cf48SDaniel Schwierzeck 266295579793STom Rini CONFIG_SPL_LDSCRIPT 266395579793STom Rini LDSCRIPT for linking the SPL binary. 266495579793STom Rini 26656ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 26666ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 26676ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 26686ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 26698960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 26706ebc3461SAlbert ARIBAUD must not be both defined at the same time. 26716ebc3461SAlbert ARIBAUD 267295579793STom Rini CONFIG_SPL_MAX_SIZE 26736ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 26746ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 26756ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 26766ebc3461SAlbert ARIBAUD not exceed it. 267795579793STom Rini 26786a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 26796a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 26806a11cf48SDaniel Schwierzeck 268194a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 268294a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 268394a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 268494a45bb1SScott Wood 268595579793STom Rini CONFIG_SPL_BSS_START_ADDR 268695579793STom Rini Link address for the BSS within the SPL binary. 268795579793STom Rini 268895579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 26896ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 26906ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 26916ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 26928960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 26936ebc3461SAlbert ARIBAUD must not be both defined at the same time. 269495579793STom Rini 269595579793STom Rini CONFIG_SPL_STACK 269695579793STom Rini Adress of the start of the stack SPL will use 269795579793STom Rini 26988c80eb3bSAlbert ARIBAUD \(3ADEV\) CONFIG_SPL_PANIC_ON_RAW_IMAGE 26998c80eb3bSAlbert ARIBAUD \(3ADEV\) When defined, SPL will panic() if the image it has 27008c80eb3bSAlbert ARIBAUD \(3ADEV\) loaded does not have a signature. 27018c80eb3bSAlbert ARIBAUD \(3ADEV\) Defining this is useful when code which loads images 27028c80eb3bSAlbert ARIBAUD \(3ADEV\) in SPL cannot guarantee that absolutely all read errors 27038c80eb3bSAlbert ARIBAUD \(3ADEV\) will be caught. 27048c80eb3bSAlbert ARIBAUD \(3ADEV\) An example is the LPC32XX MLC NAND driver, which will 27058c80eb3bSAlbert ARIBAUD \(3ADEV\) consider that a completely unreadable NAND block is bad, 27068c80eb3bSAlbert ARIBAUD \(3ADEV\) and thus should be skipped silently. 27078c80eb3bSAlbert ARIBAUD \(3ADEV\) 270894a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 270994a45bb1SScott Wood Adress of the start of the stack SPL will use after 271094a45bb1SScott Wood relocation. If unspecified, this is equal to 271194a45bb1SScott Wood CONFIG_SPL_STACK. 271294a45bb1SScott Wood 271395579793STom Rini CONFIG_SYS_SPL_MALLOC_START 271495579793STom Rini Starting address of the malloc pool used in SPL. 27159ac4fc82SFabio Estevam When this option is set the full malloc is used in SPL and 27169ac4fc82SFabio Estevam it is set up by spl_init() and before that, the simple malloc() 27179ac4fc82SFabio Estevam can be used if CONFIG_SYS_MALLOC_F is defined. 271895579793STom Rini 271995579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 272095579793STom Rini The size of the malloc pool used in SPL. 27216a11cf48SDaniel Schwierzeck 272247f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 272347f7bcaeSTom Rini Enable the SPL framework under common/. This framework 272447f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 272547f7bcaeSTom Rini NAND loading of the Linux Kernel. 272647f7bcaeSTom Rini 27279607faf2STom Rini CONFIG_SPL_OS_BOOT 27289607faf2STom Rini Enable booting directly to an OS from SPL. 27299607faf2STom Rini See also: doc/README.falcon 27309607faf2STom Rini 2731861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 2732861a86f4STom Rini For ARM, enable an optional function to print more information 2733861a86f4STom Rini about the running system. 2734861a86f4STom Rini 27354b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 27364b919725SScott Wood Arch init code should be built for a very small image 27374b919725SScott Wood 2738b97300b6SPaul Kocialkowski CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION 2739b97300b6SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 2740b97300b6SPaul Kocialkowski used in raw mode 2741b97300b6SPaul Kocialkowski 27422b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 27432b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 27442b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 27452b75b0adSPeter Korsgaard 27462b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 27472b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 27482b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 27492b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 27502b75b0adSPeter Korsgaard (for falcon mode) 27512b75b0adSPeter Korsgaard 2752e2ccdf89SPaul Kocialkowski CONFIG_SYS_MMCSD_FS_BOOT_PARTITION 2753e2ccdf89SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 2754e2ccdf89SPaul Kocialkowski used in fs mode 2755e2ccdf89SPaul Kocialkowski 2756fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_PAYLOAD_NAME 2757fae81c72SGuillaume GARDET Filename to read to load U-Boot when reading from filesystem 2758fae81c72SGuillaume GARDET 2759fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_KERNEL_NAME 27607ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 2761fae81c72SGuillaume GARDET from filesystem (for Falcon mode) 27627ad2cc79SPeter Korsgaard 2763fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_ARGS_NAME 27647ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 2765fae81c72SGuillaume GARDET when reading from filesystem (for Falcon mode) 27667ad2cc79SPeter Korsgaard 276706f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 276806f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 276906f60ae3SScott Wood start.S waits for the rest of the SPL to load before 277006f60ae3SScott Wood continuing (the hardware starts execution after just 277106f60ae3SScott Wood loading the first page rather than the full 4K). 277206f60ae3SScott Wood 2773651fcf60SPrabhakar Kushwaha CONFIG_SPL_SKIP_RELOCATE 2774651fcf60SPrabhakar Kushwaha Avoid SPL relocation 2775651fcf60SPrabhakar Kushwaha 27766f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 27776f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 27786f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 27796f2f01b9SScott Wood 27806f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 27816f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 27826f2f01b9SScott Wood 27836f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 27846f2f01b9SScott Wood Include standard software ECC in the SPL 27856f2f01b9SScott Wood 278695579793STom Rini CONFIG_SPL_NAND_SIMPLE 27877d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 27887d4b7955SScott Wood expose the cmd_ctrl() interface. 278995579793STom Rini 27906f4e7d3cSThomas Gleixner CONFIG_SPL_UBI 27916f4e7d3cSThomas Gleixner Support for a lightweight UBI (fastmap) scanner and 27926f4e7d3cSThomas Gleixner loader 27936f4e7d3cSThomas Gleixner 27940c3117b1SHeiko Schocher CONFIG_SPL_NAND_RAW_ONLY 27950c3117b1SHeiko Schocher Support to boot only raw u-boot.bin images. Use this only 27960c3117b1SHeiko Schocher if you need to save space. 27970c3117b1SHeiko Schocher 27987c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 27997c8eea59SYing Zhang Set for common ddr init with serial presence detect in 28007c8eea59SYing Zhang SPL binary. 28017c8eea59SYing Zhang 280295579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 280395579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 280495579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 280595579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 280695579793STom Rini CONFIG_SYS_NAND_ECCBYTES 280795579793STom Rini Defines the size and behavior of the NAND that SPL uses 28087d4b7955SScott Wood to read U-Boot 280995579793STom Rini 2810fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 2811fbe76ae4SPrabhakar Kushwaha Add support NAND boot 2812fbe76ae4SPrabhakar Kushwaha 281395579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 28147d4b7955SScott Wood Location in NAND to read U-Boot from 28157d4b7955SScott Wood 28167d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 28177d4b7955SScott Wood Location in memory to load U-Boot to 28187d4b7955SScott Wood 28197d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 28207d4b7955SScott Wood Size of image to load 282195579793STom Rini 282295579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 28237d4b7955SScott Wood Entry point in loaded image to jump to 282495579793STom Rini 282595579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 282695579793STom Rini Define this if you need to first read the OOB and then the 2827b445bbb4SJeremiah Mahler data. This is used, for example, on davinci platforms. 282895579793STom Rini 2829c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 2830c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 2831c57b953dSPavel Machek 283274752baaSScott Wood CONFIG_SPL_PAD_TO 28336113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 28346113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 28356113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 28366113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 28376113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 283874752baaSScott Wood 2839ca2fca22SScott Wood CONFIG_SPL_TARGET 2840ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 2841ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 2842ca2fca22SScott Wood example if more than one image needs to be produced. 2843ca2fca22SScott Wood 284487ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 284587ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 284687ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 284787ebee39SSimon Glass option to re-enable it. This will affect the output of the 284887ebee39SSimon Glass bootm command when booting a FIT image. 284987ebee39SSimon Glass 28503aa29de0SYing Zhang- TPL framework 28513aa29de0SYing Zhang CONFIG_TPL 28523aa29de0SYing Zhang Enable building of TPL globally. 28533aa29de0SYing Zhang 28543aa29de0SYing Zhang CONFIG_TPL_PAD_TO 28553aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 28563aa29de0SYing Zhang the TPL payload. By default, this is defined as 28573aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 28583aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 28593aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 28603aa29de0SYing Zhang 2861a8c7c708Swdenk- Interrupt support (PPC): 2862a8c7c708Swdenk 2863a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2864a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 286511ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2866a8c7c708Swdenk should set decrementer_count to appropriate value. If 286711ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2868a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 286911ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2870a8c7c708Swdenk specific handling. If board has watchdog / status_led 2871a8c7c708Swdenk / other_activity_monitor it works automatically from 2872a8c7c708Swdenk general timer_interrupt(). 2873a8c7c708Swdenk 2874c609719bSwdenk 28759660e442SHelmut RaigerBoard initialization settings: 28769660e442SHelmut Raiger------------------------------ 28779660e442SHelmut Raiger 28789660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 28799660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 28809660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 28819660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 28829660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 28839660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 28849660e442SHelmut Raiger 28859660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 28869660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 28879660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 28889660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 2889c609719bSwdenk 2890c609719bSwdenkConfiguration Settings: 2891c609719bSwdenk----------------------- 2892c609719bSwdenk 28934d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 28944d1fd7f1SYork Sun Optionally it can be defined to support 64-bit memory commands. 28954d1fd7f1SYork Sun 28966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2897c609719bSwdenk undefine this when you're short of memory. 2898c609719bSwdenk 28992fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 29002fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 29012fb2604dSPeter Tyser 29026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2903c609719bSwdenk prompt for user input. 2904c609719bSwdenk 29056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2906c609719bSwdenk 29076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2908c609719bSwdenk 29096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2910c609719bSwdenk 29116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2912c609719bSwdenk the application (usually a Linux kernel) when it is 2913c609719bSwdenk booted 2914c609719bSwdenk 29156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2916c609719bSwdenk List of legal baudrate settings for this board. 2917c609719bSwdenk 29186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2919c609719bSwdenk Begin and End addresses of the area used by the 2920c609719bSwdenk simple memory test. 2921c609719bSwdenk 29226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 2923c609719bSwdenk Enable an alternate, more extensive memory test. 2924c609719bSwdenk 29256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 29265f535fe1Swdenk Scratch address used by the alternate memory test 29275f535fe1Swdenk You only need to set this if address zero isn't writeable 29285f535fe1Swdenk 2929e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE 2930e61a7534SYork Sun Only implemented for ARMv8 for now. 2931e8149522SYork Sun If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory 2932e8149522SYork Sun is substracted from total RAM and won't be reported to OS. 2933e8149522SYork Sun This memory can be used as secure memory. A variable 2934e61a7534SYork Sun gd->arch.secure_ram is used to track the location. In systems 2935e8149522SYork Sun the RAM base is not zero, or RAM is divided into banks, 2936e8149522SYork Sun this variable needs to be recalcuated to get the address. 2937e8149522SYork Sun 2938aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE: 29396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 294014f73ca6SStefan Roese this specified memory area will get subtracted from the top 294111ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 294214f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 294314f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 294414f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 29455e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 294614f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 29475e12e75dSStefan Roese will have to get fixed in Linux additionally. 294814f73ca6SStefan Roese 294914f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 295014f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 295114f73ca6SStefan Roese be touched. 295214f73ca6SStefan Roese 295314f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 295414f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 295514f73ca6SStefan Roese then the end address of the Linux memory will be located at a 295614f73ca6SStefan Roese non page size aligned address and this could cause major 295714f73ca6SStefan Roese problems. 295814f73ca6SStefan Roese 29596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2960c609719bSwdenk Enable temporary baudrate change while serial download 2961c609719bSwdenk 29626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2963c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2964c609719bSwdenk 29656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2966c609719bSwdenk Physical start address of Flash memory. 2967c609719bSwdenk 29686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2969c609719bSwdenk Physical start address of boot monitor code (set by 2970c609719bSwdenk make config files to be same as the text base address 297114d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 29726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2973c609719bSwdenk 29746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 29753b57fe0aSwdenk Size of memory reserved for monitor code, used to 29763b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 29773b57fe0aSwdenk embedded within the U-Boot image, or in a separate 29783b57fe0aSwdenk flash sector. 2979c609719bSwdenk 29806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2981c609719bSwdenk Size of DRAM reserved for malloc() use. 2982c609719bSwdenk 2983d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN 2984d59476b6SSimon Glass Size of the malloc() pool for use before relocation. If 2985d59476b6SSimon Glass this is defined, then a very simple malloc() implementation 2986d59476b6SSimon Glass will become available before relocation. The address is just 2987d59476b6SSimon Glass below the global data, and the stack is moved down to make 2988d59476b6SSimon Glass space. 2989d59476b6SSimon Glass 2990d59476b6SSimon Glass This feature allocates regions with increasing addresses 2991d59476b6SSimon Glass within the region. calloc() is supported, but realloc() 2992d59476b6SSimon Glass is not available. free() is supported but does nothing. 2993b445bbb4SJeremiah Mahler The memory will be freed (or in fact just forgotten) when 2994d59476b6SSimon Glass U-Boot relocates itself. 2995d59476b6SSimon Glass 299638687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE 299738687ae6SSimon Glass Provides a simple and small malloc() and calloc() for those 299838687ae6SSimon Glass boards which do not use the full malloc in SPL (which is 299938687ae6SSimon Glass enabled with CONFIG_SYS_SPL_MALLOC_START). 300038687ae6SSimon Glass 30011dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY: 30021dfdd9baSThierry Reding Size of non-cached memory area. This area of memory will be 30031dfdd9baSThierry Reding typically located right below the malloc() area and mapped 30041dfdd9baSThierry Reding uncached in the MMU. This is useful for drivers that would 30051dfdd9baSThierry Reding otherwise require a lot of explicit cache maintenance. For 30061dfdd9baSThierry Reding some drivers it's also impossible to properly maintain the 30071dfdd9baSThierry Reding cache. For example if the regions that need to be flushed 30081dfdd9baSThierry Reding are not a multiple of the cache-line size, *and* padding 30091dfdd9baSThierry Reding cannot be allocated between the regions to align them (i.e. 30101dfdd9baSThierry Reding if the HW requires a contiguous array of regions, and the 30111dfdd9baSThierry Reding size of each region is not cache-aligned), then a flush of 30121dfdd9baSThierry Reding one region may result in overwriting data that hardware has 30131dfdd9baSThierry Reding written to another region in the same cache-line. This can 30141dfdd9baSThierry Reding happen for example in network drivers where descriptors for 30151dfdd9baSThierry Reding buffers are typically smaller than the CPU cache-line (e.g. 30161dfdd9baSThierry Reding 16 bytes vs. 32 or 64 bytes). 30171dfdd9baSThierry Reding 30181dfdd9baSThierry Reding Non-cached memory is only supported on 32-bit ARM at present. 30191dfdd9baSThierry Reding 30206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 302115940c9aSStefan Roese Normally compressed uImages are limited to an 302215940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 30236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 302415940c9aSStefan Roese to adjust this setting to your needs. 3025c609719bSwdenk 30266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3027c609719bSwdenk Maximum size of memory mapped by the startup code of 3028c609719bSwdenk the Linux kernel; all data that must be processed by 30297d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 30307d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 30311bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 30327d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3033c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3034c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3035c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3036c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3037c609719bSwdenk 3038fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3039fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3040fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3041fca43cc8SJohn Rigby is enabled. 3042fca43cc8SJohn Rigby 3043fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3044fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3045fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3046fca43cc8SJohn Rigby 3047fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3048fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3049fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3050fca43cc8SJohn Rigby 30516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3052c609719bSwdenk Max number of Flash memory banks 3053c609719bSwdenk 30546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3055c609719bSwdenk Max number of sectors on a Flash chip 3056c609719bSwdenk 30576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3058c609719bSwdenk Timeout for Flash erase operations (in ms) 3059c609719bSwdenk 30606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3061c609719bSwdenk Timeout for Flash write operations (in ms) 3062c609719bSwdenk 30636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 30648564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 30658564acf9Swdenk 30666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 30678564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 30688564acf9Swdenk 30696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 30708564acf9Swdenk If defined, hardware flash sectors protection is used 30718564acf9Swdenk instead of U-Boot software protection. 30728564acf9Swdenk 30736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3074c609719bSwdenk 3075c609719bSwdenk Enable TFTP transfers directly to flash memory; 3076c609719bSwdenk without this option such a download has to be 3077c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3078c609719bSwdenk copy from RAM to flash. 3079c609719bSwdenk 3080c609719bSwdenk The two-step approach is usually more reliable, since 3081c609719bSwdenk you can check if the download worked before you erase 308211ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 308311ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3084c609719bSwdenk downloaded image) this option may be very useful. 3085c609719bSwdenk 30866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3087c609719bSwdenk Define if the flash driver uses extra elements in the 30885653fc33Swdenk common flash structure for storing flash geometry. 30895653fc33Swdenk 309000b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 30915653fc33Swdenk This option also enables the building of the cfi_flash driver 30925653fc33Swdenk in the drivers directory 309353cf9435Sstroese 309491809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 309591809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 309691809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 309791809ed5SPiotr Ziecik to the MTD layer. 309891809ed5SPiotr Ziecik 30996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 310096ef831fSGuennadi Liakhovetski Use buffered writes to flash. 310196ef831fSGuennadi Liakhovetski 310296ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 310396ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 310496ef831fSGuennadi Liakhovetski write commands. 310596ef831fSGuennadi Liakhovetski 31066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 31075568e613SStefan Roese If this option is defined, the common CFI flash doesn't 31085568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 31095568e613SStefan Roese is useful, if some of the configured banks are only 31105568e613SStefan Roese optionally available. 31115568e613SStefan Roese 31129a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 31139a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 31149a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 31159a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 31169a042e9cSJerry Van Baren 3117352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3118352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3119352ef3f1SStefan Roese against the source after the write operation. An error message 3120352ef3f1SStefan Roese will be printed when the contents are not identical. 3121352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3122352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3123352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3124352ef3f1SStefan Roese this option if you really know what you are doing. 3125352ef3f1SStefan Roese 31266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 312711ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 312811ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 312953cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 313053cf9435Sstroese buffers can be full shortly after enabling the interface 313111ccc33fSMarcel Ziswiler on high Ethernet traffic. 313253cf9435Sstroese Defaults to 4 if not defined. 3133c609719bSwdenk 3134ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3135ea882bafSWolfgang Denk 3136ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3137ea882bafSWolfgang Denk internally to store the environment settings. The default 3138ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3139ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3140ea882bafSWolfgang Denk lib/hashtable.c for details. 3141ea882bafSWolfgang Denk 31422598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 31432598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 31441bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 31452598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 31462598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 31472598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 31482598090bSJoe Hershberger 31492598090bSJoe Hershberger The format of the list is: 31502598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3151b445bbb4SJeremiah Mahler access_attribute = [a|r|o|c] 3152b445bbb4SJeremiah Mahler attributes = type_attribute[access_attribute] 31532598090bSJoe Hershberger entry = variable_name[:attributes] 31542598090bSJoe Hershberger list = entry[,list] 31552598090bSJoe Hershberger 31562598090bSJoe Hershberger The type attributes are: 31572598090bSJoe Hershberger s - String (default) 31582598090bSJoe Hershberger d - Decimal 31592598090bSJoe Hershberger x - Hexadecimal 31602598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 31612598090bSJoe Hershberger i - IP address 31622598090bSJoe Hershberger m - MAC address 31632598090bSJoe Hershberger 3164267541f7SJoe Hershberger The access attributes are: 3165267541f7SJoe Hershberger a - Any (default) 3166267541f7SJoe Hershberger r - Read-only 3167267541f7SJoe Hershberger o - Write-once 3168267541f7SJoe Hershberger c - Change-default 3169267541f7SJoe Hershberger 31702598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 31712598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 3172b445bbb4SJeremiah Mahler environment variable in the default or embedded environment. 31732598090bSJoe Hershberger 31742598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 31752598090bSJoe Hershberger Define this to a list (string) to define validation that 31762598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 31772598090bSJoe Hershberger environment variable. To override a setting in the static 31782598090bSJoe Hershberger list, simply add an entry for the same variable name to the 31792598090bSJoe Hershberger ".flags" variable. 31802598090bSJoe Hershberger 3181bdf1fe4eSJoe Hershberger If CONFIG_REGEX is defined, the variable_name above is evaluated as a 3182bdf1fe4eSJoe Hershberger regular expression. This allows multiple variables to define the same 3183bdf1fe4eSJoe Hershberger flags without explicitly listing them for each variable. 3184bdf1fe4eSJoe Hershberger 3185267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3186267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3187267541f7SJoe Hershberger access flags. 3188267541f7SJoe Hershberger 31890d296cc2SGabe Black- CONFIG_USE_STDINT 31900d296cc2SGabe Black If stdint.h is available with your toolchain you can define this 31910d296cc2SGabe Black option to enable it. You can provide option 'USE_STDINT=1' when 31920d296cc2SGabe Black building U-Boot to enable this. 31930d296cc2SGabe Black 3194c609719bSwdenkThe following definitions that deal with the placement and management 3195c609719bSwdenkof environment data (variable area); in general, we support the 3196c609719bSwdenkfollowing configurations: 3197c609719bSwdenk 3198c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3199c3eb3fe4SMike Frysinger 3200c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3201c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3202c3eb3fe4SMike Frysinger 3203c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3204b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the 320511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3206c609719bSwdenkU-Boot will hang. 3207c609719bSwdenk 3208c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3209c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3210c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3211c609719bSwdenkto save the current settings. 3212c609719bSwdenk 32130a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 32140a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3215fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3216fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 32170a85a9e7SLiu Gang 3218b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3219b74ab737SGuennadi Liakhovetski 3220b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3221b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3222b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3223b74ab737SGuennadi Liakhovetski 3224e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3225c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 322600caae6dSSimon Glasscreated; also, when using EEPROM you will have to use env_get_f() 3227c609719bSwdenkuntil then to read environment variables. 3228c609719bSwdenk 322985ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 323085ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 323185ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 323285ec0bccSwdenknecessary, because the first environment variable we need is the 323385ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 323485ec0bccSwdenkhave any device yet where we could complain.] 3235c609719bSwdenk 3236c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3237c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 323885ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3239c609719bSwdenk 32406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3241fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3242fc3e2165Swdenk 32436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3244fc3e2165Swdenk also needs to be defined. 3245fc3e2165Swdenk 32466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3247fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3248c609719bSwdenk 3249f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 3250f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 3251f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 3252f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 3253f5675aa5SRon Madrid space for already greatly restricted images, including but not 3254f5675aa5SRon Madrid limited to NAND_SPL configurations. 3255f5675aa5SRon Madrid 3256b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 3257b2b92f53SSimon Glass Display information about the board that U-Boot is running on 3258b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 3259b2b92f53SSimon Glass to do this. 3260b2b92f53SSimon Glass 3261e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 3262e2e3e2b1SSimon Glass Similar to the previous option, but display this information 3263e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 3264e2e3e2b1SSimon Glass present. 3265e2e3e2b1SSimon Glass 3266feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT: 3267feb85801SSascha Silbe Maximum size of the U-Boot image. When defined, the 3268feb85801SSascha Silbe build system checks that the actual size does not 3269feb85801SSascha Silbe exceed it. 3270feb85801SSascha Silbe 3271c609719bSwdenkLow Level (hardware related) configuration options: 3272dc7c9a1aSwdenk--------------------------------------------------- 3273c609719bSwdenk 32746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 3275c609719bSwdenk Cache Line Size of the CPU. 3276c609719bSwdenk 3277e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 3278e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 3279e46fedfeSTimur Tabi PowerPC SOCs. 3280e46fedfeSTimur Tabi 3281e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3282e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3283e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3284e46fedfeSTimur Tabi 3285e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3286e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3287e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3288e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3289e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3290e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3291e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3292e46fedfeSTimur Tabi 3293e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3294e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3295e46fedfeSTimur Tabi 3296e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3297e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3298e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3299e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3300e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3301e46fedfeSTimur Tabi 3302e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3303e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3304e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3305e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3306e46fedfeSTimur Tabi 3307e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3308e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3309e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3310e46fedfeSTimur Tabi 33117f6c2cbcSwdenk- Floppy Disk Support: 33126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 33137f6c2cbcSwdenk 33147f6c2cbcSwdenk the default drive number (default value 0) 33157f6c2cbcSwdenk 33166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 33177f6c2cbcSwdenk 331811ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 33197f6c2cbcSwdenk (default value 1) 33207f6c2cbcSwdenk 33216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 33227f6c2cbcSwdenk 33237f6c2cbcSwdenk defines the offset of register from address. It 33247f6c2cbcSwdenk depends on which part of the data bus is connected to 332511ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 33267f6c2cbcSwdenk 33276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 33286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 33297f6c2cbcSwdenk default value. 33307f6c2cbcSwdenk 33316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 33327f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 33337f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 3334b445bbb4SJeremiah Mahler source code. It is used to make hardware-dependent 33357f6c2cbcSwdenk initializations. 33367f6c2cbcSwdenk 33370abddf82SMacpaul Lin- CONFIG_IDE_AHB: 33380abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 33390abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 33400abddf82SMacpaul Lin When software is doing ATA command and data transfer to 33410abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 33420abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 3343b445bbb4SJeremiah Mahler is required. 33440abddf82SMacpaul Lin 33456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 334625d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 3347907208c4SChristophe Leroy doing! (11-4) [MPC8xx systems only] 3348c609719bSwdenk 33496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3350c609719bSwdenk 33517152b1d0Swdenk Start address of memory area that can be used for 3352c609719bSwdenk initial data and stack; please note that this must be 3353c609719bSwdenk writable memory that is working WITHOUT special 3354c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3355c609719bSwdenk will become available only after programming the 3356c609719bSwdenk memory controller and running certain initialization 3357c609719bSwdenk sequences. 3358c609719bSwdenk 3359c609719bSwdenk U-Boot uses the following memory types: 3360907208c4SChristophe Leroy - MPC8xx: IMMR (internal memory of the CPU) 3361c609719bSwdenk 33626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3363c609719bSwdenk 3364c609719bSwdenk Offset of the initial data structure in the memory 33656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 33666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3367c609719bSwdenk data is located at the end of the available space 3368553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 3369acd51f9dSSimon Glass GENERATED_GBL_DATA_SIZE), and the initial stack is just 33706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 33716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3372c609719bSwdenk 3373c609719bSwdenk Note: 3374c609719bSwdenk On the MPC824X (or other systems that use the data 3375c609719bSwdenk cache for initial memory) the address chosen for 33766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3377c609719bSwdenk point to an otherwise UNUSED address space between 3378c609719bSwdenk the top of RAM and the start of the PCI space. 3379c609719bSwdenk 33806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3381c609719bSwdenk 33826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3383c609719bSwdenk SDRAM timing 3384c609719bSwdenk 33856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3386c609719bSwdenk periodic timer for refresh 3387c609719bSwdenk 33886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 33896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 33906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 33916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3392c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3393c609719bSwdenk 3394c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 33956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 33966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3397c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3398c609719bSwdenk 339969fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 3400b445bbb4SJeremiah Mahler Only scan through and get the devices on the buses. 340169fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 340269fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 340369fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 340469fd2d3bSAndrew Sharp by coreboot or similar. 340569fd2d3bSAndrew Sharp 3406842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 3407842033e6SGabor Juhos Enable support for indirect PCI bridges. 3408842033e6SGabor Juhos 3409a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3410a09b9b68SKumar Gala Chip has SRIO or not 3411a09b9b68SKumar Gala 3412a09b9b68SKumar Gala- CONFIG_SRIO1: 3413a09b9b68SKumar Gala Board has SRIO 1 port available 3414a09b9b68SKumar Gala 3415a09b9b68SKumar Gala- CONFIG_SRIO2: 3416a09b9b68SKumar Gala Board has SRIO 2 port available 3417a09b9b68SKumar Gala 3418c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 3419c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 3420c8b28152SLiu Gang 3421a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3422a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3423a09b9b68SKumar Gala 3424a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3425a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3426a09b9b68SKumar Gala 3427a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3428a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3429a09b9b68SKumar Gala 343066bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 343166bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 343266bd1846SFabio Estevam a 16 bit bus. 343366bd1846SFabio Estevam Not all NAND drivers use this symbol. 3434a430e916SFabio Estevam Example of drivers that use it: 343566bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 3436a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 3437eced4626SAlex Waterman 3438eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3439eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3440eced4626SAlex Waterman a default value will be used. 3441eced4626SAlex Waterman 3442bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3443218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3444218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3445218ca724SWolfgang Denk 3446bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3447bb99ad6dSBen Warren I2C address of the SPD EEPROM 3448bb99ad6dSBen Warren 34496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 3450218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 3451218ca724SWolfgang Denk one, specify here. Note that the value must resolve 3452218ca724SWolfgang Denk to something your driver can deal with. 3453bb99ad6dSBen Warren 34541b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 34551b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 34561b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 34571b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 34581b3e3c4fSYork Sun header files or board specific files. 34591b3e3c4fSYork Sun 34606f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 34616f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 34626f5e1dc5SYork Sun 3463e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH 3464e32d59a2SYork Sun Enable sync of refresh for multiple controllers. 3465e32d59a2SYork Sun 34664516ff81SYork Sun- CONFIG_FSL_DDR_BIST 34674516ff81SYork Sun Enable built-in memory test for Freescale DDR controllers. 34684516ff81SYork Sun 34696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 3470218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 3471218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 34722ad6b513STimur Tabi 3473c26e454dSwdenk- CONFIG_RMII 3474c26e454dSwdenk Enable RMII mode for all FECs. 3475c26e454dSwdenk Note that this is a global option, we can't 3476c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 3477c26e454dSwdenk 34785cf91d6bSwdenk- CONFIG_CRC32_VERIFY 34795cf91d6bSwdenk Add a verify option to the crc32 command. 34805cf91d6bSwdenk The syntax is: 34815cf91d6bSwdenk 34825cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 34835cf91d6bSwdenk 34845cf91d6bSwdenk Where address/count indicate a memory area 34855cf91d6bSwdenk and crc32 is the correct crc32 which the 34865cf91d6bSwdenk area should have. 34875cf91d6bSwdenk 348856523f12Swdenk- CONFIG_LOOPW 348956523f12Swdenk Add the "loopw" memory command. This only takes effect if 3490493f420eSSimon Glass the memory commands are activated globally (CONFIG_CMD_MEMORY). 349156523f12Swdenk 34927b466641Sstroese- CONFIG_MX_CYCLIC 34937b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 34947b466641Sstroese "md/mw" commands. 34957b466641Sstroese Examples: 34967b466641Sstroese 34977b466641Sstroese => mdc.b 10 4 500 34987b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 34997b466641Sstroese 35007b466641Sstroese => mwc.l 100 12345678 10 35017b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 35027b466641Sstroese 35037b466641Sstroese This only takes effect if the memory commands are activated 3504493f420eSSimon Glass globally (CONFIG_CMD_MEMORY). 35057b466641Sstroese 35068aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 3507afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 3508e03f3169SWolfgang Denk low level initializations (like setting up the memory 3509e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3510e03f3169SWolfgang Denk relocate itself into RAM. 35118aa1a2d1Swdenk 3512e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3513e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3514e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3515e03f3169SWolfgang Denk these initializations itself. 35168aa1a2d1Swdenk 3517b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY 3518b5bd0982SSimon Glass [ARM926EJ-S only] This allows just the call to lowlevel_init() 351990211f77Syeongjun Kim to be skipped. The normal CP15 init (such as enabling the 3520b5bd0982SSimon Glass instruction cache) is still performed. 3521b5bd0982SSimon Glass 3522401bb30bSAneesh V- CONFIG_SPL_BUILD 3523df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3524df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3525df81238bSMagnus Lilja compiling a NAND SPL. 3526400558b5Swdenk 35273aa29de0SYing Zhang- CONFIG_TPL_BUILD 35283aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 35293aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 35303aa29de0SYing Zhang It is loaded by the SPL. 35313aa29de0SYing Zhang 35325df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 35335df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 35345df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 35355df572f0SYing Zhang previous 4k of the .text section. 35365df572f0SYing Zhang 35374213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 35384213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 35394213fc29SSimon Glass effective address. It is therefore not necessary to regard 35404213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 35414213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 35424213fc29SSimon Glass it maintains its own little RAM buffer which contains all 35434213fc29SSimon Glass addressable memory. This option causes some memory accesses 35444213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 35454213fc29SSimon Glass 3546588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 3547588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 3548588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 3549b16f521aSGabe Black 355016678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 355116678eb4SHeiko Schocher Enables the RTC32K OSC on AM33xx based plattforms 355216678eb4SHeiko Schocher 3553999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 3554999d7d32SKaricheri, Muralidharan Option to disable subpage write in NAND driver 3555999d7d32SKaricheri, Muralidharan driver that uses this: 3556999d7d32SKaricheri, Muralidharan drivers/mtd/nand/davinci_nand.c 3557999d7d32SKaricheri, Muralidharan 3558f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 3559f2717b47STimur Tabi----------------------------------- 3560f2717b47STimur Tabi 3561f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 3562f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 3563f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 3564f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 3565f2717b47STimur Tabiwithin that device. 3566f2717b47STimur Tabi 3567dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR 3568dcf1d774SZhao Qiang The address in the storage device where the FMAN microcode is located. The 3569dcf1d774SZhao Qiang meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3570dcf1d774SZhao Qiang is also specified. 3571dcf1d774SZhao Qiang 3572dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR 3573dcf1d774SZhao Qiang The address in the storage device where the QE microcode is located. The 3574f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3575f2717b47STimur Tabi is also specified. 3576f2717b47STimur Tabi 3577f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 3578f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 3579f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 3580f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 3581f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 3582f2717b47STimur Tabi 3583f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 3584f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 3585f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 3586f2717b47STimur Tabi virtual address in NOR flash. 3587f2717b47STimur Tabi 3588f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 3589f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 3590f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 3591f2717b47STimur Tabi 3592f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 3593f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 3594f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3595f2717b47STimur Tabi 3596292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 3597292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 3598292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 3599fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 3600fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 3601fc54c7faSLiu Gang master's memory space. 3602f2717b47STimur Tabi 3603b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support: 3604b940ca64SJ. German Rivera--------------------------------------------------------- 3605b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of 3606b940ca64SJ. German Rivera"firmware". 3607b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros 3608b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address 3609b940ca64SJ. German Riverawithin that device. 3610b940ca64SJ. German Rivera 3611b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET 3612b940ca64SJ. German Rivera Enable the MC driver for Layerscape SoCs. 3613b940ca64SJ. German Rivera 36145c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support: 36155c055089SPrabhakar Kushwaha------------------------------------------- 36165c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of 36175c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom. 36185c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting. 36195c055089SPrabhakar Kushwaha 3620c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN 3621c0492141SYork Sun Define alignment of reserved memory MC requires 36225c055089SPrabhakar Kushwaha 3623f3f431a7SPaul KocialkowskiReproducible builds 3624f3f431a7SPaul Kocialkowski------------------- 3625f3f431a7SPaul Kocialkowski 3626f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build 3627f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value. 3628f3f431a7SPaul Kocialkowski 3629f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable. 3630f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration 3631f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot. 3632f3f431a7SPaul Kocialkowski 3633f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. 3634f3f431a7SPaul Kocialkowski 3635c609719bSwdenkBuilding the Software: 3636c609719bSwdenk====================== 3637c609719bSwdenk 3638218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 3639218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 3640218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 3641218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 3642218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3643218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 3644c609719bSwdenk 3645218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 3646218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 3647218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 3648218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 3649218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 3650c609719bSwdenk 3651218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 3652218ca724SWolfgang Denk $ export CROSS_COMPILE 3653c609719bSwdenk 36542f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 36552f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 36562f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 36572f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 36582f8d396bSPeter Tyser 36592f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 36602f8d396bSPeter Tyser 36612f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 36622f8d396bSPeter Tyser be executed on computers running Windows. 36632f8d396bSPeter Tyser 3664c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3665c609719bSwdenksources you must configure U-Boot for one specific board type. This 3666c609719bSwdenkis done by typing: 3667c609719bSwdenk 3668ab584d67SHolger Freyther make NAME_defconfig 3669c609719bSwdenk 3670ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu- 36714d675ae6SMichael Jonesrations; see boards.cfg for supported names. 367254387ac9Swdenk 3673c609719bSwdenkNote: for some board special configuration names may exist; check if 3674c609719bSwdenk additional information is available from the board vendor; for 36752729af9dSwdenk instance, the TQM823L systems are available without (standard) 36762729af9dSwdenk or with LCD support. You can select such additional "features" 367711ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3678c609719bSwdenk 3679ab584d67SHolger Freyther make TQM823L_defconfig 36802729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3681c609719bSwdenk 3682ab584d67SHolger Freyther make TQM823L_LCD_defconfig 3683c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3684c609719bSwdenk 3685c609719bSwdenk etc. 3686c609719bSwdenk 3687c609719bSwdenk 3688c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 36897152b1d0Swdenkimages ready for download to / installation on your system: 3690c609719bSwdenk 3691c609719bSwdenk- "u-boot.bin" is a raw binary image 3692c609719bSwdenk- "u-boot" is an image in ELF binary format 3693c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3694c609719bSwdenk 3695baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3696baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3697baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3698baf31249SMarian Balakowicz 3699baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3700baf31249SMarian Balakowicz 3701baf31249SMarian Balakowicz make O=/tmp/build distclean 3702ab584d67SHolger Freyther make O=/tmp/build NAME_defconfig 3703baf31249SMarian Balakowicz make O=/tmp/build all 3704baf31249SMarian Balakowicz 3705adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location: 3706baf31249SMarian Balakowicz 3707adbba996STimo Ketola export KBUILD_OUTPUT=/tmp/build 3708baf31249SMarian Balakowicz make distclean 3709ab584d67SHolger Freyther make NAME_defconfig 3710baf31249SMarian Balakowicz make all 3711baf31249SMarian Balakowicz 3712adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment 3713baf31249SMarian Balakowiczvariable. 3714baf31249SMarian Balakowicz 3715c609719bSwdenk 3716c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3717c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3718c609719bSwdenknative "make". 3719c609719bSwdenk 3720c609719bSwdenk 3721c609719bSwdenkIf the system board that you have is not listed, then you will need 3722c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3723c609719bSwdenksteps: 3724c609719bSwdenk 37253c1496cdSPhil Sutter1. Create a new directory to hold your board specific code. Add any 372685ec0bccSwdenk files you need. In your board directory, you will need at least 37273c1496cdSPhil Sutter the "Makefile" and a "<board>.c". 37283c1496cdSPhil Sutter2. Create a new configuration file "include/configs/<board>.h" for 37293c1496cdSPhil Sutter your board. 3730c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3731c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 3732ab584d67SHolger Freyther4. Run "make <board>_defconfig" with your new name. 3733c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3734c609719bSwdenk to be installed on your target system. 373585ec0bccSwdenk6. Debug and solve any problems that might arise. 3736c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3737c609719bSwdenk 3738c609719bSwdenk 3739c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3740c609719bSwdenk============================================================== 3741c609719bSwdenk 3742c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3743c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3744c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3745c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3746218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3747c609719bSwdenk 3748c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3749c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3750c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 37516de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will 37526de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this 37536de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H' 37546de80f21SSimon Glassfor documentation. 3755baf31249SMarian Balakowicz 3756baf31249SMarian Balakowicz 3757c609719bSwdenkSee also "U-Boot Porting Guide" below. 3758c609719bSwdenk 3759c609719bSwdenk 3760c609719bSwdenkMonitor Commands - Overview: 3761c609719bSwdenk============================ 3762c609719bSwdenk 3763c609719bSwdenkgo - start application at address 'addr' 3764c609719bSwdenkrun - run commands in an environment variable 3765c609719bSwdenkbootm - boot application image from memory 3766c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 376744f074c7SMarek Vasutbootz - boot zImage from memory 3768c609719bSwdenktftpboot- boot image via network using TFTP protocol 3769c609719bSwdenk and env variables "ipaddr" and "serverip" 3770c609719bSwdenk (and eventually "gatewayip") 37711fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 3772c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3773c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3774c609719bSwdenkloads - load S-Record file over serial line 3775c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3776c609719bSwdenkmd - memory display 3777c609719bSwdenkmm - memory modify (auto-incrementing) 3778c609719bSwdenknm - memory modify (constant address) 3779c609719bSwdenkmw - memory write (fill) 3780c609719bSwdenkcp - memory copy 3781c609719bSwdenkcmp - memory compare 3782c609719bSwdenkcrc32 - checksum calculation 37830f89c54bSPeter Tyseri2c - I2C sub-system 3784c609719bSwdenksspi - SPI utility commands 3785c609719bSwdenkbase - print or set address offset 3786c609719bSwdenkprintenv- print environment variables 3787c609719bSwdenksetenv - set environment variables 3788c609719bSwdenksaveenv - save environment variables to persistent storage 3789c609719bSwdenkprotect - enable or disable FLASH write protection 3790c609719bSwdenkerase - erase FLASH memory 3791c609719bSwdenkflinfo - print FLASH memory information 379210635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 3793c609719bSwdenkbdinfo - print Board Info structure 3794c609719bSwdenkiminfo - print header information for application image 3795c609719bSwdenkconinfo - print console devices and informations 3796c609719bSwdenkide - IDE sub-system 3797c609719bSwdenkloop - infinite loop on address range 379856523f12Swdenkloopw - infinite write loop on address range 3799c609719bSwdenkmtest - simple RAM test 3800c609719bSwdenkicache - enable or disable instruction cache 3801c609719bSwdenkdcache - enable or disable data cache 3802c609719bSwdenkreset - Perform RESET of the CPU 3803c609719bSwdenkecho - echo args to console 3804c609719bSwdenkversion - print monitor version 3805c609719bSwdenkhelp - print online help 3806c609719bSwdenk? - alias for 'help' 3807c609719bSwdenk 3808c609719bSwdenk 3809c609719bSwdenkMonitor Commands - Detailed Description: 3810c609719bSwdenk======================================== 3811c609719bSwdenk 3812c609719bSwdenkTODO. 3813c609719bSwdenk 3814c609719bSwdenkFor now: just type "help <command>". 3815c609719bSwdenk 3816c609719bSwdenk 3817c609719bSwdenkEnvironment Variables: 3818c609719bSwdenk====================== 3819c609719bSwdenk 3820c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3821c609719bSwdenkcan be made persistent by saving to Flash memory. 3822c609719bSwdenk 3823c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3824c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3825c609719bSwdenkwithout a value can be used to delete a variable from the 3826c609719bSwdenkenvironment. As long as you don't save the environment you are 3827c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3828c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3829c609719bSwdenk 3830c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3831c96f86eeSWolfgang Denk 3832c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3833c609719bSwdenk 3834c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3835c609719bSwdenk 3836c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3837c609719bSwdenk 3838c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3839c609719bSwdenk 3840c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3841c609719bSwdenk 3842c609719bSwdenk bootfile - Name of the image to load with TFTP 3843c609719bSwdenk 38447d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 38457d721e34SBartlomiej Sieka command can be restricted. This variable is given as 38467d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 38477d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 38487d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 38497d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 3850c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3851c3624e6eSGrant Likely bootm_mapsize. 3852c3624e6eSGrant Likely 3853c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3854c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 3855c3624e6eSGrant Likely defines the size of the memory region starting at base 3856c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 3857c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3858c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 3859c3624e6eSGrant Likely used otherwise. 38607d721e34SBartlomiej Sieka 38617d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 38627d721e34SBartlomiej Sieka command can be restricted. This variable is given as 38637d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 38647d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 38657d721e34SBartlomiej Sieka environment variable. 38667d721e34SBartlomiej Sieka 38674bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 38684bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 38694bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 38704bae9090SBartlomiej Sieka 3871c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3872c609719bSwdenk "bootp" will just load perform a lookup of the 3873c609719bSwdenk configuration from the BOOTP server, but not try to 3874c609719bSwdenk load any image using TFTP 3875c609719bSwdenk 3876c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3877c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3878c609719bSwdenk be automatically started (by internally calling 3879c609719bSwdenk "bootm") 3880c609719bSwdenk 38814a6fd34bSwdenk If set to "no", a standalone image passed to the 38824a6fd34bSwdenk "bootm" command will be copied to the load address 38834a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 38844a6fd34bSwdenk This can be used to load and uncompress arbitrary 38854a6fd34bSwdenk data. 38864a6fd34bSwdenk 3887a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 3888a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 3889fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 3890fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 3891fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 3892fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 3893fa34f6b2SShawn Guo device tree blob be copied to the maximum address 3894fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 3895fa34f6b2SShawn Guo access it during the boot procedure. 3896fa34f6b2SShawn Guo 3897a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 3898a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 3899a28afca5SDavid A. Long to work it must reside in writable memory, have 3900a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 3901a28afca5SDavid A. Long add the information it needs into it, and the memory 3902a28afca5SDavid A. Long must be accessible by the kernel. 3903a28afca5SDavid A. Long 3904eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 3905eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 3906eea63e05SSimon Glass defined. 3907eea63e05SSimon Glass 390817ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 390917ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 391017ea1177Swdenk mode (400kHZ). This environment variable is used in 391117ea1177Swdenk initialization code. So, for changes to be effective 391217ea1177Swdenk it must be saved and board must be reset. 391317ea1177Swdenk 3914c609719bSwdenk initrd_high - restrict positioning of initrd images: 3915c609719bSwdenk If this variable is not set, initrd images will be 3916c609719bSwdenk copied to the highest possible address in RAM; this 3917c609719bSwdenk is usually what you want since it allows for 3918c609719bSwdenk maximum initrd size. If for some reason you want to 3919c609719bSwdenk make sure that the initrd image is loaded below the 39206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3921c609719bSwdenk variable to a value of "no" or "off" or "0". 3922c609719bSwdenk Alternatively, you can set it to a maximum upper 3923c609719bSwdenk address to use (U-Boot will still check that it 3924c609719bSwdenk does not overwrite the U-Boot stack and data). 3925c609719bSwdenk 3926c609719bSwdenk For instance, when you have a system with 16 MB 39277152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3928c609719bSwdenk you can do this by adding "mem=12M" to the value of 3929c609719bSwdenk the "bootargs" variable. However, now you must make 39307152b1d0Swdenk sure that the initrd image is placed in the first 3931c609719bSwdenk 12 MB as well - this can be done with 3932c609719bSwdenk 3933c609719bSwdenk setenv initrd_high 00c00000 3934c609719bSwdenk 393538b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 393638b99261Swdenk indication to U-Boot that all addresses are legal 393738b99261Swdenk for the Linux kernel, including addresses in flash 393838b99261Swdenk memory. In this case U-Boot will NOT COPY the 393938b99261Swdenk ramdisk at all. This may be useful to reduce the 394038b99261Swdenk boot time on your system, but requires that this 394138b99261Swdenk feature is supported by your Linux kernel. 394238b99261Swdenk 3943c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3944c609719bSwdenk 3945c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3946dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3947c609719bSwdenk 3948c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3949c609719bSwdenk 3950c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3951c609719bSwdenk 3952c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3953c609719bSwdenk 3954c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3955c609719bSwdenk 3956c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3957c609719bSwdenk 3958e2a53458SMike Frysinger ethprime - controls which interface is used first. 3959a3d991bdSwdenk 3960e2a53458SMike Frysinger ethact - controls which interface is currently active. 3961e2a53458SMike Frysinger For example you can do the following 3962a3d991bdSwdenk 396348690d80SHeiko Schocher => setenv ethact FEC 396448690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 396548690d80SHeiko Schocher => setenv ethact SCC 396648690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 3967a3d991bdSwdenk 3968e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 3969e1692577SMatthias Fuchs available network interfaces. 3970e1692577SMatthias Fuchs It just stays at the currently selected interface. 3971e1692577SMatthias Fuchs 3972a3d991bdSwdenk netretry - When set to "no" each network operation will 3973a3d991bdSwdenk either succeed or fail without retrying. 39746e592385Swdenk When set to "once" the network operation will 39756e592385Swdenk fail when all the available network interfaces 39766e592385Swdenk are tried once without success. 3977a3d991bdSwdenk Useful on scripts which control the retry operation 3978a3d991bdSwdenk themselves. 3979a3d991bdSwdenk 3980b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 3981a1cf027aSJean-Christophe PLAGNIOL-VILLARD 3982b445bbb4SJeremiah Mahler silent_linux - If set then Linux will be told to boot silently, by 39838d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 39848d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 39858d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 39868d51aacdSSimon Glass is silent. 39878d51aacdSSimon Glass 3988f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpsrcp - If this is set, the value is used for TFTP's 3989ecb0ccd9SWolfgang Denk UDP source port. 3990ecb0ccd9SWolfgang Denk 3991f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpdstp - If this is set, the value is used for TFTP's UDP 399228cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 399328cb9375SWolfgang Denk 3994c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 3995c96f86eeSWolfgang Denk we use the TFTP server's default block size 3996c96f86eeSWolfgang Denk 3997c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 3998c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 3999c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4000c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4001c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4002c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4003c96f86eeSWolfgang Denk with unreliable TFTP servers. 4004c96f86eeSWolfgang Denk 4005f5fb7346SAlbert ARIBAUD \(3ADEV\) tftptimeoutcountmax - maximum count of TFTP timeouts (no 4006f5fb7346SAlbert ARIBAUD \(3ADEV\) unit, minimum value = 0). Defines how many timeouts 4007f5fb7346SAlbert ARIBAUD \(3ADEV\) can happen during a single file transfer before that 4008f5fb7346SAlbert ARIBAUD \(3ADEV\) transfer is aborted. The default is 10, and 0 means 4009f5fb7346SAlbert ARIBAUD \(3ADEV\) 'no timeouts allowed'. Increasing this value may help 4010f5fb7346SAlbert ARIBAUD \(3ADEV\) downloads succeed with high packet loss rates, or with 4011f5fb7346SAlbert ARIBAUD \(3ADEV\) unreliable TFTP servers or client hardware. 4012f5fb7346SAlbert ARIBAUD \(3ADEV\) 4013a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 401411ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4015a3d991bdSwdenk VLAN tagged frames. 4016c609719bSwdenk 401750768f5bSAlexandre Messier bootpretryperiod - Period during which BOOTP/DHCP sends retries. 401850768f5bSAlexandre Messier Unsigned value, in milliseconds. If not set, the period will 401950768f5bSAlexandre Messier be either the default (28000), or a value based on 402050768f5bSAlexandre Messier CONFIG_NET_RETRY_COUNT, if defined. This value has 402150768f5bSAlexandre Messier precedence over the valu based on CONFIG_NET_RETRY_COUNT. 402250768f5bSAlexandre Messier 4023dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4024dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4025dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4026dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4027dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4028dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4029dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4030dc0b7b0eSJason Hobbs 4031dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4032aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some 4033dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4034dc0b7b0eSJason Hobbs 4035dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4036dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4037dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4038dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4039dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4040dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4041dc0b7b0eSJason Hobbs 4042c609719bSwdenkThe following environment variables may be used and automatically 4043c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4044c609719bSwdenkdepending the information provided by your boot server: 4045c609719bSwdenk 4046c609719bSwdenk bootfile - see above 4047c609719bSwdenk dnsip - IP address of your Domain Name Server 4048fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4049c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4050c609719bSwdenk hostname - Target hostname 4051c609719bSwdenk ipaddr - see above 4052c609719bSwdenk netmask - Subnet Mask 4053c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4054c609719bSwdenk serverip - see above 4055c609719bSwdenk 4056c609719bSwdenk 4057c609719bSwdenkThere are two special Environment Variables: 4058c609719bSwdenk 4059c609719bSwdenk serial# - contains hardware identification information such 4060c609719bSwdenk as type string and/or serial number 4061c609719bSwdenk ethaddr - Ethernet address 4062c609719bSwdenk 4063c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4064c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4065c609719bSwdenkonce they have been set once. 4066c609719bSwdenk 4067c609719bSwdenk 4068c1551ea8SstroeseFurther special Environment Variables: 4069c1551ea8Sstroese 4070c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4071c1551ea8Sstroese with the "version" command. This variable is 4072c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4073c1551ea8Sstroese 4074c1551ea8Sstroese 4075c609719bSwdenkPlease note that changes to some configuration parameters may take 4076c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4077c609719bSwdenk 4078c609719bSwdenk 4079170ab110SJoe HershbergerCallback functions for environment variables: 4080170ab110SJoe Hershberger--------------------------------------------- 4081170ab110SJoe Hershberger 4082170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 4083b445bbb4SJeremiah Mahlerwhen their values are changed. This functionality allows functions to 4084170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 4085170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 4086170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 4087170ab110SJoe Hershberger 4088170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 4089170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 4090170ab110SJoe Hershberger 4091170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 4092170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4093170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 4094170ab110SJoe Hershbergerassociations. The list must be in the following format: 4095170ab110SJoe Hershberger 4096170ab110SJoe Hershberger entry = variable_name[:callback_name] 4097170ab110SJoe Hershberger list = entry[,list] 4098170ab110SJoe Hershberger 4099170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 4100170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 4101170ab110SJoe Hershberger 4102170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 4103170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 4104170ab110SJoe Hershbergeroverride any association in the static list. You can define 4105170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 4106b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment. 4107170ab110SJoe Hershberger 4108bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a 4109bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to 4110bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out. 4111bdf1fe4eSJoe Hershberger 4112170ab110SJoe Hershberger 4113f07771ccSwdenkCommand Line Parsing: 4114f07771ccSwdenk===================== 4115f07771ccSwdenk 4116f07771ccSwdenkThere are two different command line parsers available with U-Boot: 41177152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 4118f07771ccSwdenk 4119f07771ccSwdenkOld, simple command line parser: 4120f07771ccSwdenk-------------------------------- 4121f07771ccSwdenk 4122f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 4123f07771ccSwdenk- several commands on one line, separated by ';' 4124fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 4125f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 4126f07771ccSwdenk for example: 4127fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 4128f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 4129f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4130f07771ccSwdenk 4131f07771ccSwdenkHush shell: 4132f07771ccSwdenk----------- 4133f07771ccSwdenk 4134f07771ccSwdenk- similar to Bourne shell, with control structures like 4135f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 4136f07771ccSwdenk until...do...done, ... 4137f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 4138f07771ccSwdenk commands) and local shell variables (through standard shell syntax 4139f07771ccSwdenk "name=value"); only environment variables can be used with "run" 4140f07771ccSwdenk command 4141f07771ccSwdenk 4142f07771ccSwdenkGeneral rules: 4143f07771ccSwdenk-------------- 4144f07771ccSwdenk 4145f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 4146f07771ccSwdenk command) contains several commands separated by semicolon, and 4147f07771ccSwdenk one of these commands fails, then the remaining commands will be 4148f07771ccSwdenk executed anyway. 4149f07771ccSwdenk 4150f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 415111ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4152f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4153f07771ccSwdenk variables are not executed. 4154f07771ccSwdenk 4155c609719bSwdenkNote for Redundant Ethernet Interfaces: 4156c609719bSwdenk======================================= 4157c609719bSwdenk 415811ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 4159c609719bSwdenksuch configurations and is capable of automatic selection of a 41607152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 4161c609719bSwdenk 4162c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 4163c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4164c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 4165c609719bSwdenk 4166c609719bSwdenkIf the network interface stores some valid MAC address (for instance 4167c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 4168c609719bSwdenkding setting in the environment; if the corresponding environment 4169c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 4170c609719bSwdenk 4171c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 4172c609719bSwdenk environment, the SROM's address is used. 4173c609719bSwdenk 4174c609719bSwdenko If there is no valid address in the SROM, and a definition in the 4175c609719bSwdenk environment exists, then the value from the environment variable is 4176c609719bSwdenk used. 4177c609719bSwdenk 4178c609719bSwdenko If both the SROM and the environment contain a MAC address, and 4179c609719bSwdenk both addresses are the same, this MAC address is used. 4180c609719bSwdenk 4181c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 4182c609719bSwdenk addresses differ, the value from the environment is used and a 4183c609719bSwdenk warning is printed. 4184c609719bSwdenk 4185c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 4186bef1014bSJoe Hershberger is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case 4187bef1014bSJoe Hershberger a random, locally-assigned MAC is used. 4188c609719bSwdenk 4189ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4190ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 4191ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 4192ecee9324SBen WarrenThe naming convention is as follows: 4193ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4194c609719bSwdenk 4195c609719bSwdenkImage Formats: 4196c609719bSwdenk============== 4197c609719bSwdenk 41983310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 41993310c549SMarian Balakowiczimages in two formats: 42003310c549SMarian Balakowicz 42013310c549SMarian BalakowiczNew uImage format (FIT) 42023310c549SMarian Balakowicz----------------------- 42033310c549SMarian Balakowicz 42043310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 42053310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 42063310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 42073310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 42083310c549SMarian Balakowicz 42093310c549SMarian Balakowicz 42103310c549SMarian BalakowiczOld uImage format 42113310c549SMarian Balakowicz----------------- 42123310c549SMarian Balakowicz 42133310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 42143310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 42153310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 4216c609719bSwdenk 4217c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 4218c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 4219f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 4220f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 4221f5ed9e39SPeter Tyser INTEGRITY). 4222daab59acSAndy Shevchenko* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86, 4223afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 4224daab59acSAndy Shevchenko Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC). 4225c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 4226c609719bSwdenk* Load Address 4227c609719bSwdenk* Entry Point 4228c609719bSwdenk* Image Name 4229c609719bSwdenk* Image Timestamp 4230c609719bSwdenk 4231c609719bSwdenkThe header is marked by a special Magic Number, and both the header 4232c609719bSwdenkand the data portions of the image are secured against corruption by 4233c609719bSwdenkCRC32 checksums. 4234c609719bSwdenk 4235c609719bSwdenk 4236c609719bSwdenkLinux Support: 4237c609719bSwdenk============== 4238c609719bSwdenk 4239c609719bSwdenkAlthough U-Boot should support any OS or standalone application 42407152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 4241c609719bSwdenkU-Boot. 4242c609719bSwdenk 4243c609719bSwdenkU-Boot includes many features that so far have been part of some 4244c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 4245c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 4246c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 42477152b1d0Swdenkserves several purposes: 4248c609719bSwdenk 4249c609719bSwdenk- the same features can be used for other OS or standalone 4250c609719bSwdenk applications (for instance: using compressed images to reduce the 4251c609719bSwdenk Flash memory footprint) 4252c609719bSwdenk 4253c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 42547152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 4255c609719bSwdenk 4256c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 4257c609719bSwdenk images; of course this also means that different kernel images can 4258c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 4259c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 4260c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 4261c609719bSwdenk software is easier now. 4262c609719bSwdenk 4263c609719bSwdenk 4264c609719bSwdenkLinux HOWTO: 4265c609719bSwdenk============ 4266c609719bSwdenk 4267c609719bSwdenkPorting Linux to U-Boot based systems: 4268c609719bSwdenk--------------------------------------- 4269c609719bSwdenk 4270c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 4271c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 4272c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 4273c609719bSwdenkLinux :-). 4274c609719bSwdenk 4275a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4276c609719bSwdenk 4277c609719bSwdenkJust make sure your machine specific header file (for instance 4278c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 42791dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 42801dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 42816d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 4282c609719bSwdenk 42832eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers. 42842eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there 42852eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See 42862eb31b13SSimon Glassdoc/driver-model. 42872eb31b13SSimon Glass 4288c609719bSwdenk 4289c609719bSwdenkConfiguring the Linux kernel: 4290c609719bSwdenk----------------------------- 4291c609719bSwdenk 4292c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 4293c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 4294c609719bSwdenk 4295c609719bSwdenk 4296c609719bSwdenkBuilding a Linux Image: 4297c609719bSwdenk----------------------- 4298c609719bSwdenk 429924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 430024ee89b9Swdenknot used. If you use recent kernel source, a new build target 430124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 430224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 430324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 430424ee89b9Swdenk100% compatible format. 4305c609719bSwdenk 4306c609719bSwdenkExample: 4307c609719bSwdenk 4308ab584d67SHolger Freyther make TQM850L_defconfig 4309c609719bSwdenk make oldconfig 4310c609719bSwdenk make dep 431124ee89b9Swdenk make uImage 4312c609719bSwdenk 431324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 431424ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 431524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 4316c609719bSwdenk 431724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 431824ee89b9Swdenk 431924ee89b9Swdenk* convert the kernel into a raw binary image: 432024ee89b9Swdenk 432124ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 432224ee89b9Swdenk -R .note -R .comment \ 432324ee89b9Swdenk -S vmlinux linux.bin 432424ee89b9Swdenk 432524ee89b9Swdenk* compress the binary image: 432624ee89b9Swdenk 432724ee89b9Swdenk gzip -9 linux.bin 432824ee89b9Swdenk 432924ee89b9Swdenk* package compressed binary image for U-Boot: 433024ee89b9Swdenk 433124ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 433224ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 433324ee89b9Swdenk -d linux.bin.gz uImage 433424ee89b9Swdenk 433524ee89b9Swdenk 433624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 433724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 433824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 433924ee89b9Swdenkbyte header containing information about target architecture, 434024ee89b9Swdenkoperating system, image type, compression method, entry points, time 434124ee89b9Swdenkstamp, CRC32 checksums, etc. 434224ee89b9Swdenk 434324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 434424ee89b9Swdenkprint the header information, or to build new images. 4345c609719bSwdenk 4346c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4347c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4348c609719bSwdenkchecksum verification: 4349c609719bSwdenk 4350c609719bSwdenk tools/mkimage -l image 4351c609719bSwdenk -l ==> list image header information 4352c609719bSwdenk 4353c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4354c609719bSwdenkfrom a "data file" which is used as image payload: 4355c609719bSwdenk 4356c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4357c609719bSwdenk -n name -d data_file image 4358c609719bSwdenk -A ==> set architecture to 'arch' 4359c609719bSwdenk -O ==> set operating system to 'os' 4360c609719bSwdenk -T ==> set image type to 'type' 4361c609719bSwdenk -C ==> set compression type 'comp' 4362c609719bSwdenk -a ==> set load address to 'addr' (hex) 4363c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4364c609719bSwdenk -n ==> set image name to 'name' 4365c609719bSwdenk -d ==> use image data from 'datafile' 4366c609719bSwdenk 436769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 436869459791Swdenkaddress (0x00000000), but the entry point address depends on the 436969459791Swdenkkernel version: 4370c609719bSwdenk 4371c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 437224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4373c609719bSwdenk 4374c609719bSwdenkSo a typical call to build a U-Boot image would read: 4375c609719bSwdenk 437624ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 437724ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4378a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 437924ee89b9Swdenk > examples/uImage.TQM850L 438024ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4381c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4382c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4383c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4384c609719bSwdenk Load Address: 0x00000000 438524ee89b9Swdenk Entry Point: 0x00000000 4386c609719bSwdenk 4387c609719bSwdenkTo verify the contents of the image (or check for corruption): 4388c609719bSwdenk 438924ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 439024ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4391c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4392c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4393c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4394c609719bSwdenk Load Address: 0x00000000 439524ee89b9Swdenk Entry Point: 0x00000000 4396c609719bSwdenk 4397c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 4398c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 4399c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 4400c609719bSwdenkneed to be uncompressed: 4401c609719bSwdenk 4402a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 440324ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 440424ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4405a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 440624ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 440724ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4408c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4409c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4410c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4411c609719bSwdenk Load Address: 0x00000000 441224ee89b9Swdenk Entry Point: 0x00000000 4413c609719bSwdenk 4414c609719bSwdenk 4415c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4416c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4417c609719bSwdenk 4418c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4419c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4420c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4421c609719bSwdenk Image Name: Simple Ramdisk Image 4422c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4423c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4424c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4425c609719bSwdenk Load Address: 0x00000000 4426c609719bSwdenk Entry Point: 0x00000000 4427c609719bSwdenk 4428a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 4429a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 4430a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 4431a804b5ceSGuilherme Maciel Ferreirafrom the image: 4432a804b5ceSGuilherme Maciel Ferreira 4433f41f5b7cSGuilherme Maciel Ferreira tools/dumpimage -i image -T type -p position data_file 4434f41f5b7cSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file' 4435f41f5b7cSGuilherme Maciel Ferreira -T ==> set image type to 'type' 4436f41f5b7cSGuilherme Maciel Ferreira -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' 4437a804b5ceSGuilherme Maciel Ferreira 4438c609719bSwdenk 4439c609719bSwdenkInstalling a Linux Image: 4440c609719bSwdenk------------------------- 4441c609719bSwdenk 4442c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4443c609719bSwdenkyou must convert the image to S-Record format: 4444c609719bSwdenk 4445c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4446c609719bSwdenk 4447c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4448c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4449c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4450c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4451c609719bSwdenkcommand. 4452c609719bSwdenk 4453c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4454c609719bSwdenkTQM8xxL is in the first Flash bank): 4455c609719bSwdenk 4456c609719bSwdenk => erase 40100000 401FFFFF 4457c609719bSwdenk 4458c609719bSwdenk .......... done 4459c609719bSwdenk Erased 8 sectors 4460c609719bSwdenk 4461c609719bSwdenk => loads 40100000 4462c609719bSwdenk ## Ready for S-Record download ... 4463c609719bSwdenk ~>examples/image.srec 4464c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4465c609719bSwdenk ... 4466c609719bSwdenk 15989 15990 15991 15992 4467c609719bSwdenk [file transfer complete] 4468c609719bSwdenk [connected] 4469c609719bSwdenk ## Start Addr = 0x00000000 4470c609719bSwdenk 4471c609719bSwdenk 4472c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4473c609719bSwdenkthis includes a checksum verification so you can be sure no data 4474c609719bSwdenkcorruption happened: 4475c609719bSwdenk 4476c609719bSwdenk => imi 40100000 4477c609719bSwdenk 4478c609719bSwdenk ## Checking Image at 40100000 ... 4479c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4480c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4481c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4482c609719bSwdenk Load Address: 00000000 4483c609719bSwdenk Entry Point: 0000000c 4484c609719bSwdenk Verifying Checksum ... OK 4485c609719bSwdenk 4486c609719bSwdenk 4487c609719bSwdenkBoot Linux: 4488c609719bSwdenk----------- 4489c609719bSwdenk 4490c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4491c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4492c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4493c609719bSwdenkparameters. You can check and modify this variable using the 4494c609719bSwdenk"printenv" and "setenv" commands: 4495c609719bSwdenk 4496c609719bSwdenk 4497c609719bSwdenk => printenv bootargs 4498c609719bSwdenk bootargs=root=/dev/ram 4499c609719bSwdenk 4500c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4501c609719bSwdenk 4502c609719bSwdenk => printenv bootargs 4503c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4504c609719bSwdenk 4505c609719bSwdenk => bootm 40020000 4506c609719bSwdenk ## Booting Linux kernel at 40020000 ... 4507c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 4508c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4509c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 4510c609719bSwdenk Load Address: 00000000 4511c609719bSwdenk Entry Point: 0000000c 4512c609719bSwdenk Verifying Checksum ... OK 4513c609719bSwdenk Uncompressing Kernel Image ... OK 4514c609719bSwdenk 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 4515c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4516c609719bSwdenk time_init: decrementer frequency = 187500000/60 4517c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4518c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4519c609719bSwdenk ... 4520c609719bSwdenk 452111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 45227152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 4523c609719bSwdenkformat!) to the "bootm" command: 4524c609719bSwdenk 4525c609719bSwdenk => imi 40100000 40200000 4526c609719bSwdenk 4527c609719bSwdenk ## Checking Image at 40100000 ... 4528c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4529c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4530c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4531c609719bSwdenk Load Address: 00000000 4532c609719bSwdenk Entry Point: 0000000c 4533c609719bSwdenk Verifying Checksum ... OK 4534c609719bSwdenk 4535c609719bSwdenk ## Checking Image at 40200000 ... 4536c609719bSwdenk Image Name: Simple Ramdisk Image 4537c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4538c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4539c609719bSwdenk Load Address: 00000000 4540c609719bSwdenk Entry Point: 00000000 4541c609719bSwdenk Verifying Checksum ... OK 4542c609719bSwdenk 4543c609719bSwdenk => bootm 40100000 40200000 4544c609719bSwdenk ## Booting Linux kernel at 40100000 ... 4545c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4546c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4547c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4548c609719bSwdenk Load Address: 00000000 4549c609719bSwdenk Entry Point: 0000000c 4550c609719bSwdenk Verifying Checksum ... OK 4551c609719bSwdenk Uncompressing Kernel Image ... OK 4552c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 4553c609719bSwdenk Image Name: Simple Ramdisk Image 4554c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4555c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4556c609719bSwdenk Load Address: 00000000 4557c609719bSwdenk Entry Point: 00000000 4558c609719bSwdenk Verifying Checksum ... OK 4559c609719bSwdenk Loading Ramdisk ... OK 4560c609719bSwdenk 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 4561c609719bSwdenk Boot arguments: root=/dev/ram 4562c609719bSwdenk time_init: decrementer frequency = 187500000/60 4563c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4564c609719bSwdenk ... 4565c609719bSwdenk RAMDISK: Compressed image found at block 0 4566c609719bSwdenk VFS: Mounted root (ext2 filesystem). 4567c609719bSwdenk 4568c609719bSwdenk bash# 4569c609719bSwdenk 45700267768eSMatthew McClintockBoot Linux and pass a flat device tree: 45710267768eSMatthew McClintock----------- 45720267768eSMatthew McClintock 45730267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 45740267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 45750267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 45760267768eSMatthew McClintockflat device tree: 45770267768eSMatthew McClintock 45780267768eSMatthew McClintock=> print oftaddr 45790267768eSMatthew McClintockoftaddr=0x300000 45800267768eSMatthew McClintock=> print oft 45810267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 45820267768eSMatthew McClintock=> tftp $oftaddr $oft 45830267768eSMatthew McClintockSpeed: 1000, full duplex 45840267768eSMatthew McClintockUsing TSEC0 device 45850267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 45860267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 45870267768eSMatthew McClintockLoad address: 0x300000 45880267768eSMatthew McClintockLoading: # 45890267768eSMatthew McClintockdone 45900267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 45910267768eSMatthew McClintock=> tftp $loadaddr $bootfile 45920267768eSMatthew McClintockSpeed: 1000, full duplex 45930267768eSMatthew McClintockUsing TSEC0 device 45940267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 45950267768eSMatthew McClintockFilename 'uImage'. 45960267768eSMatthew McClintockLoad address: 0x200000 45970267768eSMatthew McClintockLoading:############ 45980267768eSMatthew McClintockdone 45990267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 46000267768eSMatthew McClintock=> print loadaddr 46010267768eSMatthew McClintockloadaddr=200000 46020267768eSMatthew McClintock=> print oftaddr 46030267768eSMatthew McClintockoftaddr=0x300000 46040267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 46050267768eSMatthew McClintock## Booting image at 00200000 ... 46060267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 46070267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 46080267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 46090267768eSMatthew McClintock Load Address: 00000000 46100267768eSMatthew McClintock Entry Point: 00000000 46110267768eSMatthew McClintock Verifying Checksum ... OK 46120267768eSMatthew McClintock Uncompressing Kernel Image ... OK 46130267768eSMatthew McClintockBooting using flat device tree at 0x300000 46140267768eSMatthew McClintockUsing MPC85xx ADS machine description 46150267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 46160267768eSMatthew McClintock[snip] 46170267768eSMatthew McClintock 46180267768eSMatthew McClintock 46196069ff26SwdenkMore About U-Boot Image Types: 46206069ff26Swdenk------------------------------ 46216069ff26Swdenk 46226069ff26SwdenkU-Boot supports the following image types: 46236069ff26Swdenk 46246069ff26Swdenk "Standalone Programs" are directly runnable in the environment 46256069ff26Swdenk provided by U-Boot; it is expected that (if they behave 46266069ff26Swdenk well) you can continue to work in U-Boot after return from 46276069ff26Swdenk the Standalone Program. 46286069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 46296069ff26Swdenk will take over control completely. Usually these programs 46306069ff26Swdenk will install their own set of exception handlers, device 46316069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 46326069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 46336069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 46346069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 46356069ff26Swdenk being started. 46366069ff26Swdenk "Multi-File Images" contain several images, typically an OS 46376069ff26Swdenk (Linux) kernel image and one or more data images like 46386069ff26Swdenk RAMDisks. This construct is useful for instance when you want 46396069ff26Swdenk to boot over the network using BOOTP etc., where the boot 46406069ff26Swdenk server provides just a single image file, but you want to get 46416069ff26Swdenk for instance an OS kernel and a RAMDisk image. 46426069ff26Swdenk 46436069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 46446069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 46456069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 46466069ff26Swdenk Immediately after the terminating 0 follow the images, one by 46476069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 46486069ff26Swdenk a multiple of 4 bytes). 46496069ff26Swdenk 46506069ff26Swdenk "Firmware Images" are binary images containing firmware (like 46516069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 46526069ff26Swdenk flash memory. 46536069ff26Swdenk 46546069ff26Swdenk "Script files" are command sequences that will be executed by 46556069ff26Swdenk U-Boot's command interpreter; this feature is especially 46566069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 46576069ff26Swdenk as command interpreter. 46586069ff26Swdenk 465944f074c7SMarek VasutBooting the Linux zImage: 466044f074c7SMarek Vasut------------------------- 466144f074c7SMarek Vasut 466244f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 466344f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 466444f074c7SMarek Vasutas the syntax of "bootm" command. 466544f074c7SMarek Vasut 46668ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 4667017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 4668017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 4669017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 4670017e1f3fSMarek Vasut 4671c609719bSwdenk 4672c609719bSwdenkStandalone HOWTO: 4673c609719bSwdenk================= 4674c609719bSwdenk 4675c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 4676c609719bSwdenkrun "standalone" applications, which can use some resources of 4677c609719bSwdenkU-Boot like console I/O functions or interrupt services. 4678c609719bSwdenk 4679c609719bSwdenkTwo simple examples are included with the sources: 4680c609719bSwdenk 4681c609719bSwdenk"Hello World" Demo: 4682c609719bSwdenk------------------- 4683c609719bSwdenk 4684c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 4685c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 4686c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 4687c609719bSwdenklike that: 4688c609719bSwdenk 4689c609719bSwdenk => loads 4690c609719bSwdenk ## Ready for S-Record download ... 4691c609719bSwdenk ~>examples/hello_world.srec 4692c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4693c609719bSwdenk [file transfer complete] 4694c609719bSwdenk [connected] 4695c609719bSwdenk ## Start Addr = 0x00040004 4696c609719bSwdenk 4697c609719bSwdenk => go 40004 Hello World! This is a test. 4698c609719bSwdenk ## Starting application at 0x00040004 ... 4699c609719bSwdenk Hello World 4700c609719bSwdenk argc = 7 4701c609719bSwdenk argv[0] = "40004" 4702c609719bSwdenk argv[1] = "Hello" 4703c609719bSwdenk argv[2] = "World!" 4704c609719bSwdenk argv[3] = "This" 4705c609719bSwdenk argv[4] = "is" 4706c609719bSwdenk argv[5] = "a" 4707c609719bSwdenk argv[6] = "test." 4708c609719bSwdenk argv[7] = "<NULL>" 4709c609719bSwdenk Hit any key to exit ... 4710c609719bSwdenk 4711c609719bSwdenk ## Application terminated, rc = 0x0 4712c609719bSwdenk 4713c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 4714c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 4715c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 4716c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 4717c609719bSwdenkcharacter, but this is just a demo program. The application can be 4718c609719bSwdenkcontrolled by the following keys: 4719c609719bSwdenk 4720c609719bSwdenk ? - print current values og the CPM Timer registers 4721c609719bSwdenk b - enable interrupts and start timer 4722c609719bSwdenk e - stop timer and disable interrupts 4723c609719bSwdenk q - quit application 4724c609719bSwdenk 4725c609719bSwdenk => loads 4726c609719bSwdenk ## Ready for S-Record download ... 4727c609719bSwdenk ~>examples/timer.srec 4728c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4729c609719bSwdenk [file transfer complete] 4730c609719bSwdenk [connected] 4731c609719bSwdenk ## Start Addr = 0x00040004 4732c609719bSwdenk 4733c609719bSwdenk => go 40004 4734c609719bSwdenk ## Starting application at 0x00040004 ... 4735c609719bSwdenk TIMERS=0xfff00980 4736c609719bSwdenk Using timer 1 4737c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4738c609719bSwdenk 4739c609719bSwdenkHit 'b': 4740c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 4741c609719bSwdenk Enabling timer 4742c609719bSwdenkHit '?': 4743c609719bSwdenk [q, b, e, ?] ........ 4744c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4745c609719bSwdenkHit '?': 4746c609719bSwdenk [q, b, e, ?] . 4747c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4748c609719bSwdenkHit '?': 4749c609719bSwdenk [q, b, e, ?] . 4750c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4751c609719bSwdenkHit '?': 4752c609719bSwdenk [q, b, e, ?] . 4753c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4754c609719bSwdenkHit 'e': 4755c609719bSwdenk [q, b, e, ?] ...Stopping timer 4756c609719bSwdenkHit 'q': 4757c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4758c609719bSwdenk 4759c609719bSwdenk 476085ec0bccSwdenkMinicom warning: 476185ec0bccSwdenk================ 476285ec0bccSwdenk 47637152b1d0SwdenkOver time, many people have reported problems when trying to use the 476485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 476585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4766f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 476785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 4768e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 4769e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 4770e53515a2SKarl O. Pincfor help with kermit. 4771e53515a2SKarl O. Pinc 477285ec0bccSwdenk 477352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 477452f52c14Swdenkconfiguration to your "File transfer protocols" section: 477552f52c14Swdenk 477652f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 477752f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 477852f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 477952f52c14Swdenk 478052f52c14Swdenk 4781c609719bSwdenkNetBSD Notes: 4782c609719bSwdenk============= 4783c609719bSwdenk 4784c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4785c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4786c609719bSwdenk 4787c609719bSwdenkBuilding requires a cross environment; it is known to work on 4788c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4789c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4790c609719bSwdenkNote that the cross-powerpc package does not install include files; 4791c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4792c609719bSwdenkmissing. This file has to be installed and patched manually: 4793c609719bSwdenk 4794c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4795c609719bSwdenk # mkdir powerpc 4796c609719bSwdenk # ln -s powerpc machine 4797c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4798c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4799c609719bSwdenk 4800c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4801c609719bSwdenkand U-Boot include files. 4802c609719bSwdenk 4803c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4804c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4805c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4806c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 48072a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4808c609719bSwdenk 4809c609719bSwdenk 4810c609719bSwdenkImplementation Internals: 4811c609719bSwdenk========================= 4812c609719bSwdenk 4813c609719bSwdenkThe following is not intended to be a complete description of every 4814c609719bSwdenkimplementation detail. However, it should help to understand the 4815c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4816c609719bSwdenkhardware. 4817c609719bSwdenk 4818c609719bSwdenk 4819c609719bSwdenkInitial Stack, Global Data: 4820c609719bSwdenk--------------------------- 4821c609719bSwdenk 4822c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4823c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4824c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4825c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4826c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4827c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4828c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4829c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4830c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4831c609719bSwdenklocked as (mis-) used as memory, etc. 4832c609719bSwdenk 48337152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 48340668236bSWolfgang Denk U-Boot mailing list: 483543d9616cSwdenk 483643d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 483743d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 483843d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 483943d9616cSwdenk ... 484043d9616cSwdenk 484143d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 484243d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 484343d9616cSwdenk require any physical RAM backing up the cache. The cleverness 484443d9616cSwdenk is that the cache is being used as a temporary supply of 484543d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 484611ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 484743d9616cSwdenk can see how this works by studying the cache architecture and 484843d9616cSwdenk operation in the architecture and processor-specific manuals. 484943d9616cSwdenk 485043d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 485143d9616cSwdenk is another option for the system designer to use as an 485211ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 485343d9616cSwdenk option should work for you. Using CS 4 should be fine if your 485443d9616cSwdenk board designers haven't used it for something that would 485543d9616cSwdenk cause you grief during the initial boot! It is frequently not 485643d9616cSwdenk used. 485743d9616cSwdenk 48586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 485943d9616cSwdenk with your processor/board/system design. The default value 486043d9616cSwdenk you will find in any recent u-boot distribution in 48618a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 486243d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 486343d9616cSwdenk it above 400_0000. Just make sure your board has no resources 486443d9616cSwdenk that are supposed to respond to that address! That code in 486543d9616cSwdenk start.S has been around a while and should work as is when 486643d9616cSwdenk you get the config right. 486743d9616cSwdenk 486843d9616cSwdenk -Chris Hallinan 486943d9616cSwdenk DS4.COM, Inc. 487043d9616cSwdenk 4871c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4872c609719bSwdenkcode for the initialization procedures: 4873c609719bSwdenk 4874c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4875c609719bSwdenk to write it. 4876c609719bSwdenk 4877b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized 4878c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 48797152b1d0Swdenk zation is performed later (when relocating to RAM). 4880c609719bSwdenk 4881c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4882c609719bSwdenk that. 4883c609719bSwdenk 4884c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4885b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it 4886c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4887c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4888c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4889c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4890c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4891c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4892c609719bSwdenkreserve for this purpose. 4893c609719bSwdenk 48947152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4895c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4896c609719bSwdenkGCC's implementation. 4897c609719bSwdenk 4898c609719bSwdenkFor PowerPC, the following registers have specific use: 4899c609719bSwdenk R1: stack pointer 4900e7670f6cSWolfgang Denk R2: reserved for system use 4901c609719bSwdenk R3-R4: parameter passing and return values 4902c609719bSwdenk R5-R10: parameter passing 4903c609719bSwdenk R13: small data area pointer 4904c609719bSwdenk R30: GOT pointer 4905c609719bSwdenk R31: frame pointer 4906c609719bSwdenk 4907e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4908e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4909e6bee808SJoakim Tjernlund going back and forth between asm and C) 4910c609719bSwdenk 4911e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4912c609719bSwdenk 4913c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4914c609719bSwdenk address of the global data structure is known at compile time), 4915c609719bSwdenk but it turned out that reserving a register results in somewhat 4916c609719bSwdenk smaller code - although the code savings are not that big (on 4917c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4918c609719bSwdenk 624 text + 127 data). 4919c609719bSwdenk 4920c609719bSwdenkOn ARM, the following registers are used: 4921c609719bSwdenk 4922c609719bSwdenk R0: function argument word/integer result 4923c609719bSwdenk R1-R3: function argument word 492412eba1b4SJeroen Hofstee R9: platform specific 492512eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 4926c609719bSwdenk R11: argument (frame) pointer 4927c609719bSwdenk R12: temporary workspace 4928c609719bSwdenk R13: stack pointer 4929c609719bSwdenk R14: link register 4930c609719bSwdenk R15: program counter 4931c609719bSwdenk 493212eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 493312eba1b4SJeroen Hofstee 493412eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 4935c609719bSwdenk 49360df01fd3SThomas ChouOn Nios II, the ABI is documented here: 49370df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 49380df01fd3SThomas Chou 49390df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 49400df01fd3SThomas Chou 49410df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 49420df01fd3SThomas Chou to access small data sections, so gp is free. 49430df01fd3SThomas Chou 4944afc1ce82SMacpaul LinOn NDS32, the following registers are used: 4945afc1ce82SMacpaul Lin 4946afc1ce82SMacpaul Lin R0-R1: argument/return 4947afc1ce82SMacpaul Lin R2-R5: argument 4948afc1ce82SMacpaul Lin R15: temporary register for assembler 4949afc1ce82SMacpaul Lin R16: trampoline register 4950afc1ce82SMacpaul Lin R28: frame pointer (FP) 4951afc1ce82SMacpaul Lin R29: global pointer (GP) 4952afc1ce82SMacpaul Lin R30: link register (LP) 4953afc1ce82SMacpaul Lin R31: stack pointer (SP) 4954afc1ce82SMacpaul Lin PC: program counter (PC) 4955afc1ce82SMacpaul Lin 4956afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 4957afc1ce82SMacpaul Lin 4958d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4959d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 4960c609719bSwdenk 4961c609719bSwdenkMemory Management: 4962c609719bSwdenk------------------ 4963c609719bSwdenk 4964c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 4965c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 4966c609719bSwdenk 4967c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 4968c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 4969c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 4970c609719bSwdenkphysical memory banks. 4971c609719bSwdenk 4972c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 4973c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4974c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 4975c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 49766d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4977c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 4978c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 4979c609719bSwdenk 4980c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 4981c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 4982c609719bSwdenk 4983c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 4984c609719bSwdenkthis: 4985c609719bSwdenk 4986c609719bSwdenk 0x0000 0000 Exception Vector code 4987c609719bSwdenk : 4988c609719bSwdenk 0x0000 1FFF 4989c609719bSwdenk 0x0000 2000 Free for Application Use 4990c609719bSwdenk : 4991c609719bSwdenk : 4992c609719bSwdenk 4993c609719bSwdenk : 4994c609719bSwdenk : 4995c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 4996c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 4997c609719bSwdenk 0x00FC 0000 Malloc Arena 4998c609719bSwdenk : 4999c609719bSwdenk 0x00FD FFFF 5000c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5001c609719bSwdenk ... eventually: LCD or video framebuffer 5002c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5003c609719bSwdenk 0x00FF FFFF [End of RAM] 5004c609719bSwdenk 5005c609719bSwdenk 5006c609719bSwdenkSystem Initialization: 5007c609719bSwdenk---------------------- 5008c609719bSwdenk 5009c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 501011ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5011c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory. 50127152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5013c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5014c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 50152eb48ff7SHeiko Schocherwhich provide such a feature like), or in a locked part of the data 50162eb48ff7SHeiko Schochercache. After that, U-Boot initializes the CPU core, the caches and 50172eb48ff7SHeiko Schocherthe SIU. 5018c609719bSwdenk 5019c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5020c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5021c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5022c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5023c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5024c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5025c609719bSwdenkbanks. 5026c609719bSwdenk 5027c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 50287152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5029c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5030c609719bSwdenk0x00000000, with any additional banks following immediately to create 5031c609719bSwdenkcontiguous memory starting from 0. 5032c609719bSwdenk 5033c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5034c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5035c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5036c609719bSwdenkpages, and the final stack is set up. 5037c609719bSwdenk 5038c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5039c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5040c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5041c609719bSwdenknew address in RAM. 5042c609719bSwdenk 5043c609719bSwdenk 5044c609719bSwdenkU-Boot Porting Guide: 5045c609719bSwdenk---------------------- 5046c609719bSwdenk 5047c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 50486aff3115Swdenklist, October 2002] 5049c609719bSwdenk 5050c609719bSwdenk 5051c609719bSwdenkint main(int argc, char *argv[]) 5052c609719bSwdenk{ 5053c609719bSwdenk sighandler_t no_more_time; 5054c609719bSwdenk 5055c609719bSwdenk signal(SIGALRM, no_more_time); 5056c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5057c609719bSwdenk 5058c609719bSwdenk if (available_money > available_manpower) { 50596c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5060c609719bSwdenk return 0; 5061c609719bSwdenk } 5062c609719bSwdenk 5063c609719bSwdenk Download latest U-Boot source; 5064c609719bSwdenk 50650668236bSWolfgang Denk Subscribe to u-boot mailing list; 50666aff3115Swdenk 50676c3fef28SJerry Van Baren if (clueless) 5068c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5069c609719bSwdenk 5070c609719bSwdenk while (learning) { 5071c609719bSwdenk Read the README file in the top level directory; 50727cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 50736c3fef28SJerry Van Baren Read applicable doc/*.README; 5074c609719bSwdenk Read the source, Luke; 50756c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5076c609719bSwdenk } 5077c609719bSwdenk 50786c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 50796c3fef28SJerry Van Baren Buy a BDI3000; 50806c3fef28SJerry Van Baren else 5081c609719bSwdenk Add a lot of aggravation and time; 5082c609719bSwdenk 50836c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 50846c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 50856c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 50866c3fef28SJerry Van Baren } else { 5087c609719bSwdenk Create your own board support subdirectory; 50886c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 50896c3fef28SJerry Van Baren } 50906c3fef28SJerry Van Baren Edit new board/<myboard> files 50916c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5092c609719bSwdenk 50936c3fef28SJerry Van Baren while (!accepted) { 5094c609719bSwdenk while (!running) { 5095c609719bSwdenk do { 5096c609719bSwdenk Add / modify source code; 5097c609719bSwdenk } until (compiles); 5098c609719bSwdenk Debug; 5099c609719bSwdenk if (clueless) 5100c609719bSwdenk email("Hi, I am having problems..."); 5101c609719bSwdenk } 51026c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 51036c3fef28SJerry Van Baren if (reasonable critiques) 51046c3fef28SJerry Van Baren Incorporate improvements from email list code review; 51056c3fef28SJerry Van Baren else 51066c3fef28SJerry Van Baren Defend code as written; 51076c3fef28SJerry Van Baren } 5108c609719bSwdenk 5109c609719bSwdenk return 0; 5110c609719bSwdenk} 5111c609719bSwdenk 5112c609719bSwdenkvoid no_more_time (int sig) 5113c609719bSwdenk{ 5114c609719bSwdenk hire_a_guru(); 5115c609719bSwdenk} 5116c609719bSwdenk 5117c609719bSwdenk 5118c609719bSwdenkCoding Standards: 5119c609719bSwdenk----------------- 5120c609719bSwdenk 5121c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 51222c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 51237ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 5124c609719bSwdenk 51252c051651SDetlev ZundelSource files originating from a different project (for example the 51262c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 5127b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those 51282c051651SDetlev Zundelsources. 51292c051651SDetlev Zundel 51302c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 51312c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 51322c051651SDetlev Zundelin your code. 5133c609719bSwdenk 5134c178d3daSwdenkPlease also stick to the following formatting rules: 5135180d3f74Swdenk- remove any trailing white space 51367ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5137180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 51387ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5139180d3f74Swdenk- do not add trailing empty lines to source files 5140180d3f74Swdenk 5141c609719bSwdenkSubmissions which do not conform to the standards may be returned 5142c609719bSwdenkwith a request to reformat the changes. 5143c609719bSwdenk 5144c609719bSwdenk 5145c609719bSwdenkSubmitting Patches: 5146c609719bSwdenk------------------- 5147c609719bSwdenk 5148c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5149c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5150c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5151c609719bSwdenk 51520d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5153218ca724SWolfgang Denk 51540668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 5155*1dade18eSS. Lockwood-Childssee https://lists.denx.de/listinfo/u-boot 51560668236bSWolfgang Denk 5157c609719bSwdenkWhen you send a patch, please include the following information with 5158c609719bSwdenkit: 5159c609719bSwdenk 5160c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 5161c609719bSwdenk this bug. Please try to include a way of demonstrating that the 5162c609719bSwdenk patch actually fixes something. 5163c609719bSwdenk 5164c609719bSwdenk* For new features: a description of the feature and your 5165c609719bSwdenk implementation. 5166c609719bSwdenk 5167c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 5168c609719bSwdenk 51697207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your 51707207b366SRobert P. J. Day information and associated file and directory references. 5171c609719bSwdenk 517227af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 517327af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 5174c609719bSwdenk 5175c609719bSwdenk* If your patch adds new configuration options, don't forget to 5176c609719bSwdenk document these in the README file. 5177c609719bSwdenk 5178218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 5179218ca724SWolfgang Denk recommended) you can easily generate the patch using the 51807ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 5181218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 5182218ca724SWolfgang Denk with some other mail clients. 5183c609719bSwdenk 5184218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 5185218ca724SWolfgang Denk diff does not support these options, then get the latest version of 5186218ca724SWolfgang Denk GNU diff. 51876dff5529Swdenk 5188218ca724SWolfgang Denk The current directory when running this command shall be the parent 5189218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 5190218ca724SWolfgang Denk your patch includes sufficient directory information for the 5191218ca724SWolfgang Denk affected files). 5192218ca724SWolfgang Denk 5193218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 5194218ca724SWolfgang Denk and compressed attachments must not be used. 5195c609719bSwdenk 519652f52c14Swdenk* If one logical set of modifications affects or creates several 519752f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 519852f52c14Swdenk 519952f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 520052f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 520152f52c14Swdenk 520252f52c14Swdenk 5203c609719bSwdenkNotes: 5204c609719bSwdenk 52056de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched 5206c609719bSwdenk source tree and make sure that no errors or warnings are reported 5207c609719bSwdenk for any of the boards. 5208c609719bSwdenk 5209c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 5210c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 5211c609719bSwdenk returned with a request to re-formatting / split it. 5212c609719bSwdenk 5213c609719bSwdenk* If you modify existing code, make sure that your new code does not 5214c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 5215c609719bSwdenk When adding new features, these should compile conditionally only 5216c609719bSwdenk (using #ifdef), and the resulting code with the new feature 5217c609719bSwdenk disabled must not need more memory than the old code without your 5218c609719bSwdenk modification. 521990dc6704Swdenk 52200668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 52210668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 52220668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 52230668236bSWolfgang Denk bigger than the size limit should be avoided. 5224