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 /avr32 Files generic to AVR32 architecture 1408d321b81SPeter Tyser /m68k Files generic to m68k architecture 1418d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1428d321b81SPeter Tyser /mips Files generic to MIPS architecture 143afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 1448d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 14533c7731bSRobert P. J. Day /openrisc Files generic to OpenRISC architecture 146a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1477207b366SRobert P. J. Day /sandbox Files generic to HW-independent "sandbox" 1488d321b81SPeter Tyser /sh Files generic to SH architecture 14933c7731bSRobert P. J. Day /x86 Files generic to x86 architecture 1508d321b81SPeter Tyser/api Machine/arch independent API for external apps 1518d321b81SPeter Tyser/board Board dependent files 152740f7e5cSXu Ziyuan/cmd U-Boot commands functions 1538d321b81SPeter Tyser/common Misc architecture independent functions 1547207b366SRobert P. J. Day/configs Board default configuration files 1558d321b81SPeter Tyser/disk Code for disk drive partition handling 1568d321b81SPeter Tyser/doc Documentation (don't expect too much) 1578d321b81SPeter Tyser/drivers Commonly used device drivers 15833c7731bSRobert P. J. Day/dts Contains Makefile for building internal U-Boot fdt. 1598d321b81SPeter Tyser/examples Example code for standalone applications, etc. 1608d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 1618d321b81SPeter Tyser/include Header Files 1627207b366SRobert P. J. Day/lib Library routines generic to all architectures 1637207b366SRobert P. J. Day/Licenses Various license files 1648d321b81SPeter Tyser/net Networking code 1658d321b81SPeter Tyser/post Power On Self Test 1667207b366SRobert P. J. Day/scripts Various build scripts and Makefiles 1677207b366SRobert P. J. Day/test Various unit test files 1688d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 169c609719bSwdenk 170c609719bSwdenkSoftware Configuration: 171c609719bSwdenk======================= 172c609719bSwdenk 173c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 174c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 175c609719bSwdenk 176c609719bSwdenkThere are two classes of configuration variables: 177c609719bSwdenk 178c609719bSwdenk* Configuration _OPTIONS_: 179c609719bSwdenk These are selectable by the user and have names beginning with 180c609719bSwdenk "CONFIG_". 181c609719bSwdenk 182c609719bSwdenk* Configuration _SETTINGS_: 183c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 184c609719bSwdenk you don't know what you're doing; they have names beginning with 1856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 186c609719bSwdenk 1877207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating 1887207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently, 1897207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel, 1907207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your 1917207b366SRobert P. J. Daybuild. 192c609719bSwdenk 193c609719bSwdenk 194c609719bSwdenkSelection of Processor Architecture and Board Type: 195c609719bSwdenk--------------------------------------------------- 196c609719bSwdenk 197c609719bSwdenkFor all supported boards there are ready-to-use default 198ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig". 199c609719bSwdenk 200c609719bSwdenkExample: For a TQM823L module type: 201c609719bSwdenk 202c609719bSwdenk cd u-boot 203ab584d67SHolger Freyther make TQM823L_defconfig 204c609719bSwdenk 2057207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board 2067207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file 2077207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards. 208c609719bSwdenk 20975b3c3aaSSimon GlassSandbox Environment: 21075b3c3aaSSimon Glass-------------------- 21175b3c3aaSSimon Glass 21275b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox' 21375b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture- 21475b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to 21575b3c3aaSSimon Glassrun some of U-Boot's tests. 21675b3c3aaSSimon Glass 2176b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details. 21875b3c3aaSSimon Glass 21975b3c3aaSSimon Glass 220db910353SSimon GlassBoard Initialisation Flow: 221db910353SSimon Glass-------------------------- 222db910353SSimon Glass 223db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both 2247207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules). 225db910353SSimon Glass 2267207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in 2277207b366SRobert P. J. Daymore detail later in this file. 2287207b366SRobert P. J. Day 2297207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names 2307207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures 2317207b366SRobert P. J. Daymay not conform to this. At least most ARM boards which use 2327207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this. 2337207b366SRobert P. J. Day 2347207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly 2357207b366SRobert P. J. DayCPU-specific) start.S file, such as: 2367207b366SRobert P. J. Day 2377207b366SRobert P. J. Day - arch/arm/cpu/armv7/start.S 2387207b366SRobert P. J. Day - arch/powerpc/cpu/mpc83xx/start.S 2397207b366SRobert P. J. Day - arch/mips/cpu/start.S 2407207b366SRobert P. J. Day 2417207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and 2427207b366SRobert P. J. Daylimitations of each of these functions are described below. 243db910353SSimon Glass 244db910353SSimon Glasslowlevel_init(): 245db910353SSimon Glass - purpose: essential init to permit execution to reach board_init_f() 246db910353SSimon Glass - no global_data or BSS 247db910353SSimon Glass - there is no stack (ARMv7 may have one but it will soon be removed) 248db910353SSimon Glass - must not set up SDRAM or use console 249db910353SSimon Glass - must only do the bare minimum to allow execution to continue to 250db910353SSimon Glass board_init_f() 251db910353SSimon Glass - this is almost never needed 252db910353SSimon Glass - return normally from this function 253db910353SSimon Glass 254db910353SSimon Glassboard_init_f(): 255db910353SSimon Glass - purpose: set up the machine ready for running board_init_r(): 256db910353SSimon Glass i.e. SDRAM and serial UART 257db910353SSimon Glass - global_data is available 258db910353SSimon Glass - stack is in SRAM 259db910353SSimon Glass - BSS is not available, so you cannot use global/static variables, 260db910353SSimon Glass only stack variables and global_data 261db910353SSimon Glass 262db910353SSimon Glass Non-SPL-specific notes: 263db910353SSimon Glass - dram_init() is called to set up DRAM. If already done in SPL this 264db910353SSimon Glass can do nothing 265db910353SSimon Glass 266db910353SSimon Glass SPL-specific notes: 267db910353SSimon Glass - you can override the entire board_init_f() function with your own 268db910353SSimon Glass version as needed. 269db910353SSimon Glass - preloader_console_init() can be called here in extremis 270db910353SSimon Glass - should set up SDRAM, and anything needed to make the UART work 271db910353SSimon Glass - these is no need to clear BSS, it will be done by crt0.S 272db910353SSimon Glass - must return normally from this function (don't call board_init_r() 273db910353SSimon Glass directly) 274db910353SSimon Glass 275db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at 276db910353SSimon Glassthis point the stack and global_data are relocated to below 277db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of 278db910353SSimon Glassmemory. 279db910353SSimon Glass 280db910353SSimon Glassboard_init_r(): 281db910353SSimon Glass - purpose: main execution, common code 282db910353SSimon Glass - global_data is available 283db910353SSimon Glass - SDRAM is available 284db910353SSimon Glass - BSS is available, all static/global variables can be used 285db910353SSimon Glass - execution eventually continues to main_loop() 286db910353SSimon Glass 287db910353SSimon Glass Non-SPL-specific notes: 288db910353SSimon Glass - U-Boot is relocated to the top of memory and is now running from 289db910353SSimon Glass there. 290db910353SSimon Glass 291db910353SSimon Glass SPL-specific notes: 292db910353SSimon Glass - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and 293db910353SSimon Glass CONFIG_SPL_STACK_R_ADDR points into SDRAM 294db910353SSimon Glass - preloader_console_init() can be called here - typically this is 295*0680f1b1SLey Foon Tan done by selecting CONFIG_SPL_BOARD_INIT and then supplying a 296db910353SSimon Glass spl_board_init() function containing this call 297db910353SSimon Glass - loads U-Boot or (in falcon mode) Linux 298db910353SSimon Glass 299db910353SSimon Glass 300db910353SSimon Glass 301c609719bSwdenkConfiguration Options: 302c609719bSwdenk---------------------- 303c609719bSwdenk 304c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 305c609719bSwdenksuch information is kept in a configuration file 306c609719bSwdenk"include/configs/<board_name>.h". 307c609719bSwdenk 308c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 309c609719bSwdenk"include/configs/TQM823L.h". 310c609719bSwdenk 311c609719bSwdenk 3127f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 3137f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 3147f6c2cbcSwdenkbuild a config tool - later. 3157f6c2cbcSwdenk 3167f6c2cbcSwdenk 317c609719bSwdenkThe following options need to be configured: 318c609719bSwdenk 3192628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 320c609719bSwdenk 3212628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 3226ccec449SWolfgang Denk 3236ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 32409ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 325c609719bSwdenk 326cf946c6dSLei Wen- Marvell Family Member 327cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 328cf946c6dSLei Wen multiple fs option at one time 329cf946c6dSLei Wen for marvell soc family 330cf946c6dSLei Wen 33111ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 33266ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 33366ca92a5Swdenk get_gclk_freq() cannot work 3345da627a4Swdenk e.g. if there is no 32KHz 3355da627a4Swdenk reference PIT/RTC clock 33666ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 33766ca92a5Swdenk or XTAL/EXTAL) 338c609719bSwdenk 33966ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 34266ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 34375d1ea7fSwdenk See doc/README.MPC866 34475d1ea7fSwdenk 3456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 34675d1ea7fSwdenk 34775d1ea7fSwdenk Define this to measure the actual CPU clock instead 34875d1ea7fSwdenk of relying on the correctness of the configured 34975d1ea7fSwdenk values. Mostly useful for board bringup to make sure 35075d1ea7fSwdenk the PLL is locked at the intended frequency. Note 35175d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 35375d1ea7fSwdenk 354506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 355506f3918SHeiko Schocher 356506f3918SHeiko Schocher Define this option if you want to enable the 357506f3918SHeiko Schocher ICache only when Code runs from RAM. 358506f3918SHeiko Schocher 35966412c63SKumar Gala- 85xx CPU Options: 360ffd06e02SYork Sun CONFIG_SYS_PPC64 361ffd06e02SYork Sun 362ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 363ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 364ffd06e02SYork Sun compliance, among other possible reasons. 365ffd06e02SYork Sun 36666412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 36766412c63SKumar Gala 36866412c63SKumar Gala Defines the core time base clock divider ratio compared to the 36966412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 37066412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 37166412c63SKumar Gala 3728f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3738f29084aSKumar Gala 3748f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3758f29084aSKumar Gala tree nodes for the given platform. 3768f29084aSKumar Gala 37733eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 37833eee330SScott Wood 37933eee330SScott Wood Enables a workaround for erratum A004510. If set, 38033eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 38133eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 38233eee330SScott Wood 38333eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 38433eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 38533eee330SScott Wood 38633eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 38733eee330SScott Wood for which the A004510 workaround should be applied. 38833eee330SScott Wood 38933eee330SScott Wood The rest of SVR is either not relevant to the decision 39033eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 39133eee330SScott Wood p2041) or is implied by the build target, which controls 39233eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 39333eee330SScott Wood 39433eee330SScott Wood See Freescale App Note 4493 for more information about 39533eee330SScott Wood this erratum. 39633eee330SScott Wood 39774fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 39874fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 399b445bbb4SJeremiah Mahler required during NOR boot. 40074fa22edSPrabhakar Kushwaha 4019f074e67SPrabhakar Kushwaha CONFIG_A008044_WORKAROUND 4029f074e67SPrabhakar Kushwaha Enables a workaround for T1040/T1042 erratum A008044. It is only 403b445bbb4SJeremiah Mahler required during NAND boot and valid for Rev 1.0 SoC revision 4049f074e67SPrabhakar Kushwaha 40533eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 40633eee330SScott Wood 40733eee330SScott Wood This is the value to write into CCSR offset 0x18600 40833eee330SScott Wood according to the A004510 workaround. 40933eee330SScott Wood 41064501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 41164501c66SPriyanka Jain This value denotes start offset of DDR memory which is 41264501c66SPriyanka Jain connected exclusively to the DSP cores. 41364501c66SPriyanka Jain 414765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 415765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 416765b0bdbSPriyanka Jain which is directly connected to the DSP core. 417765b0bdbSPriyanka Jain 41864501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 41964501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 42064501c66SPriyanka Jain connected to the DSP core. 42164501c66SPriyanka Jain 422765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 423765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 424765b0bdbSPriyanka Jain 425b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 426b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 427b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 428b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 429b135991aSPriyanka Jain 430fb4a2409SAneesh Bansal CONFIG_SYS_CPC_REINIT_F 431fb4a2409SAneesh Bansal This CONFIG is defined when the CPC is configured as SRAM at the 432a187559eSBin Meng time of U-Boot entry and is required to be re-initialized. 433fb4a2409SAneesh Bansal 434aade2004STang Yuantian CONFIG_DEEP_SLEEP 435b445bbb4SJeremiah Mahler Indicates this SoC supports deep sleep feature. If deep sleep is 436aade2004STang Yuantian supported, core will start to execute uboot when wakes up. 437aade2004STang Yuantian 4386cb461b4SDaniel Schwierzeck- Generic CPU options: 4392a1680e3SYork Sun CONFIG_SYS_GENERIC_GLOBAL_DATA 4402a1680e3SYork Sun Defines global data is initialized in generic board board_init_f(). 4412a1680e3SYork Sun If this macro is defined, global data is created and cleared in 4422a1680e3SYork Sun generic board board_init_f(). Without this macro, architecture/board 4432a1680e3SYork Sun should initialize global data before calling board_init_f(). 4442a1680e3SYork Sun 4456cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4466cb461b4SDaniel Schwierzeck 4476cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4486cb461b4SDaniel Schwierzeck values is arch specific. 4496cb461b4SDaniel Schwierzeck 4505614e71bSYork Sun CONFIG_SYS_FSL_DDR 4515614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4525614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4535614e71bSYork Sun SoCs. 4545614e71bSYork Sun 4555614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4565614e71bSYork Sun Freescale DDR memory-mapped register base. 4575614e71bSYork Sun 4585614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4595614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4605614e71bSYork Sun deskew training are not available. 4615614e71bSYork Sun 4625614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4635614e71bSYork Sun Freescale DDR1 controller. 4645614e71bSYork Sun 4655614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4665614e71bSYork Sun Freescale DDR2 controller. 4675614e71bSYork Sun 4685614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 4695614e71bSYork Sun Freescale DDR3 controller. 4705614e71bSYork Sun 47134e026f9SYork Sun CONFIG_SYS_FSL_DDRC_GEN4 47234e026f9SYork Sun Freescale DDR4 controller. 47334e026f9SYork Sun 4749ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 4759ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 4769ac4ffbdSYork Sun 4775614e71bSYork Sun CONFIG_SYS_FSL_DDR1 4785614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 4795614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 4805614e71bSYork Sun implemetation. 4815614e71bSYork Sun 4825614e71bSYork Sun CONFIG_SYS_FSL_DDR2 48362a3b7ddSRobert P. J. Day Board config to use DDR2. It can be enabled for SoCs with 4845614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 4855614e71bSYork Sun implementation. 4865614e71bSYork Sun 4875614e71bSYork Sun CONFIG_SYS_FSL_DDR3 4885614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 48934e026f9SYork Sun Freescale DDR3 or DDR3L controllers. 49034e026f9SYork Sun 49134e026f9SYork Sun CONFIG_SYS_FSL_DDR3L 49234e026f9SYork Sun Board config to use DDR3L. It can be enabled for SoCs with 49334e026f9SYork Sun DDR3L controllers. 49434e026f9SYork Sun 49534e026f9SYork Sun CONFIG_SYS_FSL_DDR4 49634e026f9SYork Sun Board config to use DDR4. It can be enabled for SoCs with 49734e026f9SYork Sun DDR4 controllers. 4985614e71bSYork Sun 4991b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_BE 5001b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Big Endian 5011b4175d6SPrabhakar Kushwaha 5021b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_LE 5031b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Little Endian 5041b4175d6SPrabhakar Kushwaha 5051c40707eSPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_CLK_DIV 5061c40707eSPrabhakar Kushwaha Defines divider of platform clock(clock input to IFC controller). 5071c40707eSPrabhakar Kushwaha 508add63f94SPrabhakar Kushwaha CONFIG_SYS_FSL_LBC_CLK_DIV 509add63f94SPrabhakar Kushwaha Defines divider of platform clock(clock input to eLBC controller). 510add63f94SPrabhakar Kushwaha 511690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_PBI 512690e4258SPrabhakar Kushwaha It enables addition of RCW (Power on reset configuration) in built image. 513690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 514690e4258SPrabhakar Kushwaha 515690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_RCW 516690e4258SPrabhakar Kushwaha It adds PBI(pre-boot instructions) commands in u-boot build image. 517690e4258SPrabhakar Kushwaha PBI commands can be used to configure SoC before it starts the execution. 518690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 519690e4258SPrabhakar Kushwaha 52089ad7be8SPrabhakar Kushwaha CONFIG_SPL_FSL_PBL 52189ad7be8SPrabhakar Kushwaha It adds a target to create boot binary having SPL binary in PBI format 52289ad7be8SPrabhakar Kushwaha concatenated with u-boot binary. 52389ad7be8SPrabhakar Kushwaha 5244e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_BE 5254e5b1bd0SYork Sun Defines the DDR controller register space as Big Endian 5264e5b1bd0SYork Sun 5274e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_LE 5284e5b1bd0SYork Sun Defines the DDR controller register space as Little Endian 5294e5b1bd0SYork Sun 5306b9e309aSYork Sun CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 5316b9e309aSYork Sun Physical address from the view of DDR controllers. It is the 5326b9e309aSYork Sun same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 5336b9e309aSYork Sun it could be different for ARM SoCs. 5346b9e309aSYork Sun 5356b1e1254SYork Sun CONFIG_SYS_FSL_DDR_INTLV_256B 5366b1e1254SYork Sun DDR controller interleaving on 256-byte. This is a special 5376b1e1254SYork Sun interleaving mode, handled by Dickens for Freescale layerscape 5386b1e1254SYork Sun SoCs with ARM core. 5396b1e1254SYork Sun 5401d71efbbSYork Sun CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS 5411d71efbbSYork Sun Number of controllers used as main memory. 5421d71efbbSYork Sun 5431d71efbbSYork Sun CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS 5441d71efbbSYork Sun Number of controllers used for other than main memory. 5451d71efbbSYork Sun 54644937214SPrabhakar Kushwaha CONFIG_SYS_FSL_HAS_DP_DDR 54744937214SPrabhakar Kushwaha Defines the SoC has DP-DDR used for DPAA. 54844937214SPrabhakar Kushwaha 549028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_BE 550028dbb8dSRuchika Gupta Defines the SEC controller register space as Big Endian 551028dbb8dSRuchika Gupta 552028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_LE 553028dbb8dSRuchika Gupta Defines the SEC controller register space as Little Endian 554028dbb8dSRuchika Gupta 55592bbd64eSDaniel Schwierzeck- MIPS CPU options: 55692bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 55792bbd64eSDaniel Schwierzeck 55892bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 55992bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 56092bbd64eSDaniel Schwierzeck relocation. 56192bbd64eSDaniel Schwierzeck 56292bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 56392bbd64eSDaniel Schwierzeck 56492bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 56592bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 56692bbd64eSDaniel Schwierzeck Possible values are: 56792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 56892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 56992bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 57092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 57192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 57292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 57392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 57492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 57592bbd64eSDaniel Schwierzeck 57692bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 57792bbd64eSDaniel Schwierzeck 57892bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 57992bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 58092bbd64eSDaniel Schwierzeck 58192bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 58292bbd64eSDaniel Schwierzeck 58392bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 58492bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 58592bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 58692bbd64eSDaniel Schwierzeck 587b67d8816SChristian Riesch- ARM options: 588b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 589b67d8816SChristian Riesch 590b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 591b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 592b67d8816SChristian Riesch 593207774b2SYork Sun COUNTER_FREQUENCY 594207774b2SYork Sun Generic timer clock source frequency. 595207774b2SYork Sun 596207774b2SYork Sun COUNTER_FREQUENCY_REAL 597207774b2SYork Sun Generic timer clock source frequency if the real clock is 598207774b2SYork Sun different from COUNTER_FREQUENCY, and can only be determined 599207774b2SYork Sun at run time. 600207774b2SYork Sun 60173c38934SStephen Warren- Tegra SoC options: 60273c38934SStephen Warren CONFIG_TEGRA_SUPPORT_NON_SECURE 60373c38934SStephen Warren 60473c38934SStephen Warren Support executing U-Boot in non-secure (NS) mode. Certain 60573c38934SStephen Warren impossible actions will be skipped if the CPU is in NS mode, 60673c38934SStephen Warren such as ARM architectural timer initialization. 60773c38934SStephen Warren 6085da627a4Swdenk- Linux Kernel Interface: 609c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 610c609719bSwdenk 611c609719bSwdenk U-Boot stores all clock information in Hz 612c609719bSwdenk internally. For binary compatibility with older Linux 613c609719bSwdenk kernels (which expect the clocks passed in the 614c609719bSwdenk bd_info data to be in MHz) the environment variable 615c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 616c609719bSwdenk converts clock data to MHZ before passing it to the 617c609719bSwdenk Linux kernel. 618c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 619c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 620c609719bSwdenk default environment. 621c609719bSwdenk 6225da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 6235da627a4Swdenk 624b445bbb4SJeremiah Mahler When transferring memsize parameter to Linux, some versions 6255da627a4Swdenk expect it to be in bytes, others in MB. 6265da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 6275da627a4Swdenk 628fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 629f57f70aaSWolfgang Denk 630f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 631213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 632213bf8c8SGerald Van Baren concepts). 633213bf8c8SGerald Van Baren 634213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 635213bf8c8SGerald Van Baren * New libfdt-based support 636213bf8c8SGerald Van Baren * Adds the "fdt" command 6373bb342fcSKim Phillips * The bootm command automatically updates the fdt 638213bf8c8SGerald Van Baren 639b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 640b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 641b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 642b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 643f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 644c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 645f57f70aaSWolfgang Denk 64611ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 64711ccc33fSMarcel Ziswiler addresses 6483bb342fcSKim Phillips 6494e253137SKumar Gala CONFIG_OF_BOARD_SETUP 6504e253137SKumar Gala 6514e253137SKumar Gala Board code has addition modification that it wants to make 6524e253137SKumar Gala to the flat device tree before handing it off to the kernel 6536705d81eSwdenk 654c654b517SSimon Glass CONFIG_OF_SYSTEM_SETUP 655c654b517SSimon Glass 656c654b517SSimon Glass Other code has addition modification that it wants to make 657c654b517SSimon Glass to the flat device tree before handing it off to the kernel. 658c654b517SSimon Glass This causes ft_system_setup() to be called before booting 659c654b517SSimon Glass the kernel. 660c654b517SSimon Glass 6613887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 6623887c3fbSHeiko Schocher 6633887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 6643887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 6653887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 6663887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 6673887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 6683887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 6693887c3fbSHeiko Schocher 6707eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 6717eb29398SIgor Grinberg 6727eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 6737eb29398SIgor Grinberg machine type and must be used to specify the machine type 6747eb29398SIgor Grinberg number as it appears in the ARM machine registry 6757eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 6767eb29398SIgor Grinberg Only boards that have multiple machine types supported 6777eb29398SIgor Grinberg in a single configuration file and the machine type is 6787eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 6797eb29398SIgor Grinberg 6800b2f4ecaSNiklaus Giger- vxWorks boot parameters: 6810b2f4ecaSNiklaus Giger 6820b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 6839e98b7e3SBin Meng environments variables: bootdev, bootfile, ipaddr, netmask, 6849e98b7e3SBin Meng serverip, gatewayip, hostname, othbootargs. 6850b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 6860b2f4ecaSNiklaus Giger 6870b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 6880b2f4ecaSNiklaus Giger the defaults discussed just above. 6890b2f4ecaSNiklaus Giger 6902c451f78SAneesh V- Cache Configuration: 6912c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 6922c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 6932c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 6942c451f78SAneesh V 69593bc2193SAneesh V- Cache Configuration for ARM: 69693bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 69793bc2193SAneesh V controller 69893bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 69993bc2193SAneesh V controller register space 70093bc2193SAneesh V 7016705d81eSwdenk- Serial Ports: 70248d0192fSAndreas Engel CONFIG_PL010_SERIAL 7036705d81eSwdenk 7046705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 7056705d81eSwdenk 70648d0192fSAndreas Engel CONFIG_PL011_SERIAL 7076705d81eSwdenk 7086705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 7096705d81eSwdenk 7106705d81eSwdenk CONFIG_PL011_CLOCK 7116705d81eSwdenk 7126705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 7136705d81eSwdenk the clock speed of the UARTs. 7146705d81eSwdenk 7156705d81eSwdenk CONFIG_PL01x_PORTS 7166705d81eSwdenk 7176705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 7186705d81eSwdenk define this to a list of base addresses for each (supported) 7196705d81eSwdenk port. See e.g. include/configs/versatile.h 7206705d81eSwdenk 721d57dee57SKaricheri, Muralidharan CONFIG_SERIAL_HW_FLOW_CONTROL 722d57dee57SKaricheri, Muralidharan 723d57dee57SKaricheri, Muralidharan Define this variable to enable hw flow control in serial driver. 724d57dee57SKaricheri, Muralidharan Current user of this option is drivers/serial/nsl16550.c driver 7256705d81eSwdenk 726c609719bSwdenk- Console Interface: 727c609719bSwdenk Depending on board, define exactly one serial port 728c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 729c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 730c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 731c609719bSwdenk 732c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 733c609719bSwdenk port routines must be defined elsewhere 734c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 735c609719bSwdenk 736c609719bSwdenk- Console Baudrate: 737c609719bSwdenk CONFIG_BAUDRATE - in bps 738c609719bSwdenk Select one of the baudrates listed in 7396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 7406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 741c609719bSwdenk 742c92fac91SHeiko Schocher- Console Rx buffer length 743c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 744c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 7452b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 746c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 747c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 748c92fac91SHeiko Schocher the SMC. 749c92fac91SHeiko Schocher 750c609719bSwdenk- Autoboot Command: 751c609719bSwdenk CONFIG_BOOTCOMMAND 752c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 753c609719bSwdenk define a command string that is automatically executed 754c609719bSwdenk when no character is read on the console interface 755c609719bSwdenk within "Boot Delay" after reset. 756c609719bSwdenk 757c609719bSwdenk CONFIG_BOOTARGS 758c609719bSwdenk This can be used to pass arguments to the bootm 759c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 760c609719bSwdenk environment value "bootargs". 761c609719bSwdenk 762c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 763c609719bSwdenk The value of these goes into the environment as 764c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 765c609719bSwdenk as a convenience, when switching between booting from 76611ccc33fSMarcel Ziswiler RAM and NFS. 767c609719bSwdenk 768eda0ba38SHeiko Schocher- Bootcount: 769eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 770eda0ba38SHeiko Schocher Implements a mechanism for detecting a repeating reboot 771eda0ba38SHeiko Schocher cycle, see: 772eda0ba38SHeiko Schocher http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 773eda0ba38SHeiko Schocher 774eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_ENV 775eda0ba38SHeiko Schocher If no softreset save registers are found on the hardware 776eda0ba38SHeiko Schocher "bootcount" is stored in the environment. To prevent a 777eda0ba38SHeiko Schocher saveenv on all reboots, the environment variable 778eda0ba38SHeiko Schocher "upgrade_available" is used. If "upgrade_available" is 779eda0ba38SHeiko Schocher 0, "bootcount" is always 0, if "upgrade_available" is 780eda0ba38SHeiko Schocher 1 "bootcount" is incremented in the environment. 781eda0ba38SHeiko Schocher So the Userspace Applikation must set the "upgrade_available" 782eda0ba38SHeiko Schocher and "bootcount" variable to 0, if a boot was successfully. 783eda0ba38SHeiko Schocher 784c609719bSwdenk- Pre-Boot Commands: 785c609719bSwdenk CONFIG_PREBOOT 786c609719bSwdenk 787c609719bSwdenk When this option is #defined, the existence of the 788c609719bSwdenk environment variable "preboot" will be checked 789c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 790c609719bSwdenk countdown and/or running the auto-boot command resp. 791c609719bSwdenk entering interactive mode. 792c609719bSwdenk 793c609719bSwdenk This feature is especially useful when "preboot" is 794c609719bSwdenk automatically generated or modified. For an example 795c609719bSwdenk see the LWMON board specific code: here "preboot" is 796c609719bSwdenk modified when the user holds down a certain 797c609719bSwdenk combination of keys on the (special) keyboard when 798c609719bSwdenk booting the systems 799c609719bSwdenk 800c609719bSwdenk- Serial Download Echo Mode: 801c609719bSwdenk CONFIG_LOADS_ECHO 802c609719bSwdenk If defined to 1, all characters received during a 803c609719bSwdenk serial download (using the "loads" command) are 804c609719bSwdenk echoed back. This might be needed by some terminal 805c609719bSwdenk emulations (like "cu"), but may as well just take 806c609719bSwdenk time on others. This setting #define's the initial 807c609719bSwdenk value of the "loads_echo" environment variable. 808c609719bSwdenk 809602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 810c609719bSwdenk CONFIG_KGDB_BAUDRATE 811c609719bSwdenk Select one of the baudrates listed in 8126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 813c609719bSwdenk 814c609719bSwdenk- Monitor Functions: 815602ad3b3SJon Loeliger Monitor commands can be included or excluded 816602ad3b3SJon Loeliger from the build by using the #include files 817c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 818ef0f2f57SJoe Hershberger commands, or adding #define's for wanted commands. 819c609719bSwdenk 820602ad3b3SJon Loeliger The default command configuration includes all commands 821602ad3b3SJon Loeliger except those marked below with a "*". 822602ad3b3SJon Loeliger 823b401b73dSMarek Vasut CONFIG_CMD_AES AES 128 CBC encrypt/decrypt 824602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 825602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 826602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 827d2b2ffe3STom Rini CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support 828602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 829602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 830710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 831602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 832602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 833a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 834a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 835a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 836a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 837602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 838602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 839246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 840602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 841aa9e6044SNikita Kiryanov CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands 842602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 8435e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 844fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 84588733e2cSAndrew Ruder CONFIG_CMD_ENV_EXISTS * check existence of env variable 8460c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 84703e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 84803e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 84916f4d933SStephen Warren CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls) 85016f4d933SStephen Warren that work for multiple fs types 85159e890efSChristian Gmeiner CONFIG_CMD_FS_UUID * Look up a filesystem UUID 852bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 853602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 85403e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 855602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 856602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 8574d98b5c8SVincent Stehlé CONFIG_CMD_FUSE * Device fuse support 85853fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 859a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 860a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 861bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 862602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 863602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 864602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 8658fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 8664d98b5c8SVincent Stehlé CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 867602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 868aa53233aSSimon Glass CONFIG_CMD_IOTRACE * I/O tracing for debugging 8690c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 870c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 871602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 872602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 873602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 874602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 8754d98b5c8SVincent Stehlé CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 876d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 877d22c338eSJoe Hershberger (169.254.*.*) 878602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 879602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 8804d98b5c8SVincent Stehlé CONFIG_CMD_MD5SUM * print md5 message digest 88102c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 88215a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 883602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 884a2681707SWolfgang Denk loop, loopw 8854d98b5c8SVincent Stehlé CONFIG_CMD_MEMTEST * mtest 886602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 887602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 888602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 88968d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 890602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 891602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 8924d98b5c8SVincent Stehlé CONFIG_CMD_NFS NFS support 893e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 894e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 895602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 896602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 897602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 898602ad3b3SJon Loeliger host 899602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 900ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 901602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 902602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 903d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 904602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 905c649e3c9SSimon Glass CONFIG_SCSI * SCSI Support 906602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 907602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 908602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 909602ad3b3SJon Loeliger (4xx only) 910f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 9114d98b5c8SVincent Stehlé CONFIG_CMD_SHA1SUM * print sha1 memory digest 91202c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 9137d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 91474de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 915602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 9167a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 9171fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 918da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 919da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 920602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 921602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 922c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 9234d98b5c8SVincent Stehlé CONFIG_CMD_XIMG Load part of Multi Image 92489c8230dSPrzemyslaw Marczak CONFIG_CMD_UUID * Generate random UUID or GUID string 925c609719bSwdenk 926c609719bSwdenk EXAMPLE: If you want all functions except of network 927c609719bSwdenk support you can write: 928c609719bSwdenk 929602ad3b3SJon Loeliger #include "config_cmd_all.h" 930602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 931c609719bSwdenk 932213bf8c8SGerald Van Baren Other Commands: 933213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 934c609719bSwdenk 935c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 936602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 937c609719bSwdenk what you (and your U-Boot users) are doing. Data 938c609719bSwdenk cache cannot be enabled on systems like the 8xx or 939c609719bSwdenk 8260 (where accesses to the IMMR region must be 940c609719bSwdenk uncached), and it cannot be disabled on all other 941c609719bSwdenk systems where we (mis-) use the data cache to hold an 942c609719bSwdenk initial stack and some data. 943c609719bSwdenk 944c609719bSwdenk 945c609719bSwdenk XXX - this list needs to get updated! 946c609719bSwdenk 947302a6487SSimon Glass- Removal of commands 948302a6487SSimon Glass If no commands are needed to boot, you can disable 949302a6487SSimon Glass CONFIG_CMDLINE to remove them. In this case, the command line 950302a6487SSimon Glass will not be available, and when U-Boot wants to execute the 951302a6487SSimon Glass boot command (on start-up) it will call board_run_command() 952302a6487SSimon Glass instead. This can reduce image size significantly for very 953302a6487SSimon Glass simple boot procedures. 954302a6487SSimon Glass 955a5ecbe62SWolfgang Denk- Regular expression support: 956a5ecbe62SWolfgang Denk CONFIG_REGEX 957a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 958a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 959a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 960a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 961a5ecbe62SWolfgang Denk 96245ba8077SSimon Glass- Device tree: 96345ba8077SSimon Glass CONFIG_OF_CONTROL 96445ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 96545ba8077SSimon Glass to configure its devices, instead of relying on statically 96645ba8077SSimon Glass compiled #defines in the board file. This option is 96745ba8077SSimon Glass experimental and only available on a few boards. The device 96845ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 96945ba8077SSimon Glass 9702c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 97182f766d1SAlex Deymo be done using one of the three options below: 972bbb0b128SSimon Glass 973bbb0b128SSimon Glass CONFIG_OF_EMBED 974bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 975bbb0b128SSimon Glass binary in its image. This device tree file should be in the 976bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 977bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 978bbb0b128SSimon Glass the global data structure as gd->blob. 97945ba8077SSimon Glass 9802c0f79e4SSimon Glass CONFIG_OF_SEPARATE 9812c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 9822c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 9832c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 9842c0f79e4SSimon Glass 9852c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 9862c0f79e4SSimon Glass 9872c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 9882c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 9892c0f79e4SSimon Glass still use the individual files if you need something more 9902c0f79e4SSimon Glass exotic. 9912c0f79e4SSimon Glass 99282f766d1SAlex Deymo CONFIG_OF_BOARD 99382f766d1SAlex Deymo If this variable is defined, U-Boot will use the device tree 99482f766d1SAlex Deymo provided by the board at runtime instead of embedding one with 99582f766d1SAlex Deymo the image. Only boards defining board_fdt_blob_setup() support 99682f766d1SAlex Deymo this option (see include/fdtdec.h file). 99782f766d1SAlex Deymo 998c609719bSwdenk- Watchdog: 999c609719bSwdenk CONFIG_WATCHDOG 1000c609719bSwdenk If this variable is defined, it enables watchdog 10016abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 10026abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 10036abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 10046abe6fb6SDetlev Zundel register. When supported for a specific SoC is 10056abe6fb6SDetlev Zundel available, then no further board specific code should 10066abe6fb6SDetlev Zundel be needed to use it. 10076abe6fb6SDetlev Zundel 10086abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 10096abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 10106abe6fb6SDetlev Zundel SoC, then define this variable and provide board 10116abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 1012c609719bSwdenk 10137bae0d6fSHeiko Schocher CONFIG_AT91_HW_WDT_TIMEOUT 10147bae0d6fSHeiko Schocher specify the timeout in seconds. default 2 seconds. 10157bae0d6fSHeiko Schocher 1016c1551ea8Sstroese- U-Boot Version: 1017c1551ea8Sstroese CONFIG_VERSION_VARIABLE 1018c1551ea8Sstroese If this variable is defined, an environment variable 1019c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 1020c1551ea8Sstroese version as printed by the "version" command. 1021a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 1022a1ea8e51SBenoît Thébaudeau next reset. 1023c1551ea8Sstroese 1024c609719bSwdenk- Real-Time Clock: 1025c609719bSwdenk 1026602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1027c609719bSwdenk has to be selected, too. Define exactly one of the 1028c609719bSwdenk following options: 1029c609719bSwdenk 1030c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1031c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 10324e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1033c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 10341cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1035c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 10367f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 1037412921d2SMarkus Niebel CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC 10383bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 10399536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 10404c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 10416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 104271d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 104371d19f30SHeiko Schocher RV3029 RTC. 1044c609719bSwdenk 1045b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1046b37c7e5eSwdenk must also be configured. See I2C Support, below. 1047b37c7e5eSwdenk 1048e92739d3SPeter Tyser- GPIO Support: 1049e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1050e92739d3SPeter Tyser 10515dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 10525dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 10535dec49caSChris Packham pins supported by a particular chip. 10545dec49caSChris Packham 1055e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1056e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1057e92739d3SPeter Tyser 1058aa53233aSSimon Glass- I/O tracing: 1059aa53233aSSimon Glass When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O 1060aa53233aSSimon Glass accesses and can checksum them or write a list of them out 1061aa53233aSSimon Glass to memory. See the 'iotrace' command for details. This is 1062aa53233aSSimon Glass useful for testing device drivers since it can confirm that 1063aa53233aSSimon Glass the driver behaves the same way before and after a code 1064aa53233aSSimon Glass change. Currently this is supported on sandbox and arm. To 1065aa53233aSSimon Glass add support for your architecture, add '#include <iotrace.h>' 1066aa53233aSSimon Glass to the bottom of arch/<arch>/include/asm/io.h and test. 1067aa53233aSSimon Glass 1068aa53233aSSimon Glass Example output from the 'iotrace stats' command is below. 1069aa53233aSSimon Glass Note that if the trace buffer is exhausted, the checksum will 1070aa53233aSSimon Glass still continue to operate. 1071aa53233aSSimon Glass 1072aa53233aSSimon Glass iotrace is enabled 1073aa53233aSSimon Glass Start: 10000000 (buffer start address) 1074aa53233aSSimon Glass Size: 00010000 (buffer size) 1075aa53233aSSimon Glass Offset: 00000120 (current buffer offset) 1076aa53233aSSimon Glass Output: 10000120 (start + offset) 1077aa53233aSSimon Glass Count: 00000018 (number of trace records) 1078aa53233aSSimon Glass CRC32: 9526fb66 (CRC32 of all trace records) 1079aa53233aSSimon Glass 1080c609719bSwdenk- Timestamp Support: 1081c609719bSwdenk 1082c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1083c609719bSwdenk (date and time) of an image is printed by image 1084c609719bSwdenk commands like bootm or iminfo. This option is 1085602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1086c609719bSwdenk 1087923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1088923c46f9SKarl O. Pinc Zero or more of the following: 1089923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1090923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1091923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1092923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1093923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1094923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1095923c46f9SKarl O. Pinc disk/part_efi.c 1096923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1097c609719bSwdenk 1098602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1099c649e3c9SSimon Glass CONFIG_SCSI) you must configure support for at 1100923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1101c609719bSwdenk 1102c609719bSwdenk- IDE Reset method: 11034d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 11044d13cbadSwdenk board configurations files but used nowhere! 1105c609719bSwdenk 11064d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 11074d13cbadSwdenk be performed by calling the function 11084d13cbadSwdenk ide_set_reset(int reset) 11094d13cbadSwdenk which has to be defined in a board specific file 1110c609719bSwdenk 1111c609719bSwdenk- ATAPI Support: 1112c609719bSwdenk CONFIG_ATAPI 1113c609719bSwdenk 1114c609719bSwdenk Set this to enable ATAPI support. 1115c609719bSwdenk 1116c40b2956Swdenk- LBA48 Support 1117c40b2956Swdenk CONFIG_LBA48 1118c40b2956Swdenk 1119c40b2956Swdenk Set this to enable support for disks larger than 137GB 11204b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1121c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1122c40b2956Swdenk support disks up to 2.1TB. 1123c40b2956Swdenk 11246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1125c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1126c40b2956Swdenk Default is 32bit. 1127c40b2956Swdenk 1128c609719bSwdenk- SCSI Support: 1129c609719bSwdenk At the moment only there is only support for the 1130c609719bSwdenk SYM53C8XX SCSI controller; define 1131c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1132c609719bSwdenk 11336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 11346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 11356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1136c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1137c609719bSwdenk devices. 11386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1139c609719bSwdenk 1140447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1141447c031bSStefan Reinauer SCSI devices found during the last scan. 1142447c031bSStefan Reinauer 1143c609719bSwdenk- NETWORK Support (PCI): 1144682011ffSwdenk CONFIG_E1000 1145ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1146ce5207e1SKyle Moffett 1147ce5207e1SKyle Moffett CONFIG_E1000_SPI 1148ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1149ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1150ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1151ce5207e1SKyle Moffett 1152ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1153ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1154ce5207e1SKyle Moffett example with the "sspi" command. 1155ce5207e1SKyle Moffett 1156ce5207e1SKyle Moffett CONFIG_CMD_E1000 1157ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1158ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1159682011ffSwdenk 1160c609719bSwdenk CONFIG_EEPRO100 1161c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 116211ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1163c609719bSwdenk write routine for first time initialisation. 1164c609719bSwdenk 1165c609719bSwdenk CONFIG_TULIP 1166c609719bSwdenk Support for Digital 2114x chips. 1167c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1168c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1169c609719bSwdenk 1170c609719bSwdenk CONFIG_NATSEMI 1171c609719bSwdenk Support for National dp83815 chips. 1172c609719bSwdenk 1173c609719bSwdenk CONFIG_NS8382X 1174c609719bSwdenk Support for National dp8382[01] gigabit chips. 1175c609719bSwdenk 117645219c46Swdenk- NETWORK Support (other): 117745219c46Swdenk 1178c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1179c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1180c041e9d2SJens Scharsig 1181c041e9d2SJens Scharsig CONFIG_RMII 1182c041e9d2SJens Scharsig Define this to use reduced MII inteface 1183c041e9d2SJens Scharsig 1184c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1185c041e9d2SJens Scharsig If this defined, the driver is quiet. 1186c041e9d2SJens Scharsig The driver doen't show link status messages. 1187c041e9d2SJens Scharsig 1188efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1189efdd7319SRob Herring Support for the Calxeda XGMAC device 1190efdd7319SRob Herring 11913bb46d23SAshok CONFIG_LAN91C96 119245219c46Swdenk Support for SMSC's LAN91C96 chips. 119345219c46Swdenk 119445219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 119545219c46Swdenk Define this to enable 32 bit addressing 119645219c46Swdenk 11973bb46d23SAshok CONFIG_SMC91111 1198f39748aeSwdenk Support for SMSC's LAN91C111 chip 1199f39748aeSwdenk 1200f39748aeSwdenk CONFIG_SMC91111_BASE 1201f39748aeSwdenk Define this to hold the physical address 1202f39748aeSwdenk of the device (I/O space) 1203f39748aeSwdenk 1204f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1205f39748aeSwdenk Define this if data bus is 32 bits 1206f39748aeSwdenk 1207f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1208f39748aeSwdenk Define this to use i/o functions instead of macros 1209f39748aeSwdenk (some hardware wont work with macros) 1210f39748aeSwdenk 1211dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1212dc02badaSHeiko Schocher Support for davinci emac 1213dc02badaSHeiko Schocher 1214dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1215dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1216dc02badaSHeiko Schocher 1217b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1218b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1219b3dbf4a5SMacpaul Lin 1220b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1221b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1222b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1223b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1224b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1225b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1226b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1227b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1228b3dbf4a5SMacpaul Lin 1229c2fff331SMike Rapoport CONFIG_SMC911X 1230557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1231557b377dSJens Gehrlein 1232c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1233557b377dSJens Gehrlein Define this to hold the physical address 1234557b377dSJens Gehrlein of the device (I/O space) 1235557b377dSJens Gehrlein 1236c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1237557b377dSJens Gehrlein Define this if data bus is 32 bits 1238557b377dSJens Gehrlein 1239c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1240557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1241557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1242c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1243557b377dSJens Gehrlein 12443d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 12453d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 12463d0075faSYoshihiro Shimoda 12473d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 12483d0075faSYoshihiro Shimoda Define the number of ports to be used 12493d0075faSYoshihiro Shimoda 12503d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 12513d0075faSYoshihiro Shimoda Define the ETH PHY's address 12523d0075faSYoshihiro Shimoda 125368260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 125468260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 125568260aabSYoshihiro Shimoda 1256b2f97cf2SHeiko Schocher- PWM Support: 1257b2f97cf2SHeiko Schocher CONFIG_PWM_IMX 12585052e819SRobert P. J. Day Support for PWM module on the imx6. 1259b2f97cf2SHeiko Schocher 12605e124724SVadim Bendebury- TPM Support: 126190899cc0SChe-liang Chiou CONFIG_TPM 126290899cc0SChe-liang Chiou Support TPM devices. 126390899cc0SChe-liang Chiou 12640766ad2fSChristophe Ricard CONFIG_TPM_TIS_INFINEON 12650766ad2fSChristophe Ricard Support for Infineon i2c bus TPM devices. Only one device 12661b393db5STom Wai-Hong Tam per system is supported at this time. 12671b393db5STom Wai-Hong Tam 12681b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 12691b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 12701b393db5STom Wai-Hong Tam 12713aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24 12723aa74088SChristophe Ricard Support for STMicroelectronics TPM devices. Requires DM_TPM support. 12733aa74088SChristophe Ricard 12743aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24_I2C 12753aa74088SChristophe Ricard Support for STMicroelectronics ST33ZP24 I2C devices. 12763aa74088SChristophe Ricard Requires TPM_ST33ZP24 and I2C. 12773aa74088SChristophe Ricard 1278b75fdc11SChristophe Ricard CONFIG_TPM_ST33ZP24_SPI 1279b75fdc11SChristophe Ricard Support for STMicroelectronics ST33ZP24 SPI devices. 1280b75fdc11SChristophe Ricard Requires TPM_ST33ZP24 and SPI. 1281b75fdc11SChristophe Ricard 1282c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1283c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1284c01939c7SDirk Eibach 128590899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 12865e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 12875e124724SVadim Bendebury per system is supported at this time. 12885e124724SVadim Bendebury 12895e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 12905e124724SVadim Bendebury Base address where the generic TPM device is mapped 12915e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 12925e124724SVadim Bendebury 0xfed40000. 12935e124724SVadim Bendebury 1294be6c1529SReinhard Pfau CONFIG_CMD_TPM 1295be6c1529SReinhard Pfau Add tpm monitor functions. 1296be6c1529SReinhard Pfau Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1297be6c1529SReinhard Pfau provides monitor access to authorized functions. 1298be6c1529SReinhard Pfau 1299be6c1529SReinhard Pfau CONFIG_TPM 1300be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1301be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1302be6c1529SReinhard Pfau Requires support for a TPM device. 1303be6c1529SReinhard Pfau 1304be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1305be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1306be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1307be6c1529SReinhard Pfau 1308c609719bSwdenk- USB Support: 1309c609719bSwdenk At the moment only the UHCI host controller is 13104d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1311c609719bSwdenk CONFIG_USB_UHCI to enable it. 1312c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 131330d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1314c609719bSwdenk storage devices. 1315c609719bSwdenk Note: 1316c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1317c609719bSwdenk (TEAC FD-05PUB). 13184d13cbadSwdenk MPC5200 USB requires additional defines: 13194d13cbadSwdenk CONFIG_USB_CLOCK 13204d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1321307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1322307ecb6dSEric Millbrandt for USB on PSC3 13234d13cbadSwdenk CONFIG_USB_CONFIG 13244d13cbadSwdenk for differential drivers: 0x00001000 13254d13cbadSwdenk for single ended drivers: 0x00005000 1326307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1327307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 13286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1329fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1330fdcfaa1bSZhang Wei instead of using asynchronous interrupts 13314d13cbadSwdenk 13329ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 13339ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 13349ab4ce22SSimon Glass 13356e9e0626SOleksandr Tymoshenko CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 13366e9e0626SOleksandr Tymoshenko HW module registers. 13376e9e0626SOleksandr Tymoshenko 133816c8d5e7SWolfgang Denk- USB Device: 133916c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 134016c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 134116c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 134211ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 134316c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 134416c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 134516c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 134616c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 134716c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 134816c8d5e7SWolfgang Denk a Linux host by 134916c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 135016c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 135116c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 135216c8d5e7SWolfgang Denk might be defined in YourBoardName.h 135316c8d5e7SWolfgang Denk 135416c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 135516c8d5e7SWolfgang Denk Define this to build a UDC device 135616c8d5e7SWolfgang Denk 135716c8d5e7SWolfgang Denk CONFIG_USB_TTY 135816c8d5e7SWolfgang Denk Define this to have a tty type of device available to 135916c8d5e7SWolfgang Denk talk to the UDC device 136016c8d5e7SWolfgang Denk 1361f9da0f89SVipin KUMAR CONFIG_USBD_HS 1362f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1363f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1364f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1365f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1366f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1367f9da0f89SVipin KUMAR speed. 1368f9da0f89SVipin KUMAR 13696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 137016c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 137116c8d5e7SWolfgang Denk be set to usbtty. 137216c8d5e7SWolfgang Denk 137316c8d5e7SWolfgang Denk mpc8xx: 13746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 137516c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 13766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 137716c8d5e7SWolfgang Denk 137816c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 137916c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 138016c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 138116c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 138216c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 138316c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 138416c8d5e7SWolfgang Denk 138516c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 138616c8d5e7SWolfgang Denk Define this string as the name of your company for 138716c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 138816c8d5e7SWolfgang Denk 138916c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 139016c8d5e7SWolfgang Denk Define this string as the name of your product 139116c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 139216c8d5e7SWolfgang Denk 139316c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 139416c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 139516c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 139616c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 139716c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 139816c8d5e7SWolfgang Denk 139916c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 140016c8d5e7SWolfgang Denk Define this as the unique Product ID 140116c8d5e7SWolfgang Denk for your device 140216c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1403c609719bSwdenk 1404d70a560fSIgor Grinberg- ULPI Layer Support: 1405d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1406d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1407d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1408d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1409d70a560fSIgor Grinberg viewport is supported. 1410d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1411d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 14126d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 14136d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 14146d365ea0SLucas Stach the appropriate value in Hz. 1415c609719bSwdenk 1416c609719bSwdenk- MMC Support: 1417c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1418c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1419c609719bSwdenk accessed from the boot prompt by mapping the device 1420c609719bSwdenk to physical memory similar to flash. Command line is 1421602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1422602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1423c609719bSwdenk 1424afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1425afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1426afb35666SYoshihiro Shimoda 1427afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1428afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1429afb35666SYoshihiro Shimoda 1430afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1431afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1432afb35666SYoshihiro Shimoda 14331fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_BOOT 14341fd93c6eSPierre Aubert Enable some additional features of the eMMC boot partitions. 14351fd93c6eSPierre Aubert 14361fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_RPMB 14371fd93c6eSPierre Aubert Enable the commands for reading, writing and programming the 14381fd93c6eSPierre Aubert key for the Replay Protection Memory Block partition in eMMC. 14391fd93c6eSPierre Aubert 1440b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 144101acd6abSPaul Kocialkowski CONFIG_USB_FUNCTION_DFU 1442b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1443b3ba6e94STom Rini 1444b3ba6e94STom Rini CONFIG_CMD_DFU 1445b3ba6e94STom Rini This enables the command "dfu" which is used to have 1446b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1447b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1448b3ba6e94STom Rini set and define the alt settings to expose to the host. 1449b3ba6e94STom Rini 1450b3ba6e94STom Rini CONFIG_DFU_MMC 1451b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1452b3ba6e94STom Rini 1453c6631764SPantelis Antoniou CONFIG_DFU_NAND 1454c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1455c6631764SPantelis Antoniou 1456a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1457a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1458a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1459a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1460a9479f04SAfzal Mohammed one that would help mostly the developer. 1461a9479f04SAfzal Mohammed 1462e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1463e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1464e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1465e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1466e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1467e7e75c70SHeiko Schocher 1468ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1469ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1470ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1471ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1472ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1473ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1474ea2453d5SPantelis Antoniou 1475001a8319SHeiko Schocher DFU_DEFAULT_POLL_TIMEOUT 1476001a8319SHeiko Schocher Poll timeout [ms], is the timeout a device can send to the 1477001a8319SHeiko Schocher host. The host must wait for this timeout before sending 1478001a8319SHeiko Schocher a subsequent DFU_GET_STATUS request to the device. 1479001a8319SHeiko Schocher 1480001a8319SHeiko Schocher DFU_MANIFEST_POLL_TIMEOUT 1481001a8319SHeiko Schocher Poll timeout [ms], which the device sends to the host when 1482001a8319SHeiko Schocher entering dfuMANIFEST state. Host waits this timeout, before 1483001a8319SHeiko Schocher sending again an USB request to the device. 1484001a8319SHeiko Schocher 14853aab70afSSebastian Siewior- USB Device Android Fastboot support: 148617da3c0cSPaul Kocialkowski CONFIG_USB_FUNCTION_FASTBOOT 148717da3c0cSPaul Kocialkowski This enables the USB part of the fastboot gadget 148817da3c0cSPaul Kocialkowski 14893aab70afSSebastian Siewior CONFIG_CMD_FASTBOOT 14903aab70afSSebastian Siewior This enables the command "fastboot" which enables the Android 14913aab70afSSebastian Siewior fastboot mode for the platform's USB device. Fastboot is a USB 14923aab70afSSebastian Siewior protocol for downloading images, flashing and device control 14933aab70afSSebastian Siewior used on Android devices. 14943aab70afSSebastian Siewior See doc/README.android-fastboot for more information. 14953aab70afSSebastian Siewior 14963aab70afSSebastian Siewior CONFIG_ANDROID_BOOT_IMAGE 14973aab70afSSebastian Siewior This enables support for booting images which use the Android 14983aab70afSSebastian Siewior image format header. 14993aab70afSSebastian Siewior 1500a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_ADDR 15013aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 15023aab70afSSebastian Siewior downloads. Define this to the starting RAM address to use for 15033aab70afSSebastian Siewior downloaded images. 15043aab70afSSebastian Siewior 1505a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_SIZE 15063aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 15073aab70afSSebastian Siewior downloads. This buffer should be as large as possible for a 15083aab70afSSebastian Siewior platform. Define this to the size available RAM for fastboot. 15093aab70afSSebastian Siewior 1510d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH 1511d1b5ed07SSteve Rae The fastboot protocol includes a "flash" command for writing 1512d1b5ed07SSteve Rae the downloaded image to a non-volatile storage device. Define 1513d1b5ed07SSteve Rae this to enable the "fastboot flash" command. 1514d1b5ed07SSteve Rae 1515d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH_MMC_DEV 1516d1b5ed07SSteve Rae The fastboot "flash" command requires additional information 1517d1b5ed07SSteve Rae regarding the non-volatile storage device. Define this to 1518d1b5ed07SSteve Rae the eMMC device that fastboot should use to store the image. 1519d1b5ed07SSteve Rae 15200ff7e585SSteve Rae CONFIG_FASTBOOT_GPT_NAME 15210ff7e585SSteve Rae The fastboot "flash" command supports writing the downloaded 15220ff7e585SSteve Rae image to the Protective MBR and the Primary GUID Partition 15230ff7e585SSteve Rae Table. (Additionally, this downloaded image is post-processed 15240ff7e585SSteve Rae to generate and write the Backup GUID Partition Table.) 15250ff7e585SSteve Rae This occurs when the specified "partition name" on the 15260ff7e585SSteve Rae "fastboot flash" command line matches this value. 15276f6c8630SPetr Kulhavy The default is "gpt" if undefined. 15280ff7e585SSteve Rae 1529b6dd69a4SPetr Kulhavy CONFIG_FASTBOOT_MBR_NAME 1530b6dd69a4SPetr Kulhavy The fastboot "flash" command supports writing the downloaded 1531b6dd69a4SPetr Kulhavy image to DOS MBR. 1532b6dd69a4SPetr Kulhavy This occurs when the "partition name" specified on the 1533b6dd69a4SPetr Kulhavy "fastboot flash" command line matches this value. 1534b6dd69a4SPetr Kulhavy If not defined the default value "mbr" is used. 1535b6dd69a4SPetr Kulhavy 15366705d81eSwdenk- Journaling Flash filesystem support: 1537b2482dffSSimon Glass CONFIG_JFFS2_NAND 15386705d81eSwdenk Define these for a default partition on a NAND device 15396705d81eSwdenk 15406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 15416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 15426705d81eSwdenk Define these for a default partition on a NOR device 15436705d81eSwdenk 1544c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1545c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1546656f4c65SDonggeun Kim 1547656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1548656f4c65SDonggeun Kim file in FAT formatted partition. 1549656f4c65SDonggeun Kim 1550656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1551656f4c65SDonggeun Kim user to write files to FAT. 1552c30a15e5SDonggeun Kim 15534f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size: 15544f0d1a2aSSiva Durga Prasad Paladugu CONFIG_FS_FAT_MAX_CLUSTSIZE 15554f0d1a2aSSiva Durga Prasad Paladugu 15564f0d1a2aSSiva Durga Prasad Paladugu Define the max cluster size for fat operations else 15574f0d1a2aSSiva Durga Prasad Paladugu a default value of 65536 will be defined. 15584f0d1a2aSSiva Durga Prasad Paladugu 1559c609719bSwdenk- Keyboard Support: 156039f615edSSimon Glass See Kconfig help for available keyboard drivers. 156139f615edSSimon Glass 156239f615edSSimon Glass CONFIG_KEYBOARD 156339f615edSSimon Glass 156439f615edSSimon Glass Define this to enable a custom keyboard support. 156539f615edSSimon Glass This simply calls drv_keyboard_init() which must be 156639f615edSSimon Glass defined in your board-specific files. This option is deprecated 156739f615edSSimon Glass and is only used by novena. For new boards, use driver model 156839f615edSSimon Glass instead. 1569c609719bSwdenk 1570c609719bSwdenk- Video support: 15717d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 15727d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 15737d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 15747d3053fbSTimur Tabi support, and should also define these other macros: 15757d3053fbSTimur Tabi 15767d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 15777d3053fbSTimur Tabi CONFIG_VIDEO 15787d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 15797d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 15807d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 15817d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 15827d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 15837d3053fbSTimur Tabi 1584ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1585ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 15868eca9439SFabio Estevam boot. See the documentation file doc/README.video for a 1587ba8e76bdSTimur Tabi description of this variable. 15887d3053fbSTimur Tabi 1589c609719bSwdenk- LCD Support: CONFIG_LCD 1590c609719bSwdenk 1591c609719bSwdenk Define this to enable LCD support (for output to LCD 1592c609719bSwdenk display); also select one of the supported displays 1593c609719bSwdenk by defining one of these: 1594c609719bSwdenk 159539cf4804SStelian Pop CONFIG_ATMEL_LCD: 159639cf4804SStelian Pop 159739cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 159839cf4804SStelian Pop 1599fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1600c609719bSwdenk 1601fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1602c609719bSwdenk 1603fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1604c609719bSwdenk 1605fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1606fd3103bbSwdenk Active, color, single scan. 1607fd3103bbSwdenk 1608fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1609fd3103bbSwdenk 1610fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1611c609719bSwdenk Active, color, single scan. 1612c609719bSwdenk 1613c609719bSwdenk CONFIG_SHARP_16x9 1614c609719bSwdenk 1615c609719bSwdenk Sharp 320x240. Active, color, single scan. 1616c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1617c609719bSwdenk 1618c609719bSwdenk CONFIG_SHARP_LQ64D341 1619c609719bSwdenk 1620c609719bSwdenk Sharp LQ64D341 display, 640x480. 1621c609719bSwdenk Active, color, single scan. 1622c609719bSwdenk 1623c609719bSwdenk CONFIG_HLD1045 1624c609719bSwdenk 1625c609719bSwdenk HLD1045 display, 640x480. 1626c609719bSwdenk Active, color, single scan. 1627c609719bSwdenk 1628c609719bSwdenk CONFIG_OPTREX_BW 1629c609719bSwdenk 1630c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1631c609719bSwdenk or 1632c609719bSwdenk Hitachi LMG6912RPFC-00T 1633c609719bSwdenk or 1634c609719bSwdenk Hitachi SP14Q002 1635c609719bSwdenk 1636c609719bSwdenk 320x240. Black & white. 1637c609719bSwdenk 1638676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1639676d319eSSimon Glass 1640b445bbb4SJeremiah Mahler Normally the LCD is page-aligned (typically 4KB). If this is 1641676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1642676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1643676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1644676d319eSSimon Glass a per-section basis. 1645676d319eSSimon Glass 1646676d319eSSimon Glass 1647604c7d4aSHannes Petermaier CONFIG_LCD_ROTATION 1648604c7d4aSHannes Petermaier 1649604c7d4aSHannes Petermaier Sometimes, for example if the display is mounted in portrait 1650604c7d4aSHannes Petermaier mode or even if it's mounted landscape but rotated by 180degree, 1651604c7d4aSHannes Petermaier we need to rotate our content of the display relative to the 1652604c7d4aSHannes Petermaier framebuffer, so that user can read the messages which are 1653604c7d4aSHannes Petermaier printed out. 1654604c7d4aSHannes Petermaier Once CONFIG_LCD_ROTATION is defined, the lcd_console will be 1655604c7d4aSHannes Petermaier initialized with a given rotation from "vl_rot" out of 1656604c7d4aSHannes Petermaier "vidinfo_t" which is provided by the board specific code. 1657604c7d4aSHannes Petermaier The value for vl_rot is coded as following (matching to 1658604c7d4aSHannes Petermaier fbcon=rotate:<n> linux-kernel commandline): 1659604c7d4aSHannes Petermaier 0 = no rotation respectively 0 degree 1660604c7d4aSHannes Petermaier 1 = 90 degree rotation 1661604c7d4aSHannes Petermaier 2 = 180 degree rotation 1662604c7d4aSHannes Petermaier 3 = 270 degree rotation 1663604c7d4aSHannes Petermaier 1664604c7d4aSHannes Petermaier If CONFIG_LCD_ROTATION is not defined, the console will be 1665604c7d4aSHannes Petermaier initialized with 0degree rotation. 1666604c7d4aSHannes Petermaier 166745d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 166845d7f525STom Wai-Hong Tam 166945d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 167045d7f525STom Wai-Hong Tam 1671735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1672735987c5STom Wai-Hong Tam 1673735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1674735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1675735987c5STom Wai-Hong Tam 16767152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1677d791b1dcSwdenk 1678d791b1dcSwdenk If this option is set, the environment is checked for 1679d791b1dcSwdenk a variable "splashimage". If found, the usual display 1680d791b1dcSwdenk of logo, copyright and system information on the LCD 1681e94d2cd9Swdenk is suppressed and the BMP image at the address 1682d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1683d791b1dcSwdenk console is redirected to the "nulldev", too. This 1684d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1685d791b1dcSwdenk loaded very quickly after power-on. 1686d791b1dcSwdenk 1687c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1688c0880485SNikita Kiryanov 1689c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1690c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1691ab5645f1SFabio Estevam (see doc/README.displaying-bmps). 1692c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1693c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1694c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1695c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1696c0880485SNikita Kiryanov there is no need to set this option. 1697c0880485SNikita Kiryanov 16981ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 16991ca298ceSMatthias Weisser 17001ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 17011ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 17021ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 17031ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 17041ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 17051ca298ceSMatthias Weisser specify 'm' for centering the image. 17061ca298ceSMatthias Weisser 17071ca298ceSMatthias Weisser Example: 17081ca298ceSMatthias Weisser setenv splashpos m,m 17091ca298ceSMatthias Weisser => image at center of screen 17101ca298ceSMatthias Weisser 17111ca298ceSMatthias Weisser setenv splashpos 30,20 17121ca298ceSMatthias Weisser => image at x = 30 and y = 20 17131ca298ceSMatthias Weisser 17141ca298ceSMatthias Weisser setenv splashpos -10,m 17151ca298ceSMatthias Weisser => vertically centered image 17161ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 17171ca298ceSMatthias Weisser 171898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 171998f4a3dfSStefan Roese 172098f4a3dfSStefan Roese If this option is set, additionally to standard BMP 172198f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 172298f4a3dfSStefan Roese splashscreen support or the bmp command. 172398f4a3dfSStefan Roese 1724d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1725d5011762SAnatolij Gustschin 1726d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1727d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1728d5011762SAnatolij Gustschin bmp command. 1729d5011762SAnatolij Gustschin 1730c29fdfc1Swdenk- Compression support: 17318ef70478SKees Cook CONFIG_GZIP 17328ef70478SKees Cook 17338ef70478SKees Cook Enabled by default to support gzip compressed images. 17348ef70478SKees Cook 1735c29fdfc1Swdenk CONFIG_BZIP2 1736c29fdfc1Swdenk 1737c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1738c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1739c29fdfc1Swdenk compressed images are supported. 1740c29fdfc1Swdenk 1741c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 17426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1743c29fdfc1Swdenk be at least 4MB. 1744d791b1dcSwdenk 1745fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1746fc9c1727SLuigi 'Comio' Mantellini 1747fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1748fc9c1727SLuigi 'Comio' Mantellini images is included. 1749fc9c1727SLuigi 'Comio' Mantellini 1750fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1751fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1752fc9c1727SLuigi 'Comio' Mantellini formula: 1753fc9c1727SLuigi 'Comio' Mantellini 1754fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1755fc9c1727SLuigi 'Comio' Mantellini 1756fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1757fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1758fc9c1727SLuigi 'Comio' Mantellini 1759fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1760fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1761fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1762fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1763fc9c1727SLuigi 'Comio' Mantellini 1764fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1765fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 17666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1767fc9c1727SLuigi 'Comio' Mantellini 17688ef70478SKees Cook CONFIG_LZO 17698ef70478SKees Cook 17708ef70478SKees Cook If this option is set, support for LZO compressed images 17718ef70478SKees Cook is included. 17728ef70478SKees Cook 177317ea1177Swdenk- MII/PHY support: 177417ea1177Swdenk CONFIG_PHY_ADDR 177517ea1177Swdenk 177617ea1177Swdenk The address of PHY on MII bus. 177717ea1177Swdenk 177817ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 177917ea1177Swdenk 178017ea1177Swdenk The clock frequency of the MII bus 178117ea1177Swdenk 178217ea1177Swdenk CONFIG_PHY_GIGE 178317ea1177Swdenk 178417ea1177Swdenk If this option is set, support for speed/duplex 178511ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 178617ea1177Swdenk 178717ea1177Swdenk CONFIG_PHY_RESET_DELAY 178817ea1177Swdenk 178917ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 179017ea1177Swdenk reset before any MII register access is possible. 179117ea1177Swdenk For such PHY, set this option to the usec delay 179217ea1177Swdenk required. (minimum 300usec for LXT971A) 179317ea1177Swdenk 179417ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 179517ea1177Swdenk 179617ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 179717ea1177Swdenk command issued before MII status register can be read 179817ea1177Swdenk 1799c609719bSwdenk- IP address: 1800c609719bSwdenk CONFIG_IPADDR 1801c609719bSwdenk 1802c609719bSwdenk Define a default value for the IP address to use for 180311ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1804c609719bSwdenk determined through e.g. bootp. 18051ebcd654SWolfgang Denk (Environment variable "ipaddr") 1806c609719bSwdenk 1807c609719bSwdenk- Server IP address: 1808c609719bSwdenk CONFIG_SERVERIP 1809c609719bSwdenk 1810c609719bSwdenk Defines a default value for the IP address of a TFTP 1811c609719bSwdenk server to contact when using the "tftboot" command. 18121ebcd654SWolfgang Denk (Environment variable "serverip") 1813c609719bSwdenk 181497cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 181597cfe861SRobin Getz 181697cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 181797cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 181897cfe861SRobin Getz 18191ebcd654SWolfgang Denk- Gateway IP address: 18201ebcd654SWolfgang Denk CONFIG_GATEWAYIP 18211ebcd654SWolfgang Denk 18221ebcd654SWolfgang Denk Defines a default value for the IP address of the 18231ebcd654SWolfgang Denk default router where packets to other networks are 18241ebcd654SWolfgang Denk sent to. 18251ebcd654SWolfgang Denk (Environment variable "gatewayip") 18261ebcd654SWolfgang Denk 18271ebcd654SWolfgang Denk- Subnet mask: 18281ebcd654SWolfgang Denk CONFIG_NETMASK 18291ebcd654SWolfgang Denk 18301ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 18311ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 18321ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 18331ebcd654SWolfgang Denk forwarded through a router. 18341ebcd654SWolfgang Denk (Environment variable "netmask") 18351ebcd654SWolfgang Denk 183653a5c424SDavid Updegraff- Multicast TFTP Mode: 183753a5c424SDavid Updegraff CONFIG_MCAST_TFTP 183853a5c424SDavid Updegraff 183953a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 184053a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 184111ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 184253a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 184353a5c424SDavid Updegraff multicast group. 184453a5c424SDavid Updegraff 1845c609719bSwdenk- BOOTP Recovery Mode: 1846c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1847c609719bSwdenk 1848c609719bSwdenk If you have many targets in a network that try to 1849c609719bSwdenk boot using BOOTP, you may want to avoid that all 1850c609719bSwdenk systems send out BOOTP requests at precisely the same 1851c609719bSwdenk moment (which would happen for instance at recovery 1852c609719bSwdenk from a power failure, when all systems will try to 1853c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1854c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1855c609719bSwdenk inserted before sending out BOOTP requests. The 18566c33c785SWolfgang Denk following delays are inserted then: 1857c609719bSwdenk 1858c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1859c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1860c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1861c609719bSwdenk 4th and following 1862c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1863c609719bSwdenk 186492ac8accSThierry Reding CONFIG_BOOTP_ID_CACHE_SIZE 186592ac8accSThierry Reding 186692ac8accSThierry Reding BOOTP packets are uniquely identified using a 32-bit ID. The 186792ac8accSThierry Reding server will copy the ID from client requests to responses and 186892ac8accSThierry Reding U-Boot will use this to determine if it is the destination of 186992ac8accSThierry Reding an incoming response. Some servers will check that addresses 187092ac8accSThierry Reding aren't in use before handing them out (usually using an ARP 187192ac8accSThierry Reding ping) and therefore take up to a few hundred milliseconds to 187292ac8accSThierry Reding respond. Network congestion may also influence the time it 187392ac8accSThierry Reding takes for a response to make it back to the client. If that 187492ac8accSThierry Reding time is too long, U-Boot will retransmit requests. In order 187592ac8accSThierry Reding to allow earlier responses to still be accepted after these 187692ac8accSThierry Reding retransmissions, U-Boot's BOOTP client keeps a small cache of 187792ac8accSThierry Reding IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this 187892ac8accSThierry Reding cache. The default is to keep IDs for up to four outstanding 187992ac8accSThierry Reding requests. Increasing this will allow U-Boot to accept offers 188092ac8accSThierry Reding from a BOOTP client in networks with unusually high latency. 188192ac8accSThierry Reding 1882fe389a82Sstroese- DHCP Advanced Options: 18831fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 18841fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1885fe389a82Sstroese 18861fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 18871fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 18881fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 18891fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 18901fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 18911fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 18921fe80d79SJon Loeliger CONFIG_BOOTP_DNS 18931fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 18941fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 18951fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 18961fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 18971fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 18982c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1899fe389a82Sstroese 19005d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 19015d110f0aSWilson Callan environment variable, not the BOOTP server. 1902fe389a82Sstroese 19032c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 19042c00e099SJoe Hershberger after the configured retry count, the call will fail 19052c00e099SJoe Hershberger instead of starting over. This can be used to fail over 19062c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 19072c00e099SJoe Hershberger is not available. 19082c00e099SJoe Hershberger 1909fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1910fe389a82Sstroese serverip from a DHCP server, it is possible that more 1911fe389a82Sstroese than one DNS serverip is offered to the client. 1912fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1913fe389a82Sstroese serverip will be stored in the additional environment 1914fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1915fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 19161fe80d79SJon Loeliger is defined. 1917fe389a82Sstroese 1918fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1919fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1920fe389a82Sstroese need the hostname of the DHCP requester. 19215d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 19221fe80d79SJon Loeliger of the "hostname" environment variable is passed as 19231fe80d79SJon Loeliger option 12 to the DHCP server. 1924fe389a82Sstroese 1925d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1926d9a2f416SAras Vaichas 1927d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1928d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1929d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1930d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1931d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1932d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1933d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1934d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1935d9a2f416SAras Vaichas that one of the retries will be successful but note that 1936d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1937d9a2f416SAras Vaichas this delay. 1938d9a2f416SAras Vaichas 1939d22c338eSJoe Hershberger - Link-local IP address negotiation: 1940d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1941d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1942d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1943d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1944d22c338eSJoe Hershberger 1945d22c338eSJoe Hershberger See doc/README.link-local for more information. 1946d22c338eSJoe Hershberger 1947a3d991bdSwdenk - CDP Options: 1948a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1949a3d991bdSwdenk 1950a3d991bdSwdenk The device id used in CDP trigger frames. 1951a3d991bdSwdenk 1952a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1953a3d991bdSwdenk 1954a3d991bdSwdenk A two character string which is prefixed to the MAC address 1955a3d991bdSwdenk of the device. 1956a3d991bdSwdenk 1957a3d991bdSwdenk CONFIG_CDP_PORT_ID 1958a3d991bdSwdenk 1959a3d991bdSwdenk A printf format string which contains the ascii name of 1960a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 196111ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1962a3d991bdSwdenk 1963a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1964a3d991bdSwdenk 1965a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1966a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1967a3d991bdSwdenk 1968a3d991bdSwdenk CONFIG_CDP_VERSION 1969a3d991bdSwdenk 1970a3d991bdSwdenk An ascii string containing the version of the software. 1971a3d991bdSwdenk 1972a3d991bdSwdenk CONFIG_CDP_PLATFORM 1973a3d991bdSwdenk 1974a3d991bdSwdenk An ascii string containing the name of the platform. 1975a3d991bdSwdenk 1976a3d991bdSwdenk CONFIG_CDP_TRIGGER 1977a3d991bdSwdenk 1978a3d991bdSwdenk A 32bit integer sent on the trigger. 1979a3d991bdSwdenk 1980a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1981a3d991bdSwdenk 1982a3d991bdSwdenk A 16bit integer containing the power consumption of the 1983a3d991bdSwdenk device in .1 of milliwatts. 1984a3d991bdSwdenk 1985a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1986a3d991bdSwdenk 1987a3d991bdSwdenk A byte containing the id of the VLAN. 1988a3d991bdSwdenk 198979267eddSUri Mashiach- Status LED: CONFIG_LED_STATUS 1990c609719bSwdenk 1991c609719bSwdenk Several configurations allow to display the current 1992c609719bSwdenk status using a LED. For instance, the LED will blink 1993c609719bSwdenk fast while running U-Boot code, stop blinking as 1994c609719bSwdenk soon as a reply to a BOOTP request was received, and 1995c609719bSwdenk start blinking slow once the Linux kernel is running 1996c609719bSwdenk (supported by a status LED driver in the Linux 199779267eddSUri Mashiach kernel). Defining CONFIG_LED_STATUS enables this 1998c609719bSwdenk feature in U-Boot. 1999c609719bSwdenk 20001df7bbbaSIgor Grinberg Additional options: 20011df7bbbaSIgor Grinberg 200279267eddSUri Mashiach CONFIG_LED_STATUS_GPIO 20031df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 20041df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 200579267eddSUri Mashiach status LED backend implementation. Define CONFIG_LED_STATUS_GPIO 20061df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 20071df7bbbaSIgor Grinberg 20089dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 20099dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 20109dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 20119dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 20129dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 20139dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 20149dfdcdfeSIgor Grinberg 2015c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 2016c609719bSwdenk 2017c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 2018c609719bSwdenk on those systems that support this (optional) 2019c609719bSwdenk feature, like the TQM8xxL modules. 2020c609719bSwdenk 20213f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 2022c609719bSwdenk 20233f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 20243f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 20253f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 20263f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 20273f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 20283f4978c7SHeiko Schocher interface. 20293f4978c7SHeiko Schocher 20303f4978c7SHeiko Schocher ported i2c driver to the new framework: 2031ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 2032ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 2033ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2034ea818dbbSHeiko Schocher for defining speed and slave address 2035ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 2036ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2037ea818dbbSHeiko Schocher for defining speed and slave address 2038ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 2039ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2040ea818dbbSHeiko Schocher for defining speed and slave address 2041ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2042ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2043ea818dbbSHeiko Schocher for defining speed and slave address 20443f4978c7SHeiko Schocher 204500f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 204600f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 204700f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 204800f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 204900f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 205000f792e0SHeiko Schocher bus. 205100f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 205200f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 205300f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 205400f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 205500f792e0SHeiko Schocher second bus. 205600f792e0SHeiko Schocher 20571f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 20581f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 20591f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 20601f2ba722SSimon Glass 100000 and the slave addr 0! 20611f2ba722SSimon Glass 2062880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 2063880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 2064880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2065880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2066880540deSDirk Eibach 2067fac96408Strem - drivers/i2c/i2c_mxc.c 2068fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 206903544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 207003544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 207103544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 207203544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 2073fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2074fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2075fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2076fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2077fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2078fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 207903544c66SAlbert ARIBAUD \\(3ADEV\\) - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED 208003544c66SAlbert ARIBAUD \\(3ADEV\\) - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE 2081b445bbb4SJeremiah Mahler If those defines are not set, default value is 100000 2082fac96408Strem for speed, and 0 for slave. 2083fac96408Strem 20841086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 20851086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 20861086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 20871086bfa9SNobuhiro Iwamatsu 20881086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 20891086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 20901086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 20911086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 20921086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 20931086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 20941086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 20951086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 20961086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 20971086bfa9SNobuhiro Iwamatsu 20982035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 20992035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 21002035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 21012035d77dSNobuhiro Iwamatsu 21022035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 21032035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 21042035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 21052035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 21062035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 21072035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 21082035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 21092035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 21102035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 21112035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 2112b445bbb4SJeremiah Mahler - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses 21132035d77dSNobuhiro Iwamatsu 21146789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 21156789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 21166789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 21176789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 21186789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 21196789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 21206789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 21216789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 21226789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 21236789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 21246789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 21256789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 21266789e84eSHeiko Schocher 21270bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 21280bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 21290bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 21300bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 21310bdffe71SHeiko Schocher 2132e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 2133e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 2134e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 2135e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 2136e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 2137e717fc6dSNaveen Krishna Ch 2138b46226bdSDirk Eibach - drivers/i2c/ihs_i2c.c 2139b46226bdSDirk Eibach - activate this driver with CONFIG_SYS_I2C_IHS 2140b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 2141b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 2142b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 2143b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 2144b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 2145b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 2146b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 2147b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 2148b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 2149b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 2150b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 2151b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 2152071be896SDirk Eibach - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL 2153071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 2154071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 2155071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 2156071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 2157071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 2158071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 2159071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 2160071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 2161b46226bdSDirk Eibach 21623f4978c7SHeiko Schocher additional defines: 21633f4978c7SHeiko Schocher 21643f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 2165945a18e6SSimon Glass Hold the number of i2c buses you want to use. 21663f4978c7SHeiko Schocher 21673f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 21683f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 21693f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 21703f4978c7SHeiko Schocher omit this define. 21713f4978c7SHeiko Schocher 21723f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 21733f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 21743f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 21753f4978c7SHeiko Schocher define. 21763f4978c7SHeiko Schocher 21773f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 2178b445bbb4SJeremiah Mahler hold a list of buses you want to use, only used if 21793f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 21803f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 21813f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 21823f4978c7SHeiko Schocher 21833f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 21843f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 21853f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 21863f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 21873f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 21883f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 21893f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 21903f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 21913f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 21923f4978c7SHeiko Schocher } 21933f4978c7SHeiko Schocher 21943f4978c7SHeiko Schocher which defines 21953f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 2196ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2197ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2198ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2199ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2200ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 22013f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 2202ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2203ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 22043f4978c7SHeiko Schocher 22053f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 22063f4978c7SHeiko Schocher 2207ce3b5d69SSimon Glass- Legacy I2C Support: 2208ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2209b37c7e5eSwdenk then the following macros need to be defined (examples are 2210b37c7e5eSwdenk from include/configs/lwmon.h): 2211c609719bSwdenk 2212c609719bSwdenk I2C_INIT 2213c609719bSwdenk 2214b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 2215c609719bSwdenk controller or configure ports. 2216c609719bSwdenk 2217b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2218b37c7e5eSwdenk 2219c609719bSwdenk I2C_PORT 2220c609719bSwdenk 2221c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 2222c609719bSwdenk assumes both bits are on the same port). Valid values 2223c609719bSwdenk are 0..3 for ports A..D. 2224c609719bSwdenk 2225c609719bSwdenk I2C_ACTIVE 2226c609719bSwdenk 2227c609719bSwdenk The code necessary to make the I2C data line active 2228c609719bSwdenk (driven). If the data line is open collector, this 2229c609719bSwdenk define can be null. 2230c609719bSwdenk 2231b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2232b37c7e5eSwdenk 2233c609719bSwdenk I2C_TRISTATE 2234c609719bSwdenk 2235c609719bSwdenk The code necessary to make the I2C data line tri-stated 2236c609719bSwdenk (inactive). If the data line is open collector, this 2237c609719bSwdenk define can be null. 2238c609719bSwdenk 2239b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2240b37c7e5eSwdenk 2241c609719bSwdenk I2C_READ 2242c609719bSwdenk 2243472d5460SYork Sun Code that returns true if the I2C data line is high, 2244472d5460SYork Sun false if it is low. 2245c609719bSwdenk 2246b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2247b37c7e5eSwdenk 2248c609719bSwdenk I2C_SDA(bit) 2249c609719bSwdenk 2250472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2251472d5460SYork Sun is false, it clears it (low). 2252c609719bSwdenk 2253b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2254b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2255b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2256b37c7e5eSwdenk 2257c609719bSwdenk I2C_SCL(bit) 2258c609719bSwdenk 2259472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2260472d5460SYork Sun is false, it clears it (low). 2261c609719bSwdenk 2262b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2263b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2264b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2265b37c7e5eSwdenk 2266c609719bSwdenk I2C_DELAY 2267c609719bSwdenk 2268c609719bSwdenk This delay is invoked four times per clock cycle so this 2269c609719bSwdenk controls the rate of data transfer. The data rate thus 2270b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2271b37c7e5eSwdenk like: 2272b37c7e5eSwdenk 2273b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2274c609719bSwdenk 2275793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2276793b5726SMike Frysinger 2277793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2278793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2279793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2280793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2281793b5726SMike Frysinger 2282793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2283793b5726SMike Frysinger the generic GPIO functions. 2284793b5726SMike Frysinger 22856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 228647cd00faSwdenk 228747cd00faSwdenk When a board is reset during an i2c bus transfer 228847cd00faSwdenk chips might think that the current transfer is still 228947cd00faSwdenk in progress. On some boards it is possible to access 229047cd00faSwdenk the i2c SCLK line directly, either by using the 229147cd00faSwdenk processor pin as a GPIO or by having a second pin 229247cd00faSwdenk connected to the bus. If this option is defined a 229347cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 229447cd00faSwdenk is run early in the boot sequence. 229547cd00faSwdenk 2296bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2297bb99ad6dSBen Warren 2298bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2299bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2300bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2301bb99ad6dSBen Warren Note that bus numbering is zero-based. 2302bb99ad6dSBen Warren 23036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2304bb99ad6dSBen Warren 2305bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 23060f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 23070f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 23080f89c54bSPeter Tyser a 1D array of device addresses 2309bb99ad6dSBen Warren 2310bb99ad6dSBen Warren e.g. 2311bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 23126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2313bb99ad6dSBen Warren 2314bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2315bb99ad6dSBen Warren 2316bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 2317945a18e6SSimon Glass #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2318bb99ad6dSBen Warren 2319bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2320bb99ad6dSBen Warren 23216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2322be5e6181STimur Tabi 2323be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2324be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2325be5e6181STimur Tabi 23266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 23270dc018ecSStefan Roese 23280dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 23290dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 23300dc018ecSStefan Roese 23316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 23320dc018ecSStefan Roese 23330dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 23340dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 23350dc018ecSStefan Roese 23366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 23379ebbb54fSVictor Gallardo 23389ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 23399ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 23409ebbb54fSVictor Gallardo specified DTT device. 23419ebbb54fSVictor Gallardo 23422ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 23432ac6985aSAndrew Dyer 23442ac6985aSAndrew Dyer defining this will force the i2c_read() function in 23452ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 23462ac6985aSAndrew Dyer between writing the address pointer and reading the 23472ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 23482ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 23492ac6985aSAndrew Dyer devices can use either method, but some require one or 23502ac6985aSAndrew Dyer the other. 2351be5e6181STimur Tabi 2352c609719bSwdenk- SPI Support: CONFIG_SPI 2353c609719bSwdenk 2354c609719bSwdenk Enables SPI driver (so far only tested with 2355c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2356c609719bSwdenk D/As on the SACSng board) 2357c609719bSwdenk 23586639562eSYoshihiro Shimoda CONFIG_SH_SPI 23596639562eSYoshihiro Shimoda 23606639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 23616639562eSYoshihiro Shimoda only SH7757 is supported. 23626639562eSYoshihiro Shimoda 2363c609719bSwdenk CONFIG_SOFT_SPI 2364c609719bSwdenk 2365c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2366c609719bSwdenk using hardware support. This is a general purpose 2367c609719bSwdenk driver that only requires three general I/O port pins 2368c609719bSwdenk (two outputs, one input) to function. If this is 2369c609719bSwdenk defined, the board configuration must define several 2370c609719bSwdenk SPI configuration items (port pins to use, etc). For 2371c609719bSwdenk an example, see include/configs/sacsng.h. 2372c609719bSwdenk 237304a9e118SBen Warren CONFIG_HARD_SPI 237404a9e118SBen Warren 237504a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 237604a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 237704a9e118SBen Warren must define a list of chip-select function pointers. 237804a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 237904a9e118SBen Warren example, see include/configs/mpc8349emds.h. 238004a9e118SBen Warren 238138254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 238238254f45SGuennadi Liakhovetski 238338254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 23842e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 238538254f45SGuennadi Liakhovetski 2386f659b573SHeiko Schocher CONFIG_SYS_SPI_MXC_WAIT 2387f659b573SHeiko Schocher Timeout for waiting until spi transfer completed. 2388f659b573SHeiko Schocher default: (CONFIG_SYS_HZ/100) /* 10 ms */ 2389f659b573SHeiko Schocher 23900133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 23910133502eSMatthias Fuchs 23920133502eSMatthias Fuchs Enables FPGA subsystem. 23930133502eSMatthias Fuchs 23940133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 23950133502eSMatthias Fuchs 23960133502eSMatthias Fuchs Enables support for specific chip vendors. 23970133502eSMatthias Fuchs (ALTERA, XILINX) 23980133502eSMatthias Fuchs 23990133502eSMatthias Fuchs CONFIG_FPGA_<family> 24000133502eSMatthias Fuchs 24010133502eSMatthias Fuchs Enables support for FPGA family. 24020133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 24030133502eSMatthias Fuchs 24040133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2405c609719bSwdenk 2406c609719bSwdenk Specify the number of FPGA devices to support. 2407c609719bSwdenk 240864e809afSSiva Durga Prasad Paladugu CONFIG_CMD_FPGA_LOADMK 240964e809afSSiva Durga Prasad Paladugu 241064e809afSSiva Durga Prasad Paladugu Enable support for fpga loadmk command 241164e809afSSiva Durga Prasad Paladugu 241267193864SMichal Simek CONFIG_CMD_FPGA_LOADP 241367193864SMichal Simek 241467193864SMichal Simek Enable support for fpga loadp command - load partial bitstream 241567193864SMichal Simek 241667193864SMichal Simek CONFIG_CMD_FPGA_LOADBP 241767193864SMichal Simek 241867193864SMichal Simek Enable support for fpga loadbp command - load partial bitstream 241967193864SMichal Simek (Xilinx only) 242067193864SMichal Simek 24216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2422c609719bSwdenk 2423c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2424c609719bSwdenk 24256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2426c609719bSwdenk 2427c609719bSwdenk Enable checks on FPGA configuration interface busy 2428c609719bSwdenk status by the configuration function. This option 2429c609719bSwdenk will require a board or device specific function to 2430c609719bSwdenk be written. 2431c609719bSwdenk 2432c609719bSwdenk CONFIG_FPGA_DELAY 2433c609719bSwdenk 2434c609719bSwdenk If defined, a function that provides delays in the FPGA 2435c609719bSwdenk configuration driver. 2436c609719bSwdenk 24376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2438c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2439c609719bSwdenk 24406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2441c609719bSwdenk 2442c609719bSwdenk Check for configuration errors during FPGA bitfile 2443c609719bSwdenk loading. For example, abort during Virtex II 2444c609719bSwdenk configuration if the INIT_B line goes low (which 2445c609719bSwdenk indicated a CRC error). 2446c609719bSwdenk 24476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2448c609719bSwdenk 2449b445bbb4SJeremiah Mahler Maximum time to wait for the INIT_B line to de-assert 2450b445bbb4SJeremiah Mahler after PROB_B has been de-asserted during a Virtex II 2451c609719bSwdenk FPGA configuration sequence. The default time is 500 245211ccc33fSMarcel Ziswiler ms. 2453c609719bSwdenk 24546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2455c609719bSwdenk 2456b445bbb4SJeremiah Mahler Maximum time to wait for BUSY to de-assert during 245711ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2458c609719bSwdenk 24596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2460c609719bSwdenk 2461c609719bSwdenk Time to wait after FPGA configuration. The default is 246211ccc33fSMarcel Ziswiler 200 ms. 2463c609719bSwdenk 2464c609719bSwdenk- Configuration Management: 2465b2b8a696SStefan Roese CONFIG_BUILD_TARGET 2466b2b8a696SStefan Roese 2467b2b8a696SStefan Roese Some SoCs need special image types (e.g. U-Boot binary 2468b2b8a696SStefan Roese with a special header) as build targets. By defining 2469b2b8a696SStefan Roese CONFIG_BUILD_TARGET in the SoC / board header, this 2470b2b8a696SStefan Roese special image will be automatically built upon calling 24716de80f21SSimon Glass make / buildman. 2472b2b8a696SStefan Roese 2473c609719bSwdenk CONFIG_IDENT_STRING 2474c609719bSwdenk 2475c609719bSwdenk If defined, this string will be added to the U-Boot 2476c609719bSwdenk version information (U_BOOT_VERSION) 2477c609719bSwdenk 2478c609719bSwdenk- Vendor Parameter Protection: 2479c609719bSwdenk 2480c609719bSwdenk U-Boot considers the values of the environment 2481c609719bSwdenk variables "serial#" (Board Serial Number) and 24827152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2483c609719bSwdenk are set once by the board vendor / manufacturer, and 2484c609719bSwdenk protects these variables from casual modification by 2485c609719bSwdenk the user. Once set, these variables are read-only, 2486c609719bSwdenk and write or delete attempts are rejected. You can 248711ccc33fSMarcel Ziswiler change this behaviour: 2488c609719bSwdenk 2489c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2490c609719bSwdenk file, the write protection for vendor parameters is 249147cd00faSwdenk completely disabled. Anybody can change or delete 2492c609719bSwdenk these parameters. 2493c609719bSwdenk 249492ac5208SJoe Hershberger Alternatively, if you define _both_ an ethaddr in the 249592ac5208SJoe Hershberger default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 249611ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2497c609719bSwdenk which can be changed exactly ONCE by the user. [The 2498c609719bSwdenk serial# is unaffected by this, i. e. it remains 2499c609719bSwdenk read-only.] 2500c609719bSwdenk 25012598090bSJoe Hershberger The same can be accomplished in a more flexible way 25022598090bSJoe Hershberger for any variable by configuring the type of access 25032598090bSJoe Hershberger to allow for those variables in the ".flags" variable 25042598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 25052598090bSJoe Hershberger 2506c609719bSwdenk- Protected RAM: 2507c609719bSwdenk CONFIG_PRAM 2508c609719bSwdenk 2509c609719bSwdenk Define this variable to enable the reservation of 2510c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2511c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2512c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2513c609719bSwdenk this default value by defining an environment 2514c609719bSwdenk variable "pram" to the number of kB you want to 2515c609719bSwdenk reserve. Note that the board info structure will 2516c609719bSwdenk still show the full amount of RAM. If pRAM is 2517c609719bSwdenk reserved, a new environment variable "mem" will 2518c609719bSwdenk automatically be defined to hold the amount of 2519c609719bSwdenk remaining RAM in a form that can be passed as boot 2520c609719bSwdenk argument to Linux, for instance like that: 2521c609719bSwdenk 2522fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2523c609719bSwdenk saveenv 2524c609719bSwdenk 2525c609719bSwdenk This way you can tell Linux not to use this memory, 2526c609719bSwdenk either, which results in a memory region that will 2527c609719bSwdenk not be affected by reboots. 2528c609719bSwdenk 2529c609719bSwdenk *WARNING* If your board configuration uses automatic 2530c609719bSwdenk detection of the RAM size, you must make sure that 2531c609719bSwdenk this memory test is non-destructive. So far, the 2532c609719bSwdenk following board configurations are known to be 2533c609719bSwdenk "pRAM-clean": 2534c609719bSwdenk 25351b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 25361b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2537544d97e9SWolfgang Denk FLAGADM, TQM8260 2538c609719bSwdenk 253940fef049SGabe Black- Access to physical memory region (> 4GB) 254040fef049SGabe Black Some basic support is provided for operations on memory not 254140fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 254240fef049SGabe Black support access to more than 4GB of memory on 32-bit 254340fef049SGabe Black machines using physical address extension or similar. 254440fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 254540fef049SGabe Black currently only supports clearing the memory. 254640fef049SGabe Black 2547c609719bSwdenk- Error Recovery: 2548c609719bSwdenk CONFIG_PANIC_HANG 2549c609719bSwdenk 2550c609719bSwdenk Define this variable to stop the system in case of a 2551c609719bSwdenk fatal error, so that you have to reset it manually. 2552c609719bSwdenk This is probably NOT a good idea for an embedded 255311ccc33fSMarcel Ziswiler system where you want the system to reboot 2554c609719bSwdenk automatically as fast as possible, but it may be 2555c609719bSwdenk useful during development since you can try to debug 2556c609719bSwdenk the conditions that lead to the situation. 2557c609719bSwdenk 2558c609719bSwdenk CONFIG_NET_RETRY_COUNT 2559c609719bSwdenk 2560c609719bSwdenk This variable defines the number of retries for 2561c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2562c609719bSwdenk before giving up the operation. If not defined, a 2563c609719bSwdenk default value of 5 is used. 2564c609719bSwdenk 256540cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 256640cb90eeSGuennadi Liakhovetski 256740cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 256840cb90eeSGuennadi Liakhovetski 256948a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 257048a3e999STetsuyuki Kobayashi 257148a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 257248a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 257348a3e999STetsuyuki Kobayashi try longer timeout such as 257448a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 257548a3e999STetsuyuki Kobayashi 2576c609719bSwdenk- Command Interpreter: 25778078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 257804a85b3bSwdenk 257904a85b3bSwdenk Enable auto completion of commands using TAB. 258004a85b3bSwdenk 25816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2582c609719bSwdenk 2583c609719bSwdenk This defines the secondary prompt string, which is 2584c609719bSwdenk printed when the command interpreter needs more input 2585c609719bSwdenk to complete a command. Usually "> ". 2586c609719bSwdenk 2587c609719bSwdenk Note: 2588c609719bSwdenk 2589c609719bSwdenk In the current implementation, the local variables 2590c609719bSwdenk space and global environment variables space are 2591c609719bSwdenk separated. Local variables are those you define by 25923b57fe0aSwdenk simply typing `name=value'. To access a local 2593c609719bSwdenk variable later on, you have write `$name' or 25943b57fe0aSwdenk `${name}'; to execute the contents of a variable 25953b57fe0aSwdenk directly type `$name' at the command prompt. 2596c609719bSwdenk 2597c609719bSwdenk Global environment variables are those you use 2598c609719bSwdenk setenv/printenv to work with. To run a command stored 2599c609719bSwdenk in such a variable, you need to use the run command, 2600c609719bSwdenk and you must not use the '$' sign to access them. 2601c609719bSwdenk 2602c609719bSwdenk To store commands and special characters in a 2603c609719bSwdenk variable, please use double quotation marks 2604c609719bSwdenk surrounding the whole text of the variable, instead 2605c609719bSwdenk of the backslashes before semicolons and special 2606c609719bSwdenk symbols. 2607c609719bSwdenk 2608b445bbb4SJeremiah Mahler- Command Line Editing and History: 2609aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2610aa0c71acSWolfgang Denk 261111ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2612aa0c71acSWolfgang Denk command line input operations 2613aa0c71acSWolfgang Denk 2614f3b267b3SMarek Vasut- Command Line PS1/PS2 support: 2615f3b267b3SMarek Vasut CONFIG_CMDLINE_PS_SUPPORT 2616f3b267b3SMarek Vasut 2617f3b267b3SMarek Vasut Enable support for changing the command prompt string 2618f3b267b3SMarek Vasut at run-time. Only static string is supported so far. 2619f3b267b3SMarek Vasut The string is obtained from environment variables PS1 2620f3b267b3SMarek Vasut and PS2. 2621f3b267b3SMarek Vasut 2622a8c7c708Swdenk- Default Environment: 2623c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2624c609719bSwdenk 2625c609719bSwdenk Define this to contain any number of null terminated 2626c609719bSwdenk strings (variable = value pairs) that will be part of 26277152b1d0Swdenk the default environment compiled into the boot image. 26282262cfeeSwdenk 2629c609719bSwdenk For example, place something like this in your 2630c609719bSwdenk board's config file: 2631c609719bSwdenk 2632c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2633c609719bSwdenk "myvar1=value1\0" \ 2634c609719bSwdenk "myvar2=value2\0" 2635c609719bSwdenk 2636c609719bSwdenk Warning: This method is based on knowledge about the 2637c609719bSwdenk internal format how the environment is stored by the 26382262cfeeSwdenk U-Boot code. This is NOT an official, exported 2639c609719bSwdenk interface! Although it is unlikely that this format 26407152b1d0Swdenk will change soon, there is no guarantee either. 2641c609719bSwdenk You better know what you are doing here. 2642c609719bSwdenk 2643c609719bSwdenk Note: overly (ab)use of the default environment is 2644c609719bSwdenk discouraged. Make sure to check other ways to preset 264574de7aefSWolfgang Denk the environment like the "source" command or the 2646c609719bSwdenk boot command first. 2647c609719bSwdenk 26485e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 26495e724ca2SStephen Warren 26505e724ca2SStephen Warren Define this in order to add variables describing the 26515e724ca2SStephen Warren U-Boot build configuration to the default environment. 26525e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 26535e724ca2SStephen Warren 26545e724ca2SStephen Warren Enabling this option will cause the following to be defined: 26555e724ca2SStephen Warren 26565e724ca2SStephen Warren - CONFIG_SYS_ARCH 26575e724ca2SStephen Warren - CONFIG_SYS_CPU 26585e724ca2SStephen Warren - CONFIG_SYS_BOARD 26595e724ca2SStephen Warren - CONFIG_SYS_VENDOR 26605e724ca2SStephen Warren - CONFIG_SYS_SOC 26615e724ca2SStephen Warren 26627e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 26637e27f89fSTom Rini 26647e27f89fSTom Rini Define this in order to add variables describing certain 26657e27f89fSTom Rini run-time determined information about the hardware to the 26667e27f89fSTom Rini environment. These will be named board_name, board_rev. 26677e27f89fSTom Rini 266806fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 266906fd8538SSimon Glass 267006fd8538SSimon Glass Normally the environment is loaded when the board is 2671b445bbb4SJeremiah Mahler initialised so that it is available to U-Boot. This inhibits 267206fd8538SSimon Glass that so that the environment is not available until 267306fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 267406fd8538SSimon Glass this is instead controlled by the value of 267506fd8538SSimon Glass /config/load-environment. 267606fd8538SSimon Glass 2677a8c7c708Swdenk- DataFlash Support: 26782abbe075Swdenk CONFIG_HAS_DATAFLASH 26792abbe075Swdenk 26802abbe075Swdenk Defining this option enables DataFlash features and 26812abbe075Swdenk allows to read/write in Dataflash via the standard 26822abbe075Swdenk commands cp, md... 26832abbe075Swdenk 2684f61ec45eSEric Nelson- Serial Flash support 2685f61ec45eSEric Nelson CONFIG_CMD_SF 2686f61ec45eSEric Nelson 2687f61ec45eSEric Nelson Defining this option enables SPI flash commands 2688f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2689f61ec45eSEric Nelson 2690f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2691f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2692f61ec45eSEric Nelson commands. 2693f61ec45eSEric Nelson 2694f61ec45eSEric Nelson The following defaults may be provided by the platform 2695f61ec45eSEric Nelson to handle the common case when only a single serial 2696f61ec45eSEric Nelson flash is present on the system. 2697f61ec45eSEric Nelson 2698f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2699f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2700f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2701f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2702f61ec45eSEric Nelson 270324007273SSimon Glass CONFIG_CMD_SF_TEST 270424007273SSimon Glass 270524007273SSimon Glass Define this option to include a destructive SPI flash 270624007273SSimon Glass test ('sf test'). 270724007273SSimon Glass 2708b902e07cSJagannadha Sutradharudu Teki CONFIG_SF_DUAL_FLASH Dual flash memories 2709b902e07cSJagannadha Sutradharudu Teki 2710b902e07cSJagannadha Sutradharudu Teki Define this option to use dual flash support where two flash 2711b902e07cSJagannadha Sutradharudu Teki memories can be connected with a given cs line. 2712b445bbb4SJeremiah Mahler Currently Xilinx Zynq qspi supports these type of connections. 2713b902e07cSJagannadha Sutradharudu Teki 27143f85ce27Swdenk- SystemACE Support: 27153f85ce27Swdenk CONFIG_SYSTEMACE 27163f85ce27Swdenk 27173f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 27183f85ce27Swdenk chips attached via some sort of local bus. The address 271911ccc33fSMarcel Ziswiler of the chip must also be defined in the 27206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 27213f85ce27Swdenk 27223f85ce27Swdenk #define CONFIG_SYSTEMACE 27236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 27243f85ce27Swdenk 27253f85ce27Swdenk When SystemACE support is added, the "ace" device type 27263f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 27273f85ce27Swdenk 2728ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2729ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2730ecb0ccd9SWolfgang Denk 273128cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2732ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 273328cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2734ecb0ccd9SWolfgang Denk number generator is used. 2735ecb0ccd9SWolfgang Denk 273628cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 273728cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 273828cb9375SWolfgang Denk defined, the normal port 69 is used. 273928cb9375SWolfgang Denk 274028cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2741ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2742ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2743ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2744ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2745ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2746ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2747ecb0ccd9SWolfgang Denk 2748bf36c5d5SSimon Glass- Hashing support: 2749bf36c5d5SSimon Glass CONFIG_CMD_HASH 2750bf36c5d5SSimon Glass 2751bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 2752bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2753bf36c5d5SSimon Glass 2754bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 2755bf36c5d5SSimon Glass 2756bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 2757bf36c5d5SSimon Glass size a little. 2758bf36c5d5SSimon Glass 275994e3c8c4Sgaurav rana CONFIG_SHA1 - This option enables support of hashing using SHA1 276094e3c8c4Sgaurav rana algorithm. The hash is calculated in software. 276194e3c8c4Sgaurav rana CONFIG_SHA256 - This option enables support of hashing using 276294e3c8c4Sgaurav rana SHA256 algorithm. The hash is calculated in software. 276394e3c8c4Sgaurav rana CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration 276494e3c8c4Sgaurav rana for SHA1/SHA256 hashing. 276594e3c8c4Sgaurav rana This affects the 'hash' command and also the 276694e3c8c4Sgaurav rana hash_lookup_algo() function. 276794e3c8c4Sgaurav rana CONFIG_SHA_PROG_HW_ACCEL - This option enables 276894e3c8c4Sgaurav rana hardware-acceleration for SHA1/SHA256 progressive hashing. 276994e3c8c4Sgaurav rana Data can be streamed in a block at a time and the hashing 277094e3c8c4Sgaurav rana is performed in hardware. 2771bf36c5d5SSimon Glass 2772bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 2773bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 2774bf36c5d5SSimon Glass 2775a11f1873SRobert Winkler- Freescale i.MX specific commands: 2776a11f1873SRobert Winkler CONFIG_CMD_HDMIDETECT 2777a11f1873SRobert Winkler This enables 'hdmidet' command which returns true if an 2778a11f1873SRobert Winkler HDMI monitor is detected. This command is i.MX 6 specific. 2779a11f1873SRobert Winkler 27809e50c406SHeiko Schocher- bootcount support: 27819e50c406SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 27829e50c406SHeiko Schocher 27839e50c406SHeiko Schocher This enables the bootcounter support, see: 27849e50c406SHeiko Schocher http://www.denx.de/wiki/DULG/UBootBootCountLimit 27859e50c406SHeiko Schocher 27869e50c406SHeiko Schocher CONFIG_AT91SAM9XE 27879e50c406SHeiko Schocher enable special bootcounter support on at91sam9xe based boards. 27889e50c406SHeiko Schocher CONFIG_SOC_DA8XX 27899e50c406SHeiko Schocher enable special bootcounter support on da850 based boards. 27909e50c406SHeiko Schocher CONFIG_BOOTCOUNT_RAM 27919e50c406SHeiko Schocher enable support for the bootcounter in RAM 27929e50c406SHeiko Schocher CONFIG_BOOTCOUNT_I2C 27939e50c406SHeiko Schocher enable support for the bootcounter on an i2c (like RTC) device. 27949e50c406SHeiko Schocher CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 27959e50c406SHeiko Schocher CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 27969e50c406SHeiko Schocher the bootcounter. 27979e50c406SHeiko Schocher CONFIG_BOOTCOUNT_ALEN = address len 279819c402afSSimon Glass 2799a8c7c708Swdenk- Show boot progress: 2800c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2801c609719bSwdenk 2802c609719bSwdenk Defining this option allows to add some board- 2803c609719bSwdenk specific code (calling a user-provided function 2804c609719bSwdenk "show_boot_progress(int)") that enables you to show 2805c609719bSwdenk the system's boot progress on some display (for 2806c609719bSwdenk example, some LED's) on your board. At the moment, 2807c609719bSwdenk the following checkpoints are implemented: 2808c609719bSwdenk 280994fd1316SSimon Glass 28101372cce2SMarian BalakowiczLegacy uImage format: 28111372cce2SMarian Balakowicz 2812c609719bSwdenk Arg Where When 2813c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2814c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2815c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2816c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2817c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2818c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2819c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2820c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2821c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 28221372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2823c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2824c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2825c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2826c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 28271372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2828c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 28291372cce2SMarian Balakowicz 28301372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 28311372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 28321372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 28331372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 28341372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 28351372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 28361372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 283711ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 28381372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 28391372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 28401372cce2SMarian Balakowicz 2841ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2842c609719bSwdenk 2843a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 284463e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 284563e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 284663e73c9aSwdenk 2847566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2848566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2849566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2850566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2851566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2852566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2853566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2854566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2855566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2856566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2857566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2858566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2859566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2860566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2861566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2862566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2863566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2864566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2865566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2866566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2867566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2868566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2869566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2870566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2871566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2872566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2873566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2874566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2875566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2876566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2877566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2878566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2879566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2880566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2881566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2882566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2883566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2884566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2885566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2886566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2887566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2888566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2889566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2890566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2891566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2892566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2893566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2894c609719bSwdenk 2895566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2896c609719bSwdenk 2897566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2898566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2899566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2900206c60cbSwdenk 2901566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2902bc0571fcSJoe Hershberger 80 common/cmd_net.c before calling net_loop() 2903bc0571fcSJoe Hershberger -81 common/cmd_net.c some error in net_loop() occurred 2904bc0571fcSJoe Hershberger 81 common/cmd_net.c net_loop() back without error 2905566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2906566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 290774de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 290874de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2909566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2910c609719bSwdenk 29111372cce2SMarian BalakowiczFIT uImage format: 29121372cce2SMarian Balakowicz 29131372cce2SMarian Balakowicz Arg Where When 29141372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 29151372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 29161372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 29171372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 29181372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 29191372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2920f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 29211372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 29221372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 29231372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 29241372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 29251372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 292611ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 292711ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 29281372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 29291372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 29301372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 29311372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 29321372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 29331372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 29341372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 29351372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 29361372cce2SMarian Balakowicz 29371372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 29381372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 29391372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 294011ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 29411372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 29421372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 29431372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 29441372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 29451372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 29461372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 29471372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 29481372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 29491372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 29501372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 29511372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 29521372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 29531372cce2SMarian Balakowicz 295411ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 29551372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 29561372cce2SMarian Balakowicz 295711ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 29581372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 29591372cce2SMarian Balakowicz 296011ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 29611372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 29621372cce2SMarian Balakowicz 296321d29f7fSHeiko Schocher- legacy image format: 296421d29f7fSHeiko Schocher CONFIG_IMAGE_FORMAT_LEGACY 296521d29f7fSHeiko Schocher enables the legacy image format support in U-Boot. 296621d29f7fSHeiko Schocher 296721d29f7fSHeiko Schocher Default: 296821d29f7fSHeiko Schocher enabled if CONFIG_FIT_SIGNATURE is not defined. 296921d29f7fSHeiko Schocher 297021d29f7fSHeiko Schocher CONFIG_DISABLE_IMAGE_LEGACY 297121d29f7fSHeiko Schocher disable the legacy image format 297221d29f7fSHeiko Schocher 297321d29f7fSHeiko Schocher This define is introduced, as the legacy image format is 297421d29f7fSHeiko Schocher enabled per default for backward compatibility. 297521d29f7fSHeiko Schocher 2976d95f6ec7SGabe Black- FIT image support: 29779a4f479bSDirk Eibach CONFIG_FIT_DISABLE_SHA256 29789a4f479bSDirk Eibach Supporting SHA256 hashes has quite an impact on binary size. 29799a4f479bSDirk Eibach For constrained systems sha256 hash support can be disabled 29809a4f479bSDirk Eibach with this option. 29819a4f479bSDirk Eibach 298273223f0eSSimon Glass TODO(sjg@chromium.org): Adjust this option to be positive, 298373223f0eSSimon Glass and move it to Kconfig 298473223f0eSSimon Glass 29854cf2609bSWolfgang Denk- Standalone program support: 29864cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 29874cf2609bSWolfgang Denk 29886feff899SWolfgang Denk This option defines a board specific value for the 29896feff899SWolfgang Denk address where standalone program gets loaded, thus 29906feff899SWolfgang Denk overwriting the architecture dependent default 29914cf2609bSWolfgang Denk settings. 29924cf2609bSWolfgang Denk 29934cf2609bSWolfgang Denk- Frame Buffer Address: 29944cf2609bSWolfgang Denk CONFIG_FB_ADDR 29954cf2609bSWolfgang Denk 29964cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 299744a53b57SWolfgang Denk address for frame buffer. This is typically the case 299844a53b57SWolfgang Denk when using a graphics controller has separate video 299944a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 300044a53b57SWolfgang Denk the given address instead of dynamically reserving it 300144a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 300244a53b57SWolfgang Denk the memory for the frame buffer depending on the 300344a53b57SWolfgang Denk configured panel size. 30044cf2609bSWolfgang Denk 30054cf2609bSWolfgang Denk Please see board_init_f function. 30064cf2609bSWolfgang Denk 3007cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 3008cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 3009cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 3010cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 3011cccfc2abSDetlev Zundel 3012cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 3013cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 3014cccfc2abSDetlev Zundel 3015cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 3016cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 3017cccfc2abSDetlev Zundel 3018cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 3019cccfc2abSDetlev Zundel Needed for mtdparts command support. 3020cccfc2abSDetlev Zundel 3021cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 3022cccfc2abSDetlev Zundel 3023cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 3024cccfc2abSDetlev Zundel kernel. Needed for UBI support. 3025cccfc2abSDetlev Zundel 302670c219cdSJoe Hershberger- UBI support 302770c219cdSJoe Hershberger CONFIG_CMD_UBI 302870c219cdSJoe Hershberger 302970c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 303070c219cdSJoe Hershberger with the UBI flash translation layer 303170c219cdSJoe Hershberger 303270c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 303370c219cdSJoe Hershberger 3034147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 3035147162daSJoe Hershberger 3036147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 3037147162daSJoe Hershberger warnings and errors enabled. 3038147162daSJoe Hershberger 3039ff94bc40SHeiko Schocher 3040ff94bc40SHeiko Schocher CONFIG_MTD_UBI_WL_THRESHOLD 3041ff94bc40SHeiko Schocher This parameter defines the maximum difference between the highest 3042ff94bc40SHeiko Schocher erase counter value and the lowest erase counter value of eraseblocks 3043ff94bc40SHeiko Schocher of UBI devices. When this threshold is exceeded, UBI starts performing 3044ff94bc40SHeiko Schocher wear leveling by means of moving data from eraseblock with low erase 3045ff94bc40SHeiko Schocher counter to eraseblocks with high erase counter. 3046ff94bc40SHeiko Schocher 3047ff94bc40SHeiko Schocher The default value should be OK for SLC NAND flashes, NOR flashes and 3048ff94bc40SHeiko Schocher other flashes which have eraseblock life-cycle 100000 or more. 3049ff94bc40SHeiko Schocher However, in case of MLC NAND flashes which typically have eraseblock 3050ff94bc40SHeiko Schocher life-cycle less than 10000, the threshold should be lessened (e.g., 3051ff94bc40SHeiko Schocher to 128 or 256, although it does not have to be power of 2). 3052ff94bc40SHeiko Schocher 3053ff94bc40SHeiko Schocher default: 4096 3054ff94bc40SHeiko Schocher 3055ff94bc40SHeiko Schocher CONFIG_MTD_UBI_BEB_LIMIT 3056ff94bc40SHeiko Schocher This option specifies the maximum bad physical eraseblocks UBI 3057ff94bc40SHeiko Schocher expects on the MTD device (per 1024 eraseblocks). If the 3058ff94bc40SHeiko Schocher underlying flash does not admit of bad eraseblocks (e.g. NOR 3059ff94bc40SHeiko Schocher flash), this value is ignored. 3060ff94bc40SHeiko Schocher 3061ff94bc40SHeiko Schocher NAND datasheets often specify the minimum and maximum NVM 3062ff94bc40SHeiko Schocher (Number of Valid Blocks) for the flashes' endurance lifetime. 3063ff94bc40SHeiko Schocher The maximum expected bad eraseblocks per 1024 eraseblocks 3064ff94bc40SHeiko Schocher then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", 3065ff94bc40SHeiko Schocher which gives 20 for most NANDs (MaxNVB is basically the total 3066ff94bc40SHeiko Schocher count of eraseblocks on the chip). 3067ff94bc40SHeiko Schocher 3068ff94bc40SHeiko Schocher To put it differently, if this value is 20, UBI will try to 3069ff94bc40SHeiko Schocher reserve about 1.9% of physical eraseblocks for bad blocks 3070ff94bc40SHeiko Schocher handling. And that will be 1.9% of eraseblocks on the entire 3071ff94bc40SHeiko Schocher NAND chip, not just the MTD partition UBI attaches. This means 3072ff94bc40SHeiko Schocher that if you have, say, a NAND flash chip admits maximum 40 bad 3073ff94bc40SHeiko Schocher eraseblocks, and it is split on two MTD partitions of the same 3074ff94bc40SHeiko Schocher size, UBI will reserve 40 eraseblocks when attaching a 3075ff94bc40SHeiko Schocher partition. 3076ff94bc40SHeiko Schocher 3077ff94bc40SHeiko Schocher default: 20 3078ff94bc40SHeiko Schocher 3079ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP 3080ff94bc40SHeiko Schocher Fastmap is a mechanism which allows attaching an UBI device 3081ff94bc40SHeiko Schocher in nearly constant time. Instead of scanning the whole MTD device it 3082ff94bc40SHeiko Schocher only has to locate a checkpoint (called fastmap) on the device. 3083ff94bc40SHeiko Schocher The on-flash fastmap contains all information needed to attach 3084ff94bc40SHeiko Schocher the device. Using fastmap makes only sense on large devices where 3085ff94bc40SHeiko Schocher attaching by scanning takes long. UBI will not automatically install 3086ff94bc40SHeiko Schocher a fastmap on old images, but you can set the UBI parameter 3087ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note 3088ff94bc40SHeiko Schocher that fastmap-enabled images are still usable with UBI implementations 3089ff94bc40SHeiko Schocher without fastmap support. On typical flash devices the whole fastmap 3090ff94bc40SHeiko Schocher fits into one PEB. UBI will reserve PEBs to hold two fastmaps. 3091ff94bc40SHeiko Schocher 3092ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT 3093ff94bc40SHeiko Schocher Set this parameter to enable fastmap automatically on images 3094ff94bc40SHeiko Schocher without a fastmap. 3095ff94bc40SHeiko Schocher default: 0 3096ff94bc40SHeiko Schocher 30970195a7bbSHeiko Schocher CONFIG_MTD_UBI_FM_DEBUG 30980195a7bbSHeiko Schocher Enable UBI fastmap debug 30990195a7bbSHeiko Schocher default: 0 31000195a7bbSHeiko Schocher 310170c219cdSJoe Hershberger- UBIFS support 310270c219cdSJoe Hershberger CONFIG_CMD_UBIFS 310370c219cdSJoe Hershberger 310470c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 310570c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 310670c219cdSJoe Hershberger 310770c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 310870c219cdSJoe Hershberger 3109147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 3110147162daSJoe Hershberger 3111147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 3112147162daSJoe Hershberger warnings and errors enabled. 3113147162daSJoe Hershberger 31146a11cf48SDaniel Schwierzeck- SPL framework 31156a11cf48SDaniel Schwierzeck CONFIG_SPL 31166a11cf48SDaniel Schwierzeck Enable building of SPL globally. 31176a11cf48SDaniel Schwierzeck 311895579793STom Rini CONFIG_SPL_LDSCRIPT 311995579793STom Rini LDSCRIPT for linking the SPL binary. 312095579793STom Rini 31216ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 31226ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 31236ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 31246ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 31258960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 31266ebc3461SAlbert ARIBAUD must not be both defined at the same time. 31276ebc3461SAlbert ARIBAUD 312895579793STom Rini CONFIG_SPL_MAX_SIZE 31296ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 31306ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 31316ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 31326ebc3461SAlbert ARIBAUD not exceed it. 313395579793STom Rini 31346a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 31356a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 31366a11cf48SDaniel Schwierzeck 313794a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 313894a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 313994a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 314094a45bb1SScott Wood 314195579793STom Rini CONFIG_SPL_BSS_START_ADDR 314295579793STom Rini Link address for the BSS within the SPL binary. 314395579793STom Rini 314495579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 31456ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 31466ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 31476ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 31488960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 31496ebc3461SAlbert ARIBAUD must not be both defined at the same time. 315095579793STom Rini 315195579793STom Rini CONFIG_SPL_STACK 315295579793STom Rini Adress of the start of the stack SPL will use 315395579793STom Rini 31548c80eb3bSAlbert ARIBAUD \(3ADEV\) CONFIG_SPL_PANIC_ON_RAW_IMAGE 31558c80eb3bSAlbert ARIBAUD \(3ADEV\) When defined, SPL will panic() if the image it has 31568c80eb3bSAlbert ARIBAUD \(3ADEV\) loaded does not have a signature. 31578c80eb3bSAlbert ARIBAUD \(3ADEV\) Defining this is useful when code which loads images 31588c80eb3bSAlbert ARIBAUD \(3ADEV\) in SPL cannot guarantee that absolutely all read errors 31598c80eb3bSAlbert ARIBAUD \(3ADEV\) will be caught. 31608c80eb3bSAlbert ARIBAUD \(3ADEV\) An example is the LPC32XX MLC NAND driver, which will 31618c80eb3bSAlbert ARIBAUD \(3ADEV\) consider that a completely unreadable NAND block is bad, 31628c80eb3bSAlbert ARIBAUD \(3ADEV\) and thus should be skipped silently. 31638c80eb3bSAlbert ARIBAUD \(3ADEV\) 316494a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 316594a45bb1SScott Wood Adress of the start of the stack SPL will use after 316694a45bb1SScott Wood relocation. If unspecified, this is equal to 316794a45bb1SScott Wood CONFIG_SPL_STACK. 316894a45bb1SScott Wood 316995579793STom Rini CONFIG_SYS_SPL_MALLOC_START 317095579793STom Rini Starting address of the malloc pool used in SPL. 31719ac4fc82SFabio Estevam When this option is set the full malloc is used in SPL and 31729ac4fc82SFabio Estevam it is set up by spl_init() and before that, the simple malloc() 31739ac4fc82SFabio Estevam can be used if CONFIG_SYS_MALLOC_F is defined. 317495579793STom Rini 317595579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 317695579793STom Rini The size of the malloc pool used in SPL. 31776a11cf48SDaniel Schwierzeck 317847f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 317947f7bcaeSTom Rini Enable the SPL framework under common/. This framework 318047f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 318147f7bcaeSTom Rini NAND loading of the Linux Kernel. 318247f7bcaeSTom Rini 31839607faf2STom Rini CONFIG_SPL_OS_BOOT 31849607faf2STom Rini Enable booting directly to an OS from SPL. 31859607faf2STom Rini See also: doc/README.falcon 31869607faf2STom Rini 3187861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 3188861a86f4STom Rini For ARM, enable an optional function to print more information 3189861a86f4STom Rini about the running system. 3190861a86f4STom Rini 31914b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 31924b919725SScott Wood Arch init code should be built for a very small image 31934b919725SScott Wood 3194b97300b6SPaul Kocialkowski CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION 3195b97300b6SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3196b97300b6SPaul Kocialkowski used in raw mode 3197b97300b6SPaul Kocialkowski 31982b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 31992b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 32002b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 32012b75b0adSPeter Korsgaard 32022b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 32032b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 32042b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 32052b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 32062b75b0adSPeter Korsgaard (for falcon mode) 32072b75b0adSPeter Korsgaard 3208e2ccdf89SPaul Kocialkowski CONFIG_SYS_MMCSD_FS_BOOT_PARTITION 3209e2ccdf89SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3210e2ccdf89SPaul Kocialkowski used in fs mode 3211e2ccdf89SPaul Kocialkowski 3212fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_PAYLOAD_NAME 3213fae81c72SGuillaume GARDET Filename to read to load U-Boot when reading from filesystem 3214fae81c72SGuillaume GARDET 3215fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_KERNEL_NAME 32167ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 3217fae81c72SGuillaume GARDET from filesystem (for Falcon mode) 32187ad2cc79SPeter Korsgaard 3219fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_ARGS_NAME 32207ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 3221fae81c72SGuillaume GARDET when reading from filesystem (for Falcon mode) 32227ad2cc79SPeter Korsgaard 322306f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 322406f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 322506f60ae3SScott Wood start.S waits for the rest of the SPL to load before 322606f60ae3SScott Wood continuing (the hardware starts execution after just 322706f60ae3SScott Wood loading the first page rather than the full 4K). 322806f60ae3SScott Wood 3229651fcf60SPrabhakar Kushwaha CONFIG_SPL_SKIP_RELOCATE 3230651fcf60SPrabhakar Kushwaha Avoid SPL relocation 3231651fcf60SPrabhakar Kushwaha 32326f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 32336f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 32346f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 32356f2f01b9SScott Wood 32366f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 32376f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 32386f2f01b9SScott Wood 32396f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 32406f2f01b9SScott Wood Include standard software ECC in the SPL 32416f2f01b9SScott Wood 324295579793STom Rini CONFIG_SPL_NAND_SIMPLE 32437d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 32447d4b7955SScott Wood expose the cmd_ctrl() interface. 324595579793STom Rini 32466f4e7d3cSThomas Gleixner CONFIG_SPL_UBI 32476f4e7d3cSThomas Gleixner Support for a lightweight UBI (fastmap) scanner and 32486f4e7d3cSThomas Gleixner loader 32496f4e7d3cSThomas Gleixner 32500c3117b1SHeiko Schocher CONFIG_SPL_NAND_RAW_ONLY 32510c3117b1SHeiko Schocher Support to boot only raw u-boot.bin images. Use this only 32520c3117b1SHeiko Schocher if you need to save space. 32530c3117b1SHeiko Schocher 32547c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 32557c8eea59SYing Zhang Set for common ddr init with serial presence detect in 32567c8eea59SYing Zhang SPL binary. 32577c8eea59SYing Zhang 325895579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 325995579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 326095579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 326195579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 326295579793STom Rini CONFIG_SYS_NAND_ECCBYTES 326395579793STom Rini Defines the size and behavior of the NAND that SPL uses 32647d4b7955SScott Wood to read U-Boot 326595579793STom Rini 3266fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 3267fbe76ae4SPrabhakar Kushwaha Add support NAND boot 3268fbe76ae4SPrabhakar Kushwaha 326995579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 32707d4b7955SScott Wood Location in NAND to read U-Boot from 32717d4b7955SScott Wood 32727d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 32737d4b7955SScott Wood Location in memory to load U-Boot to 32747d4b7955SScott Wood 32757d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 32767d4b7955SScott Wood Size of image to load 327795579793STom Rini 327895579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 32797d4b7955SScott Wood Entry point in loaded image to jump to 328095579793STom Rini 328195579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 328295579793STom Rini Define this if you need to first read the OOB and then the 3283b445bbb4SJeremiah Mahler data. This is used, for example, on davinci platforms. 328495579793STom Rini 328595579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 328695579793STom Rini Support for an OMAP3-specific set of functions to return the 328795579793STom Rini ID and MFR of the first attached NAND chip, if present. 328895579793STom Rini 3289c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3290c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3291c57b953dSPavel Machek 329274752baaSScott Wood CONFIG_SPL_PAD_TO 32936113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 32946113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 32956113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 32966113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 32976113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 329874752baaSScott Wood 3299ca2fca22SScott Wood CONFIG_SPL_TARGET 3300ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3301ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3302ca2fca22SScott Wood example if more than one image needs to be produced. 3303ca2fca22SScott Wood 330487ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 330587ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 330687ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 330787ebee39SSimon Glass option to re-enable it. This will affect the output of the 330887ebee39SSimon Glass bootm command when booting a FIT image. 330987ebee39SSimon Glass 33103aa29de0SYing Zhang- TPL framework 33113aa29de0SYing Zhang CONFIG_TPL 33123aa29de0SYing Zhang Enable building of TPL globally. 33133aa29de0SYing Zhang 33143aa29de0SYing Zhang CONFIG_TPL_PAD_TO 33153aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 33163aa29de0SYing Zhang the TPL payload. By default, this is defined as 33173aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 33183aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 33193aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 33203aa29de0SYing Zhang 3321a8c7c708Swdenk- Interrupt support (PPC): 3322a8c7c708Swdenk 3323a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3324a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 332511ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3326a8c7c708Swdenk should set decrementer_count to appropriate value. If 332711ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3328a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 332911ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3330a8c7c708Swdenk specific handling. If board has watchdog / status_led 3331a8c7c708Swdenk / other_activity_monitor it works automatically from 3332a8c7c708Swdenk general timer_interrupt(). 3333a8c7c708Swdenk 3334c609719bSwdenk 33359660e442SHelmut RaigerBoard initialization settings: 33369660e442SHelmut Raiger------------------------------ 33379660e442SHelmut Raiger 33389660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 33399660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 33409660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 33419660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 33429660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 33439660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 33449660e442SHelmut Raiger 33459660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 33469660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 33479660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 33489660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3349c609719bSwdenk 3350c609719bSwdenkConfiguration Settings: 3351c609719bSwdenk----------------------- 3352c609719bSwdenk 33534d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 33544d1fd7f1SYork Sun Optionally it can be defined to support 64-bit memory commands. 33554d1fd7f1SYork Sun 33566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3357c609719bSwdenk undefine this when you're short of memory. 3358c609719bSwdenk 33592fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 33602fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 33612fb2604dSPeter Tyser 33626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3363c609719bSwdenk prompt for user input. 3364c609719bSwdenk 33656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3366c609719bSwdenk 33676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3368c609719bSwdenk 33696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3370c609719bSwdenk 33716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3372c609719bSwdenk the application (usually a Linux kernel) when it is 3373c609719bSwdenk booted 3374c609719bSwdenk 33756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3376c609719bSwdenk List of legal baudrate settings for this board. 3377c609719bSwdenk 33786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3379c609719bSwdenk Begin and End addresses of the area used by the 3380c609719bSwdenk simple memory test. 3381c609719bSwdenk 33826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3383c609719bSwdenk Enable an alternate, more extensive memory test. 3384c609719bSwdenk 33856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 33865f535fe1Swdenk Scratch address used by the alternate memory test 33875f535fe1Swdenk You only need to set this if address zero isn't writeable 33885f535fe1Swdenk 3389e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE 3390e61a7534SYork Sun Only implemented for ARMv8 for now. 3391e8149522SYork Sun If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory 3392e8149522SYork Sun is substracted from total RAM and won't be reported to OS. 3393e8149522SYork Sun This memory can be used as secure memory. A variable 3394e61a7534SYork Sun gd->arch.secure_ram is used to track the location. In systems 3395e8149522SYork Sun the RAM base is not zero, or RAM is divided into banks, 3396e8149522SYork Sun this variable needs to be recalcuated to get the address. 3397e8149522SYork Sun 3398aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE: 33996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 340014f73ca6SStefan Roese this specified memory area will get subtracted from the top 340111ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 340214f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 340314f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 340414f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 34055e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 340614f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 34075e12e75dSStefan Roese will have to get fixed in Linux additionally. 340814f73ca6SStefan Roese 340914f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 341014f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 341114f73ca6SStefan Roese be touched. 341214f73ca6SStefan Roese 341314f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 341414f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 341514f73ca6SStefan Roese then the end address of the Linux memory will be located at a 341614f73ca6SStefan Roese non page size aligned address and this could cause major 341714f73ca6SStefan Roese problems. 341814f73ca6SStefan Roese 34196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3420c609719bSwdenk Enable temporary baudrate change while serial download 3421c609719bSwdenk 34226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3423c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3424c609719bSwdenk 34256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3426c609719bSwdenk Physical start address of Flash memory. 3427c609719bSwdenk 34286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3429c609719bSwdenk Physical start address of boot monitor code (set by 3430c609719bSwdenk make config files to be same as the text base address 343114d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 34326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3433c609719bSwdenk 34346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 34353b57fe0aSwdenk Size of memory reserved for monitor code, used to 34363b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 34373b57fe0aSwdenk embedded within the U-Boot image, or in a separate 34383b57fe0aSwdenk flash sector. 3439c609719bSwdenk 34406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3441c609719bSwdenk Size of DRAM reserved for malloc() use. 3442c609719bSwdenk 3443d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN 3444d59476b6SSimon Glass Size of the malloc() pool for use before relocation. If 3445d59476b6SSimon Glass this is defined, then a very simple malloc() implementation 3446d59476b6SSimon Glass will become available before relocation. The address is just 3447d59476b6SSimon Glass below the global data, and the stack is moved down to make 3448d59476b6SSimon Glass space. 3449d59476b6SSimon Glass 3450d59476b6SSimon Glass This feature allocates regions with increasing addresses 3451d59476b6SSimon Glass within the region. calloc() is supported, but realloc() 3452d59476b6SSimon Glass is not available. free() is supported but does nothing. 3453b445bbb4SJeremiah Mahler The memory will be freed (or in fact just forgotten) when 3454d59476b6SSimon Glass U-Boot relocates itself. 3455d59476b6SSimon Glass 345638687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE 345738687ae6SSimon Glass Provides a simple and small malloc() and calloc() for those 345838687ae6SSimon Glass boards which do not use the full malloc in SPL (which is 345938687ae6SSimon Glass enabled with CONFIG_SYS_SPL_MALLOC_START). 346038687ae6SSimon Glass 34611dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY: 34621dfdd9baSThierry Reding Size of non-cached memory area. This area of memory will be 34631dfdd9baSThierry Reding typically located right below the malloc() area and mapped 34641dfdd9baSThierry Reding uncached in the MMU. This is useful for drivers that would 34651dfdd9baSThierry Reding otherwise require a lot of explicit cache maintenance. For 34661dfdd9baSThierry Reding some drivers it's also impossible to properly maintain the 34671dfdd9baSThierry Reding cache. For example if the regions that need to be flushed 34681dfdd9baSThierry Reding are not a multiple of the cache-line size, *and* padding 34691dfdd9baSThierry Reding cannot be allocated between the regions to align them (i.e. 34701dfdd9baSThierry Reding if the HW requires a contiguous array of regions, and the 34711dfdd9baSThierry Reding size of each region is not cache-aligned), then a flush of 34721dfdd9baSThierry Reding one region may result in overwriting data that hardware has 34731dfdd9baSThierry Reding written to another region in the same cache-line. This can 34741dfdd9baSThierry Reding happen for example in network drivers where descriptors for 34751dfdd9baSThierry Reding buffers are typically smaller than the CPU cache-line (e.g. 34761dfdd9baSThierry Reding 16 bytes vs. 32 or 64 bytes). 34771dfdd9baSThierry Reding 34781dfdd9baSThierry Reding Non-cached memory is only supported on 32-bit ARM at present. 34791dfdd9baSThierry Reding 34806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 348115940c9aSStefan Roese Normally compressed uImages are limited to an 348215940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 34836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 348415940c9aSStefan Roese to adjust this setting to your needs. 3485c609719bSwdenk 34866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3487c609719bSwdenk Maximum size of memory mapped by the startup code of 3488c609719bSwdenk the Linux kernel; all data that must be processed by 34897d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 34907d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 34911bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 34927d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3493c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3494c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3495c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3496c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3497c609719bSwdenk 3498fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3499fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3500fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3501fca43cc8SJohn Rigby is enabled. 3502fca43cc8SJohn Rigby 3503fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3504fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3505fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3506fca43cc8SJohn Rigby 3507fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3508fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3509fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3510fca43cc8SJohn Rigby 35116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3512c609719bSwdenk Max number of Flash memory banks 3513c609719bSwdenk 35146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3515c609719bSwdenk Max number of sectors on a Flash chip 3516c609719bSwdenk 35176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3518c609719bSwdenk Timeout for Flash erase operations (in ms) 3519c609719bSwdenk 35206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3521c609719bSwdenk Timeout for Flash write operations (in ms) 3522c609719bSwdenk 35236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 35248564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 35258564acf9Swdenk 35266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 35278564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 35288564acf9Swdenk 35296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 35308564acf9Swdenk If defined, hardware flash sectors protection is used 35318564acf9Swdenk instead of U-Boot software protection. 35328564acf9Swdenk 35336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3534c609719bSwdenk 3535c609719bSwdenk Enable TFTP transfers directly to flash memory; 3536c609719bSwdenk without this option such a download has to be 3537c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3538c609719bSwdenk copy from RAM to flash. 3539c609719bSwdenk 3540c609719bSwdenk The two-step approach is usually more reliable, since 3541c609719bSwdenk you can check if the download worked before you erase 354211ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 354311ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3544c609719bSwdenk downloaded image) this option may be very useful. 3545c609719bSwdenk 35466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3547c609719bSwdenk Define if the flash driver uses extra elements in the 35485653fc33Swdenk common flash structure for storing flash geometry. 35495653fc33Swdenk 355000b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 35515653fc33Swdenk This option also enables the building of the cfi_flash driver 35525653fc33Swdenk in the drivers directory 355353cf9435Sstroese 355491809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 355591809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 355691809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 355791809ed5SPiotr Ziecik to the MTD layer. 355891809ed5SPiotr Ziecik 35596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 356096ef831fSGuennadi Liakhovetski Use buffered writes to flash. 356196ef831fSGuennadi Liakhovetski 356296ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 356396ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 356496ef831fSGuennadi Liakhovetski write commands. 356596ef831fSGuennadi Liakhovetski 35666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 35675568e613SStefan Roese If this option is defined, the common CFI flash doesn't 35685568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 35695568e613SStefan Roese is useful, if some of the configured banks are only 35705568e613SStefan Roese optionally available. 35715568e613SStefan Roese 35729a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 35739a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 35749a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 35759a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 35769a042e9cSJerry Van Baren 3577352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3578352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3579352ef3f1SStefan Roese against the source after the write operation. An error message 3580352ef3f1SStefan Roese will be printed when the contents are not identical. 3581352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3582352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3583352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3584352ef3f1SStefan Roese this option if you really know what you are doing. 3585352ef3f1SStefan Roese 35866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 358711ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 358811ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 358953cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 359053cf9435Sstroese buffers can be full shortly after enabling the interface 359111ccc33fSMarcel Ziswiler on high Ethernet traffic. 359253cf9435Sstroese Defaults to 4 if not defined. 3593c609719bSwdenk 3594ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3595ea882bafSWolfgang Denk 3596ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3597ea882bafSWolfgang Denk internally to store the environment settings. The default 3598ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3599ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3600ea882bafSWolfgang Denk lib/hashtable.c for details. 3601ea882bafSWolfgang Denk 36022598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 36032598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 36041bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 36052598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 36062598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 36072598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 36082598090bSJoe Hershberger 36092598090bSJoe Hershberger The format of the list is: 36102598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3611b445bbb4SJeremiah Mahler access_attribute = [a|r|o|c] 3612b445bbb4SJeremiah Mahler attributes = type_attribute[access_attribute] 36132598090bSJoe Hershberger entry = variable_name[:attributes] 36142598090bSJoe Hershberger list = entry[,list] 36152598090bSJoe Hershberger 36162598090bSJoe Hershberger The type attributes are: 36172598090bSJoe Hershberger s - String (default) 36182598090bSJoe Hershberger d - Decimal 36192598090bSJoe Hershberger x - Hexadecimal 36202598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 36212598090bSJoe Hershberger i - IP address 36222598090bSJoe Hershberger m - MAC address 36232598090bSJoe Hershberger 3624267541f7SJoe Hershberger The access attributes are: 3625267541f7SJoe Hershberger a - Any (default) 3626267541f7SJoe Hershberger r - Read-only 3627267541f7SJoe Hershberger o - Write-once 3628267541f7SJoe Hershberger c - Change-default 3629267541f7SJoe Hershberger 36302598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 36312598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 3632b445bbb4SJeremiah Mahler environment variable in the default or embedded environment. 36332598090bSJoe Hershberger 36342598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 36352598090bSJoe Hershberger Define this to a list (string) to define validation that 36362598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 36372598090bSJoe Hershberger environment variable. To override a setting in the static 36382598090bSJoe Hershberger list, simply add an entry for the same variable name to the 36392598090bSJoe Hershberger ".flags" variable. 36402598090bSJoe Hershberger 3641bdf1fe4eSJoe Hershberger If CONFIG_REGEX is defined, the variable_name above is evaluated as a 3642bdf1fe4eSJoe Hershberger regular expression. This allows multiple variables to define the same 3643bdf1fe4eSJoe Hershberger flags without explicitly listing them for each variable. 3644bdf1fe4eSJoe Hershberger 3645267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3646267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3647267541f7SJoe Hershberger access flags. 3648267541f7SJoe Hershberger 36490d296cc2SGabe Black- CONFIG_USE_STDINT 36500d296cc2SGabe Black If stdint.h is available with your toolchain you can define this 36510d296cc2SGabe Black option to enable it. You can provide option 'USE_STDINT=1' when 36520d296cc2SGabe Black building U-Boot to enable this. 36530d296cc2SGabe Black 3654c609719bSwdenkThe following definitions that deal with the placement and management 3655c609719bSwdenkof environment data (variable area); in general, we support the 3656c609719bSwdenkfollowing configurations: 3657c609719bSwdenk 3658c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3659c3eb3fe4SMike Frysinger 3660c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3661c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3662c3eb3fe4SMike Frysinger 36635a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3664c609719bSwdenk 3665c609719bSwdenk Define this if the environment is in flash memory. 3666c609719bSwdenk 3667c609719bSwdenk a) The environment occupies one whole flash sector, which is 3668c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3669c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3670c609719bSwdenk sector" type flash chips, which have several smaller 3671c609719bSwdenk sectors at the start or the end. For instance, such a 3672c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3673c609719bSwdenk such a case you would place the environment in one of the 3674c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3675c609719bSwdenk "top boot sector" type flash chips, you would put the 3676c609719bSwdenk environment in one of the last sectors, leaving a gap 3677c609719bSwdenk between U-Boot and the environment. 3678c609719bSwdenk 36790e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3680c609719bSwdenk 3681c609719bSwdenk Offset of environment data (variable area) to the 3682c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3683c609719bSwdenk type flash chips the second sector can be used: the offset 3684c609719bSwdenk for this sector is given here. 3685c609719bSwdenk 36866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3687c609719bSwdenk 36880e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3689c609719bSwdenk 3690c609719bSwdenk This is just another way to specify the start address of 3691c609719bSwdenk the flash sector containing the environment (instead of 36920e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3693c609719bSwdenk 36940e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3695c609719bSwdenk 3696c609719bSwdenk Size of the sector containing the environment. 3697c609719bSwdenk 3698c609719bSwdenk 3699c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3700c609719bSwdenk In such a case you don't want to spend a whole sector for 3701c609719bSwdenk the environment. 3702c609719bSwdenk 37030e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3704c609719bSwdenk 37055a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 37060e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3707c609719bSwdenk of this flash sector for the environment. This saves 3708c609719bSwdenk memory for the RAM copy of the environment. 3709c609719bSwdenk 3710c609719bSwdenk It may also save flash memory if you decide to use this 3711c609719bSwdenk when your environment is "embedded" within U-Boot code, 3712c609719bSwdenk since then the remainder of the flash sector could be used 3713c609719bSwdenk for U-Boot code. It should be pointed out that this is 3714c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3715c609719bSwdenk updating the environment in flash makes it always 3716c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3717c609719bSwdenk wrong before the contents has been restored from a copy in 3718c609719bSwdenk RAM, your target system will be dead. 3719c609719bSwdenk 37200e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 37210e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3722c609719bSwdenk 3723c609719bSwdenk These settings describe a second storage area used to hold 372411ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 37253e38691eSwdenk a valid backup copy in case there is a power failure during 3726c609719bSwdenk a "saveenv" operation. 3727c609719bSwdenk 3728c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3729c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3730c609719bSwdenkaccordingly! 3731c609719bSwdenk 3732c609719bSwdenk 37339314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3734c609719bSwdenk 3735c609719bSwdenk Define this if you have some non-volatile memory device 3736c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3737c609719bSwdenk environment. 3738c609719bSwdenk 37390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 37400e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3741c609719bSwdenk 374211ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3743c609719bSwdenk want to use for environment. It is assumed that this memory 3744c609719bSwdenk can just be read and written to, without any special 3745c609719bSwdenk provision. 3746c609719bSwdenk 3747c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3748b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the 374911ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3750c609719bSwdenkU-Boot will hang. 3751c609719bSwdenk 3752c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3753c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3754c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3755c609719bSwdenkto save the current settings. 3756c609719bSwdenk 3757c609719bSwdenk 3758bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3759c609719bSwdenk 3760c609719bSwdenk Use this if you have an EEPROM or similar serial access 3761c609719bSwdenk device and a driver for it. 3762c609719bSwdenk 37630e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 37640e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3765c609719bSwdenk 3766c609719bSwdenk These two #defines specify the offset and size of the 3767c609719bSwdenk environment area within the total memory of your EEPROM. 3768c609719bSwdenk 37696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3770c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3771c609719bSwdenk The default address is zero. 3772c609719bSwdenk 3773189d257bSChristian Gmeiner - CONFIG_SYS_I2C_EEPROM_BUS: 3774189d257bSChristian Gmeiner If defined, specified the i2c bus of the EEPROM device. 3775189d257bSChristian Gmeiner 37766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3777c609719bSwdenk If defined, the number of bits used to address bytes in a 3778c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3779c609719bSwdenk would require six bits. 3780c609719bSwdenk 37816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3782c609719bSwdenk If defined, the number of milliseconds to delay between 3783c609719bSwdenk page writes. The default is zero milliseconds. 3784c609719bSwdenk 37856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3786c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3787c609719bSwdenk that this is NOT the chip address length! 3788c609719bSwdenk 37896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 37905cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 37915cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 37925cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 37935cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 37945cf91d6bSwdenk byte chips. 37955cf91d6bSwdenk 37965cf91d6bSwdenk Note that we consider the length of the address field to 37975cf91d6bSwdenk still be one byte because the extra address bits are hidden 37985cf91d6bSwdenk in the chip address. 37995cf91d6bSwdenk 38006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3801c609719bSwdenk The size in bytes of the EEPROM device. 3802c609719bSwdenk 3803548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3804548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3805548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3806548738b4SHeiko Schocher 3807548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3808548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3809548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3810548738b4SHeiko Schocher EEPROM. For example: 3811548738b4SHeiko Schocher 3812ea818dbbSHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS 1 3813548738b4SHeiko Schocher 3814548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3815548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3816c609719bSwdenk 3817057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 38185779d8d9Swdenk 38195779d8d9Swdenk Define this if you have a DataFlash memory device which you 38205779d8d9Swdenk want to use for the environment. 38215779d8d9Swdenk 38220e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 38230e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 38240e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 38255779d8d9Swdenk 38265779d8d9Swdenk These three #defines specify the offset and size of the 38275779d8d9Swdenk environment area within the total memory of your DataFlash placed 38285779d8d9Swdenk at the specified address. 38295779d8d9Swdenk 3830bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH: 3831bd83b592SWu, Josh 3832bd83b592SWu, Josh Define this if you have a SPI Flash memory device which you 3833bd83b592SWu, Josh want to use for the environment. 3834bd83b592SWu, Josh 3835bd83b592SWu, Josh - CONFIG_ENV_OFFSET: 3836bd83b592SWu, Josh - CONFIG_ENV_SIZE: 3837bd83b592SWu, Josh 3838bd83b592SWu, Josh These two #defines specify the offset and size of the 3839bd83b592SWu, Josh environment area within the SPI Flash. CONFIG_ENV_OFFSET must be 3840bd83b592SWu, Josh aligned to an erase sector boundary. 3841bd83b592SWu, Josh 3842bd83b592SWu, Josh - CONFIG_ENV_SECT_SIZE: 3843bd83b592SWu, Josh 3844bd83b592SWu, Josh Define the SPI flash's sector size. 3845bd83b592SWu, Josh 3846bd83b592SWu, Josh - CONFIG_ENV_OFFSET_REDUND (optional): 3847bd83b592SWu, Josh 3848bd83b592SWu, Josh This setting describes a second storage area of CONFIG_ENV_SIZE 3849bd83b592SWu, Josh size used to hold a redundant copy of the environment data, so 3850bd83b592SWu, Josh that there is a valid backup copy in case there is a power failure 38519dd05fb8SSimon Glass during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be 3852bd83b592SWu, Josh aligned to an erase sector boundary. 3853bd83b592SWu, Josh 3854bd83b592SWu, Josh - CONFIG_ENV_SPI_BUS (optional): 3855bd83b592SWu, Josh - CONFIG_ENV_SPI_CS (optional): 3856bd83b592SWu, Josh 3857bd83b592SWu, Josh Define the SPI bus and chip select. If not defined they will be 0. 3858bd83b592SWu, Josh 3859bd83b592SWu, Josh - CONFIG_ENV_SPI_MAX_HZ (optional): 3860bd83b592SWu, Josh 3861bd83b592SWu, Josh Define the SPI max work clock. If not defined then use 1MHz. 3862bd83b592SWu, Josh 3863bd83b592SWu, Josh - CONFIG_ENV_SPI_MODE (optional): 3864bd83b592SWu, Josh 3865bd83b592SWu, Josh Define the SPI work mode. If not defined then use SPI_MODE_3. 3866bd83b592SWu, Josh 38670a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 38680a85a9e7SLiu Gang 38690a85a9e7SLiu Gang Define this if you have a remote memory space which you 38700a85a9e7SLiu Gang want to use for the local device's environment. 38710a85a9e7SLiu Gang 38720a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 38730a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 38740a85a9e7SLiu Gang 38750a85a9e7SLiu Gang These two #defines specify the address and size of the 38760a85a9e7SLiu Gang environment area within the remote memory space. The 38770a85a9e7SLiu Gang local device can get the environment from remote memory 3878fc54c7faSLiu Gang space by SRIO or PCIE links. 38790a85a9e7SLiu Gang 38800a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 38810a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3882fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3883fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 38840a85a9e7SLiu Gang 388551bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 388613a5695bSwdenk 388713a5695bSwdenk Define this if you have a NAND device which you want to use 388813a5695bSwdenk for the environment. 388913a5695bSwdenk 38900e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 38910e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 389213a5695bSwdenk 389313a5695bSwdenk These two #defines specify the offset and size of the environment 3894fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 3895fdd813deSScott Wood aligned to an erase block boundary. 38965779d8d9Swdenk 3897fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 3898e443c944SMarkus Klotzbuecher 38990e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 3900fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 3901fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 39029dd05fb8SSimon Glass during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be 3903fdd813deSScott Wood aligned to an erase block boundary. 3904e443c944SMarkus Klotzbuecher 3905fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 3906fdd813deSScott Wood 3907fdd813deSScott Wood Specifies the length of the region in which the environment 3908fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 3909fdd813deSScott Wood block size. Specifying a range with more erase blocks than 3910fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3911fdd813deSScott Wood the range to be avoided. 3912fdd813deSScott Wood 3913fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 3914fdd813deSScott Wood 3915fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 3916fdd813deSScott Wood environment from block zero's out-of-band data. The 3917fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 3918fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3919fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 3920e443c944SMarkus Klotzbuecher 3921b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3922b74ab737SGuennadi Liakhovetski 3923b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3924b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3925b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3926b74ab737SGuennadi Liakhovetski 39272b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 39282b74433fSJoe Hershberger 39292b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 39302b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 39312b74433fSJoe Hershberger accesses, which is important on NAND. 39322b74433fSJoe Hershberger 39332b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 39342b74433fSJoe Hershberger 39352b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 39362b74433fSJoe Hershberger 39372b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 39382b74433fSJoe Hershberger 39392b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 39402b74433fSJoe Hershberger environment in. 39412b74433fSJoe Hershberger 3942785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 3943785881f7SJoe Hershberger 3944785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 3945785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 3946785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 3947785881f7SJoe Hershberger 39482b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 39492b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 39502b74433fSJoe Hershberger 39512b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 39522b74433fSJoe Hershberger when storing the env in UBI. 39532b74433fSJoe Hershberger 3954d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT: 3955d1db76f1SWu, Josh Define this if you want to use the FAT file system for the environment. 3956d1db76f1SWu, Josh 3957d1db76f1SWu, Josh - FAT_ENV_INTERFACE: 3958d1db76f1SWu, Josh 3959d1db76f1SWu, Josh Define this to a string that is the name of the block device. 3960d1db76f1SWu, Josh 396141987784SNicolae Rosia - FAT_ENV_DEVICE_AND_PART: 3962d1db76f1SWu, Josh 3963d1db76f1SWu, Josh Define this to a string to specify the partition of the device. It can 3964d1db76f1SWu, Josh be as following: 3965d1db76f1SWu, Josh 3966d1db76f1SWu, Josh "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1) 3967d1db76f1SWu, Josh - "D:P": device D partition P. Error occurs if device D has no 3968d1db76f1SWu, Josh partition table. 3969d1db76f1SWu, Josh - "D:0": device D. 3970d1db76f1SWu, Josh - "D" or "D:": device D partition 1 if device D has partition 3971d1db76f1SWu, Josh table, or the whole device D if has no partition 3972d1db76f1SWu, Josh table. 3973d1db76f1SWu, Josh - "D:auto": first partition in device D with bootable flag set. 3974b445bbb4SJeremiah Mahler If none, first valid partition in device D. If no 3975d1db76f1SWu, Josh partition table then means device D. 3976d1db76f1SWu, Josh 3977d1db76f1SWu, Josh - FAT_ENV_FILE: 3978d1db76f1SWu, Josh 3979d1db76f1SWu, Josh It's a string of the FAT file name. This file use to store the 3980b445bbb4SJeremiah Mahler environment. 3981d1db76f1SWu, Josh 3982d1db76f1SWu, Josh - CONFIG_FAT_WRITE: 3983b445bbb4SJeremiah Mahler This should be defined. Otherwise it cannot save the environment file. 3984d1db76f1SWu, Josh 398506e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 398606e4ae5fSStephen Warren 398706e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 398806e4ae5fSStephen Warren environment. 398906e4ae5fSStephen Warren 399006e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 399106e4ae5fSStephen Warren 399206e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 399306e4ae5fSStephen Warren 399406e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 399506e4ae5fSStephen Warren 399606e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 399706e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 399806e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 399906e4ae5fSStephen Warren 400006e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 400106e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 400206e4ae5fSStephen Warren 400306e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 400406e4ae5fSStephen Warren area within the specified MMC device. 400506e4ae5fSStephen Warren 40065c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 40075c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 40085c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 40095c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 40105c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 40115c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 40125c088ee8SStephen Warren maximum possible space before it, to store other data. 40135c088ee8SStephen Warren 401406e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 401506e4ae5fSStephen Warren MMC sector boundary. 401606e4ae5fSStephen Warren 401706e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 401806e4ae5fSStephen Warren 401906e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 402006e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 402106e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 402206e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 402306e4ae5fSStephen Warren 40245c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 40255c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 40265c088ee8SStephen Warren 402706e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 402806e4ae5fSStephen Warren an MMC sector boundary. 402906e4ae5fSStephen Warren 403006e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 403106e4ae5fSStephen Warren 403206e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 403306e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 403406e4ae5fSStephen Warren CONFIG_ENV_SIZE. 403506e4ae5fSStephen Warren 40366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 4037c609719bSwdenk 4038c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 4039c609719bSwdenk area is used at an early stage (ROM part) if the environment 4040c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 4041c609719bSwdenk scratch DPRAM area. It is used between the two initialization 4042c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4043c609719bSwdenk to be a good choice since it makes it far enough from the 4044c609719bSwdenk start of the data area as well as from the stack pointer. 4045c609719bSwdenk 4046e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 4047c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 4048cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 4049c609719bSwdenkuntil then to read environment variables. 4050c609719bSwdenk 405185ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 405285ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 405385ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 405485ec0bccSwdenknecessary, because the first environment variable we need is the 405585ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 405685ec0bccSwdenkhave any device yet where we could complain.] 4057c609719bSwdenk 4058c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 4059c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 406085ec0bccSwdenkuse the "saveenv" command to store a valid environment. 4061c609719bSwdenk 40626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4063fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 4064fc3e2165Swdenk 40656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4066fc3e2165Swdenk also needs to be defined. 4067fc3e2165Swdenk 40686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 4069fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 4070c609719bSwdenk 4071f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 4072f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 4073f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 4074f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 4075f5675aa5SRon Madrid space for already greatly restricted images, including but not 4076f5675aa5SRon Madrid limited to NAND_SPL configurations. 4077f5675aa5SRon Madrid 4078b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 4079b2b92f53SSimon Glass Display information about the board that U-Boot is running on 4080b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 4081b2b92f53SSimon Glass to do this. 4082b2b92f53SSimon Glass 4083e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 4084e2e3e2b1SSimon Glass Similar to the previous option, but display this information 4085e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 4086e2e3e2b1SSimon Glass present. 4087e2e3e2b1SSimon Glass 4088feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT: 4089feb85801SSascha Silbe Maximum size of the U-Boot image. When defined, the 4090feb85801SSascha Silbe build system checks that the actual size does not 4091feb85801SSascha Silbe exceed it. 4092feb85801SSascha Silbe 4093c609719bSwdenkLow Level (hardware related) configuration options: 4094dc7c9a1aSwdenk--------------------------------------------------- 4095c609719bSwdenk 40966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 4097c609719bSwdenk Cache Line Size of the CPU. 4098c609719bSwdenk 40996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 4100c609719bSwdenk Default address of the IMMR after system reset. 41012535d602Swdenk 41022535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 41032535d602Swdenk and RPXsuper) to be able to adjust the position of 41042535d602Swdenk the IMMR register after a reset. 4105c609719bSwdenk 4106e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 4107e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 4108e46fedfeSTimur Tabi PowerPC SOCs. 4109e46fedfeSTimur Tabi 4110e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 4111e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 4112e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4113e46fedfeSTimur Tabi 4114e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4115e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 4116e46fedfeSTimur Tabi 4117e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 4118e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 4119e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 4120e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 4121e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4122e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 4123e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 4124e46fedfeSTimur Tabi 4125e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4126e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4127e46fedfeSTimur Tabi 4128e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4129e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4130e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 4131e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4132e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4133e46fedfeSTimur Tabi 4134e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4135e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4136e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4137e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4138e46fedfeSTimur Tabi 4139e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4140e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4141e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 4142e46fedfeSTimur Tabi 41437f6c2cbcSwdenk- Floppy Disk Support: 41446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 41457f6c2cbcSwdenk 41467f6c2cbcSwdenk the default drive number (default value 0) 41477f6c2cbcSwdenk 41486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 41497f6c2cbcSwdenk 415011ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 41517f6c2cbcSwdenk (default value 1) 41527f6c2cbcSwdenk 41536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 41547f6c2cbcSwdenk 41557f6c2cbcSwdenk defines the offset of register from address. It 41567f6c2cbcSwdenk depends on which part of the data bus is connected to 415711ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 41587f6c2cbcSwdenk 41596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 41606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 41617f6c2cbcSwdenk default value. 41627f6c2cbcSwdenk 41636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 41647f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 41657f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 4166b445bbb4SJeremiah Mahler source code. It is used to make hardware-dependent 41677f6c2cbcSwdenk initializations. 41687f6c2cbcSwdenk 41690abddf82SMacpaul Lin- CONFIG_IDE_AHB: 41700abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 41710abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 41720abddf82SMacpaul Lin When software is doing ATA command and data transfer to 41730abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 41740abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 4175b445bbb4SJeremiah Mahler is required. 41760abddf82SMacpaul Lin 41776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 417825d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 417925d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 4180c609719bSwdenk 41816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 4182c609719bSwdenk 41837152b1d0Swdenk Start address of memory area that can be used for 4184c609719bSwdenk initial data and stack; please note that this must be 4185c609719bSwdenk writable memory that is working WITHOUT special 4186c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 4187c609719bSwdenk will become available only after programming the 4188c609719bSwdenk memory controller and running certain initialization 4189c609719bSwdenk sequences. 4190c609719bSwdenk 4191c609719bSwdenk U-Boot uses the following memory types: 4192c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4193c609719bSwdenk - MPC824X: data cache 4194c609719bSwdenk - PPC4xx: data cache 4195c609719bSwdenk 41966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 4197c609719bSwdenk 4198c609719bSwdenk Offset of the initial data structure in the memory 41996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 42006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4201c609719bSwdenk data is located at the end of the available space 4202553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 4203acd51f9dSSimon Glass GENERATED_GBL_DATA_SIZE), and the initial stack is just 42046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 42056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 4206c609719bSwdenk 4207c609719bSwdenk Note: 4208c609719bSwdenk On the MPC824X (or other systems that use the data 4209c609719bSwdenk cache for initial memory) the address chosen for 42106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4211c609719bSwdenk point to an otherwise UNUSED address space between 4212c609719bSwdenk the top of RAM and the start of the PCI space. 4213c609719bSwdenk 42146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4215c609719bSwdenk 42166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4217c609719bSwdenk 42186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4219c609719bSwdenk 42206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4221c609719bSwdenk 42226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4223c609719bSwdenk 42246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4225c609719bSwdenk 42266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 4227c609719bSwdenk SDRAM timing 4228c609719bSwdenk 42296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 4230c609719bSwdenk periodic timer for refresh 4231c609719bSwdenk 42326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 4233c609719bSwdenk 42346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 42356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 42366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 42376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 4238c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4239c609719bSwdenk 4240c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 42416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 42426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4243c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4244c609719bSwdenk 42456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 42466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4247c609719bSwdenk Machine Mode Register and Memory Periodic Timer 4248c609719bSwdenk Prescaler definitions (SDRAM timing) 4249c609719bSwdenk 42506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4251c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 4252c609719bSwdenk define relocation offset in DPRAM [DSP2] 4253c609719bSwdenk 42546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4255b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 4256b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 4257b423d055SHeiko Schocher 42586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4259c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 4260c609719bSwdenk define relocation offset in DPRAM [SCC4] 4261c609719bSwdenk 42626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4263ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 4264ea909b76Swdenk (Power On Self Tests). This definition overrides 4265ea909b76Swdenk #define'd default value in commproc.h resp. 4266ea909b76Swdenk cpm_8260.h. 4267ea909b76Swdenk 42686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 42696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 42706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 42716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 42726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 42736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 42746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 42756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4276a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 42775d232d0eSwdenk 42789cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 42799cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 42809cacf4fcSDirk Eibach required. 42819cacf4fcSDirk Eibach 428269fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 4283b445bbb4SJeremiah Mahler Only scan through and get the devices on the buses. 428469fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 428569fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 428669fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 428769fd2d3bSAndrew Sharp by coreboot or similar. 428869fd2d3bSAndrew Sharp 4289842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 4290842033e6SGabor Juhos Enable support for indirect PCI bridges. 4291842033e6SGabor Juhos 4292a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 4293a09b9b68SKumar Gala Chip has SRIO or not 4294a09b9b68SKumar Gala 4295a09b9b68SKumar Gala- CONFIG_SRIO1: 4296a09b9b68SKumar Gala Board has SRIO 1 port available 4297a09b9b68SKumar Gala 4298a09b9b68SKumar Gala- CONFIG_SRIO2: 4299a09b9b68SKumar Gala Board has SRIO 2 port available 4300a09b9b68SKumar Gala 4301c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 4302c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 4303c8b28152SLiu Gang 4304a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 4305a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 4306a09b9b68SKumar Gala 4307a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 4308a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 4309a09b9b68SKumar Gala 4310a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 4311a09b9b68SKumar Gala Size of SRIO port 'n' memory region 4312a09b9b68SKumar Gala 431366bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 431466bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 431566bd1846SFabio Estevam a 16 bit bus. 431666bd1846SFabio Estevam Not all NAND drivers use this symbol. 4317a430e916SFabio Estevam Example of drivers that use it: 431866bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 4319a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 4320eced4626SAlex Waterman 4321eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 4322eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 4323eced4626SAlex Waterman a default value will be used. 4324eced4626SAlex Waterman 4325bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 4326218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 4327218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 4328218ca724SWolfgang Denk 4329bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 4330bb99ad6dSBen Warren I2C address of the SPD EEPROM 4331bb99ad6dSBen Warren 43326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4333218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4334218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4335218ca724SWolfgang Denk to something your driver can deal with. 4336bb99ad6dSBen Warren 43371b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 43381b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 43391b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 43401b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 43411b3e3c4fSYork Sun header files or board specific files. 43421b3e3c4fSYork Sun 43436f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 43446f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 43456f5e1dc5SYork Sun 4346e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH 4347e32d59a2SYork Sun Enable sync of refresh for multiple controllers. 4348e32d59a2SYork Sun 43494516ff81SYork Sun- CONFIG_FSL_DDR_BIST 43504516ff81SYork Sun Enable built-in memory test for Freescale DDR controllers. 43514516ff81SYork Sun 43526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4353218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4354218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 43552ad6b513STimur Tabi 4356c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4357c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4358c26e454dSwdenk 4359c26e454dSwdenk- CONFIG_FEC[12]_PHY 4360c26e454dSwdenk Define to the hardcoded PHY address which corresponds 43616e592385Swdenk to the given FEC; i. e. 4362c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4363c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4364c26e454dSwdenk 4365c26e454dSwdenk When set to -1, means to probe for first available. 4366c26e454dSwdenk 4367c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4368c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4369c26e454dSwdenk (so program the FEC to ignore it). 4370c26e454dSwdenk 4371c26e454dSwdenk- CONFIG_RMII 4372c26e454dSwdenk Enable RMII mode for all FECs. 4373c26e454dSwdenk Note that this is a global option, we can't 4374c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4375c26e454dSwdenk 43765cf91d6bSwdenk- CONFIG_CRC32_VERIFY 43775cf91d6bSwdenk Add a verify option to the crc32 command. 43785cf91d6bSwdenk The syntax is: 43795cf91d6bSwdenk 43805cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 43815cf91d6bSwdenk 43825cf91d6bSwdenk Where address/count indicate a memory area 43835cf91d6bSwdenk and crc32 is the correct crc32 which the 43845cf91d6bSwdenk area should have. 43855cf91d6bSwdenk 438656523f12Swdenk- CONFIG_LOOPW 438756523f12Swdenk Add the "loopw" memory command. This only takes effect if 4388602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 438956523f12Swdenk 43907b466641Sstroese- CONFIG_MX_CYCLIC 43917b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 43927b466641Sstroese "md/mw" commands. 43937b466641Sstroese Examples: 43947b466641Sstroese 43957b466641Sstroese => mdc.b 10 4 500 43967b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 43977b466641Sstroese 43987b466641Sstroese => mwc.l 100 12345678 10 43997b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 44007b466641Sstroese 44017b466641Sstroese This only takes effect if the memory commands are activated 4402602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 44037b466641Sstroese 44048aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4405afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4406e03f3169SWolfgang Denk low level initializations (like setting up the memory 4407e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4408e03f3169SWolfgang Denk relocate itself into RAM. 44098aa1a2d1Swdenk 4410e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4411e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4412e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4413e03f3169SWolfgang Denk these initializations itself. 44148aa1a2d1Swdenk 4415b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY 4416b5bd0982SSimon Glass [ARM926EJ-S only] This allows just the call to lowlevel_init() 441790211f77Syeongjun Kim to be skipped. The normal CP15 init (such as enabling the 4418b5bd0982SSimon Glass instruction cache) is still performed. 4419b5bd0982SSimon Glass 4420401bb30bSAneesh V- CONFIG_SPL_BUILD 4421df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4422df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4423df81238bSMagnus Lilja compiling a NAND SPL. 4424400558b5Swdenk 44253aa29de0SYing Zhang- CONFIG_TPL_BUILD 44263aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 44273aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 44283aa29de0SYing Zhang It is loaded by the SPL. 44293aa29de0SYing Zhang 44305df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 44315df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 44325df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 44335df572f0SYing Zhang previous 4k of the .text section. 44345df572f0SYing Zhang 44354213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 44364213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 44374213fc29SSimon Glass effective address. It is therefore not necessary to regard 44384213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 44394213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 44404213fc29SSimon Glass it maintains its own little RAM buffer which contains all 44414213fc29SSimon Glass addressable memory. This option causes some memory accesses 44424213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 44434213fc29SSimon Glass 4444588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4445588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4446588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4447b16f521aSGabe Black 444816678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 444916678eb4SHeiko Schocher Enables the RTC32K OSC on AM33xx based plattforms 445016678eb4SHeiko Schocher 4451999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 4452999d7d32SKaricheri, Muralidharan Option to disable subpage write in NAND driver 4453999d7d32SKaricheri, Muralidharan driver that uses this: 4454999d7d32SKaricheri, Muralidharan drivers/mtd/nand/davinci_nand.c 4455999d7d32SKaricheri, Muralidharan 4456f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4457f2717b47STimur Tabi----------------------------------- 4458f2717b47STimur Tabi 4459f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4460f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4461f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4462f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4463f2717b47STimur Tabiwithin that device. 4464f2717b47STimur Tabi 4465dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR 4466dcf1d774SZhao Qiang The address in the storage device where the FMAN microcode is located. The 4467dcf1d774SZhao Qiang meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4468dcf1d774SZhao Qiang is also specified. 4469dcf1d774SZhao Qiang 4470dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR 4471dcf1d774SZhao Qiang The address in the storage device where the QE microcode is located. The 4472f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4473f2717b47STimur Tabi is also specified. 4474f2717b47STimur Tabi 4475f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4476f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4477f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4478f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4479f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4480f2717b47STimur Tabi 4481f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4482f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4483f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4484f2717b47STimur Tabi virtual address in NOR flash. 4485f2717b47STimur Tabi 4486f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4487f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4488f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4489f2717b47STimur Tabi 4490f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4491f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4492f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4493f2717b47STimur Tabi 4494292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4495292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4496292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4497fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4498fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4499fc54c7faSLiu Gang master's memory space. 4500f2717b47STimur Tabi 4501b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support: 4502b940ca64SJ. German Rivera--------------------------------------------------------- 4503b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of 4504b940ca64SJ. German Rivera"firmware". 4505b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros 4506b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address 4507b940ca64SJ. German Riverawithin that device. 4508b940ca64SJ. German Rivera 4509b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET 4510b940ca64SJ. German Rivera Enable the MC driver for Layerscape SoCs. 4511b940ca64SJ. German Rivera 45125c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support: 45135c055089SPrabhakar Kushwaha------------------------------------------- 45145c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of 45155c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom. 45165c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting. 45175c055089SPrabhakar Kushwaha 4518c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN 4519c0492141SYork Sun Define alignment of reserved memory MC requires 45205c055089SPrabhakar Kushwaha 4521f3f431a7SPaul KocialkowskiReproducible builds 4522f3f431a7SPaul Kocialkowski------------------- 4523f3f431a7SPaul Kocialkowski 4524f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build 4525f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value. 4526f3f431a7SPaul Kocialkowski 4527f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable. 4528f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration 4529f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot. 4530f3f431a7SPaul Kocialkowski 4531f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. 4532f3f431a7SPaul Kocialkowski 4533c609719bSwdenkBuilding the Software: 4534c609719bSwdenk====================== 4535c609719bSwdenk 4536218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4537218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4538218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4539218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4540218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4541218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4542c609719bSwdenk 4543218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4544218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4545218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4546218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4547218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4548c609719bSwdenk 4549218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4550218ca724SWolfgang Denk $ export CROSS_COMPILE 4551c609719bSwdenk 45522f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 45532f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 45542f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 45552f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 45562f8d396bSPeter Tyser 45572f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 45582f8d396bSPeter Tyser 45592f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 45602f8d396bSPeter Tyser be executed on computers running Windows. 45612f8d396bSPeter Tyser 4562c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4563c609719bSwdenksources you must configure U-Boot for one specific board type. This 4564c609719bSwdenkis done by typing: 4565c609719bSwdenk 4566ab584d67SHolger Freyther make NAME_defconfig 4567c609719bSwdenk 4568ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu- 45694d675ae6SMichael Jonesrations; see boards.cfg for supported names. 457054387ac9Swdenk 4571c609719bSwdenkNote: for some board special configuration names may exist; check if 4572c609719bSwdenk additional information is available from the board vendor; for 45732729af9dSwdenk instance, the TQM823L systems are available without (standard) 45742729af9dSwdenk or with LCD support. You can select such additional "features" 457511ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 4576c609719bSwdenk 4577ab584d67SHolger Freyther make TQM823L_defconfig 45782729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 4579c609719bSwdenk 4580ab584d67SHolger Freyther make TQM823L_LCD_defconfig 4581c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 4582c609719bSwdenk 4583c609719bSwdenk etc. 4584c609719bSwdenk 4585c609719bSwdenk 4586c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 45877152b1d0Swdenkimages ready for download to / installation on your system: 4588c609719bSwdenk 4589c609719bSwdenk- "u-boot.bin" is a raw binary image 4590c609719bSwdenk- "u-boot" is an image in ELF binary format 4591c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 4592c609719bSwdenk 4593baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 4594baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 4595baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 4596baf31249SMarian Balakowicz 4597baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 4598baf31249SMarian Balakowicz 4599baf31249SMarian Balakowicz make O=/tmp/build distclean 4600ab584d67SHolger Freyther make O=/tmp/build NAME_defconfig 4601baf31249SMarian Balakowicz make O=/tmp/build all 4602baf31249SMarian Balakowicz 4603adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location: 4604baf31249SMarian Balakowicz 4605adbba996STimo Ketola export KBUILD_OUTPUT=/tmp/build 4606baf31249SMarian Balakowicz make distclean 4607ab584d67SHolger Freyther make NAME_defconfig 4608baf31249SMarian Balakowicz make all 4609baf31249SMarian Balakowicz 4610adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment 4611baf31249SMarian Balakowiczvariable. 4612baf31249SMarian Balakowicz 4613c609719bSwdenk 4614c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 4615c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 4616c609719bSwdenknative "make". 4617c609719bSwdenk 4618c609719bSwdenk 4619c609719bSwdenkIf the system board that you have is not listed, then you will need 4620c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 4621c609719bSwdenksteps: 4622c609719bSwdenk 46233c1496cdSPhil Sutter1. Create a new directory to hold your board specific code. Add any 462485ec0bccSwdenk files you need. In your board directory, you will need at least 46253c1496cdSPhil Sutter the "Makefile" and a "<board>.c". 46263c1496cdSPhil Sutter2. Create a new configuration file "include/configs/<board>.h" for 46273c1496cdSPhil Sutter your board. 4628c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 4629c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 4630ab584d67SHolger Freyther4. Run "make <board>_defconfig" with your new name. 4631c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 4632c609719bSwdenk to be installed on your target system. 463385ec0bccSwdenk6. Debug and solve any problems that might arise. 4634c609719bSwdenk [Of course, this last step is much harder than it sounds.] 4635c609719bSwdenk 4636c609719bSwdenk 4637c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 4638c609719bSwdenk============================================================== 4639c609719bSwdenk 4640c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 4641c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 4642c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 4643c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 4644218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 4645c609719bSwdenk 4646c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 4647c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 4648c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 46496de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will 46506de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this 46516de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H' 46526de80f21SSimon Glassfor documentation. 4653baf31249SMarian Balakowicz 4654baf31249SMarian Balakowicz 4655c609719bSwdenkSee also "U-Boot Porting Guide" below. 4656c609719bSwdenk 4657c609719bSwdenk 4658c609719bSwdenkMonitor Commands - Overview: 4659c609719bSwdenk============================ 4660c609719bSwdenk 4661c609719bSwdenkgo - start application at address 'addr' 4662c609719bSwdenkrun - run commands in an environment variable 4663c609719bSwdenkbootm - boot application image from memory 4664c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 466544f074c7SMarek Vasutbootz - boot zImage from memory 4666c609719bSwdenktftpboot- boot image via network using TFTP protocol 4667c609719bSwdenk and env variables "ipaddr" and "serverip" 4668c609719bSwdenk (and eventually "gatewayip") 46691fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 4670c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 4671c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4672c609719bSwdenkloads - load S-Record file over serial line 4673c609719bSwdenkloadb - load binary file over serial line (kermit mode) 4674c609719bSwdenkmd - memory display 4675c609719bSwdenkmm - memory modify (auto-incrementing) 4676c609719bSwdenknm - memory modify (constant address) 4677c609719bSwdenkmw - memory write (fill) 4678c609719bSwdenkcp - memory copy 4679c609719bSwdenkcmp - memory compare 4680c609719bSwdenkcrc32 - checksum calculation 46810f89c54bSPeter Tyseri2c - I2C sub-system 4682c609719bSwdenksspi - SPI utility commands 4683c609719bSwdenkbase - print or set address offset 4684c609719bSwdenkprintenv- print environment variables 4685c609719bSwdenksetenv - set environment variables 4686c609719bSwdenksaveenv - save environment variables to persistent storage 4687c609719bSwdenkprotect - enable or disable FLASH write protection 4688c609719bSwdenkerase - erase FLASH memory 4689c609719bSwdenkflinfo - print FLASH memory information 469010635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 4691c609719bSwdenkbdinfo - print Board Info structure 4692c609719bSwdenkiminfo - print header information for application image 4693c609719bSwdenkconinfo - print console devices and informations 4694c609719bSwdenkide - IDE sub-system 4695c609719bSwdenkloop - infinite loop on address range 469656523f12Swdenkloopw - infinite write loop on address range 4697c609719bSwdenkmtest - simple RAM test 4698c609719bSwdenkicache - enable or disable instruction cache 4699c609719bSwdenkdcache - enable or disable data cache 4700c609719bSwdenkreset - Perform RESET of the CPU 4701c609719bSwdenkecho - echo args to console 4702c609719bSwdenkversion - print monitor version 4703c609719bSwdenkhelp - print online help 4704c609719bSwdenk? - alias for 'help' 4705c609719bSwdenk 4706c609719bSwdenk 4707c609719bSwdenkMonitor Commands - Detailed Description: 4708c609719bSwdenk======================================== 4709c609719bSwdenk 4710c609719bSwdenkTODO. 4711c609719bSwdenk 4712c609719bSwdenkFor now: just type "help <command>". 4713c609719bSwdenk 4714c609719bSwdenk 4715c609719bSwdenkEnvironment Variables: 4716c609719bSwdenk====================== 4717c609719bSwdenk 4718c609719bSwdenkU-Boot supports user configuration using Environment Variables which 4719c609719bSwdenkcan be made persistent by saving to Flash memory. 4720c609719bSwdenk 4721c609719bSwdenkEnvironment Variables are set using "setenv", printed using 4722c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 4723c609719bSwdenkwithout a value can be used to delete a variable from the 4724c609719bSwdenkenvironment. As long as you don't save the environment you are 4725c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 4726c609719bSwdenkenvironment is erased by accident, a default environment is provided. 4727c609719bSwdenk 4728c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 4729c96f86eeSWolfgang Denk 4730c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 4731c609719bSwdenk 4732c609719bSwdenk baudrate - see CONFIG_BAUDRATE 4733c609719bSwdenk 4734c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 4735c609719bSwdenk 4736c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 4737c609719bSwdenk 4738c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 4739c609719bSwdenk 4740c609719bSwdenk bootfile - Name of the image to load with TFTP 4741c609719bSwdenk 47427d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 47437d721e34SBartlomiej Sieka command can be restricted. This variable is given as 47447d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 47457d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 47467d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 47477d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 4748c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4749c3624e6eSGrant Likely bootm_mapsize. 4750c3624e6eSGrant Likely 4751c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4752c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 4753c3624e6eSGrant Likely defines the size of the memory region starting at base 4754c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 4755c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4756c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 4757c3624e6eSGrant Likely used otherwise. 47587d721e34SBartlomiej Sieka 47597d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 47607d721e34SBartlomiej Sieka command can be restricted. This variable is given as 47617d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 47627d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 47637d721e34SBartlomiej Sieka environment variable. 47647d721e34SBartlomiej Sieka 47654bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 47664bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 47674bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 47684bae9090SBartlomiej Sieka 4769c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 4770c609719bSwdenk "bootp" will just load perform a lookup of the 4771c609719bSwdenk configuration from the BOOTP server, but not try to 4772c609719bSwdenk load any image using TFTP 4773c609719bSwdenk 4774c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 4775c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 4776c609719bSwdenk be automatically started (by internally calling 4777c609719bSwdenk "bootm") 4778c609719bSwdenk 47794a6fd34bSwdenk If set to "no", a standalone image passed to the 47804a6fd34bSwdenk "bootm" command will be copied to the load address 47814a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 47824a6fd34bSwdenk This can be used to load and uncompress arbitrary 47834a6fd34bSwdenk data. 47844a6fd34bSwdenk 4785a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 4786a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 4787fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 4788fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 4789fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 4790fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 4791fa34f6b2SShawn Guo device tree blob be copied to the maximum address 4792fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 4793fa34f6b2SShawn Guo access it during the boot procedure. 4794fa34f6b2SShawn Guo 4795a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 4796a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 4797a28afca5SDavid A. Long to work it must reside in writable memory, have 4798a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 4799a28afca5SDavid A. Long add the information it needs into it, and the memory 4800a28afca5SDavid A. Long must be accessible by the kernel. 4801a28afca5SDavid A. Long 4802eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 4803eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 4804eea63e05SSimon Glass defined. 4805eea63e05SSimon Glass 480617ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 480717ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 480817ea1177Swdenk mode (400kHZ). This environment variable is used in 480917ea1177Swdenk initialization code. So, for changes to be effective 481017ea1177Swdenk it must be saved and board must be reset. 481117ea1177Swdenk 4812c609719bSwdenk initrd_high - restrict positioning of initrd images: 4813c609719bSwdenk If this variable is not set, initrd images will be 4814c609719bSwdenk copied to the highest possible address in RAM; this 4815c609719bSwdenk is usually what you want since it allows for 4816c609719bSwdenk maximum initrd size. If for some reason you want to 4817c609719bSwdenk make sure that the initrd image is loaded below the 48186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4819c609719bSwdenk variable to a value of "no" or "off" or "0". 4820c609719bSwdenk Alternatively, you can set it to a maximum upper 4821c609719bSwdenk address to use (U-Boot will still check that it 4822c609719bSwdenk does not overwrite the U-Boot stack and data). 4823c609719bSwdenk 4824c609719bSwdenk For instance, when you have a system with 16 MB 48257152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4826c609719bSwdenk you can do this by adding "mem=12M" to the value of 4827c609719bSwdenk the "bootargs" variable. However, now you must make 48287152b1d0Swdenk sure that the initrd image is placed in the first 4829c609719bSwdenk 12 MB as well - this can be done with 4830c609719bSwdenk 4831c609719bSwdenk setenv initrd_high 00c00000 4832c609719bSwdenk 483338b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 483438b99261Swdenk indication to U-Boot that all addresses are legal 483538b99261Swdenk for the Linux kernel, including addresses in flash 483638b99261Swdenk memory. In this case U-Boot will NOT COPY the 483738b99261Swdenk ramdisk at all. This may be useful to reduce the 483838b99261Swdenk boot time on your system, but requires that this 483938b99261Swdenk feature is supported by your Linux kernel. 484038b99261Swdenk 4841c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4842c609719bSwdenk 4843c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4844dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4845c609719bSwdenk 4846c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 4847c609719bSwdenk 4848c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 4849c609719bSwdenk 4850c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 4851c609719bSwdenk 4852c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4853c609719bSwdenk 4854c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4855c609719bSwdenk 4856e2a53458SMike Frysinger ethprime - controls which interface is used first. 4857a3d991bdSwdenk 4858e2a53458SMike Frysinger ethact - controls which interface is currently active. 4859e2a53458SMike Frysinger For example you can do the following 4860a3d991bdSwdenk 486148690d80SHeiko Schocher => setenv ethact FEC 486248690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 486348690d80SHeiko Schocher => setenv ethact SCC 486448690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 4865a3d991bdSwdenk 4866e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 4867e1692577SMatthias Fuchs available network interfaces. 4868e1692577SMatthias Fuchs It just stays at the currently selected interface. 4869e1692577SMatthias Fuchs 4870a3d991bdSwdenk netretry - When set to "no" each network operation will 4871a3d991bdSwdenk either succeed or fail without retrying. 48726e592385Swdenk When set to "once" the network operation will 48736e592385Swdenk fail when all the available network interfaces 48746e592385Swdenk are tried once without success. 4875a3d991bdSwdenk Useful on scripts which control the retry operation 4876a3d991bdSwdenk themselves. 4877a3d991bdSwdenk 4878b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 4879a1cf027aSJean-Christophe PLAGNIOL-VILLARD 4880b445bbb4SJeremiah Mahler silent_linux - If set then Linux will be told to boot silently, by 48818d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 48828d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 48838d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 48848d51aacdSSimon Glass is silent. 48858d51aacdSSimon Glass 4886f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpsrcp - If this is set, the value is used for TFTP's 4887ecb0ccd9SWolfgang Denk UDP source port. 4888ecb0ccd9SWolfgang Denk 4889f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpdstp - If this is set, the value is used for TFTP's UDP 489028cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 489128cb9375SWolfgang Denk 4892c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 4893c96f86eeSWolfgang Denk we use the TFTP server's default block size 4894c96f86eeSWolfgang Denk 4895c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 4896c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 4897c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 4898c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 4899c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 4900c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 4901c96f86eeSWolfgang Denk with unreliable TFTP servers. 4902c96f86eeSWolfgang Denk 4903f5fb7346SAlbert ARIBAUD \(3ADEV\) tftptimeoutcountmax - maximum count of TFTP timeouts (no 4904f5fb7346SAlbert ARIBAUD \(3ADEV\) unit, minimum value = 0). Defines how many timeouts 4905f5fb7346SAlbert ARIBAUD \(3ADEV\) can happen during a single file transfer before that 4906f5fb7346SAlbert ARIBAUD \(3ADEV\) transfer is aborted. The default is 10, and 0 means 4907f5fb7346SAlbert ARIBAUD \(3ADEV\) 'no timeouts allowed'. Increasing this value may help 4908f5fb7346SAlbert ARIBAUD \(3ADEV\) downloads succeed with high packet loss rates, or with 4909f5fb7346SAlbert ARIBAUD \(3ADEV\) unreliable TFTP servers or client hardware. 4910f5fb7346SAlbert ARIBAUD \(3ADEV\) 4911a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 491211ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 4913a3d991bdSwdenk VLAN tagged frames. 4914c609719bSwdenk 491550768f5bSAlexandre Messier bootpretryperiod - Period during which BOOTP/DHCP sends retries. 491650768f5bSAlexandre Messier Unsigned value, in milliseconds. If not set, the period will 491750768f5bSAlexandre Messier be either the default (28000), or a value based on 491850768f5bSAlexandre Messier CONFIG_NET_RETRY_COUNT, if defined. This value has 491950768f5bSAlexandre Messier precedence over the valu based on CONFIG_NET_RETRY_COUNT. 492050768f5bSAlexandre Messier 4921dc0b7b0eSJason HobbsThe following image location variables contain the location of images 4922dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 4923dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 4924dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 4925dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 4926dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 4927dc0b7b0eSJason Hobbsflash or offset in NAND flash. 4928dc0b7b0eSJason Hobbs 4929dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 4930aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some 4931dc0b7b0eSJason Hobbsboards use these variables for other purposes. 4932dc0b7b0eSJason Hobbs 4933dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 4934dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 4935dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 4936dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 4937dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 4938dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4939dc0b7b0eSJason Hobbs 4940c609719bSwdenkThe following environment variables may be used and automatically 4941c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 4942c609719bSwdenkdepending the information provided by your boot server: 4943c609719bSwdenk 4944c609719bSwdenk bootfile - see above 4945c609719bSwdenk dnsip - IP address of your Domain Name Server 4946fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 4947c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 4948c609719bSwdenk hostname - Target hostname 4949c609719bSwdenk ipaddr - see above 4950c609719bSwdenk netmask - Subnet Mask 4951c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 4952c609719bSwdenk serverip - see above 4953c609719bSwdenk 4954c609719bSwdenk 4955c609719bSwdenkThere are two special Environment Variables: 4956c609719bSwdenk 4957c609719bSwdenk serial# - contains hardware identification information such 4958c609719bSwdenk as type string and/or serial number 4959c609719bSwdenk ethaddr - Ethernet address 4960c609719bSwdenk 4961c609719bSwdenkThese variables can be set only once (usually during manufacturing of 4962c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 4963c609719bSwdenkonce they have been set once. 4964c609719bSwdenk 4965c609719bSwdenk 4966c1551ea8SstroeseFurther special Environment Variables: 4967c1551ea8Sstroese 4968c1551ea8Sstroese ver - Contains the U-Boot version string as printed 4969c1551ea8Sstroese with the "version" command. This variable is 4970c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 4971c1551ea8Sstroese 4972c1551ea8Sstroese 4973c609719bSwdenkPlease note that changes to some configuration parameters may take 4974c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 4975c609719bSwdenk 4976c609719bSwdenk 4977170ab110SJoe HershbergerCallback functions for environment variables: 4978170ab110SJoe Hershberger--------------------------------------------- 4979170ab110SJoe Hershberger 4980170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 4981b445bbb4SJeremiah Mahlerwhen their values are changed. This functionality allows functions to 4982170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 4983170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 4984170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 4985170ab110SJoe Hershberger 4986170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 4987170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 4988170ab110SJoe Hershberger 4989170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 4990170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4991170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 4992170ab110SJoe Hershbergerassociations. The list must be in the following format: 4993170ab110SJoe Hershberger 4994170ab110SJoe Hershberger entry = variable_name[:callback_name] 4995170ab110SJoe Hershberger list = entry[,list] 4996170ab110SJoe Hershberger 4997170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 4998170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 4999170ab110SJoe Hershberger 5000170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 5001170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 5002170ab110SJoe Hershbergeroverride any association in the static list. You can define 5003170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 5004b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment. 5005170ab110SJoe Hershberger 5006bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a 5007bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to 5008bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out. 5009bdf1fe4eSJoe Hershberger 5010170ab110SJoe Hershberger 5011f07771ccSwdenkCommand Line Parsing: 5012f07771ccSwdenk===================== 5013f07771ccSwdenk 5014f07771ccSwdenkThere are two different command line parsers available with U-Boot: 50157152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 5016f07771ccSwdenk 5017f07771ccSwdenkOld, simple command line parser: 5018f07771ccSwdenk-------------------------------- 5019f07771ccSwdenk 5020f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 5021f07771ccSwdenk- several commands on one line, separated by ';' 5022fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 5023f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 5024f07771ccSwdenk for example: 5025fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 5026f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 5027f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 5028f07771ccSwdenk 5029f07771ccSwdenkHush shell: 5030f07771ccSwdenk----------- 5031f07771ccSwdenk 5032f07771ccSwdenk- similar to Bourne shell, with control structures like 5033f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 5034f07771ccSwdenk until...do...done, ... 5035f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 5036f07771ccSwdenk commands) and local shell variables (through standard shell syntax 5037f07771ccSwdenk "name=value"); only environment variables can be used with "run" 5038f07771ccSwdenk command 5039f07771ccSwdenk 5040f07771ccSwdenkGeneral rules: 5041f07771ccSwdenk-------------- 5042f07771ccSwdenk 5043f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 5044f07771ccSwdenk command) contains several commands separated by semicolon, and 5045f07771ccSwdenk one of these commands fails, then the remaining commands will be 5046f07771ccSwdenk executed anyway. 5047f07771ccSwdenk 5048f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 504911ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 5050f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 5051f07771ccSwdenk variables are not executed. 5052f07771ccSwdenk 5053c609719bSwdenkNote for Redundant Ethernet Interfaces: 5054c609719bSwdenk======================================= 5055c609719bSwdenk 505611ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 5057c609719bSwdenksuch configurations and is capable of automatic selection of a 50587152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 5059c609719bSwdenk 5060c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 5061c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5062c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 5063c609719bSwdenk 5064c609719bSwdenkIf the network interface stores some valid MAC address (for instance 5065c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 5066c609719bSwdenkding setting in the environment; if the corresponding environment 5067c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 5068c609719bSwdenk 5069c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 5070c609719bSwdenk environment, the SROM's address is used. 5071c609719bSwdenk 5072c609719bSwdenko If there is no valid address in the SROM, and a definition in the 5073c609719bSwdenk environment exists, then the value from the environment variable is 5074c609719bSwdenk used. 5075c609719bSwdenk 5076c609719bSwdenko If both the SROM and the environment contain a MAC address, and 5077c609719bSwdenk both addresses are the same, this MAC address is used. 5078c609719bSwdenk 5079c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 5080c609719bSwdenk addresses differ, the value from the environment is used and a 5081c609719bSwdenk warning is printed. 5082c609719bSwdenk 5083c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 5084bef1014bSJoe Hershberger is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case 5085bef1014bSJoe Hershberger a random, locally-assigned MAC is used. 5086c609719bSwdenk 5087ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5088ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 5089ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 5090ecee9324SBen WarrenThe naming convention is as follows: 5091ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5092c609719bSwdenk 5093c609719bSwdenkImage Formats: 5094c609719bSwdenk============== 5095c609719bSwdenk 50963310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 50973310c549SMarian Balakowiczimages in two formats: 50983310c549SMarian Balakowicz 50993310c549SMarian BalakowiczNew uImage format (FIT) 51003310c549SMarian Balakowicz----------------------- 51013310c549SMarian Balakowicz 51023310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 51033310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 51043310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 51053310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 51063310c549SMarian Balakowicz 51073310c549SMarian Balakowicz 51083310c549SMarian BalakowiczOld uImage format 51093310c549SMarian Balakowicz----------------- 51103310c549SMarian Balakowicz 51113310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 51123310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 51133310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 5114c609719bSwdenk 5115c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5116c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5117f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5118f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5119f5ed9e39SPeter Tyser INTEGRITY). 51207b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5121afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5122afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5123c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 5124c609719bSwdenk* Load Address 5125c609719bSwdenk* Entry Point 5126c609719bSwdenk* Image Name 5127c609719bSwdenk* Image Timestamp 5128c609719bSwdenk 5129c609719bSwdenkThe header is marked by a special Magic Number, and both the header 5130c609719bSwdenkand the data portions of the image are secured against corruption by 5131c609719bSwdenkCRC32 checksums. 5132c609719bSwdenk 5133c609719bSwdenk 5134c609719bSwdenkLinux Support: 5135c609719bSwdenk============== 5136c609719bSwdenk 5137c609719bSwdenkAlthough U-Boot should support any OS or standalone application 51387152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 5139c609719bSwdenkU-Boot. 5140c609719bSwdenk 5141c609719bSwdenkU-Boot includes many features that so far have been part of some 5142c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 5143c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 5144c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 51457152b1d0Swdenkserves several purposes: 5146c609719bSwdenk 5147c609719bSwdenk- the same features can be used for other OS or standalone 5148c609719bSwdenk applications (for instance: using compressed images to reduce the 5149c609719bSwdenk Flash memory footprint) 5150c609719bSwdenk 5151c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 51527152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 5153c609719bSwdenk 5154c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 5155c609719bSwdenk images; of course this also means that different kernel images can 5156c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 5157c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 5158c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 5159c609719bSwdenk software is easier now. 5160c609719bSwdenk 5161c609719bSwdenk 5162c609719bSwdenkLinux HOWTO: 5163c609719bSwdenk============ 5164c609719bSwdenk 5165c609719bSwdenkPorting Linux to U-Boot based systems: 5166c609719bSwdenk--------------------------------------- 5167c609719bSwdenk 5168c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 5169c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 5170c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 5171c609719bSwdenkLinux :-). 5172c609719bSwdenk 5173a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5174c609719bSwdenk 5175c609719bSwdenkJust make sure your machine specific header file (for instance 5176c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 51771dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 51781dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 51796d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 5180c609719bSwdenk 51812eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers. 51822eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there 51832eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See 51842eb31b13SSimon Glassdoc/driver-model. 51852eb31b13SSimon Glass 5186c609719bSwdenk 5187c609719bSwdenkConfiguring the Linux kernel: 5188c609719bSwdenk----------------------------- 5189c609719bSwdenk 5190c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 5191c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 5192c609719bSwdenk 5193c609719bSwdenk 5194c609719bSwdenkBuilding a Linux Image: 5195c609719bSwdenk----------------------- 5196c609719bSwdenk 519724ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 519824ee89b9Swdenknot used. If you use recent kernel source, a new build target 519924ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 520024ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 520124ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 520224ee89b9Swdenk100% compatible format. 5203c609719bSwdenk 5204c609719bSwdenkExample: 5205c609719bSwdenk 5206ab584d67SHolger Freyther make TQM850L_defconfig 5207c609719bSwdenk make oldconfig 5208c609719bSwdenk make dep 520924ee89b9Swdenk make uImage 5210c609719bSwdenk 521124ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 521224ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 521324ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 5214c609719bSwdenk 521524ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 521624ee89b9Swdenk 521724ee89b9Swdenk* convert the kernel into a raw binary image: 521824ee89b9Swdenk 521924ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 522024ee89b9Swdenk -R .note -R .comment \ 522124ee89b9Swdenk -S vmlinux linux.bin 522224ee89b9Swdenk 522324ee89b9Swdenk* compress the binary image: 522424ee89b9Swdenk 522524ee89b9Swdenk gzip -9 linux.bin 522624ee89b9Swdenk 522724ee89b9Swdenk* package compressed binary image for U-Boot: 522824ee89b9Swdenk 522924ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 523024ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 523124ee89b9Swdenk -d linux.bin.gz uImage 523224ee89b9Swdenk 523324ee89b9Swdenk 523424ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 523524ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 523624ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 523724ee89b9Swdenkbyte header containing information about target architecture, 523824ee89b9Swdenkoperating system, image type, compression method, entry points, time 523924ee89b9Swdenkstamp, CRC32 checksums, etc. 524024ee89b9Swdenk 524124ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 524224ee89b9Swdenkprint the header information, or to build new images. 5243c609719bSwdenk 5244c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 5245c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 5246c609719bSwdenkchecksum verification: 5247c609719bSwdenk 5248c609719bSwdenk tools/mkimage -l image 5249c609719bSwdenk -l ==> list image header information 5250c609719bSwdenk 5251c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 5252c609719bSwdenkfrom a "data file" which is used as image payload: 5253c609719bSwdenk 5254c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5255c609719bSwdenk -n name -d data_file image 5256c609719bSwdenk -A ==> set architecture to 'arch' 5257c609719bSwdenk -O ==> set operating system to 'os' 5258c609719bSwdenk -T ==> set image type to 'type' 5259c609719bSwdenk -C ==> set compression type 'comp' 5260c609719bSwdenk -a ==> set load address to 'addr' (hex) 5261c609719bSwdenk -e ==> set entry point to 'ep' (hex) 5262c609719bSwdenk -n ==> set image name to 'name' 5263c609719bSwdenk -d ==> use image data from 'datafile' 5264c609719bSwdenk 526569459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 526669459791Swdenkaddress (0x00000000), but the entry point address depends on the 526769459791Swdenkkernel version: 5268c609719bSwdenk 5269c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 527024ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 5271c609719bSwdenk 5272c609719bSwdenkSo a typical call to build a U-Boot image would read: 5273c609719bSwdenk 527424ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 527524ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5276a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 527724ee89b9Swdenk > examples/uImage.TQM850L 527824ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5279c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5280c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5281c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5282c609719bSwdenk Load Address: 0x00000000 528324ee89b9Swdenk Entry Point: 0x00000000 5284c609719bSwdenk 5285c609719bSwdenkTo verify the contents of the image (or check for corruption): 5286c609719bSwdenk 528724ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 528824ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5289c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5290c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5291c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5292c609719bSwdenk Load Address: 0x00000000 529324ee89b9Swdenk Entry Point: 0x00000000 5294c609719bSwdenk 5295c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 5296c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 5297c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 5298c609719bSwdenkneed to be uncompressed: 5299c609719bSwdenk 5300a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 530124ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 530224ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5303a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 530424ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 530524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5306c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5307c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 5308c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5309c609719bSwdenk Load Address: 0x00000000 531024ee89b9Swdenk Entry Point: 0x00000000 5311c609719bSwdenk 5312c609719bSwdenk 5313c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 5314c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 5315c609719bSwdenk 5316c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 5317c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 5318c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5319c609719bSwdenk Image Name: Simple Ramdisk Image 5320c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 5321c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5322c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5323c609719bSwdenk Load Address: 0x00000000 5324c609719bSwdenk Entry Point: 0x00000000 5325c609719bSwdenk 5326a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5327a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 5328a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 5329a804b5ceSGuilherme Maciel Ferreirafrom the image: 5330a804b5ceSGuilherme Maciel Ferreira 5331f41f5b7cSGuilherme Maciel Ferreira tools/dumpimage -i image -T type -p position data_file 5332f41f5b7cSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file' 5333f41f5b7cSGuilherme Maciel Ferreira -T ==> set image type to 'type' 5334f41f5b7cSGuilherme Maciel Ferreira -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' 5335a804b5ceSGuilherme Maciel Ferreira 5336c609719bSwdenk 5337c609719bSwdenkInstalling a Linux Image: 5338c609719bSwdenk------------------------- 5339c609719bSwdenk 5340c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 5341c609719bSwdenkyou must convert the image to S-Record format: 5342c609719bSwdenk 5343c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 5344c609719bSwdenk 5345c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 5346c609719bSwdenkimage header, so the resulting S-Record file will be relative to 5347c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 5348c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 5349c609719bSwdenkcommand. 5350c609719bSwdenk 5351c609719bSwdenkExample: install the image to address 0x40100000 (which on the 5352c609719bSwdenkTQM8xxL is in the first Flash bank): 5353c609719bSwdenk 5354c609719bSwdenk => erase 40100000 401FFFFF 5355c609719bSwdenk 5356c609719bSwdenk .......... done 5357c609719bSwdenk Erased 8 sectors 5358c609719bSwdenk 5359c609719bSwdenk => loads 40100000 5360c609719bSwdenk ## Ready for S-Record download ... 5361c609719bSwdenk ~>examples/image.srec 5362c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5363c609719bSwdenk ... 5364c609719bSwdenk 15989 15990 15991 15992 5365c609719bSwdenk [file transfer complete] 5366c609719bSwdenk [connected] 5367c609719bSwdenk ## Start Addr = 0x00000000 5368c609719bSwdenk 5369c609719bSwdenk 5370c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 5371c609719bSwdenkthis includes a checksum verification so you can be sure no data 5372c609719bSwdenkcorruption happened: 5373c609719bSwdenk 5374c609719bSwdenk => imi 40100000 5375c609719bSwdenk 5376c609719bSwdenk ## Checking Image at 40100000 ... 5377c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5378c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5379c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5380c609719bSwdenk Load Address: 00000000 5381c609719bSwdenk Entry Point: 0000000c 5382c609719bSwdenk Verifying Checksum ... OK 5383c609719bSwdenk 5384c609719bSwdenk 5385c609719bSwdenkBoot Linux: 5386c609719bSwdenk----------- 5387c609719bSwdenk 5388c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 5389c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 5390c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 5391c609719bSwdenkparameters. You can check and modify this variable using the 5392c609719bSwdenk"printenv" and "setenv" commands: 5393c609719bSwdenk 5394c609719bSwdenk 5395c609719bSwdenk => printenv bootargs 5396c609719bSwdenk bootargs=root=/dev/ram 5397c609719bSwdenk 5398c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5399c609719bSwdenk 5400c609719bSwdenk => printenv bootargs 5401c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5402c609719bSwdenk 5403c609719bSwdenk => bootm 40020000 5404c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5405c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5406c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5407c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5408c609719bSwdenk Load Address: 00000000 5409c609719bSwdenk Entry Point: 0000000c 5410c609719bSwdenk Verifying Checksum ... OK 5411c609719bSwdenk Uncompressing Kernel Image ... OK 5412c609719bSwdenk 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 5413c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5414c609719bSwdenk time_init: decrementer frequency = 187500000/60 5415c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5416c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5417c609719bSwdenk ... 5418c609719bSwdenk 541911ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 54207152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5421c609719bSwdenkformat!) to the "bootm" command: 5422c609719bSwdenk 5423c609719bSwdenk => imi 40100000 40200000 5424c609719bSwdenk 5425c609719bSwdenk ## Checking Image at 40100000 ... 5426c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5427c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5428c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5429c609719bSwdenk Load Address: 00000000 5430c609719bSwdenk Entry Point: 0000000c 5431c609719bSwdenk Verifying Checksum ... OK 5432c609719bSwdenk 5433c609719bSwdenk ## Checking Image at 40200000 ... 5434c609719bSwdenk Image Name: Simple Ramdisk Image 5435c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5436c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5437c609719bSwdenk Load Address: 00000000 5438c609719bSwdenk Entry Point: 00000000 5439c609719bSwdenk Verifying Checksum ... OK 5440c609719bSwdenk 5441c609719bSwdenk => bootm 40100000 40200000 5442c609719bSwdenk ## Booting Linux kernel at 40100000 ... 5443c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5444c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5445c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5446c609719bSwdenk Load Address: 00000000 5447c609719bSwdenk Entry Point: 0000000c 5448c609719bSwdenk Verifying Checksum ... OK 5449c609719bSwdenk Uncompressing Kernel Image ... OK 5450c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 5451c609719bSwdenk Image Name: Simple Ramdisk Image 5452c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5453c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5454c609719bSwdenk Load Address: 00000000 5455c609719bSwdenk Entry Point: 00000000 5456c609719bSwdenk Verifying Checksum ... OK 5457c609719bSwdenk Loading Ramdisk ... OK 5458c609719bSwdenk 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 5459c609719bSwdenk Boot arguments: root=/dev/ram 5460c609719bSwdenk time_init: decrementer frequency = 187500000/60 5461c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5462c609719bSwdenk ... 5463c609719bSwdenk RAMDISK: Compressed image found at block 0 5464c609719bSwdenk VFS: Mounted root (ext2 filesystem). 5465c609719bSwdenk 5466c609719bSwdenk bash# 5467c609719bSwdenk 54680267768eSMatthew McClintockBoot Linux and pass a flat device tree: 54690267768eSMatthew McClintock----------- 54700267768eSMatthew McClintock 54710267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 54720267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 54730267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 54740267768eSMatthew McClintockflat device tree: 54750267768eSMatthew McClintock 54760267768eSMatthew McClintock=> print oftaddr 54770267768eSMatthew McClintockoftaddr=0x300000 54780267768eSMatthew McClintock=> print oft 54790267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 54800267768eSMatthew McClintock=> tftp $oftaddr $oft 54810267768eSMatthew McClintockSpeed: 1000, full duplex 54820267768eSMatthew McClintockUsing TSEC0 device 54830267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 54840267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 54850267768eSMatthew McClintockLoad address: 0x300000 54860267768eSMatthew McClintockLoading: # 54870267768eSMatthew McClintockdone 54880267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 54890267768eSMatthew McClintock=> tftp $loadaddr $bootfile 54900267768eSMatthew McClintockSpeed: 1000, full duplex 54910267768eSMatthew McClintockUsing TSEC0 device 54920267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 54930267768eSMatthew McClintockFilename 'uImage'. 54940267768eSMatthew McClintockLoad address: 0x200000 54950267768eSMatthew McClintockLoading:############ 54960267768eSMatthew McClintockdone 54970267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 54980267768eSMatthew McClintock=> print loadaddr 54990267768eSMatthew McClintockloadaddr=200000 55000267768eSMatthew McClintock=> print oftaddr 55010267768eSMatthew McClintockoftaddr=0x300000 55020267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 55030267768eSMatthew McClintock## Booting image at 00200000 ... 55040267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 55050267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 55060267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 55070267768eSMatthew McClintock Load Address: 00000000 55080267768eSMatthew McClintock Entry Point: 00000000 55090267768eSMatthew McClintock Verifying Checksum ... OK 55100267768eSMatthew McClintock Uncompressing Kernel Image ... OK 55110267768eSMatthew McClintockBooting using flat device tree at 0x300000 55120267768eSMatthew McClintockUsing MPC85xx ADS machine description 55130267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 55140267768eSMatthew McClintock[snip] 55150267768eSMatthew McClintock 55160267768eSMatthew McClintock 55176069ff26SwdenkMore About U-Boot Image Types: 55186069ff26Swdenk------------------------------ 55196069ff26Swdenk 55206069ff26SwdenkU-Boot supports the following image types: 55216069ff26Swdenk 55226069ff26Swdenk "Standalone Programs" are directly runnable in the environment 55236069ff26Swdenk provided by U-Boot; it is expected that (if they behave 55246069ff26Swdenk well) you can continue to work in U-Boot after return from 55256069ff26Swdenk the Standalone Program. 55266069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 55276069ff26Swdenk will take over control completely. Usually these programs 55286069ff26Swdenk will install their own set of exception handlers, device 55296069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 55306069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 55316069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 55326069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 55336069ff26Swdenk being started. 55346069ff26Swdenk "Multi-File Images" contain several images, typically an OS 55356069ff26Swdenk (Linux) kernel image and one or more data images like 55366069ff26Swdenk RAMDisks. This construct is useful for instance when you want 55376069ff26Swdenk to boot over the network using BOOTP etc., where the boot 55386069ff26Swdenk server provides just a single image file, but you want to get 55396069ff26Swdenk for instance an OS kernel and a RAMDisk image. 55406069ff26Swdenk 55416069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 55426069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 55436069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 55446069ff26Swdenk Immediately after the terminating 0 follow the images, one by 55456069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 55466069ff26Swdenk a multiple of 4 bytes). 55476069ff26Swdenk 55486069ff26Swdenk "Firmware Images" are binary images containing firmware (like 55496069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 55506069ff26Swdenk flash memory. 55516069ff26Swdenk 55526069ff26Swdenk "Script files" are command sequences that will be executed by 55536069ff26Swdenk U-Boot's command interpreter; this feature is especially 55546069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 55556069ff26Swdenk as command interpreter. 55566069ff26Swdenk 555744f074c7SMarek VasutBooting the Linux zImage: 555844f074c7SMarek Vasut------------------------- 555944f074c7SMarek Vasut 556044f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 556144f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 556244f074c7SMarek Vasutas the syntax of "bootm" command. 556344f074c7SMarek Vasut 55648ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5565017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 5566017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 5567017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 5568017e1f3fSMarek Vasut 5569c609719bSwdenk 5570c609719bSwdenkStandalone HOWTO: 5571c609719bSwdenk================= 5572c609719bSwdenk 5573c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 5574c609719bSwdenkrun "standalone" applications, which can use some resources of 5575c609719bSwdenkU-Boot like console I/O functions or interrupt services. 5576c609719bSwdenk 5577c609719bSwdenkTwo simple examples are included with the sources: 5578c609719bSwdenk 5579c609719bSwdenk"Hello World" Demo: 5580c609719bSwdenk------------------- 5581c609719bSwdenk 5582c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 5583c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 5584c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 5585c609719bSwdenklike that: 5586c609719bSwdenk 5587c609719bSwdenk => loads 5588c609719bSwdenk ## Ready for S-Record download ... 5589c609719bSwdenk ~>examples/hello_world.srec 5590c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5591c609719bSwdenk [file transfer complete] 5592c609719bSwdenk [connected] 5593c609719bSwdenk ## Start Addr = 0x00040004 5594c609719bSwdenk 5595c609719bSwdenk => go 40004 Hello World! This is a test. 5596c609719bSwdenk ## Starting application at 0x00040004 ... 5597c609719bSwdenk Hello World 5598c609719bSwdenk argc = 7 5599c609719bSwdenk argv[0] = "40004" 5600c609719bSwdenk argv[1] = "Hello" 5601c609719bSwdenk argv[2] = "World!" 5602c609719bSwdenk argv[3] = "This" 5603c609719bSwdenk argv[4] = "is" 5604c609719bSwdenk argv[5] = "a" 5605c609719bSwdenk argv[6] = "test." 5606c609719bSwdenk argv[7] = "<NULL>" 5607c609719bSwdenk Hit any key to exit ... 5608c609719bSwdenk 5609c609719bSwdenk ## Application terminated, rc = 0x0 5610c609719bSwdenk 5611c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 5612c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 5613c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 5614c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 5615c609719bSwdenkcharacter, but this is just a demo program. The application can be 5616c609719bSwdenkcontrolled by the following keys: 5617c609719bSwdenk 5618c609719bSwdenk ? - print current values og the CPM Timer registers 5619c609719bSwdenk b - enable interrupts and start timer 5620c609719bSwdenk e - stop timer and disable interrupts 5621c609719bSwdenk q - quit application 5622c609719bSwdenk 5623c609719bSwdenk => loads 5624c609719bSwdenk ## Ready for S-Record download ... 5625c609719bSwdenk ~>examples/timer.srec 5626c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5627c609719bSwdenk [file transfer complete] 5628c609719bSwdenk [connected] 5629c609719bSwdenk ## Start Addr = 0x00040004 5630c609719bSwdenk 5631c609719bSwdenk => go 40004 5632c609719bSwdenk ## Starting application at 0x00040004 ... 5633c609719bSwdenk TIMERS=0xfff00980 5634c609719bSwdenk Using timer 1 5635c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5636c609719bSwdenk 5637c609719bSwdenkHit 'b': 5638c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 5639c609719bSwdenk Enabling timer 5640c609719bSwdenkHit '?': 5641c609719bSwdenk [q, b, e, ?] ........ 5642c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5643c609719bSwdenkHit '?': 5644c609719bSwdenk [q, b, e, ?] . 5645c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5646c609719bSwdenkHit '?': 5647c609719bSwdenk [q, b, e, ?] . 5648c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5649c609719bSwdenkHit '?': 5650c609719bSwdenk [q, b, e, ?] . 5651c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5652c609719bSwdenkHit 'e': 5653c609719bSwdenk [q, b, e, ?] ...Stopping timer 5654c609719bSwdenkHit 'q': 5655c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 5656c609719bSwdenk 5657c609719bSwdenk 565885ec0bccSwdenkMinicom warning: 565985ec0bccSwdenk================ 566085ec0bccSwdenk 56617152b1d0SwdenkOver time, many people have reported problems when trying to use the 566285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 566385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 5664f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 566585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 5666e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 5667e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5668e53515a2SKarl O. Pincfor help with kermit. 5669e53515a2SKarl O. Pinc 567085ec0bccSwdenk 567152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 567252f52c14Swdenkconfiguration to your "File transfer protocols" section: 567352f52c14Swdenk 567452f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 567552f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 567652f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 567752f52c14Swdenk 567852f52c14Swdenk 5679c609719bSwdenkNetBSD Notes: 5680c609719bSwdenk============= 5681c609719bSwdenk 5682c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 5683c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 5684c609719bSwdenk 5685c609719bSwdenkBuilding requires a cross environment; it is known to work on 5686c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5687c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 5688c609719bSwdenkNote that the cross-powerpc package does not install include files; 5689c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 5690c609719bSwdenkmissing. This file has to be installed and patched manually: 5691c609719bSwdenk 5692c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 5693c609719bSwdenk # mkdir powerpc 5694c609719bSwdenk # ln -s powerpc machine 5695c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5696c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5697c609719bSwdenk 5698c609719bSwdenkNative builds *don't* work due to incompatibilities between native 5699c609719bSwdenkand U-Boot include files. 5700c609719bSwdenk 5701c609719bSwdenkBooting assumes that (the first part of) the image booted is a 5702c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 5703c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 5704c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 57052a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5706c609719bSwdenk 5707c609719bSwdenk 5708c609719bSwdenkImplementation Internals: 5709c609719bSwdenk========================= 5710c609719bSwdenk 5711c609719bSwdenkThe following is not intended to be a complete description of every 5712c609719bSwdenkimplementation detail. However, it should help to understand the 5713c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 5714c609719bSwdenkhardware. 5715c609719bSwdenk 5716c609719bSwdenk 5717c609719bSwdenkInitial Stack, Global Data: 5718c609719bSwdenk--------------------------- 5719c609719bSwdenk 5720c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 5721c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 5722c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 5723c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 5724c609719bSwdenkis not initialized as zero. To be able to get a C environment working 5725c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 5726c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 5727c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 5728c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 5729c609719bSwdenklocked as (mis-) used as memory, etc. 5730c609719bSwdenk 57317152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 57320668236bSWolfgang Denk U-Boot mailing list: 573343d9616cSwdenk 573443d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 573543d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 573643d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 573743d9616cSwdenk ... 573843d9616cSwdenk 573943d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 574043d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 574143d9616cSwdenk require any physical RAM backing up the cache. The cleverness 574243d9616cSwdenk is that the cache is being used as a temporary supply of 574343d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 574411ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 574543d9616cSwdenk can see how this works by studying the cache architecture and 574643d9616cSwdenk operation in the architecture and processor-specific manuals. 574743d9616cSwdenk 574843d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 574943d9616cSwdenk is another option for the system designer to use as an 575011ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 575143d9616cSwdenk option should work for you. Using CS 4 should be fine if your 575243d9616cSwdenk board designers haven't used it for something that would 575343d9616cSwdenk cause you grief during the initial boot! It is frequently not 575443d9616cSwdenk used. 575543d9616cSwdenk 57566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 575743d9616cSwdenk with your processor/board/system design. The default value 575843d9616cSwdenk you will find in any recent u-boot distribution in 57598a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 576043d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 576143d9616cSwdenk it above 400_0000. Just make sure your board has no resources 576243d9616cSwdenk that are supposed to respond to that address! That code in 576343d9616cSwdenk start.S has been around a while and should work as is when 576443d9616cSwdenk you get the config right. 576543d9616cSwdenk 576643d9616cSwdenk -Chris Hallinan 576743d9616cSwdenk DS4.COM, Inc. 576843d9616cSwdenk 5769c609719bSwdenkIt is essential to remember this, since it has some impact on the C 5770c609719bSwdenkcode for the initialization procedures: 5771c609719bSwdenk 5772c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 5773c609719bSwdenk to write it. 5774c609719bSwdenk 5775b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized 5776c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 57777152b1d0Swdenk zation is performed later (when relocating to RAM). 5778c609719bSwdenk 5779c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 5780c609719bSwdenk that. 5781c609719bSwdenk 5782c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 5783b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it 5784c609719bSwdenkturned out that the implementation of U-Boot can be greatly 5785c609719bSwdenksimplified by making a global data structure (gd_t) available to all 5786c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 5787c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 5788c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 5789c609719bSwdenkplace a pointer (gd) to the global data into a register which we 5790c609719bSwdenkreserve for this purpose. 5791c609719bSwdenk 57927152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 5793c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 5794c609719bSwdenkGCC's implementation. 5795c609719bSwdenk 5796c609719bSwdenkFor PowerPC, the following registers have specific use: 5797c609719bSwdenk R1: stack pointer 5798e7670f6cSWolfgang Denk R2: reserved for system use 5799c609719bSwdenk R3-R4: parameter passing and return values 5800c609719bSwdenk R5-R10: parameter passing 5801c609719bSwdenk R13: small data area pointer 5802c609719bSwdenk R30: GOT pointer 5803c609719bSwdenk R31: frame pointer 5804c609719bSwdenk 5805e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 5806e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 5807e6bee808SJoakim Tjernlund going back and forth between asm and C) 5808c609719bSwdenk 5809e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 5810c609719bSwdenk 5811c609719bSwdenk Note: on PPC, we could use a static initializer (since the 5812c609719bSwdenk address of the global data structure is known at compile time), 5813c609719bSwdenk but it turned out that reserving a register results in somewhat 5814c609719bSwdenk smaller code - although the code savings are not that big (on 5815c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 5816c609719bSwdenk 624 text + 127 data). 5817c609719bSwdenk 5818c609719bSwdenkOn ARM, the following registers are used: 5819c609719bSwdenk 5820c609719bSwdenk R0: function argument word/integer result 5821c609719bSwdenk R1-R3: function argument word 582212eba1b4SJeroen Hofstee R9: platform specific 582312eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 5824c609719bSwdenk R11: argument (frame) pointer 5825c609719bSwdenk R12: temporary workspace 5826c609719bSwdenk R13: stack pointer 5827c609719bSwdenk R14: link register 5828c609719bSwdenk R15: program counter 5829c609719bSwdenk 583012eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 583112eba1b4SJeroen Hofstee 583212eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 5833c609719bSwdenk 58340df01fd3SThomas ChouOn Nios II, the ABI is documented here: 58350df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 58360df01fd3SThomas Chou 58370df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 58380df01fd3SThomas Chou 58390df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 58400df01fd3SThomas Chou to access small data sections, so gp is free. 58410df01fd3SThomas Chou 5842afc1ce82SMacpaul LinOn NDS32, the following registers are used: 5843afc1ce82SMacpaul Lin 5844afc1ce82SMacpaul Lin R0-R1: argument/return 5845afc1ce82SMacpaul Lin R2-R5: argument 5846afc1ce82SMacpaul Lin R15: temporary register for assembler 5847afc1ce82SMacpaul Lin R16: trampoline register 5848afc1ce82SMacpaul Lin R28: frame pointer (FP) 5849afc1ce82SMacpaul Lin R29: global pointer (GP) 5850afc1ce82SMacpaul Lin R30: link register (LP) 5851afc1ce82SMacpaul Lin R31: stack pointer (SP) 5852afc1ce82SMacpaul Lin PC: program counter (PC) 5853afc1ce82SMacpaul Lin 5854afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 5855afc1ce82SMacpaul Lin 5856d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5857d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 5858c609719bSwdenk 5859c609719bSwdenkMemory Management: 5860c609719bSwdenk------------------ 5861c609719bSwdenk 5862c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 5863c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 5864c609719bSwdenk 5865c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 5866c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 5867c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 5868c609719bSwdenkphysical memory banks. 5869c609719bSwdenk 5870c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 5871c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5872c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 5873c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 58746d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5875c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 5876c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 5877c609719bSwdenk 5878c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 5879c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 5880c609719bSwdenk 5881c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 5882c609719bSwdenkthis: 5883c609719bSwdenk 5884c609719bSwdenk 0x0000 0000 Exception Vector code 5885c609719bSwdenk : 5886c609719bSwdenk 0x0000 1FFF 5887c609719bSwdenk 0x0000 2000 Free for Application Use 5888c609719bSwdenk : 5889c609719bSwdenk : 5890c609719bSwdenk 5891c609719bSwdenk : 5892c609719bSwdenk : 5893c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 5894c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 5895c609719bSwdenk 0x00FC 0000 Malloc Arena 5896c609719bSwdenk : 5897c609719bSwdenk 0x00FD FFFF 5898c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 5899c609719bSwdenk ... eventually: LCD or video framebuffer 5900c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 5901c609719bSwdenk 0x00FF FFFF [End of RAM] 5902c609719bSwdenk 5903c609719bSwdenk 5904c609719bSwdenkSystem Initialization: 5905c609719bSwdenk---------------------- 5906c609719bSwdenk 5907c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 590811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 5909c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory. 59107152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 5911c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 5912c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 5913c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 5914c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 5915c609719bSwdenkthe caches and the SIU. 5916c609719bSwdenk 5917c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 5918c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 5919c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5920c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5921c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 5922c609719bSwdenksimple memory test is run that determines the size of the SDRAM 5923c609719bSwdenkbanks. 5924c609719bSwdenk 5925c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 59267152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 5927c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 5928c609719bSwdenk0x00000000, with any additional banks following immediately to create 5929c609719bSwdenkcontiguous memory starting from 0. 5930c609719bSwdenk 5931c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 5932c609719bSwdenkand allocates memory for use by malloc() and for the global Board 5933c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 5934c609719bSwdenkpages, and the final stack is set up. 5935c609719bSwdenk 5936c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 5937c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 5938c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 5939c609719bSwdenknew address in RAM. 5940c609719bSwdenk 5941c609719bSwdenk 5942c609719bSwdenkU-Boot Porting Guide: 5943c609719bSwdenk---------------------- 5944c609719bSwdenk 5945c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 59466aff3115Swdenklist, October 2002] 5947c609719bSwdenk 5948c609719bSwdenk 5949c609719bSwdenkint main(int argc, char *argv[]) 5950c609719bSwdenk{ 5951c609719bSwdenk sighandler_t no_more_time; 5952c609719bSwdenk 5953c609719bSwdenk signal(SIGALRM, no_more_time); 5954c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5955c609719bSwdenk 5956c609719bSwdenk if (available_money > available_manpower) { 59576c3fef28SJerry Van Baren Pay consultant to port U-Boot; 5958c609719bSwdenk return 0; 5959c609719bSwdenk } 5960c609719bSwdenk 5961c609719bSwdenk Download latest U-Boot source; 5962c609719bSwdenk 59630668236bSWolfgang Denk Subscribe to u-boot mailing list; 59646aff3115Swdenk 59656c3fef28SJerry Van Baren if (clueless) 5966c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 5967c609719bSwdenk 5968c609719bSwdenk while (learning) { 5969c609719bSwdenk Read the README file in the top level directory; 59707cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 59716c3fef28SJerry Van Baren Read applicable doc/*.README; 5972c609719bSwdenk Read the source, Luke; 59736c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5974c609719bSwdenk } 5975c609719bSwdenk 59766c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 59776c3fef28SJerry Van Baren Buy a BDI3000; 59786c3fef28SJerry Van Baren else 5979c609719bSwdenk Add a lot of aggravation and time; 5980c609719bSwdenk 59816c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 59826c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 59836c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 59846c3fef28SJerry Van Baren } else { 5985c609719bSwdenk Create your own board support subdirectory; 59866c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 59876c3fef28SJerry Van Baren } 59886c3fef28SJerry Van Baren Edit new board/<myboard> files 59896c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 5990c609719bSwdenk 59916c3fef28SJerry Van Baren while (!accepted) { 5992c609719bSwdenk while (!running) { 5993c609719bSwdenk do { 5994c609719bSwdenk Add / modify source code; 5995c609719bSwdenk } until (compiles); 5996c609719bSwdenk Debug; 5997c609719bSwdenk if (clueless) 5998c609719bSwdenk email("Hi, I am having problems..."); 5999c609719bSwdenk } 60006c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 60016c3fef28SJerry Van Baren if (reasonable critiques) 60026c3fef28SJerry Van Baren Incorporate improvements from email list code review; 60036c3fef28SJerry Van Baren else 60046c3fef28SJerry Van Baren Defend code as written; 60056c3fef28SJerry Van Baren } 6006c609719bSwdenk 6007c609719bSwdenk return 0; 6008c609719bSwdenk} 6009c609719bSwdenk 6010c609719bSwdenkvoid no_more_time (int sig) 6011c609719bSwdenk{ 6012c609719bSwdenk hire_a_guru(); 6013c609719bSwdenk} 6014c609719bSwdenk 6015c609719bSwdenk 6016c609719bSwdenkCoding Standards: 6017c609719bSwdenk----------------- 6018c609719bSwdenk 6019c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 60202c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 60217ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 6022c609719bSwdenk 60232c051651SDetlev ZundelSource files originating from a different project (for example the 60242c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 6025b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those 60262c051651SDetlev Zundelsources. 60272c051651SDetlev Zundel 60282c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 60292c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 60302c051651SDetlev Zundelin your code. 6031c609719bSwdenk 6032c178d3daSwdenkPlease also stick to the following formatting rules: 6033180d3f74Swdenk- remove any trailing white space 60347ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 6035180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 60367ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 6037180d3f74Swdenk- do not add trailing empty lines to source files 6038180d3f74Swdenk 6039c609719bSwdenkSubmissions which do not conform to the standards may be returned 6040c609719bSwdenkwith a request to reformat the changes. 6041c609719bSwdenk 6042c609719bSwdenk 6043c609719bSwdenkSubmitting Patches: 6044c609719bSwdenk------------------- 6045c609719bSwdenk 6046c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 6047c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 6048c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 6049c609719bSwdenk 60500d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 6051218ca724SWolfgang Denk 60520668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 60530668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 60540668236bSWolfgang Denk 6055c609719bSwdenkWhen you send a patch, please include the following information with 6056c609719bSwdenkit: 6057c609719bSwdenk 6058c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 6059c609719bSwdenk this bug. Please try to include a way of demonstrating that the 6060c609719bSwdenk patch actually fixes something. 6061c609719bSwdenk 6062c609719bSwdenk* For new features: a description of the feature and your 6063c609719bSwdenk implementation. 6064c609719bSwdenk 6065c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 6066c609719bSwdenk 60677207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your 60687207b366SRobert P. J. Day information and associated file and directory references. 6069c609719bSwdenk 607027af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 607127af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 6072c609719bSwdenk 6073c609719bSwdenk* If your patch adds new configuration options, don't forget to 6074c609719bSwdenk document these in the README file. 6075c609719bSwdenk 6076218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 6077218ca724SWolfgang Denk recommended) you can easily generate the patch using the 60787ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 6079218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 6080218ca724SWolfgang Denk with some other mail clients. 6081c609719bSwdenk 6082218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 6083218ca724SWolfgang Denk diff does not support these options, then get the latest version of 6084218ca724SWolfgang Denk GNU diff. 60856dff5529Swdenk 6086218ca724SWolfgang Denk The current directory when running this command shall be the parent 6087218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 6088218ca724SWolfgang Denk your patch includes sufficient directory information for the 6089218ca724SWolfgang Denk affected files). 6090218ca724SWolfgang Denk 6091218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 6092218ca724SWolfgang Denk and compressed attachments must not be used. 6093c609719bSwdenk 609452f52c14Swdenk* If one logical set of modifications affects or creates several 609552f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 609652f52c14Swdenk 609752f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 609852f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 609952f52c14Swdenk 610052f52c14Swdenk 6101c609719bSwdenkNotes: 6102c609719bSwdenk 61036de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched 6104c609719bSwdenk source tree and make sure that no errors or warnings are reported 6105c609719bSwdenk for any of the boards. 6106c609719bSwdenk 6107c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 6108c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 6109c609719bSwdenk returned with a request to re-formatting / split it. 6110c609719bSwdenk 6111c609719bSwdenk* If you modify existing code, make sure that your new code does not 6112c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 6113c609719bSwdenk When adding new features, these should compile conditionally only 6114c609719bSwdenk (using #ifdef), and the resulting code with the new feature 6115c609719bSwdenk disabled must not need more memory than the old code without your 6116c609719bSwdenk modification. 611790dc6704Swdenk 61180668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 61190668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 61200668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 61210668236bSWolfgang Denk bigger than the size limit should be avoided. 6122