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 130360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 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 /blackfin Files generic to Analog Devices Blackfin architecture 1418d321b81SPeter Tyser /m68k Files generic to m68k architecture 1428d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1438d321b81SPeter Tyser /mips Files generic to MIPS architecture 144afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 1458d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 14633c7731bSRobert P. J. Day /openrisc Files generic to OpenRISC architecture 147a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1487207b366SRobert P. J. Day /sandbox Files generic to HW-independent "sandbox" 1498d321b81SPeter Tyser /sh Files generic to SH architecture 1508d321b81SPeter Tyser /sparc Files generic to SPARC architecture 15133c7731bSRobert P. J. Day /x86 Files generic to x86 architecture 1528d321b81SPeter Tyser/api Machine/arch independent API for external apps 1538d321b81SPeter Tyser/board Board dependent files 154740f7e5cSXu Ziyuan/cmd U-Boot commands functions 1558d321b81SPeter Tyser/common Misc architecture independent functions 1567207b366SRobert P. J. Day/configs Board default configuration files 1578d321b81SPeter Tyser/disk Code for disk drive partition handling 1588d321b81SPeter Tyser/doc Documentation (don't expect too much) 1598d321b81SPeter Tyser/drivers Commonly used device drivers 16033c7731bSRobert P. J. Day/dts Contains Makefile for building internal U-Boot fdt. 1618d321b81SPeter Tyser/examples Example code for standalone applications, etc. 1628d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 1638d321b81SPeter Tyser/include Header Files 1647207b366SRobert P. J. Day/lib Library routines generic to all architectures 1657207b366SRobert P. J. Day/Licenses Various license files 1668d321b81SPeter Tyser/net Networking code 1678d321b81SPeter Tyser/post Power On Self Test 1687207b366SRobert P. J. Day/scripts Various build scripts and Makefiles 1697207b366SRobert P. J. Day/test Various unit test files 1708d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 171c609719bSwdenk 172c609719bSwdenkSoftware Configuration: 173c609719bSwdenk======================= 174c609719bSwdenk 175c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 176c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 177c609719bSwdenk 178c609719bSwdenkThere are two classes of configuration variables: 179c609719bSwdenk 180c609719bSwdenk* Configuration _OPTIONS_: 181c609719bSwdenk These are selectable by the user and have names beginning with 182c609719bSwdenk "CONFIG_". 183c609719bSwdenk 184c609719bSwdenk* Configuration _SETTINGS_: 185c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 186c609719bSwdenk you don't know what you're doing; they have names beginning with 1876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 188c609719bSwdenk 1897207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating 1907207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently, 1917207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel, 1927207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your 1937207b366SRobert P. J. Daybuild. 194c609719bSwdenk 195c609719bSwdenk 196c609719bSwdenkSelection of Processor Architecture and Board Type: 197c609719bSwdenk--------------------------------------------------- 198c609719bSwdenk 199c609719bSwdenkFor all supported boards there are ready-to-use default 200ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig". 201c609719bSwdenk 202c609719bSwdenkExample: For a TQM823L module type: 203c609719bSwdenk 204c609719bSwdenk cd u-boot 205ab584d67SHolger Freyther make TQM823L_defconfig 206c609719bSwdenk 2077207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board 2087207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file 2097207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards. 210c609719bSwdenk 21175b3c3aaSSimon GlassSandbox Environment: 21275b3c3aaSSimon Glass-------------------- 21375b3c3aaSSimon Glass 21475b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox' 21575b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture- 21675b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to 21775b3c3aaSSimon Glassrun some of U-Boot's tests. 21875b3c3aaSSimon Glass 2196b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details. 22075b3c3aaSSimon Glass 22175b3c3aaSSimon Glass 222db910353SSimon GlassBoard Initialisation Flow: 223db910353SSimon Glass-------------------------- 224db910353SSimon Glass 225db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both 2267207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules). 227db910353SSimon Glass 2287207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in 2297207b366SRobert P. J. Daymore detail later in this file. 2307207b366SRobert P. J. Day 2317207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names 2327207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures 2337207b366SRobert P. J. Daymay not conform to this. At least most ARM boards which use 2347207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this. 2357207b366SRobert P. J. Day 2367207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly 2377207b366SRobert P. J. DayCPU-specific) start.S file, such as: 2387207b366SRobert P. J. Day 2397207b366SRobert P. J. Day - arch/arm/cpu/armv7/start.S 2407207b366SRobert P. J. Day - arch/powerpc/cpu/mpc83xx/start.S 2417207b366SRobert P. J. Day - arch/mips/cpu/start.S 2427207b366SRobert P. J. Day 2437207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and 2447207b366SRobert P. J. Daylimitations of each of these functions are described below. 245db910353SSimon Glass 246db910353SSimon Glasslowlevel_init(): 247db910353SSimon Glass - purpose: essential init to permit execution to reach board_init_f() 248db910353SSimon Glass - no global_data or BSS 249db910353SSimon Glass - there is no stack (ARMv7 may have one but it will soon be removed) 250db910353SSimon Glass - must not set up SDRAM or use console 251db910353SSimon Glass - must only do the bare minimum to allow execution to continue to 252db910353SSimon Glass board_init_f() 253db910353SSimon Glass - this is almost never needed 254db910353SSimon Glass - return normally from this function 255db910353SSimon Glass 256db910353SSimon Glassboard_init_f(): 257db910353SSimon Glass - purpose: set up the machine ready for running board_init_r(): 258db910353SSimon Glass i.e. SDRAM and serial UART 259db910353SSimon Glass - global_data is available 260db910353SSimon Glass - stack is in SRAM 261db910353SSimon Glass - BSS is not available, so you cannot use global/static variables, 262db910353SSimon Glass only stack variables and global_data 263db910353SSimon Glass 264db910353SSimon Glass Non-SPL-specific notes: 265db910353SSimon Glass - dram_init() is called to set up DRAM. If already done in SPL this 266db910353SSimon Glass can do nothing 267db910353SSimon Glass 268db910353SSimon Glass SPL-specific notes: 269db910353SSimon Glass - you can override the entire board_init_f() function with your own 270db910353SSimon Glass version as needed. 271db910353SSimon Glass - preloader_console_init() can be called here in extremis 272db910353SSimon Glass - should set up SDRAM, and anything needed to make the UART work 273db910353SSimon Glass - these is no need to clear BSS, it will be done by crt0.S 274db910353SSimon Glass - must return normally from this function (don't call board_init_r() 275db910353SSimon Glass directly) 276db910353SSimon Glass 277db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at 278db910353SSimon Glassthis point the stack and global_data are relocated to below 279db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of 280db910353SSimon Glassmemory. 281db910353SSimon Glass 282db910353SSimon Glassboard_init_r(): 283db910353SSimon Glass - purpose: main execution, common code 284db910353SSimon Glass - global_data is available 285db910353SSimon Glass - SDRAM is available 286db910353SSimon Glass - BSS is available, all static/global variables can be used 287db910353SSimon Glass - execution eventually continues to main_loop() 288db910353SSimon Glass 289db910353SSimon Glass Non-SPL-specific notes: 290db910353SSimon Glass - U-Boot is relocated to the top of memory and is now running from 291db910353SSimon Glass there. 292db910353SSimon Glass 293db910353SSimon Glass SPL-specific notes: 294db910353SSimon Glass - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and 295db910353SSimon Glass CONFIG_SPL_STACK_R_ADDR points into SDRAM 296db910353SSimon Glass - preloader_console_init() can be called here - typically this is 297db910353SSimon Glass done by defining CONFIG_SPL_BOARD_INIT and then supplying a 298db910353SSimon Glass spl_board_init() function containing this call 299db910353SSimon Glass - loads U-Boot or (in falcon mode) Linux 300db910353SSimon Glass 301db910353SSimon Glass 302db910353SSimon Glass 303c609719bSwdenkConfiguration Options: 304c609719bSwdenk---------------------- 305c609719bSwdenk 306c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 307c609719bSwdenksuch information is kept in a configuration file 308c609719bSwdenk"include/configs/<board_name>.h". 309c609719bSwdenk 310c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 311c609719bSwdenk"include/configs/TQM823L.h". 312c609719bSwdenk 313c609719bSwdenk 3147f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 3157f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 3167f6c2cbcSwdenkbuild a config tool - later. 3177f6c2cbcSwdenk 3187f6c2cbcSwdenk 319c609719bSwdenkThe following options need to be configured: 320c609719bSwdenk 3212628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 322c609719bSwdenk 3232628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 3246ccec449SWolfgang Denk 3256ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 32609ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 327c609719bSwdenk 328cf946c6dSLei Wen- Marvell Family Member 329cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 330cf946c6dSLei Wen multiple fs option at one time 331cf946c6dSLei Wen for marvell soc family 332cf946c6dSLei Wen 33311ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 33466ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 33566ca92a5Swdenk get_gclk_freq() cannot work 3365da627a4Swdenk e.g. if there is no 32KHz 3375da627a4Swdenk reference PIT/RTC clock 33866ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 33966ca92a5Swdenk or XTAL/EXTAL) 340c609719bSwdenk 34166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 34466ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 34575d1ea7fSwdenk See doc/README.MPC866 34675d1ea7fSwdenk 3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 34875d1ea7fSwdenk 34975d1ea7fSwdenk Define this to measure the actual CPU clock instead 35075d1ea7fSwdenk of relying on the correctness of the configured 35175d1ea7fSwdenk values. Mostly useful for board bringup to make sure 35275d1ea7fSwdenk the PLL is locked at the intended frequency. Note 35375d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 35575d1ea7fSwdenk 356506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 357506f3918SHeiko Schocher 358506f3918SHeiko Schocher Define this option if you want to enable the 359506f3918SHeiko Schocher ICache only when Code runs from RAM. 360506f3918SHeiko Schocher 36166412c63SKumar Gala- 85xx CPU Options: 362ffd06e02SYork Sun CONFIG_SYS_PPC64 363ffd06e02SYork Sun 364ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 365ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 366ffd06e02SYork Sun compliance, among other possible reasons. 367ffd06e02SYork Sun 36866412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 36966412c63SKumar Gala 37066412c63SKumar Gala Defines the core time base clock divider ratio compared to the 37166412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 37266412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 37366412c63SKumar Gala 3748f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3758f29084aSKumar Gala 3768f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3778f29084aSKumar Gala tree nodes for the given platform. 3788f29084aSKumar Gala 379afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 380afa6b551SPrabhakar Kushwaha 381afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 382afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 383afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 384afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 385afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 386afa6b551SPrabhakar Kushwaha purpose. 387afa6b551SPrabhakar Kushwaha 38833eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 38933eee330SScott Wood 39033eee330SScott Wood Enables a workaround for erratum A004510. If set, 39133eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 39233eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 39333eee330SScott Wood 39433eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 39533eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 39633eee330SScott Wood 39733eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 39833eee330SScott Wood for which the A004510 workaround should be applied. 39933eee330SScott Wood 40033eee330SScott Wood The rest of SVR is either not relevant to the decision 40133eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 40233eee330SScott Wood p2041) or is implied by the build target, which controls 40333eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 40433eee330SScott Wood 40533eee330SScott Wood See Freescale App Note 4493 for more information about 40633eee330SScott Wood this erratum. 40733eee330SScott Wood 40874fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 40974fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 410b445bbb4SJeremiah Mahler required during NOR boot. 41174fa22edSPrabhakar Kushwaha 4129f074e67SPrabhakar Kushwaha CONFIG_A008044_WORKAROUND 4139f074e67SPrabhakar Kushwaha Enables a workaround for T1040/T1042 erratum A008044. It is only 414b445bbb4SJeremiah Mahler required during NAND boot and valid for Rev 1.0 SoC revision 4159f074e67SPrabhakar Kushwaha 41633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 41733eee330SScott Wood 41833eee330SScott Wood This is the value to write into CCSR offset 0x18600 41933eee330SScott Wood according to the A004510 workaround. 42033eee330SScott Wood 42164501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 42264501c66SPriyanka Jain This value denotes start offset of DDR memory which is 42364501c66SPriyanka Jain connected exclusively to the DSP cores. 42464501c66SPriyanka Jain 425765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 426765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 427765b0bdbSPriyanka Jain which is directly connected to the DSP core. 428765b0bdbSPriyanka Jain 42964501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 43064501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 43164501c66SPriyanka Jain connected to the DSP core. 43264501c66SPriyanka Jain 433765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 434765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 435765b0bdbSPriyanka Jain 436b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 437b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 438b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 439b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 440b135991aSPriyanka Jain 441fb4a2409SAneesh Bansal CONFIG_SYS_CPC_REINIT_F 442fb4a2409SAneesh Bansal This CONFIG is defined when the CPC is configured as SRAM at the 443a187559eSBin Meng time of U-Boot entry and is required to be re-initialized. 444fb4a2409SAneesh Bansal 445aade2004STang Yuantian CONFIG_DEEP_SLEEP 446b445bbb4SJeremiah Mahler Indicates this SoC supports deep sleep feature. If deep sleep is 447aade2004STang Yuantian supported, core will start to execute uboot when wakes up. 448aade2004STang Yuantian 4496cb461b4SDaniel Schwierzeck- Generic CPU options: 4502a1680e3SYork Sun CONFIG_SYS_GENERIC_GLOBAL_DATA 4512a1680e3SYork Sun Defines global data is initialized in generic board board_init_f(). 4522a1680e3SYork Sun If this macro is defined, global data is created and cleared in 4532a1680e3SYork Sun generic board board_init_f(). Without this macro, architecture/board 4542a1680e3SYork Sun should initialize global data before calling board_init_f(). 4552a1680e3SYork Sun 4566cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4576cb461b4SDaniel Schwierzeck 4586cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4596cb461b4SDaniel Schwierzeck values is arch specific. 4606cb461b4SDaniel Schwierzeck 4615614e71bSYork Sun CONFIG_SYS_FSL_DDR 4625614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4635614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4645614e71bSYork Sun SoCs. 4655614e71bSYork Sun 4665614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4675614e71bSYork Sun Freescale DDR memory-mapped register base. 4685614e71bSYork Sun 4695614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4705614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4715614e71bSYork Sun deskew training are not available. 4725614e71bSYork Sun 4735614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4745614e71bSYork Sun Freescale DDR1 controller. 4755614e71bSYork Sun 4765614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4775614e71bSYork Sun Freescale DDR2 controller. 4785614e71bSYork Sun 4795614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 4805614e71bSYork Sun Freescale DDR3 controller. 4815614e71bSYork Sun 48234e026f9SYork Sun CONFIG_SYS_FSL_DDRC_GEN4 48334e026f9SYork Sun Freescale DDR4 controller. 48434e026f9SYork Sun 4859ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 4869ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 4879ac4ffbdSYork Sun 4885614e71bSYork Sun CONFIG_SYS_FSL_DDR1 4895614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 4905614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 4915614e71bSYork Sun implemetation. 4925614e71bSYork Sun 4935614e71bSYork Sun CONFIG_SYS_FSL_DDR2 49462a3b7ddSRobert P. J. Day Board config to use DDR2. It can be enabled for SoCs with 4955614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 4965614e71bSYork Sun implementation. 4975614e71bSYork Sun 4985614e71bSYork Sun CONFIG_SYS_FSL_DDR3 4995614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 50034e026f9SYork Sun Freescale DDR3 or DDR3L controllers. 50134e026f9SYork Sun 50234e026f9SYork Sun CONFIG_SYS_FSL_DDR3L 50334e026f9SYork Sun Board config to use DDR3L. It can be enabled for SoCs with 50434e026f9SYork Sun DDR3L controllers. 50534e026f9SYork Sun 50634e026f9SYork Sun CONFIG_SYS_FSL_DDR4 50734e026f9SYork Sun Board config to use DDR4. It can be enabled for SoCs with 50834e026f9SYork Sun DDR4 controllers. 5095614e71bSYork Sun 5101b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_BE 5111b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Big Endian 5121b4175d6SPrabhakar Kushwaha 5131b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_LE 5141b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Little Endian 5151b4175d6SPrabhakar Kushwaha 516690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_PBI 517690e4258SPrabhakar Kushwaha It enables addition of RCW (Power on reset configuration) in built image. 518690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 519690e4258SPrabhakar Kushwaha 520690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_RCW 521690e4258SPrabhakar Kushwaha It adds PBI(pre-boot instructions) commands in u-boot build image. 522690e4258SPrabhakar Kushwaha PBI commands can be used to configure SoC before it starts the execution. 523690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 524690e4258SPrabhakar Kushwaha 52589ad7be8SPrabhakar Kushwaha CONFIG_SPL_FSL_PBL 52689ad7be8SPrabhakar Kushwaha It adds a target to create boot binary having SPL binary in PBI format 52789ad7be8SPrabhakar Kushwaha concatenated with u-boot binary. 52889ad7be8SPrabhakar Kushwaha 5294e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_BE 5304e5b1bd0SYork Sun Defines the DDR controller register space as Big Endian 5314e5b1bd0SYork Sun 5324e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_LE 5334e5b1bd0SYork Sun Defines the DDR controller register space as Little Endian 5344e5b1bd0SYork Sun 5356b9e309aSYork Sun CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 5366b9e309aSYork Sun Physical address from the view of DDR controllers. It is the 5376b9e309aSYork Sun same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 5386b9e309aSYork Sun it could be different for ARM SoCs. 5396b9e309aSYork Sun 5406b1e1254SYork Sun CONFIG_SYS_FSL_DDR_INTLV_256B 5416b1e1254SYork Sun DDR controller interleaving on 256-byte. This is a special 5426b1e1254SYork Sun interleaving mode, handled by Dickens for Freescale layerscape 5436b1e1254SYork Sun SoCs with ARM core. 5446b1e1254SYork Sun 5451d71efbbSYork Sun CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS 5461d71efbbSYork Sun Number of controllers used as main memory. 5471d71efbbSYork Sun 5481d71efbbSYork Sun CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS 5491d71efbbSYork Sun Number of controllers used for other than main memory. 5501d71efbbSYork Sun 55144937214SPrabhakar Kushwaha CONFIG_SYS_FSL_HAS_DP_DDR 55244937214SPrabhakar Kushwaha Defines the SoC has DP-DDR used for DPAA. 55344937214SPrabhakar Kushwaha 554028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_BE 555028dbb8dSRuchika Gupta Defines the SEC controller register space as Big Endian 556028dbb8dSRuchika Gupta 557028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_LE 558028dbb8dSRuchika Gupta Defines the SEC controller register space as Little Endian 559028dbb8dSRuchika Gupta 56092bbd64eSDaniel Schwierzeck- MIPS CPU options: 56192bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 56292bbd64eSDaniel Schwierzeck 56392bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 56492bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 56592bbd64eSDaniel Schwierzeck relocation. 56692bbd64eSDaniel Schwierzeck 56792bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 56892bbd64eSDaniel Schwierzeck 56992bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 57092bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 57192bbd64eSDaniel Schwierzeck Possible values are: 57292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 57392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 57492bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 57592bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 57692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 57792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 57892bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 57992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 58092bbd64eSDaniel Schwierzeck 58192bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 58292bbd64eSDaniel Schwierzeck 58392bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 58492bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 58592bbd64eSDaniel Schwierzeck 58692bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 58792bbd64eSDaniel Schwierzeck 58892bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 58992bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 59092bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 59192bbd64eSDaniel Schwierzeck 592b67d8816SChristian Riesch- ARM options: 593b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 594b67d8816SChristian Riesch 595b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 596b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 597b67d8816SChristian Riesch 5985356f545SAneesh V CONFIG_SYS_THUMB_BUILD 5995356f545SAneesh V 6005356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 6015356f545SAneesh V set for ARM architectures. Thumb instruction set provides 6025356f545SAneesh V better code density. For ARM architectures that support 6035356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 6045356f545SAneesh V GCC. 6055356f545SAneesh V 606c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 6070678587fSStephen Warren CONFIG_ARM_ERRATA_742230 6080678587fSStephen Warren CONFIG_ARM_ERRATA_743622 6090678587fSStephen Warren CONFIG_ARM_ERRATA_751472 610b7588e3bSNitin Garg CONFIG_ARM_ERRATA_761320 611e392b923SIan Campbell CONFIG_ARM_ERRATA_773022 612e392b923SIan Campbell CONFIG_ARM_ERRATA_774769 613e392b923SIan Campbell CONFIG_ARM_ERRATA_794072 6140678587fSStephen Warren 6150678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 6160678587fSStephen Warren during U-Boot startup. Note that these options force the 6170678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 6180678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 6190678587fSStephen Warren set these options unless they apply! 6200678587fSStephen Warren 621207774b2SYork Sun COUNTER_FREQUENCY 622207774b2SYork Sun Generic timer clock source frequency. 623207774b2SYork Sun 624207774b2SYork Sun COUNTER_FREQUENCY_REAL 625207774b2SYork Sun Generic timer clock source frequency if the real clock is 626207774b2SYork Sun different from COUNTER_FREQUENCY, and can only be determined 627207774b2SYork Sun at run time. 628207774b2SYork Sun 629c616a0dfSNishanth Menon NOTE: The following can be machine specific errata. These 630c616a0dfSNishanth Menon do have ability to provide rudimentary version and machine 631c616a0dfSNishanth Menon specific checks, but expect no product checks. 6325902f4ceSNishanth Menon CONFIG_ARM_ERRATA_430973 633b45c48a7SNishanth Menon CONFIG_ARM_ERRATA_454179 6349b4d65f9SNishanth Menon CONFIG_ARM_ERRATA_621766 635c616a0dfSNishanth Menon CONFIG_ARM_ERRATA_798870 636a615d0beSNishanth Menon CONFIG_ARM_ERRATA_801819 637c616a0dfSNishanth Menon 63873c38934SStephen Warren- Tegra SoC options: 63973c38934SStephen Warren CONFIG_TEGRA_SUPPORT_NON_SECURE 64073c38934SStephen Warren 64173c38934SStephen Warren Support executing U-Boot in non-secure (NS) mode. Certain 64273c38934SStephen Warren impossible actions will be skipped if the CPU is in NS mode, 64373c38934SStephen Warren such as ARM architectural timer initialization. 64473c38934SStephen Warren 6455da627a4Swdenk- Linux Kernel Interface: 646c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 647c609719bSwdenk 648c609719bSwdenk U-Boot stores all clock information in Hz 649c609719bSwdenk internally. For binary compatibility with older Linux 650c609719bSwdenk kernels (which expect the clocks passed in the 651c609719bSwdenk bd_info data to be in MHz) the environment variable 652c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 653c609719bSwdenk converts clock data to MHZ before passing it to the 654c609719bSwdenk Linux kernel. 655c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 656c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 657c609719bSwdenk default environment. 658c609719bSwdenk 6595da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 6605da627a4Swdenk 661b445bbb4SJeremiah Mahler When transferring memsize parameter to Linux, some versions 6625da627a4Swdenk expect it to be in bytes, others in MB. 6635da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 6645da627a4Swdenk 665fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 666f57f70aaSWolfgang Denk 667f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 668213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 669213bf8c8SGerald Van Baren concepts). 670213bf8c8SGerald Van Baren 671213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 672213bf8c8SGerald Van Baren * New libfdt-based support 673213bf8c8SGerald Van Baren * Adds the "fdt" command 6743bb342fcSKim Phillips * The bootm command automatically updates the fdt 675213bf8c8SGerald Van Baren 676b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 677b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 678b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 679b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 680f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 681c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 682f57f70aaSWolfgang Denk 68311ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 68411ccc33fSMarcel Ziswiler addresses 6853bb342fcSKim Phillips 6864e253137SKumar Gala CONFIG_OF_BOARD_SETUP 6874e253137SKumar Gala 6884e253137SKumar Gala Board code has addition modification that it wants to make 6894e253137SKumar Gala to the flat device tree before handing it off to the kernel 6906705d81eSwdenk 691c654b517SSimon Glass CONFIG_OF_SYSTEM_SETUP 692c654b517SSimon Glass 693c654b517SSimon Glass Other code has addition modification that it wants to make 694c654b517SSimon Glass to the flat device tree before handing it off to the kernel. 695c654b517SSimon Glass This causes ft_system_setup() to be called before booting 696c654b517SSimon Glass the kernel. 697c654b517SSimon Glass 6980267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 6990267768eSMatthew McClintock 70011ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 7010267768eSMatthew McClintock param header, the default value is zero if undefined. 7020267768eSMatthew McClintock 7033887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 7043887c3fbSHeiko Schocher 7053887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 7063887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 7073887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 7083887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 7093887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 7103887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 7113887c3fbSHeiko Schocher 7127eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 7137eb29398SIgor Grinberg 7147eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 7157eb29398SIgor Grinberg machine type and must be used to specify the machine type 7167eb29398SIgor Grinberg number as it appears in the ARM machine registry 7177eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 7187eb29398SIgor Grinberg Only boards that have multiple machine types supported 7197eb29398SIgor Grinberg in a single configuration file and the machine type is 7207eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 7217eb29398SIgor Grinberg 7220b2f4ecaSNiklaus Giger- vxWorks boot parameters: 7230b2f4ecaSNiklaus Giger 7240b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 7259e98b7e3SBin Meng environments variables: bootdev, bootfile, ipaddr, netmask, 7269e98b7e3SBin Meng serverip, gatewayip, hostname, othbootargs. 7270b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 7280b2f4ecaSNiklaus Giger 7290b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 7300b2f4ecaSNiklaus Giger the defaults discussed just above. 7310b2f4ecaSNiklaus Giger 7322c451f78SAneesh V- Cache Configuration: 7332c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 7342c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 7352c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 7362c451f78SAneesh V 73793bc2193SAneesh V- Cache Configuration for ARM: 73893bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 73993bc2193SAneesh V controller 74093bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 74193bc2193SAneesh V controller register space 74293bc2193SAneesh V 7436705d81eSwdenk- Serial Ports: 74448d0192fSAndreas Engel CONFIG_PL010_SERIAL 7456705d81eSwdenk 7466705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 7476705d81eSwdenk 74848d0192fSAndreas Engel CONFIG_PL011_SERIAL 7496705d81eSwdenk 7506705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 7516705d81eSwdenk 7526705d81eSwdenk CONFIG_PL011_CLOCK 7536705d81eSwdenk 7546705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 7556705d81eSwdenk the clock speed of the UARTs. 7566705d81eSwdenk 7576705d81eSwdenk CONFIG_PL01x_PORTS 7586705d81eSwdenk 7596705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 7606705d81eSwdenk define this to a list of base addresses for each (supported) 7616705d81eSwdenk port. See e.g. include/configs/versatile.h 7626705d81eSwdenk 763d57dee57SKaricheri, Muralidharan CONFIG_SERIAL_HW_FLOW_CONTROL 764d57dee57SKaricheri, Muralidharan 765d57dee57SKaricheri, Muralidharan Define this variable to enable hw flow control in serial driver. 766d57dee57SKaricheri, Muralidharan Current user of this option is drivers/serial/nsl16550.c driver 7676705d81eSwdenk 768c609719bSwdenk- Console Interface: 769c609719bSwdenk Depending on board, define exactly one serial port 770c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 771c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 772c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 773c609719bSwdenk 774c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 775c609719bSwdenk port routines must be defined elsewhere 776c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 777c609719bSwdenk 778c609719bSwdenk CONFIG_CFB_CONSOLE 779c609719bSwdenk Enables console device for a color framebuffer. Needs following 780c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 781c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 782c609719bSwdenk (default big endian) 783c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 784c609719bSwdenk rectangle fill 785c609719bSwdenk (cf. smiLynxEM) 786c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 787c609719bSwdenk bit-blit (cf. smiLynxEM) 788c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 789c609719bSwdenk (cols=pitch) 790c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 791c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 792c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 793c609719bSwdenk (0-5, cf. cfb_console.c) 794c609719bSwdenk VIDEO_FB_ADRS framebuffer address 795c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 79639f615edSSimon Glass (i.e. rx51_kp_init()) 797c609719bSwdenk VIDEO_TSTC_FCT test char fct 79839f615edSSimon Glass (i.e. rx51_kp_tstc) 799c609719bSwdenk VIDEO_GETC_FCT get char fct 80039f615edSSimon Glass (i.e. rx51_kp_getc) 801c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 802c609719bSwdenk upper left corner 803a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 804a6c7ad2fSwdenk linux_logo.h for logo. 805a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 806c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 80711ccc33fSMarcel Ziswiler additional board info beside 808c609719bSwdenk the logo 809adde435fSTim Harvey CONFIG_HIDE_LOGO_VERSION 810adde435fSTim Harvey do not display bootloader 811adde435fSTim Harvey version string 812c609719bSwdenk 81333a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 81433a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 81533a35bbbSPali Rohár erase functions and limited graphics rendition control). 81633a35bbbSPali Rohár 817c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 818c609719bSwdenk default i/o. Serial console can be forced with 819c609719bSwdenk environment 'console=serial'. 820c609719bSwdenk 821a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 822a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 823a3ad8e26Swdenk the "silent" environment variable. See 824a3ad8e26Swdenk doc/README.silent for more information. 825a3ad8e26Swdenk 82645ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default 82745ae2546SHeiko Schocher is 0x00. 82845ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default 82945ae2546SHeiko Schocher is 0xa0. 83045ae2546SHeiko Schocher 831c609719bSwdenk- Console Baudrate: 832c609719bSwdenk CONFIG_BAUDRATE - in bps 833c609719bSwdenk Select one of the baudrates listed in 8346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 8356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 836c609719bSwdenk 837c92fac91SHeiko Schocher- Console Rx buffer length 838c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 839c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 8402b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 841c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 842c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 843c92fac91SHeiko Schocher the SMC. 844c92fac91SHeiko Schocher 8459558b48aSGraeme Russ- Pre-Console Buffer: 8469558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 8479558b48aSGraeme Russ initialised etc) all console output is silently discarded. 8489558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 8499558b48aSGraeme Russ buffer any console messages prior to the console being 8509558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 8519558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 8529558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 8539558b48aSGraeme Russ bytes are output before the console is initialised, the 8549558b48aSGraeme Russ earlier bytes are discarded. 8559558b48aSGraeme Russ 856a8552c7cSHans de Goede Note that when printing the buffer a copy is made on the 857a8552c7cSHans de Goede stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack. 858a8552c7cSHans de Goede 8599558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 8609558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 8619558b48aSGraeme Russ 862c609719bSwdenk- Autoboot Command: 863c609719bSwdenk CONFIG_BOOTCOMMAND 864c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 865c609719bSwdenk define a command string that is automatically executed 866c609719bSwdenk when no character is read on the console interface 867c609719bSwdenk within "Boot Delay" after reset. 868c609719bSwdenk 869c609719bSwdenk CONFIG_BOOTARGS 870c609719bSwdenk This can be used to pass arguments to the bootm 871c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 872c609719bSwdenk environment value "bootargs". 873c609719bSwdenk 874c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 875c609719bSwdenk The value of these goes into the environment as 876c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 877c609719bSwdenk as a convenience, when switching between booting from 87811ccc33fSMarcel Ziswiler RAM and NFS. 879c609719bSwdenk 880eda0ba38SHeiko Schocher- Bootcount: 881eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 882eda0ba38SHeiko Schocher Implements a mechanism for detecting a repeating reboot 883eda0ba38SHeiko Schocher cycle, see: 884eda0ba38SHeiko Schocher http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 885eda0ba38SHeiko Schocher 886eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_ENV 887eda0ba38SHeiko Schocher If no softreset save registers are found on the hardware 888eda0ba38SHeiko Schocher "bootcount" is stored in the environment. To prevent a 889eda0ba38SHeiko Schocher saveenv on all reboots, the environment variable 890eda0ba38SHeiko Schocher "upgrade_available" is used. If "upgrade_available" is 891eda0ba38SHeiko Schocher 0, "bootcount" is always 0, if "upgrade_available" is 892eda0ba38SHeiko Schocher 1 "bootcount" is incremented in the environment. 893eda0ba38SHeiko Schocher So the Userspace Applikation must set the "upgrade_available" 894eda0ba38SHeiko Schocher and "bootcount" variable to 0, if a boot was successfully. 895eda0ba38SHeiko Schocher 896c609719bSwdenk- Pre-Boot Commands: 897c609719bSwdenk CONFIG_PREBOOT 898c609719bSwdenk 899c609719bSwdenk When this option is #defined, the existence of the 900c609719bSwdenk environment variable "preboot" will be checked 901c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 902c609719bSwdenk countdown and/or running the auto-boot command resp. 903c609719bSwdenk entering interactive mode. 904c609719bSwdenk 905c609719bSwdenk This feature is especially useful when "preboot" is 906c609719bSwdenk automatically generated or modified. For an example 907c609719bSwdenk see the LWMON board specific code: here "preboot" is 908c609719bSwdenk modified when the user holds down a certain 909c609719bSwdenk combination of keys on the (special) keyboard when 910c609719bSwdenk booting the systems 911c609719bSwdenk 912c609719bSwdenk- Serial Download Echo Mode: 913c609719bSwdenk CONFIG_LOADS_ECHO 914c609719bSwdenk If defined to 1, all characters received during a 915c609719bSwdenk serial download (using the "loads" command) are 916c609719bSwdenk echoed back. This might be needed by some terminal 917c609719bSwdenk emulations (like "cu"), but may as well just take 918c609719bSwdenk time on others. This setting #define's the initial 919c609719bSwdenk value of the "loads_echo" environment variable. 920c609719bSwdenk 921602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 922c609719bSwdenk CONFIG_KGDB_BAUDRATE 923c609719bSwdenk Select one of the baudrates listed in 9246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 925c609719bSwdenk 926c609719bSwdenk- Monitor Functions: 927602ad3b3SJon Loeliger Monitor commands can be included or excluded 928602ad3b3SJon Loeliger from the build by using the #include files 929c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 930ef0f2f57SJoe Hershberger commands, or adding #define's for wanted commands. 931c609719bSwdenk 932602ad3b3SJon Loeliger The default command configuration includes all commands 933602ad3b3SJon Loeliger except those marked below with a "*". 934602ad3b3SJon Loeliger 935b401b73dSMarek Vasut CONFIG_CMD_AES AES 128 CBC encrypt/decrypt 936602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 937602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 938602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 939602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 940602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 941602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 942d2b2ffe3STom Rini CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support 943602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 94408d0d6f3SMichal Simek CONFIG_CMD_CLK * clock command support 945602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 946710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 947602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 948602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 949602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 950a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 951a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 952a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 953a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 954602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 955602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 956246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 957602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 958aa9e6044SNikita Kiryanov CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands 959602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 9605e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 961fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 96288733e2cSAndrew Ruder CONFIG_CMD_ENV_EXISTS * check existence of env variable 9630c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 96403e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 96503e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 96616f4d933SStephen Warren CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls) 96716f4d933SStephen Warren that work for multiple fs types 96859e890efSChristian Gmeiner CONFIG_CMD_FS_UUID * Look up a filesystem UUID 969bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 970602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 97103e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 972602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 973602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 9744d98b5c8SVincent Stehlé CONFIG_CMD_FUSE * Device fuse support 97553fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 976a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 977a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 978bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 979602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 980602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 981602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 9828fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 9834d98b5c8SVincent Stehlé CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 984602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 985aa53233aSSimon Glass CONFIG_CMD_IOTRACE * I/O tracing for debugging 9860c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 987c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 988602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 989602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 990602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 991602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 9924d98b5c8SVincent Stehlé CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 993d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 994d22c338eSJoe Hershberger (169.254.*.*) 995602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 996602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 9974d98b5c8SVincent Stehlé CONFIG_CMD_MD5SUM * print md5 message digest 99802c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 99915a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 1000602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 1001a2681707SWolfgang Denk loop, loopw 10024d98b5c8SVincent Stehlé CONFIG_CMD_MEMTEST * mtest 1003602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 1004602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 1005602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 100668d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 1007602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 1008602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 10094d98b5c8SVincent Stehlé CONFIG_CMD_NFS NFS support 1010e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 1011e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 1012602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 1013602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 1014602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 1015602ad3b3SJon Loeliger host 1016602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 1017ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 1018602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 1019602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 1020d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 1021602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 1022c649e3c9SSimon Glass CONFIG_SCSI * SCSI Support 1023602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 1024602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 1025602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 1026602ad3b3SJon Loeliger (4xx only) 1027f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 10284d98b5c8SVincent Stehlé CONFIG_CMD_SHA1SUM * print sha1 memory digest 102902c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 10307d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 103174de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 1032602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 10337a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 10341fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 1035da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 1036da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 1037602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 1038602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 1039c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 10404d98b5c8SVincent Stehlé CONFIG_CMD_XIMG Load part of Multi Image 104189c8230dSPrzemyslaw Marczak CONFIG_CMD_UUID * Generate random UUID or GUID string 1042c609719bSwdenk 1043c609719bSwdenk EXAMPLE: If you want all functions except of network 1044c609719bSwdenk support you can write: 1045c609719bSwdenk 1046602ad3b3SJon Loeliger #include "config_cmd_all.h" 1047602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 1048c609719bSwdenk 1049213bf8c8SGerald Van Baren Other Commands: 1050213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 1051c609719bSwdenk 1052c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 1053602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 1054c609719bSwdenk what you (and your U-Boot users) are doing. Data 1055c609719bSwdenk cache cannot be enabled on systems like the 8xx or 1056c609719bSwdenk 8260 (where accesses to the IMMR region must be 1057c609719bSwdenk uncached), and it cannot be disabled on all other 1058c609719bSwdenk systems where we (mis-) use the data cache to hold an 1059c609719bSwdenk initial stack and some data. 1060c609719bSwdenk 1061c609719bSwdenk 1062c609719bSwdenk XXX - this list needs to get updated! 1063c609719bSwdenk 1064302a6487SSimon Glass- Removal of commands 1065302a6487SSimon Glass If no commands are needed to boot, you can disable 1066302a6487SSimon Glass CONFIG_CMDLINE to remove them. In this case, the command line 1067302a6487SSimon Glass will not be available, and when U-Boot wants to execute the 1068302a6487SSimon Glass boot command (on start-up) it will call board_run_command() 1069302a6487SSimon Glass instead. This can reduce image size significantly for very 1070302a6487SSimon Glass simple boot procedures. 1071302a6487SSimon Glass 1072a5ecbe62SWolfgang Denk- Regular expression support: 1073a5ecbe62SWolfgang Denk CONFIG_REGEX 1074a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 1075a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 1076a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 1077a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 1078a5ecbe62SWolfgang Denk 107945ba8077SSimon Glass- Device tree: 108045ba8077SSimon Glass CONFIG_OF_CONTROL 108145ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 108245ba8077SSimon Glass to configure its devices, instead of relying on statically 108345ba8077SSimon Glass compiled #defines in the board file. This option is 108445ba8077SSimon Glass experimental and only available on a few boards. The device 108545ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 108645ba8077SSimon Glass 10872c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 10882c0f79e4SSimon Glass be done using one of the two options below: 1089bbb0b128SSimon Glass 1090bbb0b128SSimon Glass CONFIG_OF_EMBED 1091bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 1092bbb0b128SSimon Glass binary in its image. This device tree file should be in the 1093bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 1094bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 1095bbb0b128SSimon Glass the global data structure as gd->blob. 109645ba8077SSimon Glass 10972c0f79e4SSimon Glass CONFIG_OF_SEPARATE 10982c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 10992c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 11002c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 11012c0f79e4SSimon Glass 11022c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 11032c0f79e4SSimon Glass 11042c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 11052c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 11062c0f79e4SSimon Glass still use the individual files if you need something more 11072c0f79e4SSimon Glass exotic. 11082c0f79e4SSimon Glass 1109c609719bSwdenk- Watchdog: 1110c609719bSwdenk CONFIG_WATCHDOG 1111c609719bSwdenk If this variable is defined, it enables watchdog 11126abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 11136abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 11146abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 11156abe6fb6SDetlev Zundel register. When supported for a specific SoC is 11166abe6fb6SDetlev Zundel available, then no further board specific code should 11176abe6fb6SDetlev Zundel be needed to use it. 11186abe6fb6SDetlev Zundel 11196abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 11206abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 11216abe6fb6SDetlev Zundel SoC, then define this variable and provide board 11226abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 1123c609719bSwdenk 11247bae0d6fSHeiko Schocher CONFIG_AT91_HW_WDT_TIMEOUT 11257bae0d6fSHeiko Schocher specify the timeout in seconds. default 2 seconds. 11267bae0d6fSHeiko Schocher 1127c1551ea8Sstroese- U-Boot Version: 1128c1551ea8Sstroese CONFIG_VERSION_VARIABLE 1129c1551ea8Sstroese If this variable is defined, an environment variable 1130c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 1131c1551ea8Sstroese version as printed by the "version" command. 1132a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 1133a1ea8e51SBenoît Thébaudeau next reset. 1134c1551ea8Sstroese 1135c609719bSwdenk- Real-Time Clock: 1136c609719bSwdenk 1137602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1138c609719bSwdenk has to be selected, too. Define exactly one of the 1139c609719bSwdenk following options: 1140c609719bSwdenk 1141c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1142c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 11434e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1144c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 11451cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1146c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 11477f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 1148412921d2SMarkus Niebel CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC 11493bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 11509536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 11514c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 11526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 115371d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 115471d19f30SHeiko Schocher RV3029 RTC. 1155c609719bSwdenk 1156b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1157b37c7e5eSwdenk must also be configured. See I2C Support, below. 1158b37c7e5eSwdenk 1159e92739d3SPeter Tyser- GPIO Support: 1160e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1161e92739d3SPeter Tyser 11625dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 11635dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 11645dec49caSChris Packham pins supported by a particular chip. 11655dec49caSChris Packham 1166e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1167e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1168e92739d3SPeter Tyser 1169aa53233aSSimon Glass- I/O tracing: 1170aa53233aSSimon Glass When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O 1171aa53233aSSimon Glass accesses and can checksum them or write a list of them out 1172aa53233aSSimon Glass to memory. See the 'iotrace' command for details. This is 1173aa53233aSSimon Glass useful for testing device drivers since it can confirm that 1174aa53233aSSimon Glass the driver behaves the same way before and after a code 1175aa53233aSSimon Glass change. Currently this is supported on sandbox and arm. To 1176aa53233aSSimon Glass add support for your architecture, add '#include <iotrace.h>' 1177aa53233aSSimon Glass to the bottom of arch/<arch>/include/asm/io.h and test. 1178aa53233aSSimon Glass 1179aa53233aSSimon Glass Example output from the 'iotrace stats' command is below. 1180aa53233aSSimon Glass Note that if the trace buffer is exhausted, the checksum will 1181aa53233aSSimon Glass still continue to operate. 1182aa53233aSSimon Glass 1183aa53233aSSimon Glass iotrace is enabled 1184aa53233aSSimon Glass Start: 10000000 (buffer start address) 1185aa53233aSSimon Glass Size: 00010000 (buffer size) 1186aa53233aSSimon Glass Offset: 00000120 (current buffer offset) 1187aa53233aSSimon Glass Output: 10000120 (start + offset) 1188aa53233aSSimon Glass Count: 00000018 (number of trace records) 1189aa53233aSSimon Glass CRC32: 9526fb66 (CRC32 of all trace records) 1190aa53233aSSimon Glass 1191c609719bSwdenk- Timestamp Support: 1192c609719bSwdenk 1193c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1194c609719bSwdenk (date and time) of an image is printed by image 1195c609719bSwdenk commands like bootm or iminfo. This option is 1196602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1197c609719bSwdenk 1198923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1199923c46f9SKarl O. Pinc Zero or more of the following: 1200923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1201923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1202923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1203923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1204923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1205923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1206923c46f9SKarl O. Pinc disk/part_efi.c 1207923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1208c609719bSwdenk 1209602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1210c649e3c9SSimon Glass CONFIG_SCSI) you must configure support for at 1211923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1212c609719bSwdenk 1213c609719bSwdenk- IDE Reset method: 12144d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 12154d13cbadSwdenk board configurations files but used nowhere! 1216c609719bSwdenk 12174d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 12184d13cbadSwdenk be performed by calling the function 12194d13cbadSwdenk ide_set_reset(int reset) 12204d13cbadSwdenk which has to be defined in a board specific file 1221c609719bSwdenk 1222c609719bSwdenk- ATAPI Support: 1223c609719bSwdenk CONFIG_ATAPI 1224c609719bSwdenk 1225c609719bSwdenk Set this to enable ATAPI support. 1226c609719bSwdenk 1227c40b2956Swdenk- LBA48 Support 1228c40b2956Swdenk CONFIG_LBA48 1229c40b2956Swdenk 1230c40b2956Swdenk Set this to enable support for disks larger than 137GB 12314b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1232c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1233c40b2956Swdenk support disks up to 2.1TB. 1234c40b2956Swdenk 12356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1236c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1237c40b2956Swdenk Default is 32bit. 1238c40b2956Swdenk 1239c609719bSwdenk- SCSI Support: 1240c609719bSwdenk At the moment only there is only support for the 1241c609719bSwdenk SYM53C8XX SCSI controller; define 1242c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1243c609719bSwdenk 12446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 12456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 12466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1247c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1248c609719bSwdenk devices. 12496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1250c609719bSwdenk 1251447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1252447c031bSStefan Reinauer SCSI devices found during the last scan. 1253447c031bSStefan Reinauer 1254c609719bSwdenk- NETWORK Support (PCI): 1255682011ffSwdenk CONFIG_E1000 1256ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1257ce5207e1SKyle Moffett 1258ce5207e1SKyle Moffett CONFIG_E1000_SPI 1259ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1260ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1261ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1262ce5207e1SKyle Moffett 1263ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1264ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1265ce5207e1SKyle Moffett example with the "sspi" command. 1266ce5207e1SKyle Moffett 1267ce5207e1SKyle Moffett CONFIG_CMD_E1000 1268ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1269ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1270682011ffSwdenk 1271c609719bSwdenk CONFIG_EEPRO100 1272c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 127311ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1274c609719bSwdenk write routine for first time initialisation. 1275c609719bSwdenk 1276c609719bSwdenk CONFIG_TULIP 1277c609719bSwdenk Support for Digital 2114x chips. 1278c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1279c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1280c609719bSwdenk 1281c609719bSwdenk CONFIG_NATSEMI 1282c609719bSwdenk Support for National dp83815 chips. 1283c609719bSwdenk 1284c609719bSwdenk CONFIG_NS8382X 1285c609719bSwdenk Support for National dp8382[01] gigabit chips. 1286c609719bSwdenk 128745219c46Swdenk- NETWORK Support (other): 128845219c46Swdenk 1289c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1290c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1291c041e9d2SJens Scharsig 1292c041e9d2SJens Scharsig CONFIG_RMII 1293c041e9d2SJens Scharsig Define this to use reduced MII inteface 1294c041e9d2SJens Scharsig 1295c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1296c041e9d2SJens Scharsig If this defined, the driver is quiet. 1297c041e9d2SJens Scharsig The driver doen't show link status messages. 1298c041e9d2SJens Scharsig 1299efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1300efdd7319SRob Herring Support for the Calxeda XGMAC device 1301efdd7319SRob Herring 13023bb46d23SAshok CONFIG_LAN91C96 130345219c46Swdenk Support for SMSC's LAN91C96 chips. 130445219c46Swdenk 130545219c46Swdenk CONFIG_LAN91C96_BASE 130645219c46Swdenk Define this to hold the physical address 130745219c46Swdenk of the LAN91C96's I/O space 130845219c46Swdenk 130945219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 131045219c46Swdenk Define this to enable 32 bit addressing 131145219c46Swdenk 13123bb46d23SAshok CONFIG_SMC91111 1313f39748aeSwdenk Support for SMSC's LAN91C111 chip 1314f39748aeSwdenk 1315f39748aeSwdenk CONFIG_SMC91111_BASE 1316f39748aeSwdenk Define this to hold the physical address 1317f39748aeSwdenk of the device (I/O space) 1318f39748aeSwdenk 1319f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1320f39748aeSwdenk Define this if data bus is 32 bits 1321f39748aeSwdenk 1322f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1323f39748aeSwdenk Define this to use i/o functions instead of macros 1324f39748aeSwdenk (some hardware wont work with macros) 1325f39748aeSwdenk 1326dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1327dc02badaSHeiko Schocher Support for davinci emac 1328dc02badaSHeiko Schocher 1329dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1330dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1331dc02badaSHeiko Schocher 1332b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1333b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1334b3dbf4a5SMacpaul Lin 1335b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1336b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1337b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1338b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1339b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1340b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1341b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1342b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1343b3dbf4a5SMacpaul Lin 1344c2fff331SMike Rapoport CONFIG_SMC911X 1345557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1346557b377dSJens Gehrlein 1347c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1348557b377dSJens Gehrlein Define this to hold the physical address 1349557b377dSJens Gehrlein of the device (I/O space) 1350557b377dSJens Gehrlein 1351c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1352557b377dSJens Gehrlein Define this if data bus is 32 bits 1353557b377dSJens Gehrlein 1354c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1355557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1356557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1357c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1358557b377dSJens Gehrlein 13593d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 13603d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 13613d0075faSYoshihiro Shimoda 13623d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 13633d0075faSYoshihiro Shimoda Define the number of ports to be used 13643d0075faSYoshihiro Shimoda 13653d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 13663d0075faSYoshihiro Shimoda Define the ETH PHY's address 13673d0075faSYoshihiro Shimoda 136868260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 136968260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 137068260aabSYoshihiro Shimoda 1371b2f97cf2SHeiko Schocher- PWM Support: 1372b2f97cf2SHeiko Schocher CONFIG_PWM_IMX 1373b2f97cf2SHeiko Schocher Support for PWM modul on the imx6. 1374b2f97cf2SHeiko Schocher 13755e124724SVadim Bendebury- TPM Support: 137690899cc0SChe-liang Chiou CONFIG_TPM 137790899cc0SChe-liang Chiou Support TPM devices. 137890899cc0SChe-liang Chiou 13790766ad2fSChristophe Ricard CONFIG_TPM_TIS_INFINEON 13800766ad2fSChristophe Ricard Support for Infineon i2c bus TPM devices. Only one device 13811b393db5STom Wai-Hong Tam per system is supported at this time. 13821b393db5STom Wai-Hong Tam 13831b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 13841b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 13851b393db5STom Wai-Hong Tam 13863aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24 13873aa74088SChristophe Ricard Support for STMicroelectronics TPM devices. Requires DM_TPM support. 13883aa74088SChristophe Ricard 13893aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24_I2C 13903aa74088SChristophe Ricard Support for STMicroelectronics ST33ZP24 I2C devices. 13913aa74088SChristophe Ricard Requires TPM_ST33ZP24 and I2C. 13923aa74088SChristophe Ricard 1393b75fdc11SChristophe Ricard CONFIG_TPM_ST33ZP24_SPI 1394b75fdc11SChristophe Ricard Support for STMicroelectronics ST33ZP24 SPI devices. 1395b75fdc11SChristophe Ricard Requires TPM_ST33ZP24 and SPI. 1396b75fdc11SChristophe Ricard 1397c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1398c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1399c01939c7SDirk Eibach 140090899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 14015e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 14025e124724SVadim Bendebury per system is supported at this time. 14035e124724SVadim Bendebury 14045e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 14055e124724SVadim Bendebury Base address where the generic TPM device is mapped 14065e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 14075e124724SVadim Bendebury 0xfed40000. 14085e124724SVadim Bendebury 1409be6c1529SReinhard Pfau CONFIG_CMD_TPM 1410be6c1529SReinhard Pfau Add tpm monitor functions. 1411be6c1529SReinhard Pfau Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1412be6c1529SReinhard Pfau provides monitor access to authorized functions. 1413be6c1529SReinhard Pfau 1414be6c1529SReinhard Pfau CONFIG_TPM 1415be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1416be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1417be6c1529SReinhard Pfau Requires support for a TPM device. 1418be6c1529SReinhard Pfau 1419be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1420be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1421be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1422be6c1529SReinhard Pfau 1423c609719bSwdenk- USB Support: 1424c609719bSwdenk At the moment only the UHCI host controller is 14254d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1426c609719bSwdenk CONFIG_USB_UHCI to enable it. 1427c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 142830d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1429c609719bSwdenk storage devices. 1430c609719bSwdenk Note: 1431c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1432c609719bSwdenk (TEAC FD-05PUB). 14334d13cbadSwdenk MPC5200 USB requires additional defines: 14344d13cbadSwdenk CONFIG_USB_CLOCK 14354d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1436307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1437307ecb6dSEric Millbrandt for USB on PSC3 14384d13cbadSwdenk CONFIG_USB_CONFIG 14394d13cbadSwdenk for differential drivers: 0x00001000 14404d13cbadSwdenk for single ended drivers: 0x00005000 1441307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1442307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 14436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1444fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1445fdcfaa1bSZhang Wei instead of using asynchronous interrupts 14464d13cbadSwdenk 14479ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 14489ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 14499ab4ce22SSimon Glass 14506e9e0626SOleksandr Tymoshenko CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 14516e9e0626SOleksandr Tymoshenko HW module registers. 14526e9e0626SOleksandr Tymoshenko 145316c8d5e7SWolfgang Denk- USB Device: 145416c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 145516c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 145616c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 145711ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 145816c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 145916c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 146016c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 146116c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 146216c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 146316c8d5e7SWolfgang Denk a Linux host by 146416c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 146516c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 146616c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 146716c8d5e7SWolfgang Denk might be defined in YourBoardName.h 146816c8d5e7SWolfgang Denk 146916c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 147016c8d5e7SWolfgang Denk Define this to build a UDC device 147116c8d5e7SWolfgang Denk 147216c8d5e7SWolfgang Denk CONFIG_USB_TTY 147316c8d5e7SWolfgang Denk Define this to have a tty type of device available to 147416c8d5e7SWolfgang Denk talk to the UDC device 147516c8d5e7SWolfgang Denk 1476f9da0f89SVipin KUMAR CONFIG_USBD_HS 1477f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1478f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1479f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1480f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1481f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1482f9da0f89SVipin KUMAR speed. 1483f9da0f89SVipin KUMAR 14846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 148516c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 148616c8d5e7SWolfgang Denk be set to usbtty. 148716c8d5e7SWolfgang Denk 148816c8d5e7SWolfgang Denk mpc8xx: 14896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 149016c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 14916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 149216c8d5e7SWolfgang Denk 14936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 149416c8d5e7SWolfgang Denk Derive USB clock from brgclk 14956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 149616c8d5e7SWolfgang Denk 149716c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 149816c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 149916c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 150016c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 150116c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 150216c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 150316c8d5e7SWolfgang Denk 150416c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 150516c8d5e7SWolfgang Denk Define this string as the name of your company for 150616c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 150716c8d5e7SWolfgang Denk 150816c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 150916c8d5e7SWolfgang Denk Define this string as the name of your product 151016c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 151116c8d5e7SWolfgang Denk 151216c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 151316c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 151416c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 151516c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 151616c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 151716c8d5e7SWolfgang Denk 151816c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 151916c8d5e7SWolfgang Denk Define this as the unique Product ID 152016c8d5e7SWolfgang Denk for your device 152116c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1522c609719bSwdenk 1523d70a560fSIgor Grinberg- ULPI Layer Support: 1524d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1525d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1526d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1527d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1528d70a560fSIgor Grinberg viewport is supported. 1529d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1530d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 15316d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 15326d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 15336d365ea0SLucas Stach the appropriate value in Hz. 1534c609719bSwdenk 1535c609719bSwdenk- MMC Support: 1536c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1537c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1538c609719bSwdenk accessed from the boot prompt by mapping the device 1539c609719bSwdenk to physical memory similar to flash. Command line is 1540602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1541602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1542c609719bSwdenk 1543afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1544afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1545afb35666SYoshihiro Shimoda 1546afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1547afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1548afb35666SYoshihiro Shimoda 1549afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1550afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1551afb35666SYoshihiro Shimoda 15521fd93c6eSPierre Aubert CONFIG_GENERIC_MMC 15531fd93c6eSPierre Aubert Enable the generic MMC driver 15541fd93c6eSPierre Aubert 15551fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_BOOT 15561fd93c6eSPierre Aubert Enable some additional features of the eMMC boot partitions. 15571fd93c6eSPierre Aubert 15581fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_RPMB 15591fd93c6eSPierre Aubert Enable the commands for reading, writing and programming the 15601fd93c6eSPierre Aubert key for the Replay Protection Memory Block partition in eMMC. 15611fd93c6eSPierre Aubert 1562b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 156301acd6abSPaul Kocialkowski CONFIG_USB_FUNCTION_DFU 1564b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1565b3ba6e94STom Rini 1566b3ba6e94STom Rini CONFIG_CMD_DFU 1567b3ba6e94STom Rini This enables the command "dfu" which is used to have 1568b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1569b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1570b3ba6e94STom Rini set and define the alt settings to expose to the host. 1571b3ba6e94STom Rini 1572b3ba6e94STom Rini CONFIG_DFU_MMC 1573b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1574b3ba6e94STom Rini 1575c6631764SPantelis Antoniou CONFIG_DFU_NAND 1576c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1577c6631764SPantelis Antoniou 1578a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1579a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1580a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1581a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1582a9479f04SAfzal Mohammed one that would help mostly the developer. 1583a9479f04SAfzal Mohammed 1584e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1585e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1586e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1587e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1588e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1589e7e75c70SHeiko Schocher 1590ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1591ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1592ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1593ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1594ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1595ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1596ea2453d5SPantelis Antoniou 1597001a8319SHeiko Schocher DFU_DEFAULT_POLL_TIMEOUT 1598001a8319SHeiko Schocher Poll timeout [ms], is the timeout a device can send to the 1599001a8319SHeiko Schocher host. The host must wait for this timeout before sending 1600001a8319SHeiko Schocher a subsequent DFU_GET_STATUS request to the device. 1601001a8319SHeiko Schocher 1602001a8319SHeiko Schocher DFU_MANIFEST_POLL_TIMEOUT 1603001a8319SHeiko Schocher Poll timeout [ms], which the device sends to the host when 1604001a8319SHeiko Schocher entering dfuMANIFEST state. Host waits this timeout, before 1605001a8319SHeiko Schocher sending again an USB request to the device. 1606001a8319SHeiko Schocher 16073aab70afSSebastian Siewior- USB Device Android Fastboot support: 160817da3c0cSPaul Kocialkowski CONFIG_USB_FUNCTION_FASTBOOT 160917da3c0cSPaul Kocialkowski This enables the USB part of the fastboot gadget 161017da3c0cSPaul Kocialkowski 16113aab70afSSebastian Siewior CONFIG_CMD_FASTBOOT 16123aab70afSSebastian Siewior This enables the command "fastboot" which enables the Android 16133aab70afSSebastian Siewior fastboot mode for the platform's USB device. Fastboot is a USB 16143aab70afSSebastian Siewior protocol for downloading images, flashing and device control 16153aab70afSSebastian Siewior used on Android devices. 16163aab70afSSebastian Siewior See doc/README.android-fastboot for more information. 16173aab70afSSebastian Siewior 16183aab70afSSebastian Siewior CONFIG_ANDROID_BOOT_IMAGE 16193aab70afSSebastian Siewior This enables support for booting images which use the Android 16203aab70afSSebastian Siewior image format header. 16213aab70afSSebastian Siewior 1622a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_ADDR 16233aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 16243aab70afSSebastian Siewior downloads. Define this to the starting RAM address to use for 16253aab70afSSebastian Siewior downloaded images. 16263aab70afSSebastian Siewior 1627a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_SIZE 16283aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 16293aab70afSSebastian Siewior downloads. This buffer should be as large as possible for a 16303aab70afSSebastian Siewior platform. Define this to the size available RAM for fastboot. 16313aab70afSSebastian Siewior 1632d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH 1633d1b5ed07SSteve Rae The fastboot protocol includes a "flash" command for writing 1634d1b5ed07SSteve Rae the downloaded image to a non-volatile storage device. Define 1635d1b5ed07SSteve Rae this to enable the "fastboot flash" command. 1636d1b5ed07SSteve Rae 1637d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH_MMC_DEV 1638d1b5ed07SSteve Rae The fastboot "flash" command requires additional information 1639d1b5ed07SSteve Rae regarding the non-volatile storage device. Define this to 1640d1b5ed07SSteve Rae the eMMC device that fastboot should use to store the image. 1641d1b5ed07SSteve Rae 16420ff7e585SSteve Rae CONFIG_FASTBOOT_GPT_NAME 16430ff7e585SSteve Rae The fastboot "flash" command supports writing the downloaded 16440ff7e585SSteve Rae image to the Protective MBR and the Primary GUID Partition 16450ff7e585SSteve Rae Table. (Additionally, this downloaded image is post-processed 16460ff7e585SSteve Rae to generate and write the Backup GUID Partition Table.) 16470ff7e585SSteve Rae This occurs when the specified "partition name" on the 16480ff7e585SSteve Rae "fastboot flash" command line matches this value. 16496f6c8630SPetr Kulhavy The default is "gpt" if undefined. 16500ff7e585SSteve Rae 1651b6dd69a4SPetr Kulhavy CONFIG_FASTBOOT_MBR_NAME 1652b6dd69a4SPetr Kulhavy The fastboot "flash" command supports writing the downloaded 1653b6dd69a4SPetr Kulhavy image to DOS MBR. 1654b6dd69a4SPetr Kulhavy This occurs when the "partition name" specified on the 1655b6dd69a4SPetr Kulhavy "fastboot flash" command line matches this value. 1656b6dd69a4SPetr Kulhavy If not defined the default value "mbr" is used. 1657b6dd69a4SPetr Kulhavy 16586705d81eSwdenk- Journaling Flash filesystem support: 16596705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 16606705d81eSwdenk CONFIG_JFFS2_NAND_DEV 16616705d81eSwdenk Define these for a default partition on a NAND device 16626705d81eSwdenk 16636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 16646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 16656705d81eSwdenk Define these for a default partition on a NOR device 16666705d81eSwdenk 16676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 16686705d81eSwdenk Define this to create an own partition. You have to provide a 16696705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 16706705d81eSwdenk 16716705d81eSwdenk If you define only one JFFS2 partition you may also want to 16726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 16736705d81eSwdenk to disable the command chpart. This is the default when you 16746705d81eSwdenk have not defined a custom partition 16756705d81eSwdenk 1676c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1677c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1678656f4c65SDonggeun Kim 1679656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1680656f4c65SDonggeun Kim file in FAT formatted partition. 1681656f4c65SDonggeun Kim 1682656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1683656f4c65SDonggeun Kim user to write files to FAT. 1684c30a15e5SDonggeun Kim 168584cd9327SGabe BlackCBFS (Coreboot Filesystem) support 168684cd9327SGabe Black CONFIG_CMD_CBFS 168784cd9327SGabe Black 168884cd9327SGabe Black Define this to enable support for reading from a Coreboot 168984cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 169084cd9327SGabe Black and cbfsload. 169184cd9327SGabe Black 16924f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size: 16934f0d1a2aSSiva Durga Prasad Paladugu CONFIG_FS_FAT_MAX_CLUSTSIZE 16944f0d1a2aSSiva Durga Prasad Paladugu 16954f0d1a2aSSiva Durga Prasad Paladugu Define the max cluster size for fat operations else 16964f0d1a2aSSiva Durga Prasad Paladugu a default value of 65536 will be defined. 16974f0d1a2aSSiva Durga Prasad Paladugu 1698c609719bSwdenk- Keyboard Support: 169939f615edSSimon Glass See Kconfig help for available keyboard drivers. 170039f615edSSimon Glass 170139f615edSSimon Glass CONFIG_KEYBOARD 170239f615edSSimon Glass 170339f615edSSimon Glass Define this to enable a custom keyboard support. 170439f615edSSimon Glass This simply calls drv_keyboard_init() which must be 170539f615edSSimon Glass defined in your board-specific files. This option is deprecated 170639f615edSSimon Glass and is only used by novena. For new boards, use driver model 170739f615edSSimon Glass instead. 1708c609719bSwdenk 1709c609719bSwdenk- Video support: 1710c609719bSwdenk CONFIG_VIDEO 1711c609719bSwdenk 1712c609719bSwdenk Define this to enable video support (for output to 1713c609719bSwdenk video). 1714c609719bSwdenk 1715c609719bSwdenk CONFIG_VIDEO_CT69000 1716c609719bSwdenk 1717c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1718c609719bSwdenk 1719c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1720eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1721eeb1b77bSwdenk video output is selected via environment 'videoout' 1722eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1723eeb1b77bSwdenk assumed. 1724c609719bSwdenk 1725eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 172611ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1727eeb1b77bSwdenk are possible: 1728eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1729eeb1b77bSwdenk Following standard modes are supported (* is default): 1730eeb1b77bSwdenk 1731eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1732eeb1b77bSwdenk -------------+--------------------------------------------- 1733eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1734eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1735eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1736eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1737eeb1b77bSwdenk -------------+--------------------------------------------- 1738c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1739c609719bSwdenk 1740eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 17417817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1742eeb1b77bSwdenk 1743eeb1b77bSwdenk 1744a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1745a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1746a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1747a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1748a6c7ad2fSwdenk 17497d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 17507d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 17517d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 17527d3053fbSTimur Tabi support, and should also define these other macros: 17537d3053fbSTimur Tabi 17547d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 17557d3053fbSTimur Tabi CONFIG_VIDEO 17567d3053fbSTimur Tabi CONFIG_CMD_BMP 17577d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 17587d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 17597d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 17607d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 17617d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 17627d3053fbSTimur Tabi 1763ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1764ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 17658eca9439SFabio Estevam boot. See the documentation file doc/README.video for a 1766ba8e76bdSTimur Tabi description of this variable. 17677d3053fbSTimur Tabi 1768c609719bSwdenk- LCD Support: CONFIG_LCD 1769c609719bSwdenk 1770c609719bSwdenk Define this to enable LCD support (for output to LCD 1771c609719bSwdenk display); also select one of the supported displays 1772c609719bSwdenk by defining one of these: 1773c609719bSwdenk 177439cf4804SStelian Pop CONFIG_ATMEL_LCD: 177539cf4804SStelian Pop 177639cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 177739cf4804SStelian Pop 1778fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1779c609719bSwdenk 1780fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1781c609719bSwdenk 1782fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1783c609719bSwdenk 1784fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1785fd3103bbSwdenk Active, color, single scan. 1786fd3103bbSwdenk 1787fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1788fd3103bbSwdenk 1789fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1790c609719bSwdenk Active, color, single scan. 1791c609719bSwdenk 1792c609719bSwdenk CONFIG_SHARP_16x9 1793c609719bSwdenk 1794c609719bSwdenk Sharp 320x240. Active, color, single scan. 1795c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1796c609719bSwdenk 1797c609719bSwdenk CONFIG_SHARP_LQ64D341 1798c609719bSwdenk 1799c609719bSwdenk Sharp LQ64D341 display, 640x480. 1800c609719bSwdenk Active, color, single scan. 1801c609719bSwdenk 1802c609719bSwdenk CONFIG_HLD1045 1803c609719bSwdenk 1804c609719bSwdenk HLD1045 display, 640x480. 1805c609719bSwdenk Active, color, single scan. 1806c609719bSwdenk 1807c609719bSwdenk CONFIG_OPTREX_BW 1808c609719bSwdenk 1809c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1810c609719bSwdenk or 1811c609719bSwdenk Hitachi LMG6912RPFC-00T 1812c609719bSwdenk or 1813c609719bSwdenk Hitachi SP14Q002 1814c609719bSwdenk 1815c609719bSwdenk 320x240. Black & white. 1816c609719bSwdenk 1817c609719bSwdenk Normally display is black on white background; define 18186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1819c609719bSwdenk 1820676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1821676d319eSSimon Glass 1822b445bbb4SJeremiah Mahler Normally the LCD is page-aligned (typically 4KB). If this is 1823676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1824676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1825676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1826676d319eSSimon Glass a per-section basis. 1827676d319eSSimon Glass 18280d89efefSSimon Glass CONFIG_CONSOLE_SCROLL_LINES 18290d89efefSSimon Glass 18300d89efefSSimon Glass When the console need to be scrolled, this is the number of 18310d89efefSSimon Glass lines to scroll by. It defaults to 1. Increasing this makes 18320d89efefSSimon Glass the console jump but can help speed up operation when scrolling 18330d89efefSSimon Glass is slow. 1834676d319eSSimon Glass 1835604c7d4aSHannes Petermaier CONFIG_LCD_ROTATION 1836604c7d4aSHannes Petermaier 1837604c7d4aSHannes Petermaier Sometimes, for example if the display is mounted in portrait 1838604c7d4aSHannes Petermaier mode or even if it's mounted landscape but rotated by 180degree, 1839604c7d4aSHannes Petermaier we need to rotate our content of the display relative to the 1840604c7d4aSHannes Petermaier framebuffer, so that user can read the messages which are 1841604c7d4aSHannes Petermaier printed out. 1842604c7d4aSHannes Petermaier Once CONFIG_LCD_ROTATION is defined, the lcd_console will be 1843604c7d4aSHannes Petermaier initialized with a given rotation from "vl_rot" out of 1844604c7d4aSHannes Petermaier "vidinfo_t" which is provided by the board specific code. 1845604c7d4aSHannes Petermaier The value for vl_rot is coded as following (matching to 1846604c7d4aSHannes Petermaier fbcon=rotate:<n> linux-kernel commandline): 1847604c7d4aSHannes Petermaier 0 = no rotation respectively 0 degree 1848604c7d4aSHannes Petermaier 1 = 90 degree rotation 1849604c7d4aSHannes Petermaier 2 = 180 degree rotation 1850604c7d4aSHannes Petermaier 3 = 270 degree rotation 1851604c7d4aSHannes Petermaier 1852604c7d4aSHannes Petermaier If CONFIG_LCD_ROTATION is not defined, the console will be 1853604c7d4aSHannes Petermaier initialized with 0degree rotation. 1854604c7d4aSHannes Petermaier 185545d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 185645d7f525STom Wai-Hong Tam 185745d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 185845d7f525STom Wai-Hong Tam 1859735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1860735987c5STom Wai-Hong Tam 1861735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1862735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1863735987c5STom Wai-Hong Tam 18647152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1865d791b1dcSwdenk 1866d791b1dcSwdenk If this option is set, the environment is checked for 1867d791b1dcSwdenk a variable "splashimage". If found, the usual display 1868d791b1dcSwdenk of logo, copyright and system information on the LCD 1869e94d2cd9Swdenk is suppressed and the BMP image at the address 1870d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1871d791b1dcSwdenk console is redirected to the "nulldev", too. This 1872d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1873d791b1dcSwdenk loaded very quickly after power-on. 1874d791b1dcSwdenk 1875c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1876c0880485SNikita Kiryanov 1877c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1878c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1879ab5645f1SFabio Estevam (see doc/README.displaying-bmps). 1880c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1881c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1882c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1883c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1884c0880485SNikita Kiryanov there is no need to set this option. 1885c0880485SNikita Kiryanov 18861ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 18871ca298ceSMatthias Weisser 18881ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 18891ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 18901ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 18911ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 18921ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 18931ca298ceSMatthias Weisser specify 'm' for centering the image. 18941ca298ceSMatthias Weisser 18951ca298ceSMatthias Weisser Example: 18961ca298ceSMatthias Weisser setenv splashpos m,m 18971ca298ceSMatthias Weisser => image at center of screen 18981ca298ceSMatthias Weisser 18991ca298ceSMatthias Weisser setenv splashpos 30,20 19001ca298ceSMatthias Weisser => image at x = 30 and y = 20 19011ca298ceSMatthias Weisser 19021ca298ceSMatthias Weisser setenv splashpos -10,m 19031ca298ceSMatthias Weisser => vertically centered image 19041ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 19051ca298ceSMatthias Weisser 190698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 190798f4a3dfSStefan Roese 190898f4a3dfSStefan Roese If this option is set, additionally to standard BMP 190998f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 191098f4a3dfSStefan Roese splashscreen support or the bmp command. 191198f4a3dfSStefan Roese 1912d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1913d5011762SAnatolij Gustschin 1914d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1915d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1916d5011762SAnatolij Gustschin bmp command. 1917d5011762SAnatolij Gustschin 1918b445bbb4SJeremiah Mahler- Do compressing for memory range: 1919f2b96dfbSLei Wen CONFIG_CMD_ZIP 1920f2b96dfbSLei Wen 1921f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1922f2b96dfbSLei Wen to compress the specified memory at its best effort. 1923f2b96dfbSLei Wen 1924c29fdfc1Swdenk- Compression support: 19258ef70478SKees Cook CONFIG_GZIP 19268ef70478SKees Cook 19278ef70478SKees Cook Enabled by default to support gzip compressed images. 19288ef70478SKees Cook 1929c29fdfc1Swdenk CONFIG_BZIP2 1930c29fdfc1Swdenk 1931c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1932c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1933c29fdfc1Swdenk compressed images are supported. 1934c29fdfc1Swdenk 1935c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 19366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1937c29fdfc1Swdenk be at least 4MB. 1938d791b1dcSwdenk 1939fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1940fc9c1727SLuigi 'Comio' Mantellini 1941fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1942fc9c1727SLuigi 'Comio' Mantellini images is included. 1943fc9c1727SLuigi 'Comio' Mantellini 1944fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1945fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1946fc9c1727SLuigi 'Comio' Mantellini formula: 1947fc9c1727SLuigi 'Comio' Mantellini 1948fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1949fc9c1727SLuigi 'Comio' Mantellini 1950fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1951fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1952fc9c1727SLuigi 'Comio' Mantellini 1953fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1954fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1955fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1956fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1957fc9c1727SLuigi 'Comio' Mantellini 1958fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1959fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 19606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1961fc9c1727SLuigi 'Comio' Mantellini 19628ef70478SKees Cook CONFIG_LZO 19638ef70478SKees Cook 19648ef70478SKees Cook If this option is set, support for LZO compressed images 19658ef70478SKees Cook is included. 19668ef70478SKees Cook 196717ea1177Swdenk- MII/PHY support: 196817ea1177Swdenk CONFIG_PHY_ADDR 196917ea1177Swdenk 197017ea1177Swdenk The address of PHY on MII bus. 197117ea1177Swdenk 197217ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 197317ea1177Swdenk 197417ea1177Swdenk The clock frequency of the MII bus 197517ea1177Swdenk 197617ea1177Swdenk CONFIG_PHY_GIGE 197717ea1177Swdenk 197817ea1177Swdenk If this option is set, support for speed/duplex 197911ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 198017ea1177Swdenk 198117ea1177Swdenk CONFIG_PHY_RESET_DELAY 198217ea1177Swdenk 198317ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 198417ea1177Swdenk reset before any MII register access is possible. 198517ea1177Swdenk For such PHY, set this option to the usec delay 198617ea1177Swdenk required. (minimum 300usec for LXT971A) 198717ea1177Swdenk 198817ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 198917ea1177Swdenk 199017ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 199117ea1177Swdenk command issued before MII status register can be read 199217ea1177Swdenk 1993c609719bSwdenk- IP address: 1994c609719bSwdenk CONFIG_IPADDR 1995c609719bSwdenk 1996c609719bSwdenk Define a default value for the IP address to use for 199711ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1998c609719bSwdenk determined through e.g. bootp. 19991ebcd654SWolfgang Denk (Environment variable "ipaddr") 2000c609719bSwdenk 2001c609719bSwdenk- Server IP address: 2002c609719bSwdenk CONFIG_SERVERIP 2003c609719bSwdenk 2004c609719bSwdenk Defines a default value for the IP address of a TFTP 2005c609719bSwdenk server to contact when using the "tftboot" command. 20061ebcd654SWolfgang Denk (Environment variable "serverip") 2007c609719bSwdenk 200897cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 200997cfe861SRobin Getz 201097cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 201197cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 201297cfe861SRobin Getz 20131ebcd654SWolfgang Denk- Gateway IP address: 20141ebcd654SWolfgang Denk CONFIG_GATEWAYIP 20151ebcd654SWolfgang Denk 20161ebcd654SWolfgang Denk Defines a default value for the IP address of the 20171ebcd654SWolfgang Denk default router where packets to other networks are 20181ebcd654SWolfgang Denk sent to. 20191ebcd654SWolfgang Denk (Environment variable "gatewayip") 20201ebcd654SWolfgang Denk 20211ebcd654SWolfgang Denk- Subnet mask: 20221ebcd654SWolfgang Denk CONFIG_NETMASK 20231ebcd654SWolfgang Denk 20241ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 20251ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 20261ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 20271ebcd654SWolfgang Denk forwarded through a router. 20281ebcd654SWolfgang Denk (Environment variable "netmask") 20291ebcd654SWolfgang Denk 203053a5c424SDavid Updegraff- Multicast TFTP Mode: 203153a5c424SDavid Updegraff CONFIG_MCAST_TFTP 203253a5c424SDavid Updegraff 203353a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 203453a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 203511ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 203653a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 203753a5c424SDavid Updegraff multicast group. 203853a5c424SDavid Updegraff 2039c609719bSwdenk- BOOTP Recovery Mode: 2040c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 2041c609719bSwdenk 2042c609719bSwdenk If you have many targets in a network that try to 2043c609719bSwdenk boot using BOOTP, you may want to avoid that all 2044c609719bSwdenk systems send out BOOTP requests at precisely the same 2045c609719bSwdenk moment (which would happen for instance at recovery 2046c609719bSwdenk from a power failure, when all systems will try to 2047c609719bSwdenk boot, thus flooding the BOOTP server. Defining 2048c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 2049c609719bSwdenk inserted before sending out BOOTP requests. The 20506c33c785SWolfgang Denk following delays are inserted then: 2051c609719bSwdenk 2052c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 2053c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 2054c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 2055c609719bSwdenk 4th and following 2056c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 2057c609719bSwdenk 205892ac8accSThierry Reding CONFIG_BOOTP_ID_CACHE_SIZE 205992ac8accSThierry Reding 206092ac8accSThierry Reding BOOTP packets are uniquely identified using a 32-bit ID. The 206192ac8accSThierry Reding server will copy the ID from client requests to responses and 206292ac8accSThierry Reding U-Boot will use this to determine if it is the destination of 206392ac8accSThierry Reding an incoming response. Some servers will check that addresses 206492ac8accSThierry Reding aren't in use before handing them out (usually using an ARP 206592ac8accSThierry Reding ping) and therefore take up to a few hundred milliseconds to 206692ac8accSThierry Reding respond. Network congestion may also influence the time it 206792ac8accSThierry Reding takes for a response to make it back to the client. If that 206892ac8accSThierry Reding time is too long, U-Boot will retransmit requests. In order 206992ac8accSThierry Reding to allow earlier responses to still be accepted after these 207092ac8accSThierry Reding retransmissions, U-Boot's BOOTP client keeps a small cache of 207192ac8accSThierry Reding IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this 207292ac8accSThierry Reding cache. The default is to keep IDs for up to four outstanding 207392ac8accSThierry Reding requests. Increasing this will allow U-Boot to accept offers 207492ac8accSThierry Reding from a BOOTP client in networks with unusually high latency. 207592ac8accSThierry Reding 2076fe389a82Sstroese- DHCP Advanced Options: 20771fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 20781fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 2079fe389a82Sstroese 20801fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 20811fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 20821fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 20831fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 20841fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 20851fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 20861fe80d79SJon Loeliger CONFIG_BOOTP_DNS 20871fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 20881fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 20891fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 20901fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 20911fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 20922c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 2093fe389a82Sstroese 20945d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 20955d110f0aSWilson Callan environment variable, not the BOOTP server. 2096fe389a82Sstroese 20972c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 20982c00e099SJoe Hershberger after the configured retry count, the call will fail 20992c00e099SJoe Hershberger instead of starting over. This can be used to fail over 21002c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 21012c00e099SJoe Hershberger is not available. 21022c00e099SJoe Hershberger 2103fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 2104fe389a82Sstroese serverip from a DHCP server, it is possible that more 2105fe389a82Sstroese than one DNS serverip is offered to the client. 2106fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 2107fe389a82Sstroese serverip will be stored in the additional environment 2108fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 2109fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 21101fe80d79SJon Loeliger is defined. 2111fe389a82Sstroese 2112fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 2113fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 2114fe389a82Sstroese need the hostname of the DHCP requester. 21155d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 21161fe80d79SJon Loeliger of the "hostname" environment variable is passed as 21171fe80d79SJon Loeliger option 12 to the DHCP server. 2118fe389a82Sstroese 2119d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 2120d9a2f416SAras Vaichas 2121d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 2122d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 2123d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 2124d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 2125d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 2126d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 2127d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 2128d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 2129d9a2f416SAras Vaichas that one of the retries will be successful but note that 2130d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 2131d9a2f416SAras Vaichas this delay. 2132d9a2f416SAras Vaichas 2133d22c338eSJoe Hershberger - Link-local IP address negotiation: 2134d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 2135d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 2136d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 2137d22c338eSJoe Hershberger to exist in all environments that the device must operate. 2138d22c338eSJoe Hershberger 2139d22c338eSJoe Hershberger See doc/README.link-local for more information. 2140d22c338eSJoe Hershberger 2141a3d991bdSwdenk - CDP Options: 2142a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 2143a3d991bdSwdenk 2144a3d991bdSwdenk The device id used in CDP trigger frames. 2145a3d991bdSwdenk 2146a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 2147a3d991bdSwdenk 2148a3d991bdSwdenk A two character string which is prefixed to the MAC address 2149a3d991bdSwdenk of the device. 2150a3d991bdSwdenk 2151a3d991bdSwdenk CONFIG_CDP_PORT_ID 2152a3d991bdSwdenk 2153a3d991bdSwdenk A printf format string which contains the ascii name of 2154a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 215511ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 2156a3d991bdSwdenk 2157a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 2158a3d991bdSwdenk 2159a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 2160a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 2161a3d991bdSwdenk 2162a3d991bdSwdenk CONFIG_CDP_VERSION 2163a3d991bdSwdenk 2164a3d991bdSwdenk An ascii string containing the version of the software. 2165a3d991bdSwdenk 2166a3d991bdSwdenk CONFIG_CDP_PLATFORM 2167a3d991bdSwdenk 2168a3d991bdSwdenk An ascii string containing the name of the platform. 2169a3d991bdSwdenk 2170a3d991bdSwdenk CONFIG_CDP_TRIGGER 2171a3d991bdSwdenk 2172a3d991bdSwdenk A 32bit integer sent on the trigger. 2173a3d991bdSwdenk 2174a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 2175a3d991bdSwdenk 2176a3d991bdSwdenk A 16bit integer containing the power consumption of the 2177a3d991bdSwdenk device in .1 of milliwatts. 2178a3d991bdSwdenk 2179a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 2180a3d991bdSwdenk 2181a3d991bdSwdenk A byte containing the id of the VLAN. 2182a3d991bdSwdenk 2183c609719bSwdenk- Status LED: CONFIG_STATUS_LED 2184c609719bSwdenk 2185c609719bSwdenk Several configurations allow to display the current 2186c609719bSwdenk status using a LED. For instance, the LED will blink 2187c609719bSwdenk fast while running U-Boot code, stop blinking as 2188c609719bSwdenk soon as a reply to a BOOTP request was received, and 2189c609719bSwdenk start blinking slow once the Linux kernel is running 2190c609719bSwdenk (supported by a status LED driver in the Linux 2191c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 2192c609719bSwdenk feature in U-Boot. 2193c609719bSwdenk 21941df7bbbaSIgor Grinberg Additional options: 21951df7bbbaSIgor Grinberg 21961df7bbbaSIgor Grinberg CONFIG_GPIO_LED 21971df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 21981df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 21991df7bbbaSIgor Grinberg status LED backend implementation. Define CONFIG_GPIO_LED 22001df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 22011df7bbbaSIgor Grinberg 22029dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 22039dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 22049dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 22059dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 22069dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 22079dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 22089dfdcdfeSIgor Grinberg 2209c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 2210c609719bSwdenk 2211c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 2212c609719bSwdenk on those systems that support this (optional) 2213c609719bSwdenk feature, like the TQM8xxL modules. 2214c609719bSwdenk 22153f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 2216c609719bSwdenk 22173f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 22183f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 22193f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 22203f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 22213f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 22223f4978c7SHeiko Schocher interface. 22233f4978c7SHeiko Schocher 22243f4978c7SHeiko Schocher ported i2c driver to the new framework: 2225ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 2226ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 2227ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2228ea818dbbSHeiko Schocher for defining speed and slave address 2229ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 2230ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2231ea818dbbSHeiko Schocher for defining speed and slave address 2232ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 2233ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2234ea818dbbSHeiko Schocher for defining speed and slave address 2235ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2236ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2237ea818dbbSHeiko Schocher for defining speed and slave address 22383f4978c7SHeiko Schocher 223900f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 224000f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 224100f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 224200f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 224300f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 224400f792e0SHeiko Schocher bus. 224500f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 224600f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 224700f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 224800f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 224900f792e0SHeiko Schocher second bus. 225000f792e0SHeiko Schocher 22511f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 22521f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 22531f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 22541f2ba722SSimon Glass 100000 and the slave addr 0! 22551f2ba722SSimon Glass 2256880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 2257880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 2258880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2259880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2260880540deSDirk Eibach 2261fac96408Strem - drivers/i2c/i2c_mxc.c 2262fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 226303544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 226403544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 226503544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 226603544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 2267fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2268fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2269fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2270fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2271fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2272fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 227303544c66SAlbert ARIBAUD \\(3ADEV\\) - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED 227403544c66SAlbert ARIBAUD \\(3ADEV\\) - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE 2275b445bbb4SJeremiah Mahler If those defines are not set, default value is 100000 2276fac96408Strem for speed, and 0 for slave. 2277fac96408Strem 22781086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 22791086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 22801086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 22811086bfa9SNobuhiro Iwamatsu 22821086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 22831086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 22841086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 22851086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 22861086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 22871086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 22881086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 22891086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 22901086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 22911086bfa9SNobuhiro Iwamatsu 22922035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 22932035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 22942035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 22952035d77dSNobuhiro Iwamatsu 22962035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 22972035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 22982035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 22992035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 23002035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 23012035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 23022035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 23032035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 23042035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 23052035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 23062035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5 23072035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5 2308b445bbb4SJeremiah Mahler - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses 23092035d77dSNobuhiro Iwamatsu 23106789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 23116789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 23126789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 23136789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 23146789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 23156789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 23166789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 23176789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 23186789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 23196789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 23206789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 23216789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 23226789e84eSHeiko Schocher 23230bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 23240bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 23250bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 23260bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 23270bdffe71SHeiko Schocher 2328e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 2329e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 2330e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 2331e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 2332e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 2333e717fc6dSNaveen Krishna Ch 2334b46226bdSDirk Eibach - drivers/i2c/ihs_i2c.c 2335b46226bdSDirk Eibach - activate this driver with CONFIG_SYS_I2C_IHS 2336b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 2337b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 2338b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 2339b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 2340b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 2341b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 2342b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 2343b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 2344b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 2345b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 2346b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 2347b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 2348071be896SDirk Eibach - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL 2349071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 2350071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 2351071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 2352071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 2353071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 2354071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 2355071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 2356071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 2357b46226bdSDirk Eibach 23583f4978c7SHeiko Schocher additional defines: 23593f4978c7SHeiko Schocher 23603f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 2361b445bbb4SJeremiah Mahler Hold the number of i2c buses you want to use. If you 23623f4978c7SHeiko Schocher don't use/have i2c muxes on your i2c bus, this 23633f4978c7SHeiko Schocher is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 23643f4978c7SHeiko Schocher omit this define. 23653f4978c7SHeiko Schocher 23663f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 23673f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 23683f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 23693f4978c7SHeiko Schocher omit this define. 23703f4978c7SHeiko Schocher 23713f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 23723f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 23733f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 23743f4978c7SHeiko Schocher define. 23753f4978c7SHeiko Schocher 23763f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 2377b445bbb4SJeremiah Mahler hold a list of buses you want to use, only used if 23783f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 23793f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 23803f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 23813f4978c7SHeiko Schocher 23823f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 23833f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 23843f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 23853f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 23863f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 23873f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 23883f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 23893f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 23903f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 23913f4978c7SHeiko Schocher } 23923f4978c7SHeiko Schocher 23933f4978c7SHeiko Schocher which defines 23943f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 2395ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2396ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2397ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2398ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2399ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 24003f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 2401ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2402ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 24033f4978c7SHeiko Schocher 24043f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 24053f4978c7SHeiko Schocher 2406ea818dbbSHeiko Schocher- Legacy I2C Support: CONFIG_HARD_I2C 24073f4978c7SHeiko Schocher 24083f4978c7SHeiko Schocher NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 24093f4978c7SHeiko Schocher provides the following compelling advantages: 24103f4978c7SHeiko Schocher 24113f4978c7SHeiko Schocher - more than one i2c adapter is usable 24123f4978c7SHeiko Schocher - approved multibus support 24133f4978c7SHeiko Schocher - better i2c mux support 24143f4978c7SHeiko Schocher 24153f4978c7SHeiko Schocher ** Please consider updating your I2C driver now. ** 24163f4978c7SHeiko Schocher 2417ea818dbbSHeiko Schocher These enable legacy I2C serial bus commands. Defining 2418ea818dbbSHeiko Schocher CONFIG_HARD_I2C will include the appropriate I2C driver 2419ea818dbbSHeiko Schocher for the selected CPU. 2420c609719bSwdenk 2421b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 2422602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 2423b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 2424b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 2425c609719bSwdenk command line interface. 2426c609719bSwdenk 2427bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 2428c609719bSwdenk 2429b37c7e5eSwdenk There are several other quantities that must also be 2430ea818dbbSHeiko Schocher defined when you define CONFIG_HARD_I2C. 2431c609719bSwdenk 24326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 2433b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 24346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 243511ccc33fSMarcel Ziswiler the CPU's i2c node address). 2436c609719bSwdenk 24378d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 2438a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 24398d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 24408d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 24418d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 2442b37c7e5eSwdenk 24435da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 24445da71efaSEric Millbrandt 24455da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 24465da71efaSEric Millbrandt chips might think that the current transfer is still 24475da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 24485da71efaSEric Millbrandt commands until the slave device responds. 24495da71efaSEric Millbrandt 2450b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 2451b37c7e5eSwdenk 2452ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2453b37c7e5eSwdenk then the following macros need to be defined (examples are 2454b37c7e5eSwdenk from include/configs/lwmon.h): 2455c609719bSwdenk 2456c609719bSwdenk I2C_INIT 2457c609719bSwdenk 2458b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 2459c609719bSwdenk controller or configure ports. 2460c609719bSwdenk 2461b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2462b37c7e5eSwdenk 2463c609719bSwdenk I2C_PORT 2464c609719bSwdenk 2465c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 2466c609719bSwdenk assumes both bits are on the same port). Valid values 2467c609719bSwdenk are 0..3 for ports A..D. 2468c609719bSwdenk 2469c609719bSwdenk I2C_ACTIVE 2470c609719bSwdenk 2471c609719bSwdenk The code necessary to make the I2C data line active 2472c609719bSwdenk (driven). If the data line is open collector, this 2473c609719bSwdenk define can be null. 2474c609719bSwdenk 2475b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2476b37c7e5eSwdenk 2477c609719bSwdenk I2C_TRISTATE 2478c609719bSwdenk 2479c609719bSwdenk The code necessary to make the I2C data line tri-stated 2480c609719bSwdenk (inactive). If the data line is open collector, this 2481c609719bSwdenk define can be null. 2482c609719bSwdenk 2483b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2484b37c7e5eSwdenk 2485c609719bSwdenk I2C_READ 2486c609719bSwdenk 2487472d5460SYork Sun Code that returns true if the I2C data line is high, 2488472d5460SYork Sun false if it is low. 2489c609719bSwdenk 2490b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2491b37c7e5eSwdenk 2492c609719bSwdenk I2C_SDA(bit) 2493c609719bSwdenk 2494472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2495472d5460SYork Sun is false, it clears it (low). 2496c609719bSwdenk 2497b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2498b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2499b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2500b37c7e5eSwdenk 2501c609719bSwdenk I2C_SCL(bit) 2502c609719bSwdenk 2503472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2504472d5460SYork Sun is false, it clears it (low). 2505c609719bSwdenk 2506b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2507b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2508b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2509b37c7e5eSwdenk 2510c609719bSwdenk I2C_DELAY 2511c609719bSwdenk 2512c609719bSwdenk This delay is invoked four times per clock cycle so this 2513c609719bSwdenk controls the rate of data transfer. The data rate thus 2514b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2515b37c7e5eSwdenk like: 2516b37c7e5eSwdenk 2517b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2518c609719bSwdenk 2519793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2520793b5726SMike Frysinger 2521793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2522793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2523793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2524793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2525793b5726SMike Frysinger 2526793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2527793b5726SMike Frysinger the generic GPIO functions. 2528793b5726SMike Frysinger 25296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 253047cd00faSwdenk 253147cd00faSwdenk When a board is reset during an i2c bus transfer 253247cd00faSwdenk chips might think that the current transfer is still 253347cd00faSwdenk in progress. On some boards it is possible to access 253447cd00faSwdenk the i2c SCLK line directly, either by using the 253547cd00faSwdenk processor pin as a GPIO or by having a second pin 253647cd00faSwdenk connected to the bus. If this option is defined a 253747cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 253847cd00faSwdenk is run early in the boot sequence. 253947cd00faSwdenk 254026a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 254126a33504SRichard Retanubun 254226a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 254326a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 254426a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 254526a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 254626a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 254726a33504SRichard Retanubun controller provide such a method. It is called at the end of 254826a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 254926a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 255026a33504SRichard Retanubun 255117ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 255217ea1177Swdenk 255317ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 255417ea1177Swdenk in u-boot bd_info structure based on u-boot environment 255517ea1177Swdenk variable "i2cfast". (see also i2cfast) 255617ea1177Swdenk 2557bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2558bb99ad6dSBen Warren 2559bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2560bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2561bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2562bb99ad6dSBen Warren Note that bus numbering is zero-based. 2563bb99ad6dSBen Warren 25646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2565bb99ad6dSBen Warren 2566bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 25670f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 25680f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 25690f89c54bSPeter Tyser a 1D array of device addresses 2570bb99ad6dSBen Warren 2571bb99ad6dSBen Warren e.g. 2572bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 25736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2574bb99ad6dSBen Warren 2575bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2576bb99ad6dSBen Warren 2577bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 25786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2579bb99ad6dSBen Warren 2580bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2581bb99ad6dSBen Warren 25826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2583be5e6181STimur Tabi 2584be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2585be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2586be5e6181STimur Tabi 25876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 25880dc018ecSStefan Roese 25890dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 25900dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 25910dc018ecSStefan Roese 25926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 25930dc018ecSStefan Roese 25940dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 25950dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 25960dc018ecSStefan Roese 25976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 25989ebbb54fSVictor Gallardo 25999ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 26009ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 26019ebbb54fSVictor Gallardo specified DTT device. 26029ebbb54fSVictor Gallardo 26032ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 26042ac6985aSAndrew Dyer 26052ac6985aSAndrew Dyer defining this will force the i2c_read() function in 26062ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 26072ac6985aSAndrew Dyer between writing the address pointer and reading the 26082ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 26092ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 26102ac6985aSAndrew Dyer devices can use either method, but some require one or 26112ac6985aSAndrew Dyer the other. 2612be5e6181STimur Tabi 2613c609719bSwdenk- SPI Support: CONFIG_SPI 2614c609719bSwdenk 2615c609719bSwdenk Enables SPI driver (so far only tested with 2616c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2617c609719bSwdenk D/As on the SACSng board) 2618c609719bSwdenk 26196639562eSYoshihiro Shimoda CONFIG_SH_SPI 26206639562eSYoshihiro Shimoda 26216639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 26226639562eSYoshihiro Shimoda only SH7757 is supported. 26236639562eSYoshihiro Shimoda 2624c609719bSwdenk CONFIG_SOFT_SPI 2625c609719bSwdenk 2626c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2627c609719bSwdenk using hardware support. This is a general purpose 2628c609719bSwdenk driver that only requires three general I/O port pins 2629c609719bSwdenk (two outputs, one input) to function. If this is 2630c609719bSwdenk defined, the board configuration must define several 2631c609719bSwdenk SPI configuration items (port pins to use, etc). For 2632c609719bSwdenk an example, see include/configs/sacsng.h. 2633c609719bSwdenk 263404a9e118SBen Warren CONFIG_HARD_SPI 263504a9e118SBen Warren 263604a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 263704a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 263804a9e118SBen Warren must define a list of chip-select function pointers. 263904a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 264004a9e118SBen Warren example, see include/configs/mpc8349emds.h. 264104a9e118SBen Warren 264238254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 264338254f45SGuennadi Liakhovetski 264438254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 26452e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 264638254f45SGuennadi Liakhovetski 2647f659b573SHeiko Schocher CONFIG_SYS_SPI_MXC_WAIT 2648f659b573SHeiko Schocher Timeout for waiting until spi transfer completed. 2649f659b573SHeiko Schocher default: (CONFIG_SYS_HZ/100) /* 10 ms */ 2650f659b573SHeiko Schocher 26510133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 26520133502eSMatthias Fuchs 26530133502eSMatthias Fuchs Enables FPGA subsystem. 26540133502eSMatthias Fuchs 26550133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 26560133502eSMatthias Fuchs 26570133502eSMatthias Fuchs Enables support for specific chip vendors. 26580133502eSMatthias Fuchs (ALTERA, XILINX) 26590133502eSMatthias Fuchs 26600133502eSMatthias Fuchs CONFIG_FPGA_<family> 26610133502eSMatthias Fuchs 26620133502eSMatthias Fuchs Enables support for FPGA family. 26630133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 26640133502eSMatthias Fuchs 26650133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2666c609719bSwdenk 2667c609719bSwdenk Specify the number of FPGA devices to support. 2668c609719bSwdenk 266964e809afSSiva Durga Prasad Paladugu CONFIG_CMD_FPGA_LOADMK 267064e809afSSiva Durga Prasad Paladugu 267164e809afSSiva Durga Prasad Paladugu Enable support for fpga loadmk command 267264e809afSSiva Durga Prasad Paladugu 267367193864SMichal Simek CONFIG_CMD_FPGA_LOADP 267467193864SMichal Simek 267567193864SMichal Simek Enable support for fpga loadp command - load partial bitstream 267667193864SMichal Simek 267767193864SMichal Simek CONFIG_CMD_FPGA_LOADBP 267867193864SMichal Simek 267967193864SMichal Simek Enable support for fpga loadbp command - load partial bitstream 268067193864SMichal Simek (Xilinx only) 268167193864SMichal Simek 26826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2683c609719bSwdenk 2684c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2685c609719bSwdenk 26866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2687c609719bSwdenk 2688c609719bSwdenk Enable checks on FPGA configuration interface busy 2689c609719bSwdenk status by the configuration function. This option 2690c609719bSwdenk will require a board or device specific function to 2691c609719bSwdenk be written. 2692c609719bSwdenk 2693c609719bSwdenk CONFIG_FPGA_DELAY 2694c609719bSwdenk 2695c609719bSwdenk If defined, a function that provides delays in the FPGA 2696c609719bSwdenk configuration driver. 2697c609719bSwdenk 26986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2699c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2700c609719bSwdenk 27016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2702c609719bSwdenk 2703c609719bSwdenk Check for configuration errors during FPGA bitfile 2704c609719bSwdenk loading. For example, abort during Virtex II 2705c609719bSwdenk configuration if the INIT_B line goes low (which 2706c609719bSwdenk indicated a CRC error). 2707c609719bSwdenk 27086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2709c609719bSwdenk 2710b445bbb4SJeremiah Mahler Maximum time to wait for the INIT_B line to de-assert 2711b445bbb4SJeremiah Mahler after PROB_B has been de-asserted during a Virtex II 2712c609719bSwdenk FPGA configuration sequence. The default time is 500 271311ccc33fSMarcel Ziswiler ms. 2714c609719bSwdenk 27156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2716c609719bSwdenk 2717b445bbb4SJeremiah Mahler Maximum time to wait for BUSY to de-assert during 271811ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2719c609719bSwdenk 27206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2721c609719bSwdenk 2722c609719bSwdenk Time to wait after FPGA configuration. The default is 272311ccc33fSMarcel Ziswiler 200 ms. 2724c609719bSwdenk 2725c609719bSwdenk- Configuration Management: 2726b2b8a696SStefan Roese CONFIG_BUILD_TARGET 2727b2b8a696SStefan Roese 2728b2b8a696SStefan Roese Some SoCs need special image types (e.g. U-Boot binary 2729b2b8a696SStefan Roese with a special header) as build targets. By defining 2730b2b8a696SStefan Roese CONFIG_BUILD_TARGET in the SoC / board header, this 2731b2b8a696SStefan Roese special image will be automatically built upon calling 27326de80f21SSimon Glass make / buildman. 2733b2b8a696SStefan Roese 2734c609719bSwdenk CONFIG_IDENT_STRING 2735c609719bSwdenk 2736c609719bSwdenk If defined, this string will be added to the U-Boot 2737c609719bSwdenk version information (U_BOOT_VERSION) 2738c609719bSwdenk 2739c609719bSwdenk- Vendor Parameter Protection: 2740c609719bSwdenk 2741c609719bSwdenk U-Boot considers the values of the environment 2742c609719bSwdenk variables "serial#" (Board Serial Number) and 27437152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2744c609719bSwdenk are set once by the board vendor / manufacturer, and 2745c609719bSwdenk protects these variables from casual modification by 2746c609719bSwdenk the user. Once set, these variables are read-only, 2747c609719bSwdenk and write or delete attempts are rejected. You can 274811ccc33fSMarcel Ziswiler change this behaviour: 2749c609719bSwdenk 2750c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2751c609719bSwdenk file, the write protection for vendor parameters is 275247cd00faSwdenk completely disabled. Anybody can change or delete 2753c609719bSwdenk these parameters. 2754c609719bSwdenk 275592ac5208SJoe Hershberger Alternatively, if you define _both_ an ethaddr in the 275692ac5208SJoe Hershberger default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 275711ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2758c609719bSwdenk which can be changed exactly ONCE by the user. [The 2759c609719bSwdenk serial# is unaffected by this, i. e. it remains 2760c609719bSwdenk read-only.] 2761c609719bSwdenk 27622598090bSJoe Hershberger The same can be accomplished in a more flexible way 27632598090bSJoe Hershberger for any variable by configuring the type of access 27642598090bSJoe Hershberger to allow for those variables in the ".flags" variable 27652598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 27662598090bSJoe Hershberger 2767c609719bSwdenk- Protected RAM: 2768c609719bSwdenk CONFIG_PRAM 2769c609719bSwdenk 2770c609719bSwdenk Define this variable to enable the reservation of 2771c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2772c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2773c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2774c609719bSwdenk this default value by defining an environment 2775c609719bSwdenk variable "pram" to the number of kB you want to 2776c609719bSwdenk reserve. Note that the board info structure will 2777c609719bSwdenk still show the full amount of RAM. If pRAM is 2778c609719bSwdenk reserved, a new environment variable "mem" will 2779c609719bSwdenk automatically be defined to hold the amount of 2780c609719bSwdenk remaining RAM in a form that can be passed as boot 2781c609719bSwdenk argument to Linux, for instance like that: 2782c609719bSwdenk 2783fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2784c609719bSwdenk saveenv 2785c609719bSwdenk 2786c609719bSwdenk This way you can tell Linux not to use this memory, 2787c609719bSwdenk either, which results in a memory region that will 2788c609719bSwdenk not be affected by reboots. 2789c609719bSwdenk 2790c609719bSwdenk *WARNING* If your board configuration uses automatic 2791c609719bSwdenk detection of the RAM size, you must make sure that 2792c609719bSwdenk this memory test is non-destructive. So far, the 2793c609719bSwdenk following board configurations are known to be 2794c609719bSwdenk "pRAM-clean": 2795c609719bSwdenk 27961b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 27971b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2798544d97e9SWolfgang Denk FLAGADM, TQM8260 2799c609719bSwdenk 280040fef049SGabe Black- Access to physical memory region (> 4GB) 280140fef049SGabe Black Some basic support is provided for operations on memory not 280240fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 280340fef049SGabe Black support access to more than 4GB of memory on 32-bit 280440fef049SGabe Black machines using physical address extension or similar. 280540fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 280640fef049SGabe Black currently only supports clearing the memory. 280740fef049SGabe Black 2808c609719bSwdenk- Error Recovery: 2809c609719bSwdenk CONFIG_PANIC_HANG 2810c609719bSwdenk 2811c609719bSwdenk Define this variable to stop the system in case of a 2812c609719bSwdenk fatal error, so that you have to reset it manually. 2813c609719bSwdenk This is probably NOT a good idea for an embedded 281411ccc33fSMarcel Ziswiler system where you want the system to reboot 2815c609719bSwdenk automatically as fast as possible, but it may be 2816c609719bSwdenk useful during development since you can try to debug 2817c609719bSwdenk the conditions that lead to the situation. 2818c609719bSwdenk 2819c609719bSwdenk CONFIG_NET_RETRY_COUNT 2820c609719bSwdenk 2821c609719bSwdenk This variable defines the number of retries for 2822c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2823c609719bSwdenk before giving up the operation. If not defined, a 2824c609719bSwdenk default value of 5 is used. 2825c609719bSwdenk 282640cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 282740cb90eeSGuennadi Liakhovetski 282840cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 282940cb90eeSGuennadi Liakhovetski 283048a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 283148a3e999STetsuyuki Kobayashi 283248a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 283348a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 283448a3e999STetsuyuki Kobayashi try longer timeout such as 283548a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 283648a3e999STetsuyuki Kobayashi 2837c609719bSwdenk- Command Interpreter: 28388078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 283904a85b3bSwdenk 284004a85b3bSwdenk Enable auto completion of commands using TAB. 284104a85b3bSwdenk 28426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2843c609719bSwdenk 2844c609719bSwdenk This defines the secondary prompt string, which is 2845c609719bSwdenk printed when the command interpreter needs more input 2846c609719bSwdenk to complete a command. Usually "> ". 2847c609719bSwdenk 2848c609719bSwdenk Note: 2849c609719bSwdenk 2850c609719bSwdenk In the current implementation, the local variables 2851c609719bSwdenk space and global environment variables space are 2852c609719bSwdenk separated. Local variables are those you define by 28533b57fe0aSwdenk simply typing `name=value'. To access a local 2854c609719bSwdenk variable later on, you have write `$name' or 28553b57fe0aSwdenk `${name}'; to execute the contents of a variable 28563b57fe0aSwdenk directly type `$name' at the command prompt. 2857c609719bSwdenk 2858c609719bSwdenk Global environment variables are those you use 2859c609719bSwdenk setenv/printenv to work with. To run a command stored 2860c609719bSwdenk in such a variable, you need to use the run command, 2861c609719bSwdenk and you must not use the '$' sign to access them. 2862c609719bSwdenk 2863c609719bSwdenk To store commands and special characters in a 2864c609719bSwdenk variable, please use double quotation marks 2865c609719bSwdenk surrounding the whole text of the variable, instead 2866c609719bSwdenk of the backslashes before semicolons and special 2867c609719bSwdenk symbols. 2868c609719bSwdenk 2869b445bbb4SJeremiah Mahler- Command Line Editing and History: 2870aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2871aa0c71acSWolfgang Denk 287211ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2873aa0c71acSWolfgang Denk command line input operations 2874aa0c71acSWolfgang Denk 2875f3b267b3SMarek Vasut- Command Line PS1/PS2 support: 2876f3b267b3SMarek Vasut CONFIG_CMDLINE_PS_SUPPORT 2877f3b267b3SMarek Vasut 2878f3b267b3SMarek Vasut Enable support for changing the command prompt string 2879f3b267b3SMarek Vasut at run-time. Only static string is supported so far. 2880f3b267b3SMarek Vasut The string is obtained from environment variables PS1 2881f3b267b3SMarek Vasut and PS2. 2882f3b267b3SMarek Vasut 2883a8c7c708Swdenk- Default Environment: 2884c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2885c609719bSwdenk 2886c609719bSwdenk Define this to contain any number of null terminated 2887c609719bSwdenk strings (variable = value pairs) that will be part of 28887152b1d0Swdenk the default environment compiled into the boot image. 28892262cfeeSwdenk 2890c609719bSwdenk For example, place something like this in your 2891c609719bSwdenk board's config file: 2892c609719bSwdenk 2893c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2894c609719bSwdenk "myvar1=value1\0" \ 2895c609719bSwdenk "myvar2=value2\0" 2896c609719bSwdenk 2897c609719bSwdenk Warning: This method is based on knowledge about the 2898c609719bSwdenk internal format how the environment is stored by the 28992262cfeeSwdenk U-Boot code. This is NOT an official, exported 2900c609719bSwdenk interface! Although it is unlikely that this format 29017152b1d0Swdenk will change soon, there is no guarantee either. 2902c609719bSwdenk You better know what you are doing here. 2903c609719bSwdenk 2904c609719bSwdenk Note: overly (ab)use of the default environment is 2905c609719bSwdenk discouraged. Make sure to check other ways to preset 290674de7aefSWolfgang Denk the environment like the "source" command or the 2907c609719bSwdenk boot command first. 2908c609719bSwdenk 29095e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 29105e724ca2SStephen Warren 29115e724ca2SStephen Warren Define this in order to add variables describing the 29125e724ca2SStephen Warren U-Boot build configuration to the default environment. 29135e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 29145e724ca2SStephen Warren 29155e724ca2SStephen Warren Enabling this option will cause the following to be defined: 29165e724ca2SStephen Warren 29175e724ca2SStephen Warren - CONFIG_SYS_ARCH 29185e724ca2SStephen Warren - CONFIG_SYS_CPU 29195e724ca2SStephen Warren - CONFIG_SYS_BOARD 29205e724ca2SStephen Warren - CONFIG_SYS_VENDOR 29215e724ca2SStephen Warren - CONFIG_SYS_SOC 29225e724ca2SStephen Warren 29237e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 29247e27f89fSTom Rini 29257e27f89fSTom Rini Define this in order to add variables describing certain 29267e27f89fSTom Rini run-time determined information about the hardware to the 29277e27f89fSTom Rini environment. These will be named board_name, board_rev. 29287e27f89fSTom Rini 292906fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 293006fd8538SSimon Glass 293106fd8538SSimon Glass Normally the environment is loaded when the board is 2932b445bbb4SJeremiah Mahler initialised so that it is available to U-Boot. This inhibits 293306fd8538SSimon Glass that so that the environment is not available until 293406fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 293506fd8538SSimon Glass this is instead controlled by the value of 293606fd8538SSimon Glass /config/load-environment. 293706fd8538SSimon Glass 29383b10cf12SChris Packham- Parallel Flash support: 29393b10cf12SChris Packham CONFIG_SYS_NO_FLASH 29403b10cf12SChris Packham 2941a187559eSBin Meng Traditionally U-Boot was run on systems with parallel NOR 29423b10cf12SChris Packham flash. This option is used to disable support for parallel NOR 29433b10cf12SChris Packham flash. This option should be defined if the board does not have 29443b10cf12SChris Packham parallel flash. 29453b10cf12SChris Packham 29463b10cf12SChris Packham If this option is not defined one of the generic flash drivers 29473b10cf12SChris Packham (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be 29483b10cf12SChris Packham selected or the board must provide an implementation of the 29493b10cf12SChris Packham flash API (see include/flash.h). 29503b10cf12SChris Packham 2951a8c7c708Swdenk- DataFlash Support: 29522abbe075Swdenk CONFIG_HAS_DATAFLASH 29532abbe075Swdenk 29542abbe075Swdenk Defining this option enables DataFlash features and 29552abbe075Swdenk allows to read/write in Dataflash via the standard 29562abbe075Swdenk commands cp, md... 29572abbe075Swdenk 2958f61ec45eSEric Nelson- Serial Flash support 2959f61ec45eSEric Nelson CONFIG_CMD_SF 2960f61ec45eSEric Nelson 2961f61ec45eSEric Nelson Defining this option enables SPI flash commands 2962f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2963f61ec45eSEric Nelson 2964f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2965f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2966f61ec45eSEric Nelson commands. 2967f61ec45eSEric Nelson 2968f61ec45eSEric Nelson The following defaults may be provided by the platform 2969f61ec45eSEric Nelson to handle the common case when only a single serial 2970f61ec45eSEric Nelson flash is present on the system. 2971f61ec45eSEric Nelson 2972f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2973f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2974f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2975f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2976f61ec45eSEric Nelson 297724007273SSimon Glass CONFIG_CMD_SF_TEST 297824007273SSimon Glass 297924007273SSimon Glass Define this option to include a destructive SPI flash 298024007273SSimon Glass test ('sf test'). 298124007273SSimon Glass 2982b902e07cSJagannadha Sutradharudu Teki CONFIG_SF_DUAL_FLASH Dual flash memories 2983b902e07cSJagannadha Sutradharudu Teki 2984b902e07cSJagannadha Sutradharudu Teki Define this option to use dual flash support where two flash 2985b902e07cSJagannadha Sutradharudu Teki memories can be connected with a given cs line. 2986b445bbb4SJeremiah Mahler Currently Xilinx Zynq qspi supports these type of connections. 2987b902e07cSJagannadha Sutradharudu Teki 29883f85ce27Swdenk- SystemACE Support: 29893f85ce27Swdenk CONFIG_SYSTEMACE 29903f85ce27Swdenk 29913f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 29923f85ce27Swdenk chips attached via some sort of local bus. The address 299311ccc33fSMarcel Ziswiler of the chip must also be defined in the 29946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 29953f85ce27Swdenk 29963f85ce27Swdenk #define CONFIG_SYSTEMACE 29976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 29983f85ce27Swdenk 29993f85ce27Swdenk When SystemACE support is added, the "ace" device type 30003f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 30013f85ce27Swdenk 3002ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 3003ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 3004ecb0ccd9SWolfgang Denk 300528cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 3006ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 300728cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 3008ecb0ccd9SWolfgang Denk number generator is used. 3009ecb0ccd9SWolfgang Denk 301028cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 301128cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 301228cb9375SWolfgang Denk defined, the normal port 69 is used. 301328cb9375SWolfgang Denk 301428cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 3015ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 3016ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 3017ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 3018ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 3019ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 3020ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 3021ecb0ccd9SWolfgang Denk 3022bf36c5d5SSimon Glass- Hashing support: 3023bf36c5d5SSimon Glass CONFIG_CMD_HASH 3024bf36c5d5SSimon Glass 3025bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 3026bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 3027bf36c5d5SSimon Glass 3028bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 3029bf36c5d5SSimon Glass 3030bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 3031bf36c5d5SSimon Glass size a little. 3032bf36c5d5SSimon Glass 303394e3c8c4Sgaurav rana CONFIG_SHA1 - This option enables support of hashing using SHA1 303494e3c8c4Sgaurav rana algorithm. The hash is calculated in software. 303594e3c8c4Sgaurav rana CONFIG_SHA256 - This option enables support of hashing using 303694e3c8c4Sgaurav rana SHA256 algorithm. The hash is calculated in software. 303794e3c8c4Sgaurav rana CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration 303894e3c8c4Sgaurav rana for SHA1/SHA256 hashing. 303994e3c8c4Sgaurav rana This affects the 'hash' command and also the 304094e3c8c4Sgaurav rana hash_lookup_algo() function. 304194e3c8c4Sgaurav rana CONFIG_SHA_PROG_HW_ACCEL - This option enables 304294e3c8c4Sgaurav rana hardware-acceleration for SHA1/SHA256 progressive hashing. 304394e3c8c4Sgaurav rana Data can be streamed in a block at a time and the hashing 304494e3c8c4Sgaurav rana is performed in hardware. 3045bf36c5d5SSimon Glass 3046bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 3047bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 3048bf36c5d5SSimon Glass 3049a11f1873SRobert Winkler- Freescale i.MX specific commands: 3050a11f1873SRobert Winkler CONFIG_CMD_HDMIDETECT 3051a11f1873SRobert Winkler This enables 'hdmidet' command which returns true if an 3052a11f1873SRobert Winkler HDMI monitor is detected. This command is i.MX 6 specific. 3053a11f1873SRobert Winkler 3054a11f1873SRobert Winkler CONFIG_CMD_BMODE 3055a11f1873SRobert Winkler This enables the 'bmode' (bootmode) command for forcing 3056a11f1873SRobert Winkler a boot from specific media. 3057a11f1873SRobert Winkler 3058a11f1873SRobert Winkler This is useful for forcing the ROM's usb downloader to 3059a11f1873SRobert Winkler activate upon a watchdog reset which is nice when iterating 3060a11f1873SRobert Winkler on U-Boot. Using the reset button or running bmode normal 3061a11f1873SRobert Winkler will set it back to normal. This command currently 3062a11f1873SRobert Winkler supports i.MX53 and i.MX6. 3063a11f1873SRobert Winkler 30649e50c406SHeiko Schocher- bootcount support: 30659e50c406SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 30669e50c406SHeiko Schocher 30679e50c406SHeiko Schocher This enables the bootcounter support, see: 30689e50c406SHeiko Schocher http://www.denx.de/wiki/DULG/UBootBootCountLimit 30699e50c406SHeiko Schocher 30709e50c406SHeiko Schocher CONFIG_AT91SAM9XE 30719e50c406SHeiko Schocher enable special bootcounter support on at91sam9xe based boards. 30729e50c406SHeiko Schocher CONFIG_BLACKFIN 30739e50c406SHeiko Schocher enable special bootcounter support on blackfin based boards. 30749e50c406SHeiko Schocher CONFIG_SOC_DA8XX 30759e50c406SHeiko Schocher enable special bootcounter support on da850 based boards. 30769e50c406SHeiko Schocher CONFIG_BOOTCOUNT_RAM 30779e50c406SHeiko Schocher enable support for the bootcounter in RAM 30789e50c406SHeiko Schocher CONFIG_BOOTCOUNT_I2C 30799e50c406SHeiko Schocher enable support for the bootcounter on an i2c (like RTC) device. 30809e50c406SHeiko Schocher CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 30819e50c406SHeiko Schocher CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 30829e50c406SHeiko Schocher the bootcounter. 30839e50c406SHeiko Schocher CONFIG_BOOTCOUNT_ALEN = address len 308419c402afSSimon Glass 3085a8c7c708Swdenk- Show boot progress: 3086c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 3087c609719bSwdenk 3088c609719bSwdenk Defining this option allows to add some board- 3089c609719bSwdenk specific code (calling a user-provided function 3090c609719bSwdenk "show_boot_progress(int)") that enables you to show 3091c609719bSwdenk the system's boot progress on some display (for 3092c609719bSwdenk example, some LED's) on your board. At the moment, 3093c609719bSwdenk the following checkpoints are implemented: 3094c609719bSwdenk 309594fd1316SSimon Glass 30961372cce2SMarian BalakowiczLegacy uImage format: 30971372cce2SMarian Balakowicz 3098c609719bSwdenk Arg Where When 3099c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 3100c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 3101c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 3102c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 3103c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 3104c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 3105c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 3106c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 3107c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 31081372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 3109c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 3110c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 3111c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 3112c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 31131372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 3114c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 31151372cce2SMarian Balakowicz 31161372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 31171372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 31181372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 31191372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 31201372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 31211372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 31221372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 312311ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 31241372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 31251372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 31261372cce2SMarian Balakowicz 3127ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 3128c609719bSwdenk 3129a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 313063e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 313163e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 313263e73c9aSwdenk 3133566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 3134566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 3135566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 3136566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 3137566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 3138566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 3139566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 3140566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 3141566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 3142566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 3143566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 3144566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 3145566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 3146566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 3147566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 3148566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 3149566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 3150566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 3151566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 3152566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 3153566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 3154566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 3155566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 3156566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 3157566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 3158566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 3159566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 3160566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 3161566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 3162566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 3163566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 3164566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 3165566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 3166566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 3167566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 3168566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 3169566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 3170566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 3171566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 3172566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 3173566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 3174566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 3175566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 3176566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 3177566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 3178566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 3179566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 3180c609719bSwdenk 3181566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 3182c609719bSwdenk 3183566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 3184566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 3185566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 3186206c60cbSwdenk 3187566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 3188bc0571fcSJoe Hershberger 80 common/cmd_net.c before calling net_loop() 3189bc0571fcSJoe Hershberger -81 common/cmd_net.c some error in net_loop() occurred 3190bc0571fcSJoe Hershberger 81 common/cmd_net.c net_loop() back without error 3191566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 3192566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 319374de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 319474de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 3195566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 3196c609719bSwdenk 31971372cce2SMarian BalakowiczFIT uImage format: 31981372cce2SMarian Balakowicz 31991372cce2SMarian Balakowicz Arg Where When 32001372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 32011372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 32021372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 32031372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 32041372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 32051372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 3206f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 32071372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 32081372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 32091372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 32101372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 32111372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 321211ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 321311ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 32141372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 32151372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 32161372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 32171372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 32181372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 32191372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 32201372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 32211372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 32221372cce2SMarian Balakowicz 32231372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 32241372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 32251372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 322611ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 32271372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 32281372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 32291372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 32301372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 32311372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 32321372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 32331372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 32341372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 32351372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 32361372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 32371372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 32381372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 32391372cce2SMarian Balakowicz 324011ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 32411372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 32421372cce2SMarian Balakowicz 324311ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 32441372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 32451372cce2SMarian Balakowicz 324611ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 32471372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 32481372cce2SMarian Balakowicz 324921d29f7fSHeiko Schocher- legacy image format: 325021d29f7fSHeiko Schocher CONFIG_IMAGE_FORMAT_LEGACY 325121d29f7fSHeiko Schocher enables the legacy image format support in U-Boot. 325221d29f7fSHeiko Schocher 325321d29f7fSHeiko Schocher Default: 325421d29f7fSHeiko Schocher enabled if CONFIG_FIT_SIGNATURE is not defined. 325521d29f7fSHeiko Schocher 325621d29f7fSHeiko Schocher CONFIG_DISABLE_IMAGE_LEGACY 325721d29f7fSHeiko Schocher disable the legacy image format 325821d29f7fSHeiko Schocher 325921d29f7fSHeiko Schocher This define is introduced, as the legacy image format is 326021d29f7fSHeiko Schocher enabled per default for backward compatibility. 326121d29f7fSHeiko Schocher 3262d95f6ec7SGabe Black- FIT image support: 32639a4f479bSDirk Eibach CONFIG_FIT_DISABLE_SHA256 32649a4f479bSDirk Eibach Supporting SHA256 hashes has quite an impact on binary size. 32659a4f479bSDirk Eibach For constrained systems sha256 hash support can be disabled 32669a4f479bSDirk Eibach with this option. 32679a4f479bSDirk Eibach 326873223f0eSSimon Glass TODO(sjg@chromium.org): Adjust this option to be positive, 326973223f0eSSimon Glass and move it to Kconfig 327073223f0eSSimon Glass 32714cf2609bSWolfgang Denk- Standalone program support: 32724cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 32734cf2609bSWolfgang Denk 32746feff899SWolfgang Denk This option defines a board specific value for the 32756feff899SWolfgang Denk address where standalone program gets loaded, thus 32766feff899SWolfgang Denk overwriting the architecture dependent default 32774cf2609bSWolfgang Denk settings. 32784cf2609bSWolfgang Denk 32794cf2609bSWolfgang Denk- Frame Buffer Address: 32804cf2609bSWolfgang Denk CONFIG_FB_ADDR 32814cf2609bSWolfgang Denk 32824cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 328344a53b57SWolfgang Denk address for frame buffer. This is typically the case 328444a53b57SWolfgang Denk when using a graphics controller has separate video 328544a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 328644a53b57SWolfgang Denk the given address instead of dynamically reserving it 328744a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 328844a53b57SWolfgang Denk the memory for the frame buffer depending on the 328944a53b57SWolfgang Denk configured panel size. 32904cf2609bSWolfgang Denk 32914cf2609bSWolfgang Denk Please see board_init_f function. 32924cf2609bSWolfgang Denk 3293cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 3294cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 3295cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 3296cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 3297cccfc2abSDetlev Zundel 3298cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 3299cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 3300cccfc2abSDetlev Zundel 3301cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 3302cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 3303cccfc2abSDetlev Zundel 3304cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 3305cccfc2abSDetlev Zundel Needed for mtdparts command support. 3306cccfc2abSDetlev Zundel 3307cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 3308cccfc2abSDetlev Zundel 3309cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 3310cccfc2abSDetlev Zundel kernel. Needed for UBI support. 3311cccfc2abSDetlev Zundel 331270c219cdSJoe Hershberger- UBI support 331370c219cdSJoe Hershberger CONFIG_CMD_UBI 331470c219cdSJoe Hershberger 331570c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 331670c219cdSJoe Hershberger with the UBI flash translation layer 331770c219cdSJoe Hershberger 331870c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 331970c219cdSJoe Hershberger 3320147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 3321147162daSJoe Hershberger 3322147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 3323147162daSJoe Hershberger warnings and errors enabled. 3324147162daSJoe Hershberger 3325ff94bc40SHeiko Schocher 3326ff94bc40SHeiko Schocher CONFIG_MTD_UBI_WL_THRESHOLD 3327ff94bc40SHeiko Schocher This parameter defines the maximum difference between the highest 3328ff94bc40SHeiko Schocher erase counter value and the lowest erase counter value of eraseblocks 3329ff94bc40SHeiko Schocher of UBI devices. When this threshold is exceeded, UBI starts performing 3330ff94bc40SHeiko Schocher wear leveling by means of moving data from eraseblock with low erase 3331ff94bc40SHeiko Schocher counter to eraseblocks with high erase counter. 3332ff94bc40SHeiko Schocher 3333ff94bc40SHeiko Schocher The default value should be OK for SLC NAND flashes, NOR flashes and 3334ff94bc40SHeiko Schocher other flashes which have eraseblock life-cycle 100000 or more. 3335ff94bc40SHeiko Schocher However, in case of MLC NAND flashes which typically have eraseblock 3336ff94bc40SHeiko Schocher life-cycle less than 10000, the threshold should be lessened (e.g., 3337ff94bc40SHeiko Schocher to 128 or 256, although it does not have to be power of 2). 3338ff94bc40SHeiko Schocher 3339ff94bc40SHeiko Schocher default: 4096 3340ff94bc40SHeiko Schocher 3341ff94bc40SHeiko Schocher CONFIG_MTD_UBI_BEB_LIMIT 3342ff94bc40SHeiko Schocher This option specifies the maximum bad physical eraseblocks UBI 3343ff94bc40SHeiko Schocher expects on the MTD device (per 1024 eraseblocks). If the 3344ff94bc40SHeiko Schocher underlying flash does not admit of bad eraseblocks (e.g. NOR 3345ff94bc40SHeiko Schocher flash), this value is ignored. 3346ff94bc40SHeiko Schocher 3347ff94bc40SHeiko Schocher NAND datasheets often specify the minimum and maximum NVM 3348ff94bc40SHeiko Schocher (Number of Valid Blocks) for the flashes' endurance lifetime. 3349ff94bc40SHeiko Schocher The maximum expected bad eraseblocks per 1024 eraseblocks 3350ff94bc40SHeiko Schocher then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", 3351ff94bc40SHeiko Schocher which gives 20 for most NANDs (MaxNVB is basically the total 3352ff94bc40SHeiko Schocher count of eraseblocks on the chip). 3353ff94bc40SHeiko Schocher 3354ff94bc40SHeiko Schocher To put it differently, if this value is 20, UBI will try to 3355ff94bc40SHeiko Schocher reserve about 1.9% of physical eraseblocks for bad blocks 3356ff94bc40SHeiko Schocher handling. And that will be 1.9% of eraseblocks on the entire 3357ff94bc40SHeiko Schocher NAND chip, not just the MTD partition UBI attaches. This means 3358ff94bc40SHeiko Schocher that if you have, say, a NAND flash chip admits maximum 40 bad 3359ff94bc40SHeiko Schocher eraseblocks, and it is split on two MTD partitions of the same 3360ff94bc40SHeiko Schocher size, UBI will reserve 40 eraseblocks when attaching a 3361ff94bc40SHeiko Schocher partition. 3362ff94bc40SHeiko Schocher 3363ff94bc40SHeiko Schocher default: 20 3364ff94bc40SHeiko Schocher 3365ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP 3366ff94bc40SHeiko Schocher Fastmap is a mechanism which allows attaching an UBI device 3367ff94bc40SHeiko Schocher in nearly constant time. Instead of scanning the whole MTD device it 3368ff94bc40SHeiko Schocher only has to locate a checkpoint (called fastmap) on the device. 3369ff94bc40SHeiko Schocher The on-flash fastmap contains all information needed to attach 3370ff94bc40SHeiko Schocher the device. Using fastmap makes only sense on large devices where 3371ff94bc40SHeiko Schocher attaching by scanning takes long. UBI will not automatically install 3372ff94bc40SHeiko Schocher a fastmap on old images, but you can set the UBI parameter 3373ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note 3374ff94bc40SHeiko Schocher that fastmap-enabled images are still usable with UBI implementations 3375ff94bc40SHeiko Schocher without fastmap support. On typical flash devices the whole fastmap 3376ff94bc40SHeiko Schocher fits into one PEB. UBI will reserve PEBs to hold two fastmaps. 3377ff94bc40SHeiko Schocher 3378ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT 3379ff94bc40SHeiko Schocher Set this parameter to enable fastmap automatically on images 3380ff94bc40SHeiko Schocher without a fastmap. 3381ff94bc40SHeiko Schocher default: 0 3382ff94bc40SHeiko Schocher 33830195a7bbSHeiko Schocher CONFIG_MTD_UBI_FM_DEBUG 33840195a7bbSHeiko Schocher Enable UBI fastmap debug 33850195a7bbSHeiko Schocher default: 0 33860195a7bbSHeiko Schocher 338770c219cdSJoe Hershberger- UBIFS support 338870c219cdSJoe Hershberger CONFIG_CMD_UBIFS 338970c219cdSJoe Hershberger 339070c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 339170c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 339270c219cdSJoe Hershberger 339370c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 339470c219cdSJoe Hershberger 3395147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 3396147162daSJoe Hershberger 3397147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 3398147162daSJoe Hershberger warnings and errors enabled. 3399147162daSJoe Hershberger 34006a11cf48SDaniel Schwierzeck- SPL framework 34016a11cf48SDaniel Schwierzeck CONFIG_SPL 34026a11cf48SDaniel Schwierzeck Enable building of SPL globally. 34036a11cf48SDaniel Schwierzeck 340495579793STom Rini CONFIG_SPL_LDSCRIPT 340595579793STom Rini LDSCRIPT for linking the SPL binary. 340695579793STom Rini 34076ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 34086ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 34096ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 34106ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 34118960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 34126ebc3461SAlbert ARIBAUD must not be both defined at the same time. 34136ebc3461SAlbert ARIBAUD 341495579793STom Rini CONFIG_SPL_MAX_SIZE 34156ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 34166ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 34176ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 34186ebc3461SAlbert ARIBAUD not exceed it. 341995579793STom Rini 34206a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 34216a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 34226a11cf48SDaniel Schwierzeck 342394a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 342494a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 342594a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 342694a45bb1SScott Wood 342795579793STom Rini CONFIG_SPL_BSS_START_ADDR 342895579793STom Rini Link address for the BSS within the SPL binary. 342995579793STom Rini 343095579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 34316ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 34326ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 34336ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 34348960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 34356ebc3461SAlbert ARIBAUD must not be both defined at the same time. 343695579793STom Rini 343795579793STom Rini CONFIG_SPL_STACK 343895579793STom Rini Adress of the start of the stack SPL will use 343995579793STom Rini 34408c80eb3bSAlbert ARIBAUD \(3ADEV\) CONFIG_SPL_PANIC_ON_RAW_IMAGE 34418c80eb3bSAlbert ARIBAUD \(3ADEV\) When defined, SPL will panic() if the image it has 34428c80eb3bSAlbert ARIBAUD \(3ADEV\) loaded does not have a signature. 34438c80eb3bSAlbert ARIBAUD \(3ADEV\) Defining this is useful when code which loads images 34448c80eb3bSAlbert ARIBAUD \(3ADEV\) in SPL cannot guarantee that absolutely all read errors 34458c80eb3bSAlbert ARIBAUD \(3ADEV\) will be caught. 34468c80eb3bSAlbert ARIBAUD \(3ADEV\) An example is the LPC32XX MLC NAND driver, which will 34478c80eb3bSAlbert ARIBAUD \(3ADEV\) consider that a completely unreadable NAND block is bad, 34488c80eb3bSAlbert ARIBAUD \(3ADEV\) and thus should be skipped silently. 34498c80eb3bSAlbert ARIBAUD \(3ADEV\) 3450e0727515SMarek Vasut CONFIG_SPL_ABORT_ON_RAW_IMAGE 3451e0727515SMarek Vasut When defined, SPL will proceed to another boot method 3452e0727515SMarek Vasut if the image it has loaded does not have a signature. 3453e0727515SMarek Vasut 345494a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 345594a45bb1SScott Wood Adress of the start of the stack SPL will use after 345694a45bb1SScott Wood relocation. If unspecified, this is equal to 345794a45bb1SScott Wood CONFIG_SPL_STACK. 345894a45bb1SScott Wood 345995579793STom Rini CONFIG_SYS_SPL_MALLOC_START 346095579793STom Rini Starting address of the malloc pool used in SPL. 34619ac4fc82SFabio Estevam When this option is set the full malloc is used in SPL and 34629ac4fc82SFabio Estevam it is set up by spl_init() and before that, the simple malloc() 34639ac4fc82SFabio Estevam can be used if CONFIG_SYS_MALLOC_F is defined. 346495579793STom Rini 346595579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 346695579793STom Rini The size of the malloc pool used in SPL. 34676a11cf48SDaniel Schwierzeck 346847f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 346947f7bcaeSTom Rini Enable the SPL framework under common/. This framework 347047f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 347147f7bcaeSTom Rini NAND loading of the Linux Kernel. 347247f7bcaeSTom Rini 34739607faf2STom Rini CONFIG_SPL_OS_BOOT 34749607faf2STom Rini Enable booting directly to an OS from SPL. 34759607faf2STom Rini See also: doc/README.falcon 34769607faf2STom Rini 3477861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 3478861a86f4STom Rini For ARM, enable an optional function to print more information 3479861a86f4STom Rini about the running system. 3480861a86f4STom Rini 34814b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 34824b919725SScott Wood Arch init code should be built for a very small image 34834b919725SScott Wood 348495579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 348595579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 3486e2ccdf89SPaul Kocialkowski Address and partition on the MMC to load U-Boot from 348795579793STom Rini when the MMC is being used in raw mode. 348895579793STom Rini 3489b97300b6SPaul Kocialkowski CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION 3490b97300b6SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3491b97300b6SPaul Kocialkowski used in raw mode 3492b97300b6SPaul Kocialkowski 34932b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 34942b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 34952b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 34962b75b0adSPeter Korsgaard 34972b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 34982b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 34992b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 35002b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 35012b75b0adSPeter Korsgaard (for falcon mode) 35022b75b0adSPeter Korsgaard 3503e2ccdf89SPaul Kocialkowski CONFIG_SYS_MMCSD_FS_BOOT_PARTITION 3504e2ccdf89SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3505e2ccdf89SPaul Kocialkowski used in fs mode 3506e2ccdf89SPaul Kocialkowski 3507fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_PAYLOAD_NAME 3508fae81c72SGuillaume GARDET Filename to read to load U-Boot when reading from filesystem 3509fae81c72SGuillaume GARDET 3510fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_KERNEL_NAME 35117ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 3512fae81c72SGuillaume GARDET from filesystem (for Falcon mode) 35137ad2cc79SPeter Korsgaard 3514fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_ARGS_NAME 35157ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 3516fae81c72SGuillaume GARDET when reading from filesystem (for Falcon mode) 35177ad2cc79SPeter Korsgaard 351806f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 351906f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 352006f60ae3SScott Wood start.S waits for the rest of the SPL to load before 352106f60ae3SScott Wood continuing (the hardware starts execution after just 352206f60ae3SScott Wood loading the first page rather than the full 4K). 352306f60ae3SScott Wood 3524651fcf60SPrabhakar Kushwaha CONFIG_SPL_SKIP_RELOCATE 3525651fcf60SPrabhakar Kushwaha Avoid SPL relocation 3526651fcf60SPrabhakar Kushwaha 35276f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 35286f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 35296f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 35306f2f01b9SScott Wood 35316f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 35326f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 35336f2f01b9SScott Wood 35346f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 35356f2f01b9SScott Wood Include standard software ECC in the SPL 35366f2f01b9SScott Wood 353795579793STom Rini CONFIG_SPL_NAND_SIMPLE 35387d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 35397d4b7955SScott Wood expose the cmd_ctrl() interface. 354095579793STom Rini 35416f4e7d3cSThomas Gleixner CONFIG_SPL_UBI 35426f4e7d3cSThomas Gleixner Support for a lightweight UBI (fastmap) scanner and 35436f4e7d3cSThomas Gleixner loader 35446f4e7d3cSThomas Gleixner 35450c3117b1SHeiko Schocher CONFIG_SPL_NAND_RAW_ONLY 35460c3117b1SHeiko Schocher Support to boot only raw u-boot.bin images. Use this only 35470c3117b1SHeiko Schocher if you need to save space. 35480c3117b1SHeiko Schocher 35497c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 35507c8eea59SYing Zhang Set for common ddr init with serial presence detect in 35517c8eea59SYing Zhang SPL binary. 35527c8eea59SYing Zhang 355395579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 355495579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 355595579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 355695579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 355795579793STom Rini CONFIG_SYS_NAND_ECCBYTES 355895579793STom Rini Defines the size and behavior of the NAND that SPL uses 35597d4b7955SScott Wood to read U-Boot 356095579793STom Rini 3561fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 3562fbe76ae4SPrabhakar Kushwaha Add support NAND boot 3563fbe76ae4SPrabhakar Kushwaha 356495579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 35657d4b7955SScott Wood Location in NAND to read U-Boot from 35667d4b7955SScott Wood 35677d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 35687d4b7955SScott Wood Location in memory to load U-Boot to 35697d4b7955SScott Wood 35707d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 35717d4b7955SScott Wood Size of image to load 357295579793STom Rini 357395579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 35747d4b7955SScott Wood Entry point in loaded image to jump to 357595579793STom Rini 357695579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 357795579793STom Rini Define this if you need to first read the OOB and then the 3578b445bbb4SJeremiah Mahler data. This is used, for example, on davinci platforms. 357995579793STom Rini 358095579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 358195579793STom Rini Support for an OMAP3-specific set of functions to return the 358295579793STom Rini ID and MFR of the first attached NAND chip, if present. 358395579793STom Rini 3584c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3585c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3586c57b953dSPavel Machek 358774752baaSScott Wood CONFIG_SPL_PAD_TO 35886113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 35896113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 35906113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 35916113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 35926113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 359374752baaSScott Wood 3594ca2fca22SScott Wood CONFIG_SPL_TARGET 3595ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3596ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3597ca2fca22SScott Wood example if more than one image needs to be produced. 3598ca2fca22SScott Wood 359987ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 360087ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 360187ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 360287ebee39SSimon Glass option to re-enable it. This will affect the output of the 360387ebee39SSimon Glass bootm command when booting a FIT image. 360487ebee39SSimon Glass 36053aa29de0SYing Zhang- TPL framework 36063aa29de0SYing Zhang CONFIG_TPL 36073aa29de0SYing Zhang Enable building of TPL globally. 36083aa29de0SYing Zhang 36093aa29de0SYing Zhang CONFIG_TPL_PAD_TO 36103aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 36113aa29de0SYing Zhang the TPL payload. By default, this is defined as 36123aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 36133aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 36143aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 36153aa29de0SYing Zhang 3616a8c7c708Swdenk- Interrupt support (PPC): 3617a8c7c708Swdenk 3618a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3619a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 362011ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3621a8c7c708Swdenk should set decrementer_count to appropriate value. If 362211ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3623a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 362411ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3625a8c7c708Swdenk specific handling. If board has watchdog / status_led 3626a8c7c708Swdenk / other_activity_monitor it works automatically from 3627a8c7c708Swdenk general timer_interrupt(). 3628a8c7c708Swdenk 3629c609719bSwdenk 36309660e442SHelmut RaigerBoard initialization settings: 36319660e442SHelmut Raiger------------------------------ 36329660e442SHelmut Raiger 36339660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 36349660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 36359660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 36369660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 36379660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 36389660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 36399660e442SHelmut Raiger 36409660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 36419660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 36429660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 36439660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3644c609719bSwdenk 3645c609719bSwdenkConfiguration Settings: 3646c609719bSwdenk----------------------- 3647c609719bSwdenk 36484d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 36494d1fd7f1SYork Sun Optionally it can be defined to support 64-bit memory commands. 36504d1fd7f1SYork Sun 36516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3652c609719bSwdenk undefine this when you're short of memory. 3653c609719bSwdenk 36542fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 36552fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 36562fb2604dSPeter Tyser 36576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3658c609719bSwdenk prompt for user input. 3659c609719bSwdenk 36606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3661c609719bSwdenk 36626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3663c609719bSwdenk 36646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3665c609719bSwdenk 36666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3667c609719bSwdenk the application (usually a Linux kernel) when it is 3668c609719bSwdenk booted 3669c609719bSwdenk 36706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3671c609719bSwdenk List of legal baudrate settings for this board. 3672c609719bSwdenk 36736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 3674c609719bSwdenk Suppress display of console information at boot. 3675c609719bSwdenk 36766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 3677c609719bSwdenk If the board specific function 3678c609719bSwdenk extern int overwrite_console (void); 3679c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 3680c609719bSwdenk serial port, else the settings in the environment are used. 3681c609719bSwdenk 36826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3683c609719bSwdenk Enable the call to overwrite_console(). 3684c609719bSwdenk 36856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3686c609719bSwdenk Enable overwrite of previous console environment settings. 3687c609719bSwdenk 36886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3689c609719bSwdenk Begin and End addresses of the area used by the 3690c609719bSwdenk simple memory test. 3691c609719bSwdenk 36926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3693c609719bSwdenk Enable an alternate, more extensive memory test. 3694c609719bSwdenk 36956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 36965f535fe1Swdenk Scratch address used by the alternate memory test 36975f535fe1Swdenk You only need to set this if address zero isn't writeable 36985f535fe1Swdenk 3699e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE 3700e61a7534SYork Sun Only implemented for ARMv8 for now. 3701e8149522SYork Sun If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory 3702e8149522SYork Sun is substracted from total RAM and won't be reported to OS. 3703e8149522SYork Sun This memory can be used as secure memory. A variable 3704e61a7534SYork Sun gd->arch.secure_ram is used to track the location. In systems 3705e8149522SYork Sun the RAM base is not zero, or RAM is divided into banks, 3706e8149522SYork Sun this variable needs to be recalcuated to get the address. 3707e8149522SYork Sun 3708aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE: 37096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 371014f73ca6SStefan Roese this specified memory area will get subtracted from the top 371111ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 371214f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 371314f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 371414f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 37155e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 371614f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 37175e12e75dSStefan Roese will have to get fixed in Linux additionally. 371814f73ca6SStefan Roese 371914f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 372014f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 372114f73ca6SStefan Roese be touched. 372214f73ca6SStefan Roese 372314f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 372414f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 372514f73ca6SStefan Roese then the end address of the Linux memory will be located at a 372614f73ca6SStefan Roese non page size aligned address and this could cause major 372714f73ca6SStefan Roese problems. 372814f73ca6SStefan Roese 37296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3730c609719bSwdenk Enable temporary baudrate change while serial download 3731c609719bSwdenk 37326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3733c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3734c609719bSwdenk 37356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3736c609719bSwdenk Physical start address of Flash memory. 3737c609719bSwdenk 37386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3739c609719bSwdenk Physical start address of boot monitor code (set by 3740c609719bSwdenk make config files to be same as the text base address 374114d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 37426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3743c609719bSwdenk 37446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 37453b57fe0aSwdenk Size of memory reserved for monitor code, used to 37463b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 37473b57fe0aSwdenk embedded within the U-Boot image, or in a separate 37483b57fe0aSwdenk flash sector. 3749c609719bSwdenk 37506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3751c609719bSwdenk Size of DRAM reserved for malloc() use. 3752c609719bSwdenk 3753d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN 3754d59476b6SSimon Glass Size of the malloc() pool for use before relocation. If 3755d59476b6SSimon Glass this is defined, then a very simple malloc() implementation 3756d59476b6SSimon Glass will become available before relocation. The address is just 3757d59476b6SSimon Glass below the global data, and the stack is moved down to make 3758d59476b6SSimon Glass space. 3759d59476b6SSimon Glass 3760d59476b6SSimon Glass This feature allocates regions with increasing addresses 3761d59476b6SSimon Glass within the region. calloc() is supported, but realloc() 3762d59476b6SSimon Glass is not available. free() is supported but does nothing. 3763b445bbb4SJeremiah Mahler The memory will be freed (or in fact just forgotten) when 3764d59476b6SSimon Glass U-Boot relocates itself. 3765d59476b6SSimon Glass 376638687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE 376738687ae6SSimon Glass Provides a simple and small malloc() and calloc() for those 376838687ae6SSimon Glass boards which do not use the full malloc in SPL (which is 376938687ae6SSimon Glass enabled with CONFIG_SYS_SPL_MALLOC_START). 377038687ae6SSimon Glass 37711dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY: 37721dfdd9baSThierry Reding Size of non-cached memory area. This area of memory will be 37731dfdd9baSThierry Reding typically located right below the malloc() area and mapped 37741dfdd9baSThierry Reding uncached in the MMU. This is useful for drivers that would 37751dfdd9baSThierry Reding otherwise require a lot of explicit cache maintenance. For 37761dfdd9baSThierry Reding some drivers it's also impossible to properly maintain the 37771dfdd9baSThierry Reding cache. For example if the regions that need to be flushed 37781dfdd9baSThierry Reding are not a multiple of the cache-line size, *and* padding 37791dfdd9baSThierry Reding cannot be allocated between the regions to align them (i.e. 37801dfdd9baSThierry Reding if the HW requires a contiguous array of regions, and the 37811dfdd9baSThierry Reding size of each region is not cache-aligned), then a flush of 37821dfdd9baSThierry Reding one region may result in overwriting data that hardware has 37831dfdd9baSThierry Reding written to another region in the same cache-line. This can 37841dfdd9baSThierry Reding happen for example in network drivers where descriptors for 37851dfdd9baSThierry Reding buffers are typically smaller than the CPU cache-line (e.g. 37861dfdd9baSThierry Reding 16 bytes vs. 32 or 64 bytes). 37871dfdd9baSThierry Reding 37881dfdd9baSThierry Reding Non-cached memory is only supported on 32-bit ARM at present. 37891dfdd9baSThierry Reding 37906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 379115940c9aSStefan Roese Normally compressed uImages are limited to an 379215940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 37936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 379415940c9aSStefan Roese to adjust this setting to your needs. 3795c609719bSwdenk 37966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3797c609719bSwdenk Maximum size of memory mapped by the startup code of 3798c609719bSwdenk the Linux kernel; all data that must be processed by 37997d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 38007d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 38011bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 38027d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3803c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3804c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3805c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3806c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3807c609719bSwdenk 3808fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3809fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3810fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3811fca43cc8SJohn Rigby is enabled. 3812fca43cc8SJohn Rigby 3813fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3814fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3815fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3816fca43cc8SJohn Rigby 3817fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3818fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3819fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3820fca43cc8SJohn Rigby 38216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3822c609719bSwdenk Max number of Flash memory banks 3823c609719bSwdenk 38246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3825c609719bSwdenk Max number of sectors on a Flash chip 3826c609719bSwdenk 38276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3828c609719bSwdenk Timeout for Flash erase operations (in ms) 3829c609719bSwdenk 38306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3831c609719bSwdenk Timeout for Flash write operations (in ms) 3832c609719bSwdenk 38336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 38348564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 38358564acf9Swdenk 38366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 38378564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 38388564acf9Swdenk 38396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 38408564acf9Swdenk If defined, hardware flash sectors protection is used 38418564acf9Swdenk instead of U-Boot software protection. 38428564acf9Swdenk 38436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3844c609719bSwdenk 3845c609719bSwdenk Enable TFTP transfers directly to flash memory; 3846c609719bSwdenk without this option such a download has to be 3847c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3848c609719bSwdenk copy from RAM to flash. 3849c609719bSwdenk 3850c609719bSwdenk The two-step approach is usually more reliable, since 3851c609719bSwdenk you can check if the download worked before you erase 385211ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 385311ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3854c609719bSwdenk downloaded image) this option may be very useful. 3855c609719bSwdenk 38566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3857c609719bSwdenk Define if the flash driver uses extra elements in the 38585653fc33Swdenk common flash structure for storing flash geometry. 38595653fc33Swdenk 386000b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 38615653fc33Swdenk This option also enables the building of the cfi_flash driver 38625653fc33Swdenk in the drivers directory 386353cf9435Sstroese 386491809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 386591809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 386691809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 386791809ed5SPiotr Ziecik to the MTD layer. 386891809ed5SPiotr Ziecik 38696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 387096ef831fSGuennadi Liakhovetski Use buffered writes to flash. 387196ef831fSGuennadi Liakhovetski 387296ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 387396ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 387496ef831fSGuennadi Liakhovetski write commands. 387596ef831fSGuennadi Liakhovetski 38766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 38775568e613SStefan Roese If this option is defined, the common CFI flash doesn't 38785568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 38795568e613SStefan Roese is useful, if some of the configured banks are only 38805568e613SStefan Roese optionally available. 38815568e613SStefan Roese 38829a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 38839a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 38849a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 38859a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 38869a042e9cSJerry Van Baren 3887352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3888352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3889352ef3f1SStefan Roese against the source after the write operation. An error message 3890352ef3f1SStefan Roese will be printed when the contents are not identical. 3891352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3892352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3893352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3894352ef3f1SStefan Roese this option if you really know what you are doing. 3895352ef3f1SStefan Roese 38966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 389711ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 389811ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 389953cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 390053cf9435Sstroese buffers can be full shortly after enabling the interface 390111ccc33fSMarcel Ziswiler on high Ethernet traffic. 390253cf9435Sstroese Defaults to 4 if not defined. 3903c609719bSwdenk 3904ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3905ea882bafSWolfgang Denk 3906ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3907ea882bafSWolfgang Denk internally to store the environment settings. The default 3908ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3909ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3910ea882bafSWolfgang Denk lib/hashtable.c for details. 3911ea882bafSWolfgang Denk 39122598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 39132598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 39141bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 39152598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 39162598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 39172598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 39182598090bSJoe Hershberger 39192598090bSJoe Hershberger The format of the list is: 39202598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3921b445bbb4SJeremiah Mahler access_attribute = [a|r|o|c] 3922b445bbb4SJeremiah Mahler attributes = type_attribute[access_attribute] 39232598090bSJoe Hershberger entry = variable_name[:attributes] 39242598090bSJoe Hershberger list = entry[,list] 39252598090bSJoe Hershberger 39262598090bSJoe Hershberger The type attributes are: 39272598090bSJoe Hershberger s - String (default) 39282598090bSJoe Hershberger d - Decimal 39292598090bSJoe Hershberger x - Hexadecimal 39302598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 39312598090bSJoe Hershberger i - IP address 39322598090bSJoe Hershberger m - MAC address 39332598090bSJoe Hershberger 3934267541f7SJoe Hershberger The access attributes are: 3935267541f7SJoe Hershberger a - Any (default) 3936267541f7SJoe Hershberger r - Read-only 3937267541f7SJoe Hershberger o - Write-once 3938267541f7SJoe Hershberger c - Change-default 3939267541f7SJoe Hershberger 39402598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 39412598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 3942b445bbb4SJeremiah Mahler environment variable in the default or embedded environment. 39432598090bSJoe Hershberger 39442598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 39452598090bSJoe Hershberger Define this to a list (string) to define validation that 39462598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 39472598090bSJoe Hershberger environment variable. To override a setting in the static 39482598090bSJoe Hershberger list, simply add an entry for the same variable name to the 39492598090bSJoe Hershberger ".flags" variable. 39502598090bSJoe Hershberger 3951bdf1fe4eSJoe Hershberger If CONFIG_REGEX is defined, the variable_name above is evaluated as a 3952bdf1fe4eSJoe Hershberger regular expression. This allows multiple variables to define the same 3953bdf1fe4eSJoe Hershberger flags without explicitly listing them for each variable. 3954bdf1fe4eSJoe Hershberger 3955267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3956267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3957267541f7SJoe Hershberger access flags. 3958267541f7SJoe Hershberger 39590b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 39600b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 39610b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 3962b445bbb4SJeremiah Mahler the value can be calculated on a given board. 3963632efa74SSimon Glass 39640d296cc2SGabe Black- CONFIG_USE_STDINT 39650d296cc2SGabe Black If stdint.h is available with your toolchain you can define this 39660d296cc2SGabe Black option to enable it. You can provide option 'USE_STDINT=1' when 39670d296cc2SGabe Black building U-Boot to enable this. 39680d296cc2SGabe Black 3969c609719bSwdenkThe following definitions that deal with the placement and management 3970c609719bSwdenkof environment data (variable area); in general, we support the 3971c609719bSwdenkfollowing configurations: 3972c609719bSwdenk 3973c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3974c3eb3fe4SMike Frysinger 3975c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3976c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3977c3eb3fe4SMike Frysinger 39785a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3979c609719bSwdenk 3980c609719bSwdenk Define this if the environment is in flash memory. 3981c609719bSwdenk 3982c609719bSwdenk a) The environment occupies one whole flash sector, which is 3983c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3984c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3985c609719bSwdenk sector" type flash chips, which have several smaller 3986c609719bSwdenk sectors at the start or the end. For instance, such a 3987c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3988c609719bSwdenk such a case you would place the environment in one of the 3989c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3990c609719bSwdenk "top boot sector" type flash chips, you would put the 3991c609719bSwdenk environment in one of the last sectors, leaving a gap 3992c609719bSwdenk between U-Boot and the environment. 3993c609719bSwdenk 39940e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3995c609719bSwdenk 3996c609719bSwdenk Offset of environment data (variable area) to the 3997c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3998c609719bSwdenk type flash chips the second sector can be used: the offset 3999c609719bSwdenk for this sector is given here. 4000c609719bSwdenk 40016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 4002c609719bSwdenk 40030e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 4004c609719bSwdenk 4005c609719bSwdenk This is just another way to specify the start address of 4006c609719bSwdenk the flash sector containing the environment (instead of 40070e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 4008c609719bSwdenk 40090e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 4010c609719bSwdenk 4011c609719bSwdenk Size of the sector containing the environment. 4012c609719bSwdenk 4013c609719bSwdenk 4014c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 4015c609719bSwdenk In such a case you don't want to spend a whole sector for 4016c609719bSwdenk the environment. 4017c609719bSwdenk 40180e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 4019c609719bSwdenk 40205a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 40210e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 4022c609719bSwdenk of this flash sector for the environment. This saves 4023c609719bSwdenk memory for the RAM copy of the environment. 4024c609719bSwdenk 4025c609719bSwdenk It may also save flash memory if you decide to use this 4026c609719bSwdenk when your environment is "embedded" within U-Boot code, 4027c609719bSwdenk since then the remainder of the flash sector could be used 4028c609719bSwdenk for U-Boot code. It should be pointed out that this is 4029c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 4030c609719bSwdenk updating the environment in flash makes it always 4031c609719bSwdenk necessary to erase the WHOLE sector. If something goes 4032c609719bSwdenk wrong before the contents has been restored from a copy in 4033c609719bSwdenk RAM, your target system will be dead. 4034c609719bSwdenk 40350e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 40360e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 4037c609719bSwdenk 4038c609719bSwdenk These settings describe a second storage area used to hold 403911ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 40403e38691eSwdenk a valid backup copy in case there is a power failure during 4041c609719bSwdenk a "saveenv" operation. 4042c609719bSwdenk 4043c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 4044c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 4045c609719bSwdenkaccordingly! 4046c609719bSwdenk 4047c609719bSwdenk 40489314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 4049c609719bSwdenk 4050c609719bSwdenk Define this if you have some non-volatile memory device 4051c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 4052c609719bSwdenk environment. 4053c609719bSwdenk 40540e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 40550e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 4056c609719bSwdenk 405711ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 4058c609719bSwdenk want to use for environment. It is assumed that this memory 4059c609719bSwdenk can just be read and written to, without any special 4060c609719bSwdenk provision. 4061c609719bSwdenk 4062c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 4063b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the 406411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 4065c609719bSwdenkU-Boot will hang. 4066c609719bSwdenk 4067c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 4068c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 4069c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 4070c609719bSwdenkto save the current settings. 4071c609719bSwdenk 4072c609719bSwdenk 4073bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 4074c609719bSwdenk 4075c609719bSwdenk Use this if you have an EEPROM or similar serial access 4076c609719bSwdenk device and a driver for it. 4077c609719bSwdenk 40780e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 40790e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 4080c609719bSwdenk 4081c609719bSwdenk These two #defines specify the offset and size of the 4082c609719bSwdenk environment area within the total memory of your EEPROM. 4083c609719bSwdenk 40846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 4085c609719bSwdenk If defined, specified the chip address of the EEPROM device. 4086c609719bSwdenk The default address is zero. 4087c609719bSwdenk 4088189d257bSChristian Gmeiner - CONFIG_SYS_I2C_EEPROM_BUS: 4089189d257bSChristian Gmeiner If defined, specified the i2c bus of the EEPROM device. 4090189d257bSChristian Gmeiner 40916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 4092c609719bSwdenk If defined, the number of bits used to address bytes in a 4093c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 4094c609719bSwdenk would require six bits. 4095c609719bSwdenk 40966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 4097c609719bSwdenk If defined, the number of milliseconds to delay between 4098c609719bSwdenk page writes. The default is zero milliseconds. 4099c609719bSwdenk 41006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 4101c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 4102c609719bSwdenk that this is NOT the chip address length! 4103c609719bSwdenk 41046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 41055cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 41065cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 41075cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 41085cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 41095cf91d6bSwdenk byte chips. 41105cf91d6bSwdenk 41115cf91d6bSwdenk Note that we consider the length of the address field to 41125cf91d6bSwdenk still be one byte because the extra address bits are hidden 41135cf91d6bSwdenk in the chip address. 41145cf91d6bSwdenk 41156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 4116c609719bSwdenk The size in bytes of the EEPROM device. 4117c609719bSwdenk 4118548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 4119548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 4120548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 4121548738b4SHeiko Schocher 4122548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 4123548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 4124548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 4125548738b4SHeiko Schocher EEPROM. For example: 4126548738b4SHeiko Schocher 4127ea818dbbSHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS 1 4128548738b4SHeiko Schocher 4129548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 4130548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 4131c609719bSwdenk 4132057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 41335779d8d9Swdenk 41345779d8d9Swdenk Define this if you have a DataFlash memory device which you 41355779d8d9Swdenk want to use for the environment. 41365779d8d9Swdenk 41370e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 41380e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 41390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 41405779d8d9Swdenk 41415779d8d9Swdenk These three #defines specify the offset and size of the 41425779d8d9Swdenk environment area within the total memory of your DataFlash placed 41435779d8d9Swdenk at the specified address. 41445779d8d9Swdenk 4145bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH: 4146bd83b592SWu, Josh 4147bd83b592SWu, Josh Define this if you have a SPI Flash memory device which you 4148bd83b592SWu, Josh want to use for the environment. 4149bd83b592SWu, Josh 4150bd83b592SWu, Josh - CONFIG_ENV_OFFSET: 4151bd83b592SWu, Josh - CONFIG_ENV_SIZE: 4152bd83b592SWu, Josh 4153bd83b592SWu, Josh These two #defines specify the offset and size of the 4154bd83b592SWu, Josh environment area within the SPI Flash. CONFIG_ENV_OFFSET must be 4155bd83b592SWu, Josh aligned to an erase sector boundary. 4156bd83b592SWu, Josh 4157bd83b592SWu, Josh - CONFIG_ENV_SECT_SIZE: 4158bd83b592SWu, Josh 4159bd83b592SWu, Josh Define the SPI flash's sector size. 4160bd83b592SWu, Josh 4161bd83b592SWu, Josh - CONFIG_ENV_OFFSET_REDUND (optional): 4162bd83b592SWu, Josh 4163bd83b592SWu, Josh This setting describes a second storage area of CONFIG_ENV_SIZE 4164bd83b592SWu, Josh size used to hold a redundant copy of the environment data, so 4165bd83b592SWu, Josh that there is a valid backup copy in case there is a power failure 4166*9dd05fb8SSimon Glass during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be 4167bd83b592SWu, Josh aligned to an erase sector boundary. 4168bd83b592SWu, Josh 4169bd83b592SWu, Josh - CONFIG_ENV_SPI_BUS (optional): 4170bd83b592SWu, Josh - CONFIG_ENV_SPI_CS (optional): 4171bd83b592SWu, Josh 4172bd83b592SWu, Josh Define the SPI bus and chip select. If not defined they will be 0. 4173bd83b592SWu, Josh 4174bd83b592SWu, Josh - CONFIG_ENV_SPI_MAX_HZ (optional): 4175bd83b592SWu, Josh 4176bd83b592SWu, Josh Define the SPI max work clock. If not defined then use 1MHz. 4177bd83b592SWu, Josh 4178bd83b592SWu, Josh - CONFIG_ENV_SPI_MODE (optional): 4179bd83b592SWu, Josh 4180bd83b592SWu, Josh Define the SPI work mode. If not defined then use SPI_MODE_3. 4181bd83b592SWu, Josh 41820a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 41830a85a9e7SLiu Gang 41840a85a9e7SLiu Gang Define this if you have a remote memory space which you 41850a85a9e7SLiu Gang want to use for the local device's environment. 41860a85a9e7SLiu Gang 41870a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 41880a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 41890a85a9e7SLiu Gang 41900a85a9e7SLiu Gang These two #defines specify the address and size of the 41910a85a9e7SLiu Gang environment area within the remote memory space. The 41920a85a9e7SLiu Gang local device can get the environment from remote memory 4193fc54c7faSLiu Gang space by SRIO or PCIE links. 41940a85a9e7SLiu Gang 41950a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 41960a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 4197fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 4198fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 41990a85a9e7SLiu Gang 420051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 420113a5695bSwdenk 420213a5695bSwdenk Define this if you have a NAND device which you want to use 420313a5695bSwdenk for the environment. 420413a5695bSwdenk 42050e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 42060e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 420713a5695bSwdenk 420813a5695bSwdenk These two #defines specify the offset and size of the environment 4209fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 4210fdd813deSScott Wood aligned to an erase block boundary. 42115779d8d9Swdenk 4212fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 4213e443c944SMarkus Klotzbuecher 42140e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 4215fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 4216fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 4217*9dd05fb8SSimon Glass during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be 4218fdd813deSScott Wood aligned to an erase block boundary. 4219e443c944SMarkus Klotzbuecher 4220fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 4221fdd813deSScott Wood 4222fdd813deSScott Wood Specifies the length of the region in which the environment 4223fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 4224fdd813deSScott Wood block size. Specifying a range with more erase blocks than 4225fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 4226fdd813deSScott Wood the range to be avoided. 4227fdd813deSScott Wood 4228fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 4229fdd813deSScott Wood 4230fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 4231fdd813deSScott Wood environment from block zero's out-of-band data. The 4232fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 4233fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 4234fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 4235e443c944SMarkus Klotzbuecher 4236b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 4237b74ab737SGuennadi Liakhovetski 4238b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 4239b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 4240b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 4241b74ab737SGuennadi Liakhovetski 42422b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 42432b74433fSJoe Hershberger 42442b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 42452b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 42462b74433fSJoe Hershberger accesses, which is important on NAND. 42472b74433fSJoe Hershberger 42482b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 42492b74433fSJoe Hershberger 42502b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 42512b74433fSJoe Hershberger 42522b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 42532b74433fSJoe Hershberger 42542b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 42552b74433fSJoe Hershberger environment in. 42562b74433fSJoe Hershberger 4257785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 4258785881f7SJoe Hershberger 4259785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 4260785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 4261785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 4262785881f7SJoe Hershberger 42632b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 42642b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 42652b74433fSJoe Hershberger 42662b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 42672b74433fSJoe Hershberger when storing the env in UBI. 42682b74433fSJoe Hershberger 4269d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT: 4270d1db76f1SWu, Josh Define this if you want to use the FAT file system for the environment. 4271d1db76f1SWu, Josh 4272d1db76f1SWu, Josh - FAT_ENV_INTERFACE: 4273d1db76f1SWu, Josh 4274d1db76f1SWu, Josh Define this to a string that is the name of the block device. 4275d1db76f1SWu, Josh 4276d1db76f1SWu, Josh - FAT_ENV_DEV_AND_PART: 4277d1db76f1SWu, Josh 4278d1db76f1SWu, Josh Define this to a string to specify the partition of the device. It can 4279d1db76f1SWu, Josh be as following: 4280d1db76f1SWu, Josh 4281d1db76f1SWu, Josh "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1) 4282d1db76f1SWu, Josh - "D:P": device D partition P. Error occurs if device D has no 4283d1db76f1SWu, Josh partition table. 4284d1db76f1SWu, Josh - "D:0": device D. 4285d1db76f1SWu, Josh - "D" or "D:": device D partition 1 if device D has partition 4286d1db76f1SWu, Josh table, or the whole device D if has no partition 4287d1db76f1SWu, Josh table. 4288d1db76f1SWu, Josh - "D:auto": first partition in device D with bootable flag set. 4289b445bbb4SJeremiah Mahler If none, first valid partition in device D. If no 4290d1db76f1SWu, Josh partition table then means device D. 4291d1db76f1SWu, Josh 4292d1db76f1SWu, Josh - FAT_ENV_FILE: 4293d1db76f1SWu, Josh 4294d1db76f1SWu, Josh It's a string of the FAT file name. This file use to store the 4295b445bbb4SJeremiah Mahler environment. 4296d1db76f1SWu, Josh 4297d1db76f1SWu, Josh - CONFIG_FAT_WRITE: 4298b445bbb4SJeremiah Mahler This should be defined. Otherwise it cannot save the environment file. 4299d1db76f1SWu, Josh 430006e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 430106e4ae5fSStephen Warren 430206e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 430306e4ae5fSStephen Warren environment. 430406e4ae5fSStephen Warren 430506e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 430606e4ae5fSStephen Warren 430706e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 430806e4ae5fSStephen Warren 430906e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 431006e4ae5fSStephen Warren 431106e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 431206e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 431306e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 431406e4ae5fSStephen Warren 431506e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 431606e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 431706e4ae5fSStephen Warren 431806e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 431906e4ae5fSStephen Warren area within the specified MMC device. 432006e4ae5fSStephen Warren 43215c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 43225c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 43235c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 43245c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 43255c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 43265c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 43275c088ee8SStephen Warren maximum possible space before it, to store other data. 43285c088ee8SStephen Warren 432906e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 433006e4ae5fSStephen Warren MMC sector boundary. 433106e4ae5fSStephen Warren 433206e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 433306e4ae5fSStephen Warren 433406e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 433506e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 433606e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 433706e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 433806e4ae5fSStephen Warren 43395c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 43405c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 43415c088ee8SStephen Warren 434206e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 434306e4ae5fSStephen Warren an MMC sector boundary. 434406e4ae5fSStephen Warren 434506e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 434606e4ae5fSStephen Warren 434706e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 434806e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 434906e4ae5fSStephen Warren CONFIG_ENV_SIZE. 435006e4ae5fSStephen Warren 43516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 4352c609719bSwdenk 4353c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 4354c609719bSwdenk area is used at an early stage (ROM part) if the environment 4355c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 4356c609719bSwdenk scratch DPRAM area. It is used between the two initialization 4357c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4358c609719bSwdenk to be a good choice since it makes it far enough from the 4359c609719bSwdenk start of the data area as well as from the stack pointer. 4360c609719bSwdenk 4361e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 4362c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 4363cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 4364c609719bSwdenkuntil then to read environment variables. 4365c609719bSwdenk 436685ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 436785ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 436885ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 436985ec0bccSwdenknecessary, because the first environment variable we need is the 437085ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 437185ec0bccSwdenkhave any device yet where we could complain.] 4372c609719bSwdenk 4373c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 4374c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 437585ec0bccSwdenkuse the "saveenv" command to store a valid environment. 4376c609719bSwdenk 43776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4378fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 4379fc3e2165Swdenk 43806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4381fc3e2165Swdenk also needs to be defined. 4382fc3e2165Swdenk 43836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 4384fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 4385c609719bSwdenk 4386f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 4387f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 4388f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 4389f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 4390f5675aa5SRon Madrid space for already greatly restricted images, including but not 4391f5675aa5SRon Madrid limited to NAND_SPL configurations. 4392f5675aa5SRon Madrid 4393b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 4394b2b92f53SSimon Glass Display information about the board that U-Boot is running on 4395b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 4396b2b92f53SSimon Glass to do this. 4397b2b92f53SSimon Glass 4398e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 4399e2e3e2b1SSimon Glass Similar to the previous option, but display this information 4400e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 4401e2e3e2b1SSimon Glass present. 4402e2e3e2b1SSimon Glass 4403feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT: 4404feb85801SSascha Silbe Maximum size of the U-Boot image. When defined, the 4405feb85801SSascha Silbe build system checks that the actual size does not 4406feb85801SSascha Silbe exceed it. 4407feb85801SSascha Silbe 4408c609719bSwdenkLow Level (hardware related) configuration options: 4409dc7c9a1aSwdenk--------------------------------------------------- 4410c609719bSwdenk 44116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 4412c609719bSwdenk Cache Line Size of the CPU. 4413c609719bSwdenk 44146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 4415c609719bSwdenk Default address of the IMMR after system reset. 44162535d602Swdenk 44172535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 44182535d602Swdenk and RPXsuper) to be able to adjust the position of 44192535d602Swdenk the IMMR register after a reset. 4420c609719bSwdenk 4421e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 4422e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 4423e46fedfeSTimur Tabi PowerPC SOCs. 4424e46fedfeSTimur Tabi 4425e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 4426e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 4427e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4428e46fedfeSTimur Tabi 4429e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4430e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 4431e46fedfeSTimur Tabi 4432e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 4433e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 4434e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 4435e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 4436e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4437e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 4438e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 4439e46fedfeSTimur Tabi 4440e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4441e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4442e46fedfeSTimur Tabi 4443e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4444e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4445e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 4446e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4447e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4448e46fedfeSTimur Tabi 4449e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4450e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4451e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4452e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4453e46fedfeSTimur Tabi 4454e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4455e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4456e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 4457e46fedfeSTimur Tabi 44587f6c2cbcSwdenk- Floppy Disk Support: 44596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 44607f6c2cbcSwdenk 44617f6c2cbcSwdenk the default drive number (default value 0) 44627f6c2cbcSwdenk 44636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 44647f6c2cbcSwdenk 446511ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 44667f6c2cbcSwdenk (default value 1) 44677f6c2cbcSwdenk 44686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 44697f6c2cbcSwdenk 44707f6c2cbcSwdenk defines the offset of register from address. It 44717f6c2cbcSwdenk depends on which part of the data bus is connected to 447211ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 44737f6c2cbcSwdenk 44746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 44756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 44767f6c2cbcSwdenk default value. 44777f6c2cbcSwdenk 44786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 44797f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 44807f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 4481b445bbb4SJeremiah Mahler source code. It is used to make hardware-dependent 44827f6c2cbcSwdenk initializations. 44837f6c2cbcSwdenk 44840abddf82SMacpaul Lin- CONFIG_IDE_AHB: 44850abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 44860abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 44870abddf82SMacpaul Lin When software is doing ATA command and data transfer to 44880abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 44890abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 4490b445bbb4SJeremiah Mahler is required. 44910abddf82SMacpaul Lin 44926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 449325d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 449425d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 4495c609719bSwdenk 44966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 4497c609719bSwdenk 44987152b1d0Swdenk Start address of memory area that can be used for 4499c609719bSwdenk initial data and stack; please note that this must be 4500c609719bSwdenk writable memory that is working WITHOUT special 4501c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 4502c609719bSwdenk will become available only after programming the 4503c609719bSwdenk memory controller and running certain initialization 4504c609719bSwdenk sequences. 4505c609719bSwdenk 4506c609719bSwdenk U-Boot uses the following memory types: 4507c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4508c609719bSwdenk - MPC824X: data cache 4509c609719bSwdenk - PPC4xx: data cache 4510c609719bSwdenk 45116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 4512c609719bSwdenk 4513c609719bSwdenk Offset of the initial data structure in the memory 45146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 45156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4516c609719bSwdenk data is located at the end of the available space 4517553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 45186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 45196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 45206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 4521c609719bSwdenk 4522c609719bSwdenk Note: 4523c609719bSwdenk On the MPC824X (or other systems that use the data 4524c609719bSwdenk cache for initial memory) the address chosen for 45256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4526c609719bSwdenk point to an otherwise UNUSED address space between 4527c609719bSwdenk the top of RAM and the start of the PCI space. 4528c609719bSwdenk 45296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4530c609719bSwdenk 45316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4532c609719bSwdenk 45336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4534c609719bSwdenk 45356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4536c609719bSwdenk 45376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4538c609719bSwdenk 45396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4540c609719bSwdenk 45416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 4542c609719bSwdenk SDRAM timing 4543c609719bSwdenk 45446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 4545c609719bSwdenk periodic timer for refresh 4546c609719bSwdenk 45476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 4548c609719bSwdenk 45496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 45506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 45516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 45526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 4553c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4554c609719bSwdenk 4555c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 45566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 45576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4558c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4559c609719bSwdenk 45606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 45616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4562c609719bSwdenk Machine Mode Register and Memory Periodic Timer 4563c609719bSwdenk Prescaler definitions (SDRAM timing) 4564c609719bSwdenk 45656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4566c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 4567c609719bSwdenk define relocation offset in DPRAM [DSP2] 4568c609719bSwdenk 45696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4570b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 4571b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 4572b423d055SHeiko Schocher 45736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4574c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 4575c609719bSwdenk define relocation offset in DPRAM [SCC4] 4576c609719bSwdenk 45776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 4578c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 4579c609719bSwdenk wrong setting might damage your board. Read 4580c609719bSwdenk doc/README.MBX before setting this variable! 4581c609719bSwdenk 45826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4583ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 4584ea909b76Swdenk (Power On Self Tests). This definition overrides 4585ea909b76Swdenk #define'd default value in commproc.h resp. 4586ea909b76Swdenk cpm_8260.h. 4587ea909b76Swdenk 45886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 45896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 45906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 45916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 45926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 45936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 45946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 45956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4596a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 45975d232d0eSwdenk 45989cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 45999cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 46009cacf4fcSDirk Eibach required. 46019cacf4fcSDirk Eibach 460269fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 4603b445bbb4SJeremiah Mahler Only scan through and get the devices on the buses. 460469fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 460569fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 460669fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 460769fd2d3bSAndrew Sharp by coreboot or similar. 460869fd2d3bSAndrew Sharp 4609842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 4610842033e6SGabor Juhos Enable support for indirect PCI bridges. 4611842033e6SGabor Juhos 4612a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 4613a09b9b68SKumar Gala Chip has SRIO or not 4614a09b9b68SKumar Gala 4615a09b9b68SKumar Gala- CONFIG_SRIO1: 4616a09b9b68SKumar Gala Board has SRIO 1 port available 4617a09b9b68SKumar Gala 4618a09b9b68SKumar Gala- CONFIG_SRIO2: 4619a09b9b68SKumar Gala Board has SRIO 2 port available 4620a09b9b68SKumar Gala 4621c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 4622c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 4623c8b28152SLiu Gang 4624a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 4625a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 4626a09b9b68SKumar Gala 4627a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 4628a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 4629a09b9b68SKumar Gala 4630a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 4631a09b9b68SKumar Gala Size of SRIO port 'n' memory region 4632a09b9b68SKumar Gala 463366bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 463466bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 463566bd1846SFabio Estevam a 16 bit bus. 463666bd1846SFabio Estevam Not all NAND drivers use this symbol. 4637a430e916SFabio Estevam Example of drivers that use it: 463866bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 4639a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 4640eced4626SAlex Waterman 4641eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 4642eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 4643eced4626SAlex Waterman a default value will be used. 4644eced4626SAlex Waterman 4645bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 4646218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 4647218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 4648218ca724SWolfgang Denk 4649bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 4650bb99ad6dSBen Warren I2C address of the SPD EEPROM 4651bb99ad6dSBen Warren 46526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4653218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4654218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4655218ca724SWolfgang Denk to something your driver can deal with. 4656bb99ad6dSBen Warren 46571b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 46581b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 46591b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 46601b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 46611b3e3c4fSYork Sun header files or board specific files. 46621b3e3c4fSYork Sun 46636f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 46646f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 46656f5e1dc5SYork Sun 4666e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH 4667e32d59a2SYork Sun Enable sync of refresh for multiple controllers. 4668e32d59a2SYork Sun 46694516ff81SYork Sun- CONFIG_FSL_DDR_BIST 46704516ff81SYork Sun Enable built-in memory test for Freescale DDR controllers. 46714516ff81SYork Sun 46726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4673218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4674218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 46752ad6b513STimur Tabi 4676c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4677c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4678c26e454dSwdenk 4679c26e454dSwdenk- CONFIG_FEC[12]_PHY 4680c26e454dSwdenk Define to the hardcoded PHY address which corresponds 46816e592385Swdenk to the given FEC; i. e. 4682c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4683c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4684c26e454dSwdenk 4685c26e454dSwdenk When set to -1, means to probe for first available. 4686c26e454dSwdenk 4687c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4688c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4689c26e454dSwdenk (so program the FEC to ignore it). 4690c26e454dSwdenk 4691c26e454dSwdenk- CONFIG_RMII 4692c26e454dSwdenk Enable RMII mode for all FECs. 4693c26e454dSwdenk Note that this is a global option, we can't 4694c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4695c26e454dSwdenk 46965cf91d6bSwdenk- CONFIG_CRC32_VERIFY 46975cf91d6bSwdenk Add a verify option to the crc32 command. 46985cf91d6bSwdenk The syntax is: 46995cf91d6bSwdenk 47005cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 47015cf91d6bSwdenk 47025cf91d6bSwdenk Where address/count indicate a memory area 47035cf91d6bSwdenk and crc32 is the correct crc32 which the 47045cf91d6bSwdenk area should have. 47055cf91d6bSwdenk 470656523f12Swdenk- CONFIG_LOOPW 470756523f12Swdenk Add the "loopw" memory command. This only takes effect if 4708602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 470956523f12Swdenk 47107b466641Sstroese- CONFIG_MX_CYCLIC 47117b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 47127b466641Sstroese "md/mw" commands. 47137b466641Sstroese Examples: 47147b466641Sstroese 47157b466641Sstroese => mdc.b 10 4 500 47167b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 47177b466641Sstroese 47187b466641Sstroese => mwc.l 100 12345678 10 47197b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 47207b466641Sstroese 47217b466641Sstroese This only takes effect if the memory commands are activated 4722602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 47237b466641Sstroese 47248aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4725afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4726e03f3169SWolfgang Denk low level initializations (like setting up the memory 4727e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4728e03f3169SWolfgang Denk relocate itself into RAM. 47298aa1a2d1Swdenk 4730e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4731e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4732e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4733e03f3169SWolfgang Denk these initializations itself. 47348aa1a2d1Swdenk 4735b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY 4736b5bd0982SSimon Glass [ARM926EJ-S only] This allows just the call to lowlevel_init() 473790211f77Syeongjun Kim to be skipped. The normal CP15 init (such as enabling the 4738b5bd0982SSimon Glass instruction cache) is still performed. 4739b5bd0982SSimon Glass 4740401bb30bSAneesh V- CONFIG_SPL_BUILD 4741df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4742df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4743df81238bSMagnus Lilja compiling a NAND SPL. 4744400558b5Swdenk 47453aa29de0SYing Zhang- CONFIG_TPL_BUILD 47463aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 47473aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 47483aa29de0SYing Zhang It is loaded by the SPL. 47493aa29de0SYing Zhang 47505df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 47515df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 47525df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 47535df572f0SYing Zhang previous 4k of the .text section. 47545df572f0SYing Zhang 47554213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 47564213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 47574213fc29SSimon Glass effective address. It is therefore not necessary to regard 47584213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 47594213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 47604213fc29SSimon Glass it maintains its own little RAM buffer which contains all 47614213fc29SSimon Glass addressable memory. This option causes some memory accesses 47624213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 47634213fc29SSimon Glass 4764d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 4765d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 4766d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 4767d8834a13SMatthias Weisser be used if available. These functions may be faster under some 4768d8834a13SMatthias Weisser conditions but may increase the binary size. 4769d8834a13SMatthias Weisser 4770588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4771588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4772588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4773b16f521aSGabe Black 4774fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4775fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4776fc33705eSMark Jackson 4777fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 47785b5ece9eSGabe Black 477916678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 478016678eb4SHeiko Schocher Enables the RTC32K OSC on AM33xx based plattforms 478116678eb4SHeiko Schocher 4782999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 4783999d7d32SKaricheri, Muralidharan Option to disable subpage write in NAND driver 4784999d7d32SKaricheri, Muralidharan driver that uses this: 4785999d7d32SKaricheri, Muralidharan drivers/mtd/nand/davinci_nand.c 4786999d7d32SKaricheri, Muralidharan 4787f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4788f2717b47STimur Tabi----------------------------------- 4789f2717b47STimur Tabi 4790f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4791f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4792f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4793f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4794f2717b47STimur Tabiwithin that device. 4795f2717b47STimur Tabi 4796dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR 4797dcf1d774SZhao Qiang The address in the storage device where the FMAN microcode is located. The 4798dcf1d774SZhao Qiang meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4799dcf1d774SZhao Qiang is also specified. 4800dcf1d774SZhao Qiang 4801dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR 4802dcf1d774SZhao Qiang The address in the storage device where the QE microcode is located. The 4803f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4804f2717b47STimur Tabi is also specified. 4805f2717b47STimur Tabi 4806f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4807f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4808f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4809f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4810f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4811f2717b47STimur Tabi 4812f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4813f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4814f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4815f2717b47STimur Tabi virtual address in NOR flash. 4816f2717b47STimur Tabi 4817f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4818f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4819f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4820f2717b47STimur Tabi 4821f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4822f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4823f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4824f2717b47STimur Tabi 4825f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4826f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 4827f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4828f2717b47STimur Tabi 4829292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4830292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4831292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4832fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4833fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4834fc54c7faSLiu Gang master's memory space. 4835f2717b47STimur Tabi 4836b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support: 4837b940ca64SJ. German Rivera--------------------------------------------------------- 4838b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of 4839b940ca64SJ. German Rivera"firmware". 4840b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros 4841b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address 4842b940ca64SJ. German Riverawithin that device. 4843b940ca64SJ. German Rivera 4844b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET 4845b940ca64SJ. German Rivera Enable the MC driver for Layerscape SoCs. 4846b940ca64SJ. German Rivera 4847b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR 4848b940ca64SJ. German Rivera The address in the storage device where the firmware is located. The 4849b940ca64SJ. German Rivera meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro 4850b940ca64SJ. German Rivera is also specified. 4851b940ca64SJ. German Rivera 4852b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH 4853b940ca64SJ. German Rivera The maximum possible size of the firmware. The firmware binary format 4854b940ca64SJ. German Rivera has a field that specifies the actual size of the firmware, but it 4855b940ca64SJ. German Rivera might not be possible to read any part of the firmware unless some 4856b940ca64SJ. German Rivera local storage is allocated to hold the entire firmware first. 4857b940ca64SJ. German Rivera 4858b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR 4859b940ca64SJ. German Rivera Specifies that MC firmware is located in NOR flash, mapped as 4860b940ca64SJ. German Rivera normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the 4861b940ca64SJ. German Rivera virtual address in NOR flash. 4862b940ca64SJ. German Rivera 48635c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support: 48645c055089SPrabhakar Kushwaha------------------------------------------- 48655c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of 48665c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom. 48675c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting. 48685c055089SPrabhakar Kushwaha 4869c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN 4870c0492141SYork Sun Define alignment of reserved memory MC requires 48715c055089SPrabhakar Kushwaha 4872f3f431a7SPaul KocialkowskiReproducible builds 4873f3f431a7SPaul Kocialkowski------------------- 4874f3f431a7SPaul Kocialkowski 4875f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build 4876f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value. 4877f3f431a7SPaul Kocialkowski 4878f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable. 4879f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration 4880f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot. 4881f3f431a7SPaul Kocialkowski 4882f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. 4883f3f431a7SPaul Kocialkowski 4884c609719bSwdenkBuilding the Software: 4885c609719bSwdenk====================== 4886c609719bSwdenk 4887218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4888218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4889218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4890218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4891218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4892218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4893c609719bSwdenk 4894218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4895218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4896218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4897218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4898218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4899c609719bSwdenk 4900218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4901218ca724SWolfgang Denk $ export CROSS_COMPILE 4902c609719bSwdenk 49032f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 49042f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 49052f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 49062f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 49072f8d396bSPeter Tyser 49082f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 49092f8d396bSPeter Tyser 49102f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 49112f8d396bSPeter Tyser be executed on computers running Windows. 49122f8d396bSPeter Tyser 4913c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4914c609719bSwdenksources you must configure U-Boot for one specific board type. This 4915c609719bSwdenkis done by typing: 4916c609719bSwdenk 4917ab584d67SHolger Freyther make NAME_defconfig 4918c609719bSwdenk 4919ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu- 49204d675ae6SMichael Jonesrations; see boards.cfg for supported names. 492154387ac9Swdenk 4922c609719bSwdenkNote: for some board special configuration names may exist; check if 4923c609719bSwdenk additional information is available from the board vendor; for 49242729af9dSwdenk instance, the TQM823L systems are available without (standard) 49252729af9dSwdenk or with LCD support. You can select such additional "features" 492611ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 4927c609719bSwdenk 4928ab584d67SHolger Freyther make TQM823L_defconfig 49292729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 4930c609719bSwdenk 4931ab584d67SHolger Freyther make TQM823L_LCD_defconfig 4932c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 4933c609719bSwdenk 4934c609719bSwdenk etc. 4935c609719bSwdenk 4936c609719bSwdenk 4937c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 49387152b1d0Swdenkimages ready for download to / installation on your system: 4939c609719bSwdenk 4940c609719bSwdenk- "u-boot.bin" is a raw binary image 4941c609719bSwdenk- "u-boot" is an image in ELF binary format 4942c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 4943c609719bSwdenk 4944baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 4945baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 4946baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 4947baf31249SMarian Balakowicz 4948baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 4949baf31249SMarian Balakowicz 4950baf31249SMarian Balakowicz make O=/tmp/build distclean 4951ab584d67SHolger Freyther make O=/tmp/build NAME_defconfig 4952baf31249SMarian Balakowicz make O=/tmp/build all 4953baf31249SMarian Balakowicz 4954adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location: 4955baf31249SMarian Balakowicz 4956adbba996STimo Ketola export KBUILD_OUTPUT=/tmp/build 4957baf31249SMarian Balakowicz make distclean 4958ab584d67SHolger Freyther make NAME_defconfig 4959baf31249SMarian Balakowicz make all 4960baf31249SMarian Balakowicz 4961adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment 4962baf31249SMarian Balakowiczvariable. 4963baf31249SMarian Balakowicz 4964c609719bSwdenk 4965c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 4966c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 4967c609719bSwdenknative "make". 4968c609719bSwdenk 4969c609719bSwdenk 4970c609719bSwdenkIf the system board that you have is not listed, then you will need 4971c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 4972c609719bSwdenksteps: 4973c609719bSwdenk 49743c1496cdSPhil Sutter1. Create a new directory to hold your board specific code. Add any 497585ec0bccSwdenk files you need. In your board directory, you will need at least 49763c1496cdSPhil Sutter the "Makefile" and a "<board>.c". 49773c1496cdSPhil Sutter2. Create a new configuration file "include/configs/<board>.h" for 49783c1496cdSPhil Sutter your board. 4979c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 4980c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 4981ab584d67SHolger Freyther4. Run "make <board>_defconfig" with your new name. 4982c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 4983c609719bSwdenk to be installed on your target system. 498485ec0bccSwdenk6. Debug and solve any problems that might arise. 4985c609719bSwdenk [Of course, this last step is much harder than it sounds.] 4986c609719bSwdenk 4987c609719bSwdenk 4988c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 4989c609719bSwdenk============================================================== 4990c609719bSwdenk 4991c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 4992c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 4993c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 4994c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 4995218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 4996c609719bSwdenk 4997c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 4998c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 4999c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 50006de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will 50016de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this 50026de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H' 50036de80f21SSimon Glassfor documentation. 5004baf31249SMarian Balakowicz 5005baf31249SMarian Balakowicz 5006c609719bSwdenkSee also "U-Boot Porting Guide" below. 5007c609719bSwdenk 5008c609719bSwdenk 5009c609719bSwdenkMonitor Commands - Overview: 5010c609719bSwdenk============================ 5011c609719bSwdenk 5012c609719bSwdenkgo - start application at address 'addr' 5013c609719bSwdenkrun - run commands in an environment variable 5014c609719bSwdenkbootm - boot application image from memory 5015c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 501644f074c7SMarek Vasutbootz - boot zImage from memory 5017c609719bSwdenktftpboot- boot image via network using TFTP protocol 5018c609719bSwdenk and env variables "ipaddr" and "serverip" 5019c609719bSwdenk (and eventually "gatewayip") 50201fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 5021c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 5022c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 5023c609719bSwdenkloads - load S-Record file over serial line 5024c609719bSwdenkloadb - load binary file over serial line (kermit mode) 5025c609719bSwdenkmd - memory display 5026c609719bSwdenkmm - memory modify (auto-incrementing) 5027c609719bSwdenknm - memory modify (constant address) 5028c609719bSwdenkmw - memory write (fill) 5029c609719bSwdenkcp - memory copy 5030c609719bSwdenkcmp - memory compare 5031c609719bSwdenkcrc32 - checksum calculation 50320f89c54bSPeter Tyseri2c - I2C sub-system 5033c609719bSwdenksspi - SPI utility commands 5034c609719bSwdenkbase - print or set address offset 5035c609719bSwdenkprintenv- print environment variables 5036c609719bSwdenksetenv - set environment variables 5037c609719bSwdenksaveenv - save environment variables to persistent storage 5038c609719bSwdenkprotect - enable or disable FLASH write protection 5039c609719bSwdenkerase - erase FLASH memory 5040c609719bSwdenkflinfo - print FLASH memory information 504110635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 5042c609719bSwdenkbdinfo - print Board Info structure 5043c609719bSwdenkiminfo - print header information for application image 5044c609719bSwdenkconinfo - print console devices and informations 5045c609719bSwdenkide - IDE sub-system 5046c609719bSwdenkloop - infinite loop on address range 504756523f12Swdenkloopw - infinite write loop on address range 5048c609719bSwdenkmtest - simple RAM test 5049c609719bSwdenkicache - enable or disable instruction cache 5050c609719bSwdenkdcache - enable or disable data cache 5051c609719bSwdenkreset - Perform RESET of the CPU 5052c609719bSwdenkecho - echo args to console 5053c609719bSwdenkversion - print monitor version 5054c609719bSwdenkhelp - print online help 5055c609719bSwdenk? - alias for 'help' 5056c609719bSwdenk 5057c609719bSwdenk 5058c609719bSwdenkMonitor Commands - Detailed Description: 5059c609719bSwdenk======================================== 5060c609719bSwdenk 5061c609719bSwdenkTODO. 5062c609719bSwdenk 5063c609719bSwdenkFor now: just type "help <command>". 5064c609719bSwdenk 5065c609719bSwdenk 5066c609719bSwdenkEnvironment Variables: 5067c609719bSwdenk====================== 5068c609719bSwdenk 5069c609719bSwdenkU-Boot supports user configuration using Environment Variables which 5070c609719bSwdenkcan be made persistent by saving to Flash memory. 5071c609719bSwdenk 5072c609719bSwdenkEnvironment Variables are set using "setenv", printed using 5073c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 5074c609719bSwdenkwithout a value can be used to delete a variable from the 5075c609719bSwdenkenvironment. As long as you don't save the environment you are 5076c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 5077c609719bSwdenkenvironment is erased by accident, a default environment is provided. 5078c609719bSwdenk 5079c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 5080c96f86eeSWolfgang Denk 5081c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 5082c609719bSwdenk 5083c609719bSwdenk baudrate - see CONFIG_BAUDRATE 5084c609719bSwdenk 5085c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 5086c609719bSwdenk 5087c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 5088c609719bSwdenk 5089c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 5090c609719bSwdenk 5091c609719bSwdenk bootfile - Name of the image to load with TFTP 5092c609719bSwdenk 50937d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 50947d721e34SBartlomiej Sieka command can be restricted. This variable is given as 50957d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 50967d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 50977d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 50987d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 5099c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 5100c3624e6eSGrant Likely bootm_mapsize. 5101c3624e6eSGrant Likely 5102c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 5103c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 5104c3624e6eSGrant Likely defines the size of the memory region starting at base 5105c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 5106c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 5107c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 5108c3624e6eSGrant Likely used otherwise. 51097d721e34SBartlomiej Sieka 51107d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 51117d721e34SBartlomiej Sieka command can be restricted. This variable is given as 51127d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 51137d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 51147d721e34SBartlomiej Sieka environment variable. 51157d721e34SBartlomiej Sieka 51164bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 51174bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 51184bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 51194bae9090SBartlomiej Sieka 5120c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 5121c609719bSwdenk "bootp" will just load perform a lookup of the 5122c609719bSwdenk configuration from the BOOTP server, but not try to 5123c609719bSwdenk load any image using TFTP 5124c609719bSwdenk 5125c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 5126c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 5127c609719bSwdenk be automatically started (by internally calling 5128c609719bSwdenk "bootm") 5129c609719bSwdenk 51304a6fd34bSwdenk If set to "no", a standalone image passed to the 51314a6fd34bSwdenk "bootm" command will be copied to the load address 51324a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 51334a6fd34bSwdenk This can be used to load and uncompress arbitrary 51344a6fd34bSwdenk data. 51354a6fd34bSwdenk 5136a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 5137a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 5138fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 5139fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 5140fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 5141fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 5142fa34f6b2SShawn Guo device tree blob be copied to the maximum address 5143fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 5144fa34f6b2SShawn Guo access it during the boot procedure. 5145fa34f6b2SShawn Guo 5146a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 5147a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 5148a28afca5SDavid A. Long to work it must reside in writable memory, have 5149a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 5150a28afca5SDavid A. Long add the information it needs into it, and the memory 5151a28afca5SDavid A. Long must be accessible by the kernel. 5152a28afca5SDavid A. Long 5153eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 5154eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 5155eea63e05SSimon Glass defined. 5156eea63e05SSimon Glass 515717ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 515817ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 515917ea1177Swdenk mode (400kHZ). This environment variable is used in 516017ea1177Swdenk initialization code. So, for changes to be effective 516117ea1177Swdenk it must be saved and board must be reset. 516217ea1177Swdenk 5163c609719bSwdenk initrd_high - restrict positioning of initrd images: 5164c609719bSwdenk If this variable is not set, initrd images will be 5165c609719bSwdenk copied to the highest possible address in RAM; this 5166c609719bSwdenk is usually what you want since it allows for 5167c609719bSwdenk maximum initrd size. If for some reason you want to 5168c609719bSwdenk make sure that the initrd image is loaded below the 51696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 5170c609719bSwdenk variable to a value of "no" or "off" or "0". 5171c609719bSwdenk Alternatively, you can set it to a maximum upper 5172c609719bSwdenk address to use (U-Boot will still check that it 5173c609719bSwdenk does not overwrite the U-Boot stack and data). 5174c609719bSwdenk 5175c609719bSwdenk For instance, when you have a system with 16 MB 51767152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 5177c609719bSwdenk you can do this by adding "mem=12M" to the value of 5178c609719bSwdenk the "bootargs" variable. However, now you must make 51797152b1d0Swdenk sure that the initrd image is placed in the first 5180c609719bSwdenk 12 MB as well - this can be done with 5181c609719bSwdenk 5182c609719bSwdenk setenv initrd_high 00c00000 5183c609719bSwdenk 518438b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 518538b99261Swdenk indication to U-Boot that all addresses are legal 518638b99261Swdenk for the Linux kernel, including addresses in flash 518738b99261Swdenk memory. In this case U-Boot will NOT COPY the 518838b99261Swdenk ramdisk at all. This may be useful to reduce the 518938b99261Swdenk boot time on your system, but requires that this 519038b99261Swdenk feature is supported by your Linux kernel. 519138b99261Swdenk 5192c609719bSwdenk ipaddr - IP address; needed for tftpboot command 5193c609719bSwdenk 5194c609719bSwdenk loadaddr - Default load address for commands like "bootp", 5195dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 5196c609719bSwdenk 5197c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 5198c609719bSwdenk 5199c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 5200c609719bSwdenk 5201c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 5202c609719bSwdenk 5203c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 5204c609719bSwdenk 5205c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 5206c609719bSwdenk 5207e2a53458SMike Frysinger ethprime - controls which interface is used first. 5208a3d991bdSwdenk 5209e2a53458SMike Frysinger ethact - controls which interface is currently active. 5210e2a53458SMike Frysinger For example you can do the following 5211a3d991bdSwdenk 521248690d80SHeiko Schocher => setenv ethact FEC 521348690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 521448690d80SHeiko Schocher => setenv ethact SCC 521548690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 5216a3d991bdSwdenk 5217e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 5218e1692577SMatthias Fuchs available network interfaces. 5219e1692577SMatthias Fuchs It just stays at the currently selected interface. 5220e1692577SMatthias Fuchs 5221a3d991bdSwdenk netretry - When set to "no" each network operation will 5222a3d991bdSwdenk either succeed or fail without retrying. 52236e592385Swdenk When set to "once" the network operation will 52246e592385Swdenk fail when all the available network interfaces 52256e592385Swdenk are tried once without success. 5226a3d991bdSwdenk Useful on scripts which control the retry operation 5227a3d991bdSwdenk themselves. 5228a3d991bdSwdenk 5229b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 5230a1cf027aSJean-Christophe PLAGNIOL-VILLARD 5231b445bbb4SJeremiah Mahler silent_linux - If set then Linux will be told to boot silently, by 52328d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 52338d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 52348d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 52358d51aacdSSimon Glass is silent. 52368d51aacdSSimon Glass 5237f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpsrcp - If this is set, the value is used for TFTP's 5238ecb0ccd9SWolfgang Denk UDP source port. 5239ecb0ccd9SWolfgang Denk 5240f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpdstp - If this is set, the value is used for TFTP's UDP 524128cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 524228cb9375SWolfgang Denk 5243c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 5244c96f86eeSWolfgang Denk we use the TFTP server's default block size 5245c96f86eeSWolfgang Denk 5246c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 5247c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 5248c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 5249c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 5250c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 5251c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 5252c96f86eeSWolfgang Denk with unreliable TFTP servers. 5253c96f86eeSWolfgang Denk 5254f5fb7346SAlbert ARIBAUD \(3ADEV\) tftptimeoutcountmax - maximum count of TFTP timeouts (no 5255f5fb7346SAlbert ARIBAUD \(3ADEV\) unit, minimum value = 0). Defines how many timeouts 5256f5fb7346SAlbert ARIBAUD \(3ADEV\) can happen during a single file transfer before that 5257f5fb7346SAlbert ARIBAUD \(3ADEV\) transfer is aborted. The default is 10, and 0 means 5258f5fb7346SAlbert ARIBAUD \(3ADEV\) 'no timeouts allowed'. Increasing this value may help 5259f5fb7346SAlbert ARIBAUD \(3ADEV\) downloads succeed with high packet loss rates, or with 5260f5fb7346SAlbert ARIBAUD \(3ADEV\) unreliable TFTP servers or client hardware. 5261f5fb7346SAlbert ARIBAUD \(3ADEV\) 5262a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 526311ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 5264a3d991bdSwdenk VLAN tagged frames. 5265c609719bSwdenk 526650768f5bSAlexandre Messier bootpretryperiod - Period during which BOOTP/DHCP sends retries. 526750768f5bSAlexandre Messier Unsigned value, in milliseconds. If not set, the period will 526850768f5bSAlexandre Messier be either the default (28000), or a value based on 526950768f5bSAlexandre Messier CONFIG_NET_RETRY_COUNT, if defined. This value has 527050768f5bSAlexandre Messier precedence over the valu based on CONFIG_NET_RETRY_COUNT. 527150768f5bSAlexandre Messier 5272dc0b7b0eSJason HobbsThe following image location variables contain the location of images 5273dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 5274dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 5275dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 5276dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 5277dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 5278dc0b7b0eSJason Hobbsflash or offset in NAND flash. 5279dc0b7b0eSJason Hobbs 5280dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 5281aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some 5282dc0b7b0eSJason Hobbsboards use these variables for other purposes. 5283dc0b7b0eSJason Hobbs 5284dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 5285dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 5286dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 5287dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 5288dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 5289dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 5290dc0b7b0eSJason Hobbs 5291c609719bSwdenkThe following environment variables may be used and automatically 5292c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 5293c609719bSwdenkdepending the information provided by your boot server: 5294c609719bSwdenk 5295c609719bSwdenk bootfile - see above 5296c609719bSwdenk dnsip - IP address of your Domain Name Server 5297fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 5298c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 5299c609719bSwdenk hostname - Target hostname 5300c609719bSwdenk ipaddr - see above 5301c609719bSwdenk netmask - Subnet Mask 5302c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 5303c609719bSwdenk serverip - see above 5304c609719bSwdenk 5305c609719bSwdenk 5306c609719bSwdenkThere are two special Environment Variables: 5307c609719bSwdenk 5308c609719bSwdenk serial# - contains hardware identification information such 5309c609719bSwdenk as type string and/or serial number 5310c609719bSwdenk ethaddr - Ethernet address 5311c609719bSwdenk 5312c609719bSwdenkThese variables can be set only once (usually during manufacturing of 5313c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 5314c609719bSwdenkonce they have been set once. 5315c609719bSwdenk 5316c609719bSwdenk 5317c1551ea8SstroeseFurther special Environment Variables: 5318c1551ea8Sstroese 5319c1551ea8Sstroese ver - Contains the U-Boot version string as printed 5320c1551ea8Sstroese with the "version" command. This variable is 5321c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 5322c1551ea8Sstroese 5323c1551ea8Sstroese 5324c609719bSwdenkPlease note that changes to some configuration parameters may take 5325c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 5326c609719bSwdenk 5327c609719bSwdenk 5328170ab110SJoe HershbergerCallback functions for environment variables: 5329170ab110SJoe Hershberger--------------------------------------------- 5330170ab110SJoe Hershberger 5331170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 5332b445bbb4SJeremiah Mahlerwhen their values are changed. This functionality allows functions to 5333170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 5334170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 5335170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 5336170ab110SJoe Hershberger 5337170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 5338170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 5339170ab110SJoe Hershberger 5340170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 5341170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 5342170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 5343170ab110SJoe Hershbergerassociations. The list must be in the following format: 5344170ab110SJoe Hershberger 5345170ab110SJoe Hershberger entry = variable_name[:callback_name] 5346170ab110SJoe Hershberger list = entry[,list] 5347170ab110SJoe Hershberger 5348170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 5349170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 5350170ab110SJoe Hershberger 5351170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 5352170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 5353170ab110SJoe Hershbergeroverride any association in the static list. You can define 5354170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 5355b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment. 5356170ab110SJoe Hershberger 5357bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a 5358bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to 5359bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out. 5360bdf1fe4eSJoe Hershberger 5361170ab110SJoe Hershberger 5362f07771ccSwdenkCommand Line Parsing: 5363f07771ccSwdenk===================== 5364f07771ccSwdenk 5365f07771ccSwdenkThere are two different command line parsers available with U-Boot: 53667152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 5367f07771ccSwdenk 5368f07771ccSwdenkOld, simple command line parser: 5369f07771ccSwdenk-------------------------------- 5370f07771ccSwdenk 5371f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 5372f07771ccSwdenk- several commands on one line, separated by ';' 5373fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 5374f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 5375f07771ccSwdenk for example: 5376fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 5377f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 5378f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 5379f07771ccSwdenk 5380f07771ccSwdenkHush shell: 5381f07771ccSwdenk----------- 5382f07771ccSwdenk 5383f07771ccSwdenk- similar to Bourne shell, with control structures like 5384f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 5385f07771ccSwdenk until...do...done, ... 5386f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 5387f07771ccSwdenk commands) and local shell variables (through standard shell syntax 5388f07771ccSwdenk "name=value"); only environment variables can be used with "run" 5389f07771ccSwdenk command 5390f07771ccSwdenk 5391f07771ccSwdenkGeneral rules: 5392f07771ccSwdenk-------------- 5393f07771ccSwdenk 5394f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 5395f07771ccSwdenk command) contains several commands separated by semicolon, and 5396f07771ccSwdenk one of these commands fails, then the remaining commands will be 5397f07771ccSwdenk executed anyway. 5398f07771ccSwdenk 5399f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 540011ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 5401f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 5402f07771ccSwdenk variables are not executed. 5403f07771ccSwdenk 5404c609719bSwdenkNote for Redundant Ethernet Interfaces: 5405c609719bSwdenk======================================= 5406c609719bSwdenk 540711ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 5408c609719bSwdenksuch configurations and is capable of automatic selection of a 54097152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 5410c609719bSwdenk 5411c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 5412c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5413c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 5414c609719bSwdenk 5415c609719bSwdenkIf the network interface stores some valid MAC address (for instance 5416c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 5417c609719bSwdenkding setting in the environment; if the corresponding environment 5418c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 5419c609719bSwdenk 5420c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 5421c609719bSwdenk environment, the SROM's address is used. 5422c609719bSwdenk 5423c609719bSwdenko If there is no valid address in the SROM, and a definition in the 5424c609719bSwdenk environment exists, then the value from the environment variable is 5425c609719bSwdenk used. 5426c609719bSwdenk 5427c609719bSwdenko If both the SROM and the environment contain a MAC address, and 5428c609719bSwdenk both addresses are the same, this MAC address is used. 5429c609719bSwdenk 5430c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 5431c609719bSwdenk addresses differ, the value from the environment is used and a 5432c609719bSwdenk warning is printed. 5433c609719bSwdenk 5434c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 5435bef1014bSJoe Hershberger is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case 5436bef1014bSJoe Hershberger a random, locally-assigned MAC is used. 5437c609719bSwdenk 5438ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5439ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 5440ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 5441ecee9324SBen WarrenThe naming convention is as follows: 5442ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5443c609719bSwdenk 5444c609719bSwdenkImage Formats: 5445c609719bSwdenk============== 5446c609719bSwdenk 54473310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 54483310c549SMarian Balakowiczimages in two formats: 54493310c549SMarian Balakowicz 54503310c549SMarian BalakowiczNew uImage format (FIT) 54513310c549SMarian Balakowicz----------------------- 54523310c549SMarian Balakowicz 54533310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 54543310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 54553310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 54563310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 54573310c549SMarian Balakowicz 54583310c549SMarian Balakowicz 54593310c549SMarian BalakowiczOld uImage format 54603310c549SMarian Balakowicz----------------- 54613310c549SMarian Balakowicz 54623310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 54633310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 54643310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 5465c609719bSwdenk 5466c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5467c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5468f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5469f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5470f5ed9e39SPeter Tyser INTEGRITY). 54717b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5472afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5473afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5474c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 5475c609719bSwdenk* Load Address 5476c609719bSwdenk* Entry Point 5477c609719bSwdenk* Image Name 5478c609719bSwdenk* Image Timestamp 5479c609719bSwdenk 5480c609719bSwdenkThe header is marked by a special Magic Number, and both the header 5481c609719bSwdenkand the data portions of the image are secured against corruption by 5482c609719bSwdenkCRC32 checksums. 5483c609719bSwdenk 5484c609719bSwdenk 5485c609719bSwdenkLinux Support: 5486c609719bSwdenk============== 5487c609719bSwdenk 5488c609719bSwdenkAlthough U-Boot should support any OS or standalone application 54897152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 5490c609719bSwdenkU-Boot. 5491c609719bSwdenk 5492c609719bSwdenkU-Boot includes many features that so far have been part of some 5493c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 5494c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 5495c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 54967152b1d0Swdenkserves several purposes: 5497c609719bSwdenk 5498c609719bSwdenk- the same features can be used for other OS or standalone 5499c609719bSwdenk applications (for instance: using compressed images to reduce the 5500c609719bSwdenk Flash memory footprint) 5501c609719bSwdenk 5502c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 55037152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 5504c609719bSwdenk 5505c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 5506c609719bSwdenk images; of course this also means that different kernel images can 5507c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 5508c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 5509c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 5510c609719bSwdenk software is easier now. 5511c609719bSwdenk 5512c609719bSwdenk 5513c609719bSwdenkLinux HOWTO: 5514c609719bSwdenk============ 5515c609719bSwdenk 5516c609719bSwdenkPorting Linux to U-Boot based systems: 5517c609719bSwdenk--------------------------------------- 5518c609719bSwdenk 5519c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 5520c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 5521c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 5522c609719bSwdenkLinux :-). 5523c609719bSwdenk 5524a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5525c609719bSwdenk 5526c609719bSwdenkJust make sure your machine specific header file (for instance 5527c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 55281dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 55291dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 55306d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 5531c609719bSwdenk 55322eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers. 55332eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there 55342eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See 55352eb31b13SSimon Glassdoc/driver-model. 55362eb31b13SSimon Glass 5537c609719bSwdenk 5538c609719bSwdenkConfiguring the Linux kernel: 5539c609719bSwdenk----------------------------- 5540c609719bSwdenk 5541c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 5542c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 5543c609719bSwdenk 5544c609719bSwdenk 5545c609719bSwdenkBuilding a Linux Image: 5546c609719bSwdenk----------------------- 5547c609719bSwdenk 554824ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 554924ee89b9Swdenknot used. If you use recent kernel source, a new build target 555024ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 555124ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 555224ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 555324ee89b9Swdenk100% compatible format. 5554c609719bSwdenk 5555c609719bSwdenkExample: 5556c609719bSwdenk 5557ab584d67SHolger Freyther make TQM850L_defconfig 5558c609719bSwdenk make oldconfig 5559c609719bSwdenk make dep 556024ee89b9Swdenk make uImage 5561c609719bSwdenk 556224ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 556324ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 556424ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 5565c609719bSwdenk 556624ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 556724ee89b9Swdenk 556824ee89b9Swdenk* convert the kernel into a raw binary image: 556924ee89b9Swdenk 557024ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 557124ee89b9Swdenk -R .note -R .comment \ 557224ee89b9Swdenk -S vmlinux linux.bin 557324ee89b9Swdenk 557424ee89b9Swdenk* compress the binary image: 557524ee89b9Swdenk 557624ee89b9Swdenk gzip -9 linux.bin 557724ee89b9Swdenk 557824ee89b9Swdenk* package compressed binary image for U-Boot: 557924ee89b9Swdenk 558024ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 558124ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 558224ee89b9Swdenk -d linux.bin.gz uImage 558324ee89b9Swdenk 558424ee89b9Swdenk 558524ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 558624ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 558724ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 558824ee89b9Swdenkbyte header containing information about target architecture, 558924ee89b9Swdenkoperating system, image type, compression method, entry points, time 559024ee89b9Swdenkstamp, CRC32 checksums, etc. 559124ee89b9Swdenk 559224ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 559324ee89b9Swdenkprint the header information, or to build new images. 5594c609719bSwdenk 5595c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 5596c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 5597c609719bSwdenkchecksum verification: 5598c609719bSwdenk 5599c609719bSwdenk tools/mkimage -l image 5600c609719bSwdenk -l ==> list image header information 5601c609719bSwdenk 5602c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 5603c609719bSwdenkfrom a "data file" which is used as image payload: 5604c609719bSwdenk 5605c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5606c609719bSwdenk -n name -d data_file image 5607c609719bSwdenk -A ==> set architecture to 'arch' 5608c609719bSwdenk -O ==> set operating system to 'os' 5609c609719bSwdenk -T ==> set image type to 'type' 5610c609719bSwdenk -C ==> set compression type 'comp' 5611c609719bSwdenk -a ==> set load address to 'addr' (hex) 5612c609719bSwdenk -e ==> set entry point to 'ep' (hex) 5613c609719bSwdenk -n ==> set image name to 'name' 5614c609719bSwdenk -d ==> use image data from 'datafile' 5615c609719bSwdenk 561669459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 561769459791Swdenkaddress (0x00000000), but the entry point address depends on the 561869459791Swdenkkernel version: 5619c609719bSwdenk 5620c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 562124ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 5622c609719bSwdenk 5623c609719bSwdenkSo a typical call to build a U-Boot image would read: 5624c609719bSwdenk 562524ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 562624ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5627a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 562824ee89b9Swdenk > examples/uImage.TQM850L 562924ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5630c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5631c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5632c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5633c609719bSwdenk Load Address: 0x00000000 563424ee89b9Swdenk Entry Point: 0x00000000 5635c609719bSwdenk 5636c609719bSwdenkTo verify the contents of the image (or check for corruption): 5637c609719bSwdenk 563824ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 563924ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5640c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5641c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5642c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5643c609719bSwdenk Load Address: 0x00000000 564424ee89b9Swdenk Entry Point: 0x00000000 5645c609719bSwdenk 5646c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 5647c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 5648c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 5649c609719bSwdenkneed to be uncompressed: 5650c609719bSwdenk 5651a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 565224ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 565324ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5654a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 565524ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 565624ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5657c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5658c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 5659c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5660c609719bSwdenk Load Address: 0x00000000 566124ee89b9Swdenk Entry Point: 0x00000000 5662c609719bSwdenk 5663c609719bSwdenk 5664c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 5665c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 5666c609719bSwdenk 5667c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 5668c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 5669c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5670c609719bSwdenk Image Name: Simple Ramdisk Image 5671c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 5672c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5673c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5674c609719bSwdenk Load Address: 0x00000000 5675c609719bSwdenk Entry Point: 0x00000000 5676c609719bSwdenk 5677a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5678a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 5679a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 5680a804b5ceSGuilherme Maciel Ferreirafrom the image: 5681a804b5ceSGuilherme Maciel Ferreira 5682f41f5b7cSGuilherme Maciel Ferreira tools/dumpimage -i image -T type -p position data_file 5683f41f5b7cSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file' 5684f41f5b7cSGuilherme Maciel Ferreira -T ==> set image type to 'type' 5685f41f5b7cSGuilherme Maciel Ferreira -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' 5686a804b5ceSGuilherme Maciel Ferreira 5687c609719bSwdenk 5688c609719bSwdenkInstalling a Linux Image: 5689c609719bSwdenk------------------------- 5690c609719bSwdenk 5691c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 5692c609719bSwdenkyou must convert the image to S-Record format: 5693c609719bSwdenk 5694c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 5695c609719bSwdenk 5696c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 5697c609719bSwdenkimage header, so the resulting S-Record file will be relative to 5698c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 5699c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 5700c609719bSwdenkcommand. 5701c609719bSwdenk 5702c609719bSwdenkExample: install the image to address 0x40100000 (which on the 5703c609719bSwdenkTQM8xxL is in the first Flash bank): 5704c609719bSwdenk 5705c609719bSwdenk => erase 40100000 401FFFFF 5706c609719bSwdenk 5707c609719bSwdenk .......... done 5708c609719bSwdenk Erased 8 sectors 5709c609719bSwdenk 5710c609719bSwdenk => loads 40100000 5711c609719bSwdenk ## Ready for S-Record download ... 5712c609719bSwdenk ~>examples/image.srec 5713c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5714c609719bSwdenk ... 5715c609719bSwdenk 15989 15990 15991 15992 5716c609719bSwdenk [file transfer complete] 5717c609719bSwdenk [connected] 5718c609719bSwdenk ## Start Addr = 0x00000000 5719c609719bSwdenk 5720c609719bSwdenk 5721c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 5722c609719bSwdenkthis includes a checksum verification so you can be sure no data 5723c609719bSwdenkcorruption happened: 5724c609719bSwdenk 5725c609719bSwdenk => imi 40100000 5726c609719bSwdenk 5727c609719bSwdenk ## Checking Image at 40100000 ... 5728c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5729c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5730c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5731c609719bSwdenk Load Address: 00000000 5732c609719bSwdenk Entry Point: 0000000c 5733c609719bSwdenk Verifying Checksum ... OK 5734c609719bSwdenk 5735c609719bSwdenk 5736c609719bSwdenkBoot Linux: 5737c609719bSwdenk----------- 5738c609719bSwdenk 5739c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 5740c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 5741c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 5742c609719bSwdenkparameters. You can check and modify this variable using the 5743c609719bSwdenk"printenv" and "setenv" commands: 5744c609719bSwdenk 5745c609719bSwdenk 5746c609719bSwdenk => printenv bootargs 5747c609719bSwdenk bootargs=root=/dev/ram 5748c609719bSwdenk 5749c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5750c609719bSwdenk 5751c609719bSwdenk => printenv bootargs 5752c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5753c609719bSwdenk 5754c609719bSwdenk => bootm 40020000 5755c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5756c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5757c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5758c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5759c609719bSwdenk Load Address: 00000000 5760c609719bSwdenk Entry Point: 0000000c 5761c609719bSwdenk Verifying Checksum ... OK 5762c609719bSwdenk Uncompressing Kernel Image ... OK 5763c609719bSwdenk 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 5764c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5765c609719bSwdenk time_init: decrementer frequency = 187500000/60 5766c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5767c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5768c609719bSwdenk ... 5769c609719bSwdenk 577011ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 57717152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5772c609719bSwdenkformat!) to the "bootm" command: 5773c609719bSwdenk 5774c609719bSwdenk => imi 40100000 40200000 5775c609719bSwdenk 5776c609719bSwdenk ## Checking Image at 40100000 ... 5777c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5778c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5779c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5780c609719bSwdenk Load Address: 00000000 5781c609719bSwdenk Entry Point: 0000000c 5782c609719bSwdenk Verifying Checksum ... OK 5783c609719bSwdenk 5784c609719bSwdenk ## Checking Image at 40200000 ... 5785c609719bSwdenk Image Name: Simple Ramdisk Image 5786c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5787c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5788c609719bSwdenk Load Address: 00000000 5789c609719bSwdenk Entry Point: 00000000 5790c609719bSwdenk Verifying Checksum ... OK 5791c609719bSwdenk 5792c609719bSwdenk => bootm 40100000 40200000 5793c609719bSwdenk ## Booting Linux kernel at 40100000 ... 5794c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5795c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5796c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5797c609719bSwdenk Load Address: 00000000 5798c609719bSwdenk Entry Point: 0000000c 5799c609719bSwdenk Verifying Checksum ... OK 5800c609719bSwdenk Uncompressing Kernel Image ... OK 5801c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 5802c609719bSwdenk Image Name: Simple Ramdisk Image 5803c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5804c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5805c609719bSwdenk Load Address: 00000000 5806c609719bSwdenk Entry Point: 00000000 5807c609719bSwdenk Verifying Checksum ... OK 5808c609719bSwdenk Loading Ramdisk ... OK 5809c609719bSwdenk 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 5810c609719bSwdenk Boot arguments: root=/dev/ram 5811c609719bSwdenk time_init: decrementer frequency = 187500000/60 5812c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5813c609719bSwdenk ... 5814c609719bSwdenk RAMDISK: Compressed image found at block 0 5815c609719bSwdenk VFS: Mounted root (ext2 filesystem). 5816c609719bSwdenk 5817c609719bSwdenk bash# 5818c609719bSwdenk 58190267768eSMatthew McClintockBoot Linux and pass a flat device tree: 58200267768eSMatthew McClintock----------- 58210267768eSMatthew McClintock 58220267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 58230267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 58240267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 58250267768eSMatthew McClintockflat device tree: 58260267768eSMatthew McClintock 58270267768eSMatthew McClintock=> print oftaddr 58280267768eSMatthew McClintockoftaddr=0x300000 58290267768eSMatthew McClintock=> print oft 58300267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 58310267768eSMatthew McClintock=> tftp $oftaddr $oft 58320267768eSMatthew McClintockSpeed: 1000, full duplex 58330267768eSMatthew McClintockUsing TSEC0 device 58340267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 58350267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 58360267768eSMatthew McClintockLoad address: 0x300000 58370267768eSMatthew McClintockLoading: # 58380267768eSMatthew McClintockdone 58390267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 58400267768eSMatthew McClintock=> tftp $loadaddr $bootfile 58410267768eSMatthew McClintockSpeed: 1000, full duplex 58420267768eSMatthew McClintockUsing TSEC0 device 58430267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 58440267768eSMatthew McClintockFilename 'uImage'. 58450267768eSMatthew McClintockLoad address: 0x200000 58460267768eSMatthew McClintockLoading:############ 58470267768eSMatthew McClintockdone 58480267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 58490267768eSMatthew McClintock=> print loadaddr 58500267768eSMatthew McClintockloadaddr=200000 58510267768eSMatthew McClintock=> print oftaddr 58520267768eSMatthew McClintockoftaddr=0x300000 58530267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 58540267768eSMatthew McClintock## Booting image at 00200000 ... 58550267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 58560267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 58570267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 58580267768eSMatthew McClintock Load Address: 00000000 58590267768eSMatthew McClintock Entry Point: 00000000 58600267768eSMatthew McClintock Verifying Checksum ... OK 58610267768eSMatthew McClintock Uncompressing Kernel Image ... OK 58620267768eSMatthew McClintockBooting using flat device tree at 0x300000 58630267768eSMatthew McClintockUsing MPC85xx ADS machine description 58640267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 58650267768eSMatthew McClintock[snip] 58660267768eSMatthew McClintock 58670267768eSMatthew McClintock 58686069ff26SwdenkMore About U-Boot Image Types: 58696069ff26Swdenk------------------------------ 58706069ff26Swdenk 58716069ff26SwdenkU-Boot supports the following image types: 58726069ff26Swdenk 58736069ff26Swdenk "Standalone Programs" are directly runnable in the environment 58746069ff26Swdenk provided by U-Boot; it is expected that (if they behave 58756069ff26Swdenk well) you can continue to work in U-Boot after return from 58766069ff26Swdenk the Standalone Program. 58776069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 58786069ff26Swdenk will take over control completely. Usually these programs 58796069ff26Swdenk will install their own set of exception handlers, device 58806069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 58816069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 58826069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 58836069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 58846069ff26Swdenk being started. 58856069ff26Swdenk "Multi-File Images" contain several images, typically an OS 58866069ff26Swdenk (Linux) kernel image and one or more data images like 58876069ff26Swdenk RAMDisks. This construct is useful for instance when you want 58886069ff26Swdenk to boot over the network using BOOTP etc., where the boot 58896069ff26Swdenk server provides just a single image file, but you want to get 58906069ff26Swdenk for instance an OS kernel and a RAMDisk image. 58916069ff26Swdenk 58926069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 58936069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 58946069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 58956069ff26Swdenk Immediately after the terminating 0 follow the images, one by 58966069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 58976069ff26Swdenk a multiple of 4 bytes). 58986069ff26Swdenk 58996069ff26Swdenk "Firmware Images" are binary images containing firmware (like 59006069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 59016069ff26Swdenk flash memory. 59026069ff26Swdenk 59036069ff26Swdenk "Script files" are command sequences that will be executed by 59046069ff26Swdenk U-Boot's command interpreter; this feature is especially 59056069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 59066069ff26Swdenk as command interpreter. 59076069ff26Swdenk 590844f074c7SMarek VasutBooting the Linux zImage: 590944f074c7SMarek Vasut------------------------- 591044f074c7SMarek Vasut 591144f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 591244f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 591344f074c7SMarek Vasutas the syntax of "bootm" command. 591444f074c7SMarek Vasut 59158ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5916017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 5917017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 5918017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 5919017e1f3fSMarek Vasut 5920c609719bSwdenk 5921c609719bSwdenkStandalone HOWTO: 5922c609719bSwdenk================= 5923c609719bSwdenk 5924c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 5925c609719bSwdenkrun "standalone" applications, which can use some resources of 5926c609719bSwdenkU-Boot like console I/O functions or interrupt services. 5927c609719bSwdenk 5928c609719bSwdenkTwo simple examples are included with the sources: 5929c609719bSwdenk 5930c609719bSwdenk"Hello World" Demo: 5931c609719bSwdenk------------------- 5932c609719bSwdenk 5933c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 5934c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 5935c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 5936c609719bSwdenklike that: 5937c609719bSwdenk 5938c609719bSwdenk => loads 5939c609719bSwdenk ## Ready for S-Record download ... 5940c609719bSwdenk ~>examples/hello_world.srec 5941c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5942c609719bSwdenk [file transfer complete] 5943c609719bSwdenk [connected] 5944c609719bSwdenk ## Start Addr = 0x00040004 5945c609719bSwdenk 5946c609719bSwdenk => go 40004 Hello World! This is a test. 5947c609719bSwdenk ## Starting application at 0x00040004 ... 5948c609719bSwdenk Hello World 5949c609719bSwdenk argc = 7 5950c609719bSwdenk argv[0] = "40004" 5951c609719bSwdenk argv[1] = "Hello" 5952c609719bSwdenk argv[2] = "World!" 5953c609719bSwdenk argv[3] = "This" 5954c609719bSwdenk argv[4] = "is" 5955c609719bSwdenk argv[5] = "a" 5956c609719bSwdenk argv[6] = "test." 5957c609719bSwdenk argv[7] = "<NULL>" 5958c609719bSwdenk Hit any key to exit ... 5959c609719bSwdenk 5960c609719bSwdenk ## Application terminated, rc = 0x0 5961c609719bSwdenk 5962c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 5963c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 5964c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 5965c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 5966c609719bSwdenkcharacter, but this is just a demo program. The application can be 5967c609719bSwdenkcontrolled by the following keys: 5968c609719bSwdenk 5969c609719bSwdenk ? - print current values og the CPM Timer registers 5970c609719bSwdenk b - enable interrupts and start timer 5971c609719bSwdenk e - stop timer and disable interrupts 5972c609719bSwdenk q - quit application 5973c609719bSwdenk 5974c609719bSwdenk => loads 5975c609719bSwdenk ## Ready for S-Record download ... 5976c609719bSwdenk ~>examples/timer.srec 5977c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5978c609719bSwdenk [file transfer complete] 5979c609719bSwdenk [connected] 5980c609719bSwdenk ## Start Addr = 0x00040004 5981c609719bSwdenk 5982c609719bSwdenk => go 40004 5983c609719bSwdenk ## Starting application at 0x00040004 ... 5984c609719bSwdenk TIMERS=0xfff00980 5985c609719bSwdenk Using timer 1 5986c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5987c609719bSwdenk 5988c609719bSwdenkHit 'b': 5989c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 5990c609719bSwdenk Enabling timer 5991c609719bSwdenkHit '?': 5992c609719bSwdenk [q, b, e, ?] ........ 5993c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5994c609719bSwdenkHit '?': 5995c609719bSwdenk [q, b, e, ?] . 5996c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5997c609719bSwdenkHit '?': 5998c609719bSwdenk [q, b, e, ?] . 5999c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 6000c609719bSwdenkHit '?': 6001c609719bSwdenk [q, b, e, ?] . 6002c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 6003c609719bSwdenkHit 'e': 6004c609719bSwdenk [q, b, e, ?] ...Stopping timer 6005c609719bSwdenkHit 'q': 6006c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 6007c609719bSwdenk 6008c609719bSwdenk 600985ec0bccSwdenkMinicom warning: 601085ec0bccSwdenk================ 601185ec0bccSwdenk 60127152b1d0SwdenkOver time, many people have reported problems when trying to use the 601385ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 601485ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 6015f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 601685ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 6017e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 6018e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 6019e53515a2SKarl O. Pincfor help with kermit. 6020e53515a2SKarl O. Pinc 602185ec0bccSwdenk 602252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 602352f52c14Swdenkconfiguration to your "File transfer protocols" section: 602452f52c14Swdenk 602552f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 602652f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 602752f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 602852f52c14Swdenk 602952f52c14Swdenk 6030c609719bSwdenkNetBSD Notes: 6031c609719bSwdenk============= 6032c609719bSwdenk 6033c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 6034c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 6035c609719bSwdenk 6036c609719bSwdenkBuilding requires a cross environment; it is known to work on 6037c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 6038c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 6039c609719bSwdenkNote that the cross-powerpc package does not install include files; 6040c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 6041c609719bSwdenkmissing. This file has to be installed and patched manually: 6042c609719bSwdenk 6043c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 6044c609719bSwdenk # mkdir powerpc 6045c609719bSwdenk # ln -s powerpc machine 6046c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 6047c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 6048c609719bSwdenk 6049c609719bSwdenkNative builds *don't* work due to incompatibilities between native 6050c609719bSwdenkand U-Boot include files. 6051c609719bSwdenk 6052c609719bSwdenkBooting assumes that (the first part of) the image booted is a 6053c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 6054c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 6055c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 60562a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 6057c609719bSwdenk 6058c609719bSwdenk 6059c609719bSwdenkImplementation Internals: 6060c609719bSwdenk========================= 6061c609719bSwdenk 6062c609719bSwdenkThe following is not intended to be a complete description of every 6063c609719bSwdenkimplementation detail. However, it should help to understand the 6064c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 6065c609719bSwdenkhardware. 6066c609719bSwdenk 6067c609719bSwdenk 6068c609719bSwdenkInitial Stack, Global Data: 6069c609719bSwdenk--------------------------- 6070c609719bSwdenk 6071c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 6072c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 6073c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 6074c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 6075c609719bSwdenkis not initialized as zero. To be able to get a C environment working 6076c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 6077c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 6078c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 6079c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 6080c609719bSwdenklocked as (mis-) used as memory, etc. 6081c609719bSwdenk 60827152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 60830668236bSWolfgang Denk U-Boot mailing list: 608443d9616cSwdenk 608543d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 608643d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 608743d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 608843d9616cSwdenk ... 608943d9616cSwdenk 609043d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 609143d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 609243d9616cSwdenk require any physical RAM backing up the cache. The cleverness 609343d9616cSwdenk is that the cache is being used as a temporary supply of 609443d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 609511ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 609643d9616cSwdenk can see how this works by studying the cache architecture and 609743d9616cSwdenk operation in the architecture and processor-specific manuals. 609843d9616cSwdenk 609943d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 610043d9616cSwdenk is another option for the system designer to use as an 610111ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 610243d9616cSwdenk option should work for you. Using CS 4 should be fine if your 610343d9616cSwdenk board designers haven't used it for something that would 610443d9616cSwdenk cause you grief during the initial boot! It is frequently not 610543d9616cSwdenk used. 610643d9616cSwdenk 61076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 610843d9616cSwdenk with your processor/board/system design. The default value 610943d9616cSwdenk you will find in any recent u-boot distribution in 61108a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 611143d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 611243d9616cSwdenk it above 400_0000. Just make sure your board has no resources 611343d9616cSwdenk that are supposed to respond to that address! That code in 611443d9616cSwdenk start.S has been around a while and should work as is when 611543d9616cSwdenk you get the config right. 611643d9616cSwdenk 611743d9616cSwdenk -Chris Hallinan 611843d9616cSwdenk DS4.COM, Inc. 611943d9616cSwdenk 6120c609719bSwdenkIt is essential to remember this, since it has some impact on the C 6121c609719bSwdenkcode for the initialization procedures: 6122c609719bSwdenk 6123c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 6124c609719bSwdenk to write it. 6125c609719bSwdenk 6126b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized 6127c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 61287152b1d0Swdenk zation is performed later (when relocating to RAM). 6129c609719bSwdenk 6130c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 6131c609719bSwdenk that. 6132c609719bSwdenk 6133c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 6134b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it 6135c609719bSwdenkturned out that the implementation of U-Boot can be greatly 6136c609719bSwdenksimplified by making a global data structure (gd_t) available to all 6137c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 6138c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 6139c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 6140c609719bSwdenkplace a pointer (gd) to the global data into a register which we 6141c609719bSwdenkreserve for this purpose. 6142c609719bSwdenk 61437152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 6144c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 6145c609719bSwdenkGCC's implementation. 6146c609719bSwdenk 6147c609719bSwdenkFor PowerPC, the following registers have specific use: 6148c609719bSwdenk R1: stack pointer 6149e7670f6cSWolfgang Denk R2: reserved for system use 6150c609719bSwdenk R3-R4: parameter passing and return values 6151c609719bSwdenk R5-R10: parameter passing 6152c609719bSwdenk R13: small data area pointer 6153c609719bSwdenk R30: GOT pointer 6154c609719bSwdenk R31: frame pointer 6155c609719bSwdenk 6156e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 6157e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 6158e6bee808SJoakim Tjernlund going back and forth between asm and C) 6159c609719bSwdenk 6160e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 6161c609719bSwdenk 6162c609719bSwdenk Note: on PPC, we could use a static initializer (since the 6163c609719bSwdenk address of the global data structure is known at compile time), 6164c609719bSwdenk but it turned out that reserving a register results in somewhat 6165c609719bSwdenk smaller code - although the code savings are not that big (on 6166c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 6167c609719bSwdenk 624 text + 127 data). 6168c609719bSwdenk 6169c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 61704c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 61714c58eb55SMike Frysinger 6172c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 61734c58eb55SMike Frysinger 6174c609719bSwdenkOn ARM, the following registers are used: 6175c609719bSwdenk 6176c609719bSwdenk R0: function argument word/integer result 6177c609719bSwdenk R1-R3: function argument word 617812eba1b4SJeroen Hofstee R9: platform specific 617912eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 6180c609719bSwdenk R11: argument (frame) pointer 6181c609719bSwdenk R12: temporary workspace 6182c609719bSwdenk R13: stack pointer 6183c609719bSwdenk R14: link register 6184c609719bSwdenk R15: program counter 6185c609719bSwdenk 618612eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 618712eba1b4SJeroen Hofstee 618812eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 6189c609719bSwdenk 61900df01fd3SThomas ChouOn Nios II, the ABI is documented here: 61910df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 61920df01fd3SThomas Chou 61930df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 61940df01fd3SThomas Chou 61950df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 61960df01fd3SThomas Chou to access small data sections, so gp is free. 61970df01fd3SThomas Chou 6198afc1ce82SMacpaul LinOn NDS32, the following registers are used: 6199afc1ce82SMacpaul Lin 6200afc1ce82SMacpaul Lin R0-R1: argument/return 6201afc1ce82SMacpaul Lin R2-R5: argument 6202afc1ce82SMacpaul Lin R15: temporary register for assembler 6203afc1ce82SMacpaul Lin R16: trampoline register 6204afc1ce82SMacpaul Lin R28: frame pointer (FP) 6205afc1ce82SMacpaul Lin R29: global pointer (GP) 6206afc1ce82SMacpaul Lin R30: link register (LP) 6207afc1ce82SMacpaul Lin R31: stack pointer (SP) 6208afc1ce82SMacpaul Lin PC: program counter (PC) 6209afc1ce82SMacpaul Lin 6210afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 6211afc1ce82SMacpaul Lin 6212d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 6213d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 6214c609719bSwdenk 6215c609719bSwdenkMemory Management: 6216c609719bSwdenk------------------ 6217c609719bSwdenk 6218c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 6219c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 6220c609719bSwdenk 6221c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 6222c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 6223c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 6224c609719bSwdenkphysical memory banks. 6225c609719bSwdenk 6226c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 6227c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 6228c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 6229c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 62306d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 6231c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 6232c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 6233c609719bSwdenk 6234c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 6235c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 6236c609719bSwdenk 6237c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 6238c609719bSwdenkthis: 6239c609719bSwdenk 6240c609719bSwdenk 0x0000 0000 Exception Vector code 6241c609719bSwdenk : 6242c609719bSwdenk 0x0000 1FFF 6243c609719bSwdenk 0x0000 2000 Free for Application Use 6244c609719bSwdenk : 6245c609719bSwdenk : 6246c609719bSwdenk 6247c609719bSwdenk : 6248c609719bSwdenk : 6249c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 6250c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 6251c609719bSwdenk 0x00FC 0000 Malloc Arena 6252c609719bSwdenk : 6253c609719bSwdenk 0x00FD FFFF 6254c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 6255c609719bSwdenk ... eventually: LCD or video framebuffer 6256c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 6257c609719bSwdenk 0x00FF FFFF [End of RAM] 6258c609719bSwdenk 6259c609719bSwdenk 6260c609719bSwdenkSystem Initialization: 6261c609719bSwdenk---------------------- 6262c609719bSwdenk 6263c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 626411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 6265c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory. 62667152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 6267c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 6268c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 6269c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 6270c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 6271c609719bSwdenkthe caches and the SIU. 6272c609719bSwdenk 6273c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 6274c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 6275c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 6276c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 6277c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 6278c609719bSwdenksimple memory test is run that determines the size of the SDRAM 6279c609719bSwdenkbanks. 6280c609719bSwdenk 6281c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 62827152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 6283c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 6284c609719bSwdenk0x00000000, with any additional banks following immediately to create 6285c609719bSwdenkcontiguous memory starting from 0. 6286c609719bSwdenk 6287c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 6288c609719bSwdenkand allocates memory for use by malloc() and for the global Board 6289c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 6290c609719bSwdenkpages, and the final stack is set up. 6291c609719bSwdenk 6292c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 6293c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 6294c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 6295c609719bSwdenknew address in RAM. 6296c609719bSwdenk 6297c609719bSwdenk 6298c609719bSwdenkU-Boot Porting Guide: 6299c609719bSwdenk---------------------- 6300c609719bSwdenk 6301c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 63026aff3115Swdenklist, October 2002] 6303c609719bSwdenk 6304c609719bSwdenk 6305c609719bSwdenkint main(int argc, char *argv[]) 6306c609719bSwdenk{ 6307c609719bSwdenk sighandler_t no_more_time; 6308c609719bSwdenk 6309c609719bSwdenk signal(SIGALRM, no_more_time); 6310c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 6311c609719bSwdenk 6312c609719bSwdenk if (available_money > available_manpower) { 63136c3fef28SJerry Van Baren Pay consultant to port U-Boot; 6314c609719bSwdenk return 0; 6315c609719bSwdenk } 6316c609719bSwdenk 6317c609719bSwdenk Download latest U-Boot source; 6318c609719bSwdenk 63190668236bSWolfgang Denk Subscribe to u-boot mailing list; 63206aff3115Swdenk 63216c3fef28SJerry Van Baren if (clueless) 6322c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 6323c609719bSwdenk 6324c609719bSwdenk while (learning) { 6325c609719bSwdenk Read the README file in the top level directory; 63267cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 63276c3fef28SJerry Van Baren Read applicable doc/*.README; 6328c609719bSwdenk Read the source, Luke; 63296c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 6330c609719bSwdenk } 6331c609719bSwdenk 63326c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 63336c3fef28SJerry Van Baren Buy a BDI3000; 63346c3fef28SJerry Van Baren else 6335c609719bSwdenk Add a lot of aggravation and time; 6336c609719bSwdenk 63376c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 63386c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 63396c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 63406c3fef28SJerry Van Baren } else { 6341c609719bSwdenk Create your own board support subdirectory; 63426c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 63436c3fef28SJerry Van Baren } 63446c3fef28SJerry Van Baren Edit new board/<myboard> files 63456c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 6346c609719bSwdenk 63476c3fef28SJerry Van Baren while (!accepted) { 6348c609719bSwdenk while (!running) { 6349c609719bSwdenk do { 6350c609719bSwdenk Add / modify source code; 6351c609719bSwdenk } until (compiles); 6352c609719bSwdenk Debug; 6353c609719bSwdenk if (clueless) 6354c609719bSwdenk email("Hi, I am having problems..."); 6355c609719bSwdenk } 63566c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 63576c3fef28SJerry Van Baren if (reasonable critiques) 63586c3fef28SJerry Van Baren Incorporate improvements from email list code review; 63596c3fef28SJerry Van Baren else 63606c3fef28SJerry Van Baren Defend code as written; 63616c3fef28SJerry Van Baren } 6362c609719bSwdenk 6363c609719bSwdenk return 0; 6364c609719bSwdenk} 6365c609719bSwdenk 6366c609719bSwdenkvoid no_more_time (int sig) 6367c609719bSwdenk{ 6368c609719bSwdenk hire_a_guru(); 6369c609719bSwdenk} 6370c609719bSwdenk 6371c609719bSwdenk 6372c609719bSwdenkCoding Standards: 6373c609719bSwdenk----------------- 6374c609719bSwdenk 6375c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 63762c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 63777ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 6378c609719bSwdenk 63792c051651SDetlev ZundelSource files originating from a different project (for example the 63802c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 6381b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those 63822c051651SDetlev Zundelsources. 63832c051651SDetlev Zundel 63842c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 63852c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 63862c051651SDetlev Zundelin your code. 6387c609719bSwdenk 6388c178d3daSwdenkPlease also stick to the following formatting rules: 6389180d3f74Swdenk- remove any trailing white space 63907ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 6391180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 63927ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 6393180d3f74Swdenk- do not add trailing empty lines to source files 6394180d3f74Swdenk 6395c609719bSwdenkSubmissions which do not conform to the standards may be returned 6396c609719bSwdenkwith a request to reformat the changes. 6397c609719bSwdenk 6398c609719bSwdenk 6399c609719bSwdenkSubmitting Patches: 6400c609719bSwdenk------------------- 6401c609719bSwdenk 6402c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 6403c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 6404c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 6405c609719bSwdenk 64060d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 6407218ca724SWolfgang Denk 64080668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 64090668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 64100668236bSWolfgang Denk 6411c609719bSwdenkWhen you send a patch, please include the following information with 6412c609719bSwdenkit: 6413c609719bSwdenk 6414c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 6415c609719bSwdenk this bug. Please try to include a way of demonstrating that the 6416c609719bSwdenk patch actually fixes something. 6417c609719bSwdenk 6418c609719bSwdenk* For new features: a description of the feature and your 6419c609719bSwdenk implementation. 6420c609719bSwdenk 6421c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 6422c609719bSwdenk 64237207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your 64247207b366SRobert P. J. Day information and associated file and directory references. 6425c609719bSwdenk 642627af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 642727af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 6428c609719bSwdenk 6429c609719bSwdenk* If your patch adds new configuration options, don't forget to 6430c609719bSwdenk document these in the README file. 6431c609719bSwdenk 6432218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 6433218ca724SWolfgang Denk recommended) you can easily generate the patch using the 64347ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 6435218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 6436218ca724SWolfgang Denk with some other mail clients. 6437c609719bSwdenk 6438218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 6439218ca724SWolfgang Denk diff does not support these options, then get the latest version of 6440218ca724SWolfgang Denk GNU diff. 64416dff5529Swdenk 6442218ca724SWolfgang Denk The current directory when running this command shall be the parent 6443218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 6444218ca724SWolfgang Denk your patch includes sufficient directory information for the 6445218ca724SWolfgang Denk affected files). 6446218ca724SWolfgang Denk 6447218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 6448218ca724SWolfgang Denk and compressed attachments must not be used. 6449c609719bSwdenk 645052f52c14Swdenk* If one logical set of modifications affects or creates several 645152f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 645252f52c14Swdenk 645352f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 645452f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 645552f52c14Swdenk 645652f52c14Swdenk 6457c609719bSwdenkNotes: 6458c609719bSwdenk 64596de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched 6460c609719bSwdenk source tree and make sure that no errors or warnings are reported 6461c609719bSwdenk for any of the boards. 6462c609719bSwdenk 6463c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 6464c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 6465c609719bSwdenk returned with a request to re-formatting / split it. 6466c609719bSwdenk 6467c609719bSwdenk* If you modify existing code, make sure that your new code does not 6468c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 6469c609719bSwdenk When adding new features, these should compile conditionally only 6470c609719bSwdenk (using #ifdef), and the resulting code with the new feature 6471c609719bSwdenk disabled must not need more memory than the old code without your 6472c609719bSwdenk modification. 647390dc6704Swdenk 64740668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 64750668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 64760668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 64770668236bSWolfgang Denk bigger than the size limit should be avoided. 6478