1c609719bSwdenk# 2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5eca3aeb3SWolfgang Denk# SPDX-License-Identifier: GPL-2.0+ 6c609719bSwdenk# 7c609719bSwdenk 8c609719bSwdenkSummary: 9c609719bSwdenk======== 10c609719bSwdenk 1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 14e86e5a07Swdenkinitialize and test the hardware or to download and run application 15e86e5a07Swdenkcode. 16c609719bSwdenk 17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some 1924ee89b9Swdenkheader files in common, and special provision has been made to 20c609719bSwdenksupport booting of Linux images. 21c609719bSwdenk 22c609719bSwdenkSome attention has been paid to make this software easily 23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 24c609719bSwdenkimplemented with the same call interface, so that it's very easy to 25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 27c609719bSwdenkload and run it dynamically. 28c609719bSwdenk 29c609719bSwdenk 30c609719bSwdenkStatus: 31c609719bSwdenk======= 32c609719bSwdenk 33c609719bSwdenkIn general, all boards for which a configuration option exists in the 34c609719bSwdenkMakefile have been tested to some extent and can be considered 35c609719bSwdenk"working". In fact, many of them are used in production systems. 36c609719bSwdenk 377207b366SRobert P. J. DayIn case of problems see the CHANGELOG file to find out who contributed 387207b366SRobert P. J. Daythe specific port. In addition, there are various MAINTAINERS files 397207b366SRobert P. J. Dayscattered throughout the U-Boot source identifying the people or 407207b366SRobert P. J. Daycompanies responsible for various boards and subsystems. 41c609719bSwdenk 427207b366SRobert P. J. DayNote: As of August, 2010, there is no longer a CHANGELOG file in the 437207b366SRobert P. J. Dayactual U-Boot source tree; however, it can be created dynamically 447207b366SRobert P. J. Dayfrom the Git log using: 45adb9d851SRobert P. J. Day 46adb9d851SRobert P. J. Day make CHANGELOG 47adb9d851SRobert P. J. Day 48c609719bSwdenk 49c609719bSwdenkWhere to get help: 50c609719bSwdenk================== 51c609719bSwdenk 52c609719bSwdenkIn case you have questions about, problems with or contributions for 537207b366SRobert P. J. DayU-Boot, you should send a message to the U-Boot mailing list at 540c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 550c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 560c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 570c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 58c609719bSwdenk 59c609719bSwdenk 60218ca724SWolfgang DenkWhere to get source code: 61218ca724SWolfgang Denk========================= 62218ca724SWolfgang Denk 637207b366SRobert P. J. DayThe U-Boot source code is maintained in the Git repository at 64218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 65218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 66218ca724SWolfgang Denk 67218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 6811ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 69218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 70218ca724SWolfgang Denkdirectory. 71218ca724SWolfgang Denk 72d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 73218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 74218ca724SWolfgang Denk 75218ca724SWolfgang Denk 76c609719bSwdenkWhere we come from: 77c609719bSwdenk=================== 78c609719bSwdenk 79c609719bSwdenk- start from 8xxrom sources 8024ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 81c609719bSwdenk- clean up code 82c609719bSwdenk- make it easier to add custom boards 83c609719bSwdenk- make it possible to add other [PowerPC] CPUs 84c609719bSwdenk- extend functions, especially: 85c609719bSwdenk * Provide extended interface to Linux boot loader 86c609719bSwdenk * S-Record download 87c609719bSwdenk * network boot 8811ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 8924ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 90c609719bSwdenk- add other CPU families (starting with ARM) 9124ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 920d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 9324ee89b9Swdenk 9424ee89b9Swdenk 9524ee89b9SwdenkNames and Spelling: 9624ee89b9Swdenk=================== 9724ee89b9Swdenk 9824ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 9924ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 10024ee89b9Swdenkin source files etc.). Example: 10124ee89b9Swdenk 10224ee89b9Swdenk This is the README file for the U-Boot project. 10324ee89b9Swdenk 10424ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 10524ee89b9Swdenk 10624ee89b9Swdenk include/asm-ppc/u-boot.h 10724ee89b9Swdenk 10824ee89b9Swdenk #include <asm/u-boot.h> 10924ee89b9Swdenk 11024ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 11124ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 11224ee89b9Swdenk 11324ee89b9Swdenk U_BOOT_VERSION u_boot_logo 11424ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 115c609719bSwdenk 116c609719bSwdenk 11793f19cc0SwdenkVersioning: 11893f19cc0Swdenk=========== 11993f19cc0Swdenk 120360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 121360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 122360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 123360d883aSThomas Webernames consisting of the calendar year and month of the release date. 124360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 125360d883aSThomas Weberreleases in "stable" maintenance trees. 12693f19cc0Swdenk 127360d883aSThomas WeberExamples: 128360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 129360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 1300de21ecbSJelle van der Waa U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release 13193f19cc0Swdenk 13293f19cc0Swdenk 133c609719bSwdenkDirectory Hierarchy: 134c609719bSwdenk==================== 135c609719bSwdenk 1368d321b81SPeter Tyser/arch Architecture specific files 1376eae68e4SMasahiro Yamada /arc Files generic to ARC architecture 1388d321b81SPeter Tyser /arm Files generic to ARM architecture 1398d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1408d321b81SPeter Tyser /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 37933eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 38033eee330SScott Wood 38133eee330SScott Wood Enables a workaround for erratum A004510. If set, 38233eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 38333eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 38433eee330SScott Wood 38533eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 38633eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 38733eee330SScott Wood 38833eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 38933eee330SScott Wood for which the A004510 workaround should be applied. 39033eee330SScott Wood 39133eee330SScott Wood The rest of SVR is either not relevant to the decision 39233eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 39333eee330SScott Wood p2041) or is implied by the build target, which controls 39433eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 39533eee330SScott Wood 39633eee330SScott Wood See Freescale App Note 4493 for more information about 39733eee330SScott Wood this erratum. 39833eee330SScott Wood 39974fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 40074fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 401b445bbb4SJeremiah Mahler required during NOR boot. 40274fa22edSPrabhakar Kushwaha 4039f074e67SPrabhakar Kushwaha CONFIG_A008044_WORKAROUND 4049f074e67SPrabhakar Kushwaha Enables a workaround for T1040/T1042 erratum A008044. It is only 405b445bbb4SJeremiah Mahler required during NAND boot and valid for Rev 1.0 SoC revision 4069f074e67SPrabhakar Kushwaha 40733eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 40833eee330SScott Wood 40933eee330SScott Wood This is the value to write into CCSR offset 0x18600 41033eee330SScott Wood according to the A004510 workaround. 41133eee330SScott Wood 41264501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 41364501c66SPriyanka Jain This value denotes start offset of DDR memory which is 41464501c66SPriyanka Jain connected exclusively to the DSP cores. 41564501c66SPriyanka Jain 416765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 417765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 418765b0bdbSPriyanka Jain which is directly connected to the DSP core. 419765b0bdbSPriyanka Jain 42064501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 42164501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 42264501c66SPriyanka Jain connected to the DSP core. 42364501c66SPriyanka Jain 424765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 425765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 426765b0bdbSPriyanka Jain 427b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 428b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 429b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 430b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 431b135991aSPriyanka Jain 432fb4a2409SAneesh Bansal CONFIG_SYS_CPC_REINIT_F 433fb4a2409SAneesh Bansal This CONFIG is defined when the CPC is configured as SRAM at the 434a187559eSBin Meng time of U-Boot entry and is required to be re-initialized. 435fb4a2409SAneesh Bansal 436aade2004STang Yuantian CONFIG_DEEP_SLEEP 437b445bbb4SJeremiah Mahler Indicates this SoC supports deep sleep feature. If deep sleep is 438aade2004STang Yuantian supported, core will start to execute uboot when wakes up. 439aade2004STang Yuantian 4406cb461b4SDaniel Schwierzeck- Generic CPU options: 4412a1680e3SYork Sun CONFIG_SYS_GENERIC_GLOBAL_DATA 4422a1680e3SYork Sun Defines global data is initialized in generic board board_init_f(). 4432a1680e3SYork Sun If this macro is defined, global data is created and cleared in 4442a1680e3SYork Sun generic board board_init_f(). Without this macro, architecture/board 4452a1680e3SYork Sun should initialize global data before calling board_init_f(). 4462a1680e3SYork Sun 4476cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4486cb461b4SDaniel Schwierzeck 4496cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4506cb461b4SDaniel Schwierzeck values is arch specific. 4516cb461b4SDaniel Schwierzeck 4525614e71bSYork Sun CONFIG_SYS_FSL_DDR 4535614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4545614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4555614e71bSYork Sun SoCs. 4565614e71bSYork Sun 4575614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4585614e71bSYork Sun Freescale DDR memory-mapped register base. 4595614e71bSYork Sun 4605614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4615614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4625614e71bSYork Sun deskew training are not available. 4635614e71bSYork Sun 4645614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4655614e71bSYork Sun Freescale DDR1 controller. 4665614e71bSYork Sun 4675614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4685614e71bSYork Sun Freescale DDR2 controller. 4695614e71bSYork Sun 4705614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 4715614e71bSYork Sun Freescale DDR3 controller. 4725614e71bSYork Sun 47334e026f9SYork Sun CONFIG_SYS_FSL_DDRC_GEN4 47434e026f9SYork Sun Freescale DDR4 controller. 47534e026f9SYork Sun 4769ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 4779ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 4789ac4ffbdSYork Sun 4795614e71bSYork Sun CONFIG_SYS_FSL_DDR1 4805614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 4815614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 4825614e71bSYork Sun implemetation. 4835614e71bSYork Sun 4845614e71bSYork Sun CONFIG_SYS_FSL_DDR2 48562a3b7ddSRobert P. J. Day Board config to use DDR2. It can be enabled for SoCs with 4865614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 4875614e71bSYork Sun implementation. 4885614e71bSYork Sun 4895614e71bSYork Sun CONFIG_SYS_FSL_DDR3 4905614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 49134e026f9SYork Sun Freescale DDR3 or DDR3L controllers. 49234e026f9SYork Sun 49334e026f9SYork Sun CONFIG_SYS_FSL_DDR3L 49434e026f9SYork Sun Board config to use DDR3L. It can be enabled for SoCs with 49534e026f9SYork Sun DDR3L controllers. 49634e026f9SYork Sun 49734e026f9SYork Sun CONFIG_SYS_FSL_DDR4 49834e026f9SYork Sun Board config to use DDR4. It can be enabled for SoCs with 49934e026f9SYork Sun DDR4 controllers. 5005614e71bSYork Sun 5011b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_BE 5021b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Big Endian 5031b4175d6SPrabhakar Kushwaha 5041b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_LE 5051b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Little Endian 5061b4175d6SPrabhakar Kushwaha 5071c40707eSPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_CLK_DIV 5081c40707eSPrabhakar Kushwaha Defines divider of platform clock(clock input to IFC controller). 5091c40707eSPrabhakar Kushwaha 510*add63f94SPrabhakar Kushwaha CONFIG_SYS_FSL_LBC_CLK_DIV 511*add63f94SPrabhakar Kushwaha Defines divider of platform clock(clock input to eLBC controller). 512*add63f94SPrabhakar Kushwaha 513690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_PBI 514690e4258SPrabhakar Kushwaha It enables addition of RCW (Power on reset configuration) in built image. 515690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 516690e4258SPrabhakar Kushwaha 517690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_RCW 518690e4258SPrabhakar Kushwaha It adds PBI(pre-boot instructions) commands in u-boot build image. 519690e4258SPrabhakar Kushwaha PBI commands can be used to configure SoC before it starts the execution. 520690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 521690e4258SPrabhakar Kushwaha 52289ad7be8SPrabhakar Kushwaha CONFIG_SPL_FSL_PBL 52389ad7be8SPrabhakar Kushwaha It adds a target to create boot binary having SPL binary in PBI format 52489ad7be8SPrabhakar Kushwaha concatenated with u-boot binary. 52589ad7be8SPrabhakar Kushwaha 5264e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_BE 5274e5b1bd0SYork Sun Defines the DDR controller register space as Big Endian 5284e5b1bd0SYork Sun 5294e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_LE 5304e5b1bd0SYork Sun Defines the DDR controller register space as Little Endian 5314e5b1bd0SYork Sun 5326b9e309aSYork Sun CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 5336b9e309aSYork Sun Physical address from the view of DDR controllers. It is the 5346b9e309aSYork Sun same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 5356b9e309aSYork Sun it could be different for ARM SoCs. 5366b9e309aSYork Sun 5376b1e1254SYork Sun CONFIG_SYS_FSL_DDR_INTLV_256B 5386b1e1254SYork Sun DDR controller interleaving on 256-byte. This is a special 5396b1e1254SYork Sun interleaving mode, handled by Dickens for Freescale layerscape 5406b1e1254SYork Sun SoCs with ARM core. 5416b1e1254SYork Sun 5421d71efbbSYork Sun CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS 5431d71efbbSYork Sun Number of controllers used as main memory. 5441d71efbbSYork Sun 5451d71efbbSYork Sun CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS 5461d71efbbSYork Sun Number of controllers used for other than main memory. 5471d71efbbSYork Sun 54844937214SPrabhakar Kushwaha CONFIG_SYS_FSL_HAS_DP_DDR 54944937214SPrabhakar Kushwaha Defines the SoC has DP-DDR used for DPAA. 55044937214SPrabhakar Kushwaha 551028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_BE 552028dbb8dSRuchika Gupta Defines the SEC controller register space as Big Endian 553028dbb8dSRuchika Gupta 554028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_LE 555028dbb8dSRuchika Gupta Defines the SEC controller register space as Little Endian 556028dbb8dSRuchika Gupta 55792bbd64eSDaniel Schwierzeck- MIPS CPU options: 55892bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 55992bbd64eSDaniel Schwierzeck 56092bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 56192bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 56292bbd64eSDaniel Schwierzeck relocation. 56392bbd64eSDaniel Schwierzeck 56492bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 56592bbd64eSDaniel Schwierzeck 56692bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 56792bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 56892bbd64eSDaniel Schwierzeck Possible values are: 56992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 57092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 57192bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 57292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 57392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 57492bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 57592bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 57692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 57792bbd64eSDaniel Schwierzeck 57892bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 57992bbd64eSDaniel Schwierzeck 58092bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 58192bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 58292bbd64eSDaniel Schwierzeck 58392bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 58492bbd64eSDaniel Schwierzeck 58592bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 58692bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 58792bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 58892bbd64eSDaniel Schwierzeck 589b67d8816SChristian Riesch- ARM options: 590b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 591b67d8816SChristian Riesch 592b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 593b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 594b67d8816SChristian Riesch 5955356f545SAneesh V CONFIG_SYS_THUMB_BUILD 5965356f545SAneesh V 5975356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 5985356f545SAneesh V set for ARM architectures. Thumb instruction set provides 5995356f545SAneesh V better code density. For ARM architectures that support 6005356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 6015356f545SAneesh V GCC. 6025356f545SAneesh V 603c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 6040678587fSStephen Warren CONFIG_ARM_ERRATA_742230 6050678587fSStephen Warren CONFIG_ARM_ERRATA_743622 6060678587fSStephen Warren CONFIG_ARM_ERRATA_751472 607b7588e3bSNitin Garg CONFIG_ARM_ERRATA_761320 608e392b923SIan Campbell CONFIG_ARM_ERRATA_773022 609e392b923SIan Campbell CONFIG_ARM_ERRATA_774769 610e392b923SIan Campbell CONFIG_ARM_ERRATA_794072 6110678587fSStephen Warren 6120678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 6130678587fSStephen Warren during U-Boot startup. Note that these options force the 6140678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 6150678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 6160678587fSStephen Warren set these options unless they apply! 6170678587fSStephen Warren 618207774b2SYork Sun COUNTER_FREQUENCY 619207774b2SYork Sun Generic timer clock source frequency. 620207774b2SYork Sun 621207774b2SYork Sun COUNTER_FREQUENCY_REAL 622207774b2SYork Sun Generic timer clock source frequency if the real clock is 623207774b2SYork Sun different from COUNTER_FREQUENCY, and can only be determined 624207774b2SYork Sun at run time. 625207774b2SYork Sun 626c616a0dfSNishanth Menon NOTE: The following can be machine specific errata. These 627c616a0dfSNishanth Menon do have ability to provide rudimentary version and machine 628c616a0dfSNishanth Menon specific checks, but expect no product checks. 6295902f4ceSNishanth Menon CONFIG_ARM_ERRATA_430973 630b45c48a7SNishanth Menon CONFIG_ARM_ERRATA_454179 6319b4d65f9SNishanth Menon CONFIG_ARM_ERRATA_621766 632c616a0dfSNishanth Menon CONFIG_ARM_ERRATA_798870 633a615d0beSNishanth Menon CONFIG_ARM_ERRATA_801819 634c616a0dfSNishanth Menon 63573c38934SStephen Warren- Tegra SoC options: 63673c38934SStephen Warren CONFIG_TEGRA_SUPPORT_NON_SECURE 63773c38934SStephen Warren 63873c38934SStephen Warren Support executing U-Boot in non-secure (NS) mode. Certain 63973c38934SStephen Warren impossible actions will be skipped if the CPU is in NS mode, 64073c38934SStephen Warren such as ARM architectural timer initialization. 64173c38934SStephen Warren 6425da627a4Swdenk- Linux Kernel Interface: 643c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 644c609719bSwdenk 645c609719bSwdenk U-Boot stores all clock information in Hz 646c609719bSwdenk internally. For binary compatibility with older Linux 647c609719bSwdenk kernels (which expect the clocks passed in the 648c609719bSwdenk bd_info data to be in MHz) the environment variable 649c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 650c609719bSwdenk converts clock data to MHZ before passing it to the 651c609719bSwdenk Linux kernel. 652c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 653c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 654c609719bSwdenk default environment. 655c609719bSwdenk 6565da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 6575da627a4Swdenk 658b445bbb4SJeremiah Mahler When transferring memsize parameter to Linux, some versions 6595da627a4Swdenk expect it to be in bytes, others in MB. 6605da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 6615da627a4Swdenk 662fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 663f57f70aaSWolfgang Denk 664f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 665213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 666213bf8c8SGerald Van Baren concepts). 667213bf8c8SGerald Van Baren 668213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 669213bf8c8SGerald Van Baren * New libfdt-based support 670213bf8c8SGerald Van Baren * Adds the "fdt" command 6713bb342fcSKim Phillips * The bootm command automatically updates the fdt 672213bf8c8SGerald Van Baren 673b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 674b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 675b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 676b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 677f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 678c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 679f57f70aaSWolfgang Denk 68011ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 68111ccc33fSMarcel Ziswiler addresses 6823bb342fcSKim Phillips 6834e253137SKumar Gala CONFIG_OF_BOARD_SETUP 6844e253137SKumar Gala 6854e253137SKumar Gala Board code has addition modification that it wants to make 6864e253137SKumar Gala to the flat device tree before handing it off to the kernel 6876705d81eSwdenk 688c654b517SSimon Glass CONFIG_OF_SYSTEM_SETUP 689c654b517SSimon Glass 690c654b517SSimon Glass Other code has addition modification that it wants to make 691c654b517SSimon Glass to the flat device tree before handing it off to the kernel. 692c654b517SSimon Glass This causes ft_system_setup() to be called before booting 693c654b517SSimon Glass the kernel. 694c654b517SSimon Glass 6953887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 6963887c3fbSHeiko Schocher 6973887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 6983887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 6993887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 7003887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 7013887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 7023887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 7033887c3fbSHeiko Schocher 7047eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 7057eb29398SIgor Grinberg 7067eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 7077eb29398SIgor Grinberg machine type and must be used to specify the machine type 7087eb29398SIgor Grinberg number as it appears in the ARM machine registry 7097eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 7107eb29398SIgor Grinberg Only boards that have multiple machine types supported 7117eb29398SIgor Grinberg in a single configuration file and the machine type is 7127eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 7137eb29398SIgor Grinberg 7140b2f4ecaSNiklaus Giger- vxWorks boot parameters: 7150b2f4ecaSNiklaus Giger 7160b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 7179e98b7e3SBin Meng environments variables: bootdev, bootfile, ipaddr, netmask, 7189e98b7e3SBin Meng serverip, gatewayip, hostname, othbootargs. 7190b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 7200b2f4ecaSNiklaus Giger 7210b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 7220b2f4ecaSNiklaus Giger the defaults discussed just above. 7230b2f4ecaSNiklaus Giger 7242c451f78SAneesh V- Cache Configuration: 7252c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 7262c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 7272c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 7282c451f78SAneesh V 72993bc2193SAneesh V- Cache Configuration for ARM: 73093bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 73193bc2193SAneesh V controller 73293bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 73393bc2193SAneesh V controller register space 73493bc2193SAneesh V 7356705d81eSwdenk- Serial Ports: 73648d0192fSAndreas Engel CONFIG_PL010_SERIAL 7376705d81eSwdenk 7386705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 7396705d81eSwdenk 74048d0192fSAndreas Engel CONFIG_PL011_SERIAL 7416705d81eSwdenk 7426705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 7436705d81eSwdenk 7446705d81eSwdenk CONFIG_PL011_CLOCK 7456705d81eSwdenk 7466705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 7476705d81eSwdenk the clock speed of the UARTs. 7486705d81eSwdenk 7496705d81eSwdenk CONFIG_PL01x_PORTS 7506705d81eSwdenk 7516705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 7526705d81eSwdenk define this to a list of base addresses for each (supported) 7536705d81eSwdenk port. See e.g. include/configs/versatile.h 7546705d81eSwdenk 755d57dee57SKaricheri, Muralidharan CONFIG_SERIAL_HW_FLOW_CONTROL 756d57dee57SKaricheri, Muralidharan 757d57dee57SKaricheri, Muralidharan Define this variable to enable hw flow control in serial driver. 758d57dee57SKaricheri, Muralidharan Current user of this option is drivers/serial/nsl16550.c driver 7596705d81eSwdenk 760c609719bSwdenk- Console Interface: 761c609719bSwdenk Depending on board, define exactly one serial port 762c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 763c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 764c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 765c609719bSwdenk 766c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 767c609719bSwdenk port routines must be defined elsewhere 768c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 769c609719bSwdenk 770c609719bSwdenk- Console Baudrate: 771c609719bSwdenk CONFIG_BAUDRATE - in bps 772c609719bSwdenk Select one of the baudrates listed in 7736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 7746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 775c609719bSwdenk 776c92fac91SHeiko Schocher- Console Rx buffer length 777c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 778c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 7792b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 780c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 781c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 782c92fac91SHeiko Schocher the SMC. 783c92fac91SHeiko Schocher 784c609719bSwdenk- Autoboot Command: 785c609719bSwdenk CONFIG_BOOTCOMMAND 786c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 787c609719bSwdenk define a command string that is automatically executed 788c609719bSwdenk when no character is read on the console interface 789c609719bSwdenk within "Boot Delay" after reset. 790c609719bSwdenk 791c609719bSwdenk CONFIG_BOOTARGS 792c609719bSwdenk This can be used to pass arguments to the bootm 793c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 794c609719bSwdenk environment value "bootargs". 795c609719bSwdenk 796c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 797c609719bSwdenk The value of these goes into the environment as 798c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 799c609719bSwdenk as a convenience, when switching between booting from 80011ccc33fSMarcel Ziswiler RAM and NFS. 801c609719bSwdenk 802eda0ba38SHeiko Schocher- Bootcount: 803eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 804eda0ba38SHeiko Schocher Implements a mechanism for detecting a repeating reboot 805eda0ba38SHeiko Schocher cycle, see: 806eda0ba38SHeiko Schocher http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 807eda0ba38SHeiko Schocher 808eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_ENV 809eda0ba38SHeiko Schocher If no softreset save registers are found on the hardware 810eda0ba38SHeiko Schocher "bootcount" is stored in the environment. To prevent a 811eda0ba38SHeiko Schocher saveenv on all reboots, the environment variable 812eda0ba38SHeiko Schocher "upgrade_available" is used. If "upgrade_available" is 813eda0ba38SHeiko Schocher 0, "bootcount" is always 0, if "upgrade_available" is 814eda0ba38SHeiko Schocher 1 "bootcount" is incremented in the environment. 815eda0ba38SHeiko Schocher So the Userspace Applikation must set the "upgrade_available" 816eda0ba38SHeiko Schocher and "bootcount" variable to 0, if a boot was successfully. 817eda0ba38SHeiko Schocher 818c609719bSwdenk- Pre-Boot Commands: 819c609719bSwdenk CONFIG_PREBOOT 820c609719bSwdenk 821c609719bSwdenk When this option is #defined, the existence of the 822c609719bSwdenk environment variable "preboot" will be checked 823c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 824c609719bSwdenk countdown and/or running the auto-boot command resp. 825c609719bSwdenk entering interactive mode. 826c609719bSwdenk 827c609719bSwdenk This feature is especially useful when "preboot" is 828c609719bSwdenk automatically generated or modified. For an example 829c609719bSwdenk see the LWMON board specific code: here "preboot" is 830c609719bSwdenk modified when the user holds down a certain 831c609719bSwdenk combination of keys on the (special) keyboard when 832c609719bSwdenk booting the systems 833c609719bSwdenk 834c609719bSwdenk- Serial Download Echo Mode: 835c609719bSwdenk CONFIG_LOADS_ECHO 836c609719bSwdenk If defined to 1, all characters received during a 837c609719bSwdenk serial download (using the "loads" command) are 838c609719bSwdenk echoed back. This might be needed by some terminal 839c609719bSwdenk emulations (like "cu"), but may as well just take 840c609719bSwdenk time on others. This setting #define's the initial 841c609719bSwdenk value of the "loads_echo" environment variable. 842c609719bSwdenk 843602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 844c609719bSwdenk CONFIG_KGDB_BAUDRATE 845c609719bSwdenk Select one of the baudrates listed in 8466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 847c609719bSwdenk 848c609719bSwdenk- Monitor Functions: 849602ad3b3SJon Loeliger Monitor commands can be included or excluded 850602ad3b3SJon Loeliger from the build by using the #include files 851c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 852ef0f2f57SJoe Hershberger commands, or adding #define's for wanted commands. 853c609719bSwdenk 854602ad3b3SJon Loeliger The default command configuration includes all commands 855602ad3b3SJon Loeliger except those marked below with a "*". 856602ad3b3SJon Loeliger 857b401b73dSMarek Vasut CONFIG_CMD_AES AES 128 CBC encrypt/decrypt 858602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 859602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 860602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 861602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 862602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 863602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 864d2b2ffe3STom Rini CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support 865602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 86608d0d6f3SMichal Simek CONFIG_CMD_CLK * clock command support 867602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 868710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 869602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 870602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 871602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 872a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 873a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 874a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 875a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 876602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 877602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 878246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 879602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 880aa9e6044SNikita Kiryanov CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands 881602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 8825e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 883fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 88488733e2cSAndrew Ruder CONFIG_CMD_ENV_EXISTS * check existence of env variable 8850c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 88603e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 88703e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 88816f4d933SStephen Warren CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls) 88916f4d933SStephen Warren that work for multiple fs types 89059e890efSChristian Gmeiner CONFIG_CMD_FS_UUID * Look up a filesystem UUID 891bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 892602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 89303e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 894602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 895602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 8964d98b5c8SVincent Stehlé CONFIG_CMD_FUSE * Device fuse support 89753fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 898a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 899a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 900bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 901602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 902602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 903602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 9048fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 9054d98b5c8SVincent Stehlé CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 906602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 907aa53233aSSimon Glass CONFIG_CMD_IOTRACE * I/O tracing for debugging 9080c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 909c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 910602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 911602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 912602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 913602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 9144d98b5c8SVincent Stehlé CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 915d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 916d22c338eSJoe Hershberger (169.254.*.*) 917602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 918602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 9194d98b5c8SVincent Stehlé CONFIG_CMD_MD5SUM * print md5 message digest 92002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 92115a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 922602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 923a2681707SWolfgang Denk loop, loopw 9244d98b5c8SVincent Stehlé CONFIG_CMD_MEMTEST * mtest 925602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 926602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 927602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 92868d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 929602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 930602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 9314d98b5c8SVincent Stehlé CONFIG_CMD_NFS NFS support 932e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 933e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 934602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 935602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 936602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 937602ad3b3SJon Loeliger host 938602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 939ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 940602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 941602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 942d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 943602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 944c649e3c9SSimon Glass CONFIG_SCSI * SCSI Support 945602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 946602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 947602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 948602ad3b3SJon Loeliger (4xx only) 949f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 9504d98b5c8SVincent Stehlé CONFIG_CMD_SHA1SUM * print sha1 memory digest 95102c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 9527d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 95374de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 954602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 9557a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 9561fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 957da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 958da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 959602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 960602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 961c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 9624d98b5c8SVincent Stehlé CONFIG_CMD_XIMG Load part of Multi Image 96389c8230dSPrzemyslaw Marczak CONFIG_CMD_UUID * Generate random UUID or GUID string 964c609719bSwdenk 965c609719bSwdenk EXAMPLE: If you want all functions except of network 966c609719bSwdenk support you can write: 967c609719bSwdenk 968602ad3b3SJon Loeliger #include "config_cmd_all.h" 969602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 970c609719bSwdenk 971213bf8c8SGerald Van Baren Other Commands: 972213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 973c609719bSwdenk 974c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 975602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 976c609719bSwdenk what you (and your U-Boot users) are doing. Data 977c609719bSwdenk cache cannot be enabled on systems like the 8xx or 978c609719bSwdenk 8260 (where accesses to the IMMR region must be 979c609719bSwdenk uncached), and it cannot be disabled on all other 980c609719bSwdenk systems where we (mis-) use the data cache to hold an 981c609719bSwdenk initial stack and some data. 982c609719bSwdenk 983c609719bSwdenk 984c609719bSwdenk XXX - this list needs to get updated! 985c609719bSwdenk 986302a6487SSimon Glass- Removal of commands 987302a6487SSimon Glass If no commands are needed to boot, you can disable 988302a6487SSimon Glass CONFIG_CMDLINE to remove them. In this case, the command line 989302a6487SSimon Glass will not be available, and when U-Boot wants to execute the 990302a6487SSimon Glass boot command (on start-up) it will call board_run_command() 991302a6487SSimon Glass instead. This can reduce image size significantly for very 992302a6487SSimon Glass simple boot procedures. 993302a6487SSimon Glass 994a5ecbe62SWolfgang Denk- Regular expression support: 995a5ecbe62SWolfgang Denk CONFIG_REGEX 996a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 997a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 998a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 999a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 1000a5ecbe62SWolfgang Denk 100145ba8077SSimon Glass- Device tree: 100245ba8077SSimon Glass CONFIG_OF_CONTROL 100345ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 100445ba8077SSimon Glass to configure its devices, instead of relying on statically 100545ba8077SSimon Glass compiled #defines in the board file. This option is 100645ba8077SSimon Glass experimental and only available on a few boards. The device 100745ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 100845ba8077SSimon Glass 10092c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 10102c0f79e4SSimon Glass be done using one of the two options below: 1011bbb0b128SSimon Glass 1012bbb0b128SSimon Glass CONFIG_OF_EMBED 1013bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 1014bbb0b128SSimon Glass binary in its image. This device tree file should be in the 1015bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 1016bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 1017bbb0b128SSimon Glass the global data structure as gd->blob. 101845ba8077SSimon Glass 10192c0f79e4SSimon Glass CONFIG_OF_SEPARATE 10202c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 10212c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 10222c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 10232c0f79e4SSimon Glass 10242c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 10252c0f79e4SSimon Glass 10262c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 10272c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 10282c0f79e4SSimon Glass still use the individual files if you need something more 10292c0f79e4SSimon Glass exotic. 10302c0f79e4SSimon Glass 1031c609719bSwdenk- Watchdog: 1032c609719bSwdenk CONFIG_WATCHDOG 1033c609719bSwdenk If this variable is defined, it enables watchdog 10346abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 10356abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 10366abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 10376abe6fb6SDetlev Zundel register. When supported for a specific SoC is 10386abe6fb6SDetlev Zundel available, then no further board specific code should 10396abe6fb6SDetlev Zundel be needed to use it. 10406abe6fb6SDetlev Zundel 10416abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 10426abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 10436abe6fb6SDetlev Zundel SoC, then define this variable and provide board 10446abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 1045c609719bSwdenk 10467bae0d6fSHeiko Schocher CONFIG_AT91_HW_WDT_TIMEOUT 10477bae0d6fSHeiko Schocher specify the timeout in seconds. default 2 seconds. 10487bae0d6fSHeiko Schocher 1049c1551ea8Sstroese- U-Boot Version: 1050c1551ea8Sstroese CONFIG_VERSION_VARIABLE 1051c1551ea8Sstroese If this variable is defined, an environment variable 1052c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 1053c1551ea8Sstroese version as printed by the "version" command. 1054a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 1055a1ea8e51SBenoît Thébaudeau next reset. 1056c1551ea8Sstroese 1057c609719bSwdenk- Real-Time Clock: 1058c609719bSwdenk 1059602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1060c609719bSwdenk has to be selected, too. Define exactly one of the 1061c609719bSwdenk following options: 1062c609719bSwdenk 1063c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1064c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 10654e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1066c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 10671cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1068c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 10697f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 1070412921d2SMarkus Niebel CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC 10713bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 10729536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 10734c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 10746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 107571d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 107671d19f30SHeiko Schocher RV3029 RTC. 1077c609719bSwdenk 1078b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1079b37c7e5eSwdenk must also be configured. See I2C Support, below. 1080b37c7e5eSwdenk 1081e92739d3SPeter Tyser- GPIO Support: 1082e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1083e92739d3SPeter Tyser 10845dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 10855dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 10865dec49caSChris Packham pins supported by a particular chip. 10875dec49caSChris Packham 1088e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1089e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1090e92739d3SPeter Tyser 1091aa53233aSSimon Glass- I/O tracing: 1092aa53233aSSimon Glass When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O 1093aa53233aSSimon Glass accesses and can checksum them or write a list of them out 1094aa53233aSSimon Glass to memory. See the 'iotrace' command for details. This is 1095aa53233aSSimon Glass useful for testing device drivers since it can confirm that 1096aa53233aSSimon Glass the driver behaves the same way before and after a code 1097aa53233aSSimon Glass change. Currently this is supported on sandbox and arm. To 1098aa53233aSSimon Glass add support for your architecture, add '#include <iotrace.h>' 1099aa53233aSSimon Glass to the bottom of arch/<arch>/include/asm/io.h and test. 1100aa53233aSSimon Glass 1101aa53233aSSimon Glass Example output from the 'iotrace stats' command is below. 1102aa53233aSSimon Glass Note that if the trace buffer is exhausted, the checksum will 1103aa53233aSSimon Glass still continue to operate. 1104aa53233aSSimon Glass 1105aa53233aSSimon Glass iotrace is enabled 1106aa53233aSSimon Glass Start: 10000000 (buffer start address) 1107aa53233aSSimon Glass Size: 00010000 (buffer size) 1108aa53233aSSimon Glass Offset: 00000120 (current buffer offset) 1109aa53233aSSimon Glass Output: 10000120 (start + offset) 1110aa53233aSSimon Glass Count: 00000018 (number of trace records) 1111aa53233aSSimon Glass CRC32: 9526fb66 (CRC32 of all trace records) 1112aa53233aSSimon Glass 1113c609719bSwdenk- Timestamp Support: 1114c609719bSwdenk 1115c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1116c609719bSwdenk (date and time) of an image is printed by image 1117c609719bSwdenk commands like bootm or iminfo. This option is 1118602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1119c609719bSwdenk 1120923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1121923c46f9SKarl O. Pinc Zero or more of the following: 1122923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1123923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1124923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1125923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1126923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1127923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1128923c46f9SKarl O. Pinc disk/part_efi.c 1129923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1130c609719bSwdenk 1131602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1132c649e3c9SSimon Glass CONFIG_SCSI) you must configure support for at 1133923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1134c609719bSwdenk 1135c609719bSwdenk- IDE Reset method: 11364d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 11374d13cbadSwdenk board configurations files but used nowhere! 1138c609719bSwdenk 11394d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 11404d13cbadSwdenk be performed by calling the function 11414d13cbadSwdenk ide_set_reset(int reset) 11424d13cbadSwdenk which has to be defined in a board specific file 1143c609719bSwdenk 1144c609719bSwdenk- ATAPI Support: 1145c609719bSwdenk CONFIG_ATAPI 1146c609719bSwdenk 1147c609719bSwdenk Set this to enable ATAPI support. 1148c609719bSwdenk 1149c40b2956Swdenk- LBA48 Support 1150c40b2956Swdenk CONFIG_LBA48 1151c40b2956Swdenk 1152c40b2956Swdenk Set this to enable support for disks larger than 137GB 11534b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1154c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1155c40b2956Swdenk support disks up to 2.1TB. 1156c40b2956Swdenk 11576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1158c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1159c40b2956Swdenk Default is 32bit. 1160c40b2956Swdenk 1161c609719bSwdenk- SCSI Support: 1162c609719bSwdenk At the moment only there is only support for the 1163c609719bSwdenk SYM53C8XX SCSI controller; define 1164c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1165c609719bSwdenk 11666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 11676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 11686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1169c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1170c609719bSwdenk devices. 11716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1172c609719bSwdenk 1173447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1174447c031bSStefan Reinauer SCSI devices found during the last scan. 1175447c031bSStefan Reinauer 1176c609719bSwdenk- NETWORK Support (PCI): 1177682011ffSwdenk CONFIG_E1000 1178ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1179ce5207e1SKyle Moffett 1180ce5207e1SKyle Moffett CONFIG_E1000_SPI 1181ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1182ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1183ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1184ce5207e1SKyle Moffett 1185ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1186ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1187ce5207e1SKyle Moffett example with the "sspi" command. 1188ce5207e1SKyle Moffett 1189ce5207e1SKyle Moffett CONFIG_CMD_E1000 1190ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1191ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1192682011ffSwdenk 1193c609719bSwdenk CONFIG_EEPRO100 1194c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 119511ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1196c609719bSwdenk write routine for first time initialisation. 1197c609719bSwdenk 1198c609719bSwdenk CONFIG_TULIP 1199c609719bSwdenk Support for Digital 2114x chips. 1200c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1201c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1202c609719bSwdenk 1203c609719bSwdenk CONFIG_NATSEMI 1204c609719bSwdenk Support for National dp83815 chips. 1205c609719bSwdenk 1206c609719bSwdenk CONFIG_NS8382X 1207c609719bSwdenk Support for National dp8382[01] gigabit chips. 1208c609719bSwdenk 120945219c46Swdenk- NETWORK Support (other): 121045219c46Swdenk 1211c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1212c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1213c041e9d2SJens Scharsig 1214c041e9d2SJens Scharsig CONFIG_RMII 1215c041e9d2SJens Scharsig Define this to use reduced MII inteface 1216c041e9d2SJens Scharsig 1217c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1218c041e9d2SJens Scharsig If this defined, the driver is quiet. 1219c041e9d2SJens Scharsig The driver doen't show link status messages. 1220c041e9d2SJens Scharsig 1221efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1222efdd7319SRob Herring Support for the Calxeda XGMAC device 1223efdd7319SRob Herring 12243bb46d23SAshok CONFIG_LAN91C96 122545219c46Swdenk Support for SMSC's LAN91C96 chips. 122645219c46Swdenk 122745219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 122845219c46Swdenk Define this to enable 32 bit addressing 122945219c46Swdenk 12303bb46d23SAshok CONFIG_SMC91111 1231f39748aeSwdenk Support for SMSC's LAN91C111 chip 1232f39748aeSwdenk 1233f39748aeSwdenk CONFIG_SMC91111_BASE 1234f39748aeSwdenk Define this to hold the physical address 1235f39748aeSwdenk of the device (I/O space) 1236f39748aeSwdenk 1237f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1238f39748aeSwdenk Define this if data bus is 32 bits 1239f39748aeSwdenk 1240f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1241f39748aeSwdenk Define this to use i/o functions instead of macros 1242f39748aeSwdenk (some hardware wont work with macros) 1243f39748aeSwdenk 1244dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1245dc02badaSHeiko Schocher Support for davinci emac 1246dc02badaSHeiko Schocher 1247dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1248dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1249dc02badaSHeiko Schocher 1250b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1251b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1252b3dbf4a5SMacpaul Lin 1253b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1254b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1255b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1256b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1257b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1258b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1259b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1260b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1261b3dbf4a5SMacpaul Lin 1262c2fff331SMike Rapoport CONFIG_SMC911X 1263557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1264557b377dSJens Gehrlein 1265c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1266557b377dSJens Gehrlein Define this to hold the physical address 1267557b377dSJens Gehrlein of the device (I/O space) 1268557b377dSJens Gehrlein 1269c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1270557b377dSJens Gehrlein Define this if data bus is 32 bits 1271557b377dSJens Gehrlein 1272c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1273557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1274557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1275c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1276557b377dSJens Gehrlein 12773d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 12783d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 12793d0075faSYoshihiro Shimoda 12803d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 12813d0075faSYoshihiro Shimoda Define the number of ports to be used 12823d0075faSYoshihiro Shimoda 12833d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 12843d0075faSYoshihiro Shimoda Define the ETH PHY's address 12853d0075faSYoshihiro Shimoda 128668260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 128768260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 128868260aabSYoshihiro Shimoda 1289b2f97cf2SHeiko Schocher- PWM Support: 1290b2f97cf2SHeiko Schocher CONFIG_PWM_IMX 12915052e819SRobert P. J. Day Support for PWM module on the imx6. 1292b2f97cf2SHeiko Schocher 12935e124724SVadim Bendebury- TPM Support: 129490899cc0SChe-liang Chiou CONFIG_TPM 129590899cc0SChe-liang Chiou Support TPM devices. 129690899cc0SChe-liang Chiou 12970766ad2fSChristophe Ricard CONFIG_TPM_TIS_INFINEON 12980766ad2fSChristophe Ricard Support for Infineon i2c bus TPM devices. Only one device 12991b393db5STom Wai-Hong Tam per system is supported at this time. 13001b393db5STom Wai-Hong Tam 13011b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 13021b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 13031b393db5STom Wai-Hong Tam 13043aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24 13053aa74088SChristophe Ricard Support for STMicroelectronics TPM devices. Requires DM_TPM support. 13063aa74088SChristophe Ricard 13073aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24_I2C 13083aa74088SChristophe Ricard Support for STMicroelectronics ST33ZP24 I2C devices. 13093aa74088SChristophe Ricard Requires TPM_ST33ZP24 and I2C. 13103aa74088SChristophe Ricard 1311b75fdc11SChristophe Ricard CONFIG_TPM_ST33ZP24_SPI 1312b75fdc11SChristophe Ricard Support for STMicroelectronics ST33ZP24 SPI devices. 1313b75fdc11SChristophe Ricard Requires TPM_ST33ZP24 and SPI. 1314b75fdc11SChristophe Ricard 1315c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1316c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1317c01939c7SDirk Eibach 131890899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 13195e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 13205e124724SVadim Bendebury per system is supported at this time. 13215e124724SVadim Bendebury 13225e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 13235e124724SVadim Bendebury Base address where the generic TPM device is mapped 13245e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 13255e124724SVadim Bendebury 0xfed40000. 13265e124724SVadim Bendebury 1327be6c1529SReinhard Pfau CONFIG_CMD_TPM 1328be6c1529SReinhard Pfau Add tpm monitor functions. 1329be6c1529SReinhard Pfau Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1330be6c1529SReinhard Pfau provides monitor access to authorized functions. 1331be6c1529SReinhard Pfau 1332be6c1529SReinhard Pfau CONFIG_TPM 1333be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1334be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1335be6c1529SReinhard Pfau Requires support for a TPM device. 1336be6c1529SReinhard Pfau 1337be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1338be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1339be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1340be6c1529SReinhard Pfau 1341c609719bSwdenk- USB Support: 1342c609719bSwdenk At the moment only the UHCI host controller is 13434d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1344c609719bSwdenk CONFIG_USB_UHCI to enable it. 1345c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 134630d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1347c609719bSwdenk storage devices. 1348c609719bSwdenk Note: 1349c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1350c609719bSwdenk (TEAC FD-05PUB). 13514d13cbadSwdenk MPC5200 USB requires additional defines: 13524d13cbadSwdenk CONFIG_USB_CLOCK 13534d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1354307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1355307ecb6dSEric Millbrandt for USB on PSC3 13564d13cbadSwdenk CONFIG_USB_CONFIG 13574d13cbadSwdenk for differential drivers: 0x00001000 13584d13cbadSwdenk for single ended drivers: 0x00005000 1359307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1360307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 13616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1362fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1363fdcfaa1bSZhang Wei instead of using asynchronous interrupts 13644d13cbadSwdenk 13659ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 13669ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 13679ab4ce22SSimon Glass 13686e9e0626SOleksandr Tymoshenko CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 13696e9e0626SOleksandr Tymoshenko HW module registers. 13706e9e0626SOleksandr Tymoshenko 137116c8d5e7SWolfgang Denk- USB Device: 137216c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 137316c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 137416c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 137511ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 137616c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 137716c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 137816c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 137916c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 138016c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 138116c8d5e7SWolfgang Denk a Linux host by 138216c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 138316c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 138416c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 138516c8d5e7SWolfgang Denk might be defined in YourBoardName.h 138616c8d5e7SWolfgang Denk 138716c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 138816c8d5e7SWolfgang Denk Define this to build a UDC device 138916c8d5e7SWolfgang Denk 139016c8d5e7SWolfgang Denk CONFIG_USB_TTY 139116c8d5e7SWolfgang Denk Define this to have a tty type of device available to 139216c8d5e7SWolfgang Denk talk to the UDC device 139316c8d5e7SWolfgang Denk 1394f9da0f89SVipin KUMAR CONFIG_USBD_HS 1395f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1396f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1397f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1398f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1399f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1400f9da0f89SVipin KUMAR speed. 1401f9da0f89SVipin KUMAR 14026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 140316c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 140416c8d5e7SWolfgang Denk be set to usbtty. 140516c8d5e7SWolfgang Denk 140616c8d5e7SWolfgang Denk mpc8xx: 14076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 140816c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 14096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 141016c8d5e7SWolfgang Denk 141116c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 141216c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 141316c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 141416c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 141516c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 141616c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 141716c8d5e7SWolfgang Denk 141816c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 141916c8d5e7SWolfgang Denk Define this string as the name of your company for 142016c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 142116c8d5e7SWolfgang Denk 142216c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 142316c8d5e7SWolfgang Denk Define this string as the name of your product 142416c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 142516c8d5e7SWolfgang Denk 142616c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 142716c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 142816c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 142916c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 143016c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 143116c8d5e7SWolfgang Denk 143216c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 143316c8d5e7SWolfgang Denk Define this as the unique Product ID 143416c8d5e7SWolfgang Denk for your device 143516c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1436c609719bSwdenk 1437d70a560fSIgor Grinberg- ULPI Layer Support: 1438d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1439d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1440d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1441d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1442d70a560fSIgor Grinberg viewport is supported. 1443d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1444d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 14456d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 14466d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 14476d365ea0SLucas Stach the appropriate value in Hz. 1448c609719bSwdenk 1449c609719bSwdenk- MMC Support: 1450c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1451c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1452c609719bSwdenk accessed from the boot prompt by mapping the device 1453c609719bSwdenk to physical memory similar to flash. Command line is 1454602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1455602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1456c609719bSwdenk 1457afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1458afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1459afb35666SYoshihiro Shimoda 1460afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1461afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1462afb35666SYoshihiro Shimoda 1463afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1464afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1465afb35666SYoshihiro Shimoda 14661fd93c6eSPierre Aubert CONFIG_GENERIC_MMC 14671fd93c6eSPierre Aubert Enable the generic MMC driver 14681fd93c6eSPierre Aubert 14691fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_BOOT 14701fd93c6eSPierre Aubert Enable some additional features of the eMMC boot partitions. 14711fd93c6eSPierre Aubert 14721fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_RPMB 14731fd93c6eSPierre Aubert Enable the commands for reading, writing and programming the 14741fd93c6eSPierre Aubert key for the Replay Protection Memory Block partition in eMMC. 14751fd93c6eSPierre Aubert 1476b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 147701acd6abSPaul Kocialkowski CONFIG_USB_FUNCTION_DFU 1478b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1479b3ba6e94STom Rini 1480b3ba6e94STom Rini CONFIG_CMD_DFU 1481b3ba6e94STom Rini This enables the command "dfu" which is used to have 1482b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1483b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1484b3ba6e94STom Rini set and define the alt settings to expose to the host. 1485b3ba6e94STom Rini 1486b3ba6e94STom Rini CONFIG_DFU_MMC 1487b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1488b3ba6e94STom Rini 1489c6631764SPantelis Antoniou CONFIG_DFU_NAND 1490c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1491c6631764SPantelis Antoniou 1492a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1493a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1494a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1495a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1496a9479f04SAfzal Mohammed one that would help mostly the developer. 1497a9479f04SAfzal Mohammed 1498e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1499e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1500e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1501e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1502e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1503e7e75c70SHeiko Schocher 1504ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1505ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1506ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1507ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1508ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1509ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1510ea2453d5SPantelis Antoniou 1511001a8319SHeiko Schocher DFU_DEFAULT_POLL_TIMEOUT 1512001a8319SHeiko Schocher Poll timeout [ms], is the timeout a device can send to the 1513001a8319SHeiko Schocher host. The host must wait for this timeout before sending 1514001a8319SHeiko Schocher a subsequent DFU_GET_STATUS request to the device. 1515001a8319SHeiko Schocher 1516001a8319SHeiko Schocher DFU_MANIFEST_POLL_TIMEOUT 1517001a8319SHeiko Schocher Poll timeout [ms], which the device sends to the host when 1518001a8319SHeiko Schocher entering dfuMANIFEST state. Host waits this timeout, before 1519001a8319SHeiko Schocher sending again an USB request to the device. 1520001a8319SHeiko Schocher 15213aab70afSSebastian Siewior- USB Device Android Fastboot support: 152217da3c0cSPaul Kocialkowski CONFIG_USB_FUNCTION_FASTBOOT 152317da3c0cSPaul Kocialkowski This enables the USB part of the fastboot gadget 152417da3c0cSPaul Kocialkowski 15253aab70afSSebastian Siewior CONFIG_CMD_FASTBOOT 15263aab70afSSebastian Siewior This enables the command "fastboot" which enables the Android 15273aab70afSSebastian Siewior fastboot mode for the platform's USB device. Fastboot is a USB 15283aab70afSSebastian Siewior protocol for downloading images, flashing and device control 15293aab70afSSebastian Siewior used on Android devices. 15303aab70afSSebastian Siewior See doc/README.android-fastboot for more information. 15313aab70afSSebastian Siewior 15323aab70afSSebastian Siewior CONFIG_ANDROID_BOOT_IMAGE 15333aab70afSSebastian Siewior This enables support for booting images which use the Android 15343aab70afSSebastian Siewior image format header. 15353aab70afSSebastian Siewior 1536a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_ADDR 15373aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 15383aab70afSSebastian Siewior downloads. Define this to the starting RAM address to use for 15393aab70afSSebastian Siewior downloaded images. 15403aab70afSSebastian Siewior 1541a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_SIZE 15423aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 15433aab70afSSebastian Siewior downloads. This buffer should be as large as possible for a 15443aab70afSSebastian Siewior platform. Define this to the size available RAM for fastboot. 15453aab70afSSebastian Siewior 1546d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH 1547d1b5ed07SSteve Rae The fastboot protocol includes a "flash" command for writing 1548d1b5ed07SSteve Rae the downloaded image to a non-volatile storage device. Define 1549d1b5ed07SSteve Rae this to enable the "fastboot flash" command. 1550d1b5ed07SSteve Rae 1551d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH_MMC_DEV 1552d1b5ed07SSteve Rae The fastboot "flash" command requires additional information 1553d1b5ed07SSteve Rae regarding the non-volatile storage device. Define this to 1554d1b5ed07SSteve Rae the eMMC device that fastboot should use to store the image. 1555d1b5ed07SSteve Rae 15560ff7e585SSteve Rae CONFIG_FASTBOOT_GPT_NAME 15570ff7e585SSteve Rae The fastboot "flash" command supports writing the downloaded 15580ff7e585SSteve Rae image to the Protective MBR and the Primary GUID Partition 15590ff7e585SSteve Rae Table. (Additionally, this downloaded image is post-processed 15600ff7e585SSteve Rae to generate and write the Backup GUID Partition Table.) 15610ff7e585SSteve Rae This occurs when the specified "partition name" on the 15620ff7e585SSteve Rae "fastboot flash" command line matches this value. 15636f6c8630SPetr Kulhavy The default is "gpt" if undefined. 15640ff7e585SSteve Rae 1565b6dd69a4SPetr Kulhavy CONFIG_FASTBOOT_MBR_NAME 1566b6dd69a4SPetr Kulhavy The fastboot "flash" command supports writing the downloaded 1567b6dd69a4SPetr Kulhavy image to DOS MBR. 1568b6dd69a4SPetr Kulhavy This occurs when the "partition name" specified on the 1569b6dd69a4SPetr Kulhavy "fastboot flash" command line matches this value. 1570b6dd69a4SPetr Kulhavy If not defined the default value "mbr" is used. 1571b6dd69a4SPetr Kulhavy 15726705d81eSwdenk- Journaling Flash filesystem support: 1573b2482dffSSimon Glass CONFIG_JFFS2_NAND 15746705d81eSwdenk Define these for a default partition on a NAND device 15756705d81eSwdenk 15766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 15776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 15786705d81eSwdenk Define these for a default partition on a NOR device 15796705d81eSwdenk 1580c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1581c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1582656f4c65SDonggeun Kim 1583656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1584656f4c65SDonggeun Kim file in FAT formatted partition. 1585656f4c65SDonggeun Kim 1586656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1587656f4c65SDonggeun Kim user to write files to FAT. 1588c30a15e5SDonggeun Kim 1589edb42dbaSAlexander von Gernler- CBFS (Coreboot Filesystem) support: 159084cd9327SGabe Black CONFIG_CMD_CBFS 159184cd9327SGabe Black 159284cd9327SGabe Black Define this to enable support for reading from a Coreboot 159384cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 159484cd9327SGabe Black and cbfsload. 159584cd9327SGabe Black 15964f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size: 15974f0d1a2aSSiva Durga Prasad Paladugu CONFIG_FS_FAT_MAX_CLUSTSIZE 15984f0d1a2aSSiva Durga Prasad Paladugu 15994f0d1a2aSSiva Durga Prasad Paladugu Define the max cluster size for fat operations else 16004f0d1a2aSSiva Durga Prasad Paladugu a default value of 65536 will be defined. 16014f0d1a2aSSiva Durga Prasad Paladugu 1602c609719bSwdenk- Keyboard Support: 160339f615edSSimon Glass See Kconfig help for available keyboard drivers. 160439f615edSSimon Glass 160539f615edSSimon Glass CONFIG_KEYBOARD 160639f615edSSimon Glass 160739f615edSSimon Glass Define this to enable a custom keyboard support. 160839f615edSSimon Glass This simply calls drv_keyboard_init() which must be 160939f615edSSimon Glass defined in your board-specific files. This option is deprecated 161039f615edSSimon Glass and is only used by novena. For new boards, use driver model 161139f615edSSimon Glass instead. 1612c609719bSwdenk 1613c609719bSwdenk- Video support: 16147d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 16157d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 16167d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 16177d3053fbSTimur Tabi support, and should also define these other macros: 16187d3053fbSTimur Tabi 16197d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 16207d3053fbSTimur Tabi CONFIG_VIDEO 16217d3053fbSTimur Tabi CONFIG_CMD_BMP 16227d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 16237d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 16247d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 16257d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 16267d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 16277d3053fbSTimur Tabi 1628ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1629ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 16308eca9439SFabio Estevam boot. See the documentation file doc/README.video for a 1631ba8e76bdSTimur Tabi description of this variable. 16327d3053fbSTimur Tabi 1633c609719bSwdenk- LCD Support: CONFIG_LCD 1634c609719bSwdenk 1635c609719bSwdenk Define this to enable LCD support (for output to LCD 1636c609719bSwdenk display); also select one of the supported displays 1637c609719bSwdenk by defining one of these: 1638c609719bSwdenk 163939cf4804SStelian Pop CONFIG_ATMEL_LCD: 164039cf4804SStelian Pop 164139cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 164239cf4804SStelian Pop 1643fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1644c609719bSwdenk 1645fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1646c609719bSwdenk 1647fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1648c609719bSwdenk 1649fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1650fd3103bbSwdenk Active, color, single scan. 1651fd3103bbSwdenk 1652fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1653fd3103bbSwdenk 1654fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1655c609719bSwdenk Active, color, single scan. 1656c609719bSwdenk 1657c609719bSwdenk CONFIG_SHARP_16x9 1658c609719bSwdenk 1659c609719bSwdenk Sharp 320x240. Active, color, single scan. 1660c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1661c609719bSwdenk 1662c609719bSwdenk CONFIG_SHARP_LQ64D341 1663c609719bSwdenk 1664c609719bSwdenk Sharp LQ64D341 display, 640x480. 1665c609719bSwdenk Active, color, single scan. 1666c609719bSwdenk 1667c609719bSwdenk CONFIG_HLD1045 1668c609719bSwdenk 1669c609719bSwdenk HLD1045 display, 640x480. 1670c609719bSwdenk Active, color, single scan. 1671c609719bSwdenk 1672c609719bSwdenk CONFIG_OPTREX_BW 1673c609719bSwdenk 1674c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1675c609719bSwdenk or 1676c609719bSwdenk Hitachi LMG6912RPFC-00T 1677c609719bSwdenk or 1678c609719bSwdenk Hitachi SP14Q002 1679c609719bSwdenk 1680c609719bSwdenk 320x240. Black & white. 1681c609719bSwdenk 1682c609719bSwdenk Normally display is black on white background; define 16836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1684c609719bSwdenk 1685676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1686676d319eSSimon Glass 1687b445bbb4SJeremiah Mahler Normally the LCD is page-aligned (typically 4KB). If this is 1688676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1689676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1690676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1691676d319eSSimon Glass a per-section basis. 1692676d319eSSimon Glass 1693676d319eSSimon Glass 1694604c7d4aSHannes Petermaier CONFIG_LCD_ROTATION 1695604c7d4aSHannes Petermaier 1696604c7d4aSHannes Petermaier Sometimes, for example if the display is mounted in portrait 1697604c7d4aSHannes Petermaier mode or even if it's mounted landscape but rotated by 180degree, 1698604c7d4aSHannes Petermaier we need to rotate our content of the display relative to the 1699604c7d4aSHannes Petermaier framebuffer, so that user can read the messages which are 1700604c7d4aSHannes Petermaier printed out. 1701604c7d4aSHannes Petermaier Once CONFIG_LCD_ROTATION is defined, the lcd_console will be 1702604c7d4aSHannes Petermaier initialized with a given rotation from "vl_rot" out of 1703604c7d4aSHannes Petermaier "vidinfo_t" which is provided by the board specific code. 1704604c7d4aSHannes Petermaier The value for vl_rot is coded as following (matching to 1705604c7d4aSHannes Petermaier fbcon=rotate:<n> linux-kernel commandline): 1706604c7d4aSHannes Petermaier 0 = no rotation respectively 0 degree 1707604c7d4aSHannes Petermaier 1 = 90 degree rotation 1708604c7d4aSHannes Petermaier 2 = 180 degree rotation 1709604c7d4aSHannes Petermaier 3 = 270 degree rotation 1710604c7d4aSHannes Petermaier 1711604c7d4aSHannes Petermaier If CONFIG_LCD_ROTATION is not defined, the console will be 1712604c7d4aSHannes Petermaier initialized with 0degree rotation. 1713604c7d4aSHannes Petermaier 171445d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 171545d7f525STom Wai-Hong Tam 171645d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 171745d7f525STom Wai-Hong Tam 1718735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1719735987c5STom Wai-Hong Tam 1720735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1721735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1722735987c5STom Wai-Hong Tam 17237152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1724d791b1dcSwdenk 1725d791b1dcSwdenk If this option is set, the environment is checked for 1726d791b1dcSwdenk a variable "splashimage". If found, the usual display 1727d791b1dcSwdenk of logo, copyright and system information on the LCD 1728e94d2cd9Swdenk is suppressed and the BMP image at the address 1729d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1730d791b1dcSwdenk console is redirected to the "nulldev", too. This 1731d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1732d791b1dcSwdenk loaded very quickly after power-on. 1733d791b1dcSwdenk 1734c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1735c0880485SNikita Kiryanov 1736c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1737c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1738ab5645f1SFabio Estevam (see doc/README.displaying-bmps). 1739c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1740c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1741c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1742c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1743c0880485SNikita Kiryanov there is no need to set this option. 1744c0880485SNikita Kiryanov 17451ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 17461ca298ceSMatthias Weisser 17471ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 17481ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 17491ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 17501ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 17511ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 17521ca298ceSMatthias Weisser specify 'm' for centering the image. 17531ca298ceSMatthias Weisser 17541ca298ceSMatthias Weisser Example: 17551ca298ceSMatthias Weisser setenv splashpos m,m 17561ca298ceSMatthias Weisser => image at center of screen 17571ca298ceSMatthias Weisser 17581ca298ceSMatthias Weisser setenv splashpos 30,20 17591ca298ceSMatthias Weisser => image at x = 30 and y = 20 17601ca298ceSMatthias Weisser 17611ca298ceSMatthias Weisser setenv splashpos -10,m 17621ca298ceSMatthias Weisser => vertically centered image 17631ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 17641ca298ceSMatthias Weisser 176598f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 176698f4a3dfSStefan Roese 176798f4a3dfSStefan Roese If this option is set, additionally to standard BMP 176898f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 176998f4a3dfSStefan Roese splashscreen support or the bmp command. 177098f4a3dfSStefan Roese 1771d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1772d5011762SAnatolij Gustschin 1773d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1774d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1775d5011762SAnatolij Gustschin bmp command. 1776d5011762SAnatolij Gustschin 1777b445bbb4SJeremiah Mahler- Do compressing for memory range: 1778f2b96dfbSLei Wen CONFIG_CMD_ZIP 1779f2b96dfbSLei Wen 1780f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1781f2b96dfbSLei Wen to compress the specified memory at its best effort. 1782f2b96dfbSLei Wen 1783c29fdfc1Swdenk- Compression support: 17848ef70478SKees Cook CONFIG_GZIP 17858ef70478SKees Cook 17868ef70478SKees Cook Enabled by default to support gzip compressed images. 17878ef70478SKees Cook 1788c29fdfc1Swdenk CONFIG_BZIP2 1789c29fdfc1Swdenk 1790c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1791c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1792c29fdfc1Swdenk compressed images are supported. 1793c29fdfc1Swdenk 1794c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 17956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1796c29fdfc1Swdenk be at least 4MB. 1797d791b1dcSwdenk 1798fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1799fc9c1727SLuigi 'Comio' Mantellini 1800fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1801fc9c1727SLuigi 'Comio' Mantellini images is included. 1802fc9c1727SLuigi 'Comio' Mantellini 1803fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1804fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1805fc9c1727SLuigi 'Comio' Mantellini formula: 1806fc9c1727SLuigi 'Comio' Mantellini 1807fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1808fc9c1727SLuigi 'Comio' Mantellini 1809fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1810fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1811fc9c1727SLuigi 'Comio' Mantellini 1812fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1813fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1814fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1815fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1816fc9c1727SLuigi 'Comio' Mantellini 1817fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1818fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 18196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1820fc9c1727SLuigi 'Comio' Mantellini 18218ef70478SKees Cook CONFIG_LZO 18228ef70478SKees Cook 18238ef70478SKees Cook If this option is set, support for LZO compressed images 18248ef70478SKees Cook is included. 18258ef70478SKees Cook 182617ea1177Swdenk- MII/PHY support: 182717ea1177Swdenk CONFIG_PHY_ADDR 182817ea1177Swdenk 182917ea1177Swdenk The address of PHY on MII bus. 183017ea1177Swdenk 183117ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 183217ea1177Swdenk 183317ea1177Swdenk The clock frequency of the MII bus 183417ea1177Swdenk 183517ea1177Swdenk CONFIG_PHY_GIGE 183617ea1177Swdenk 183717ea1177Swdenk If this option is set, support for speed/duplex 183811ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 183917ea1177Swdenk 184017ea1177Swdenk CONFIG_PHY_RESET_DELAY 184117ea1177Swdenk 184217ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 184317ea1177Swdenk reset before any MII register access is possible. 184417ea1177Swdenk For such PHY, set this option to the usec delay 184517ea1177Swdenk required. (minimum 300usec for LXT971A) 184617ea1177Swdenk 184717ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 184817ea1177Swdenk 184917ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 185017ea1177Swdenk command issued before MII status register can be read 185117ea1177Swdenk 1852c609719bSwdenk- IP address: 1853c609719bSwdenk CONFIG_IPADDR 1854c609719bSwdenk 1855c609719bSwdenk Define a default value for the IP address to use for 185611ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1857c609719bSwdenk determined through e.g. bootp. 18581ebcd654SWolfgang Denk (Environment variable "ipaddr") 1859c609719bSwdenk 1860c609719bSwdenk- Server IP address: 1861c609719bSwdenk CONFIG_SERVERIP 1862c609719bSwdenk 1863c609719bSwdenk Defines a default value for the IP address of a TFTP 1864c609719bSwdenk server to contact when using the "tftboot" command. 18651ebcd654SWolfgang Denk (Environment variable "serverip") 1866c609719bSwdenk 186797cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 186897cfe861SRobin Getz 186997cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 187097cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 187197cfe861SRobin Getz 18721ebcd654SWolfgang Denk- Gateway IP address: 18731ebcd654SWolfgang Denk CONFIG_GATEWAYIP 18741ebcd654SWolfgang Denk 18751ebcd654SWolfgang Denk Defines a default value for the IP address of the 18761ebcd654SWolfgang Denk default router where packets to other networks are 18771ebcd654SWolfgang Denk sent to. 18781ebcd654SWolfgang Denk (Environment variable "gatewayip") 18791ebcd654SWolfgang Denk 18801ebcd654SWolfgang Denk- Subnet mask: 18811ebcd654SWolfgang Denk CONFIG_NETMASK 18821ebcd654SWolfgang Denk 18831ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 18841ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 18851ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 18861ebcd654SWolfgang Denk forwarded through a router. 18871ebcd654SWolfgang Denk (Environment variable "netmask") 18881ebcd654SWolfgang Denk 188953a5c424SDavid Updegraff- Multicast TFTP Mode: 189053a5c424SDavid Updegraff CONFIG_MCAST_TFTP 189153a5c424SDavid Updegraff 189253a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 189353a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 189411ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 189553a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 189653a5c424SDavid Updegraff multicast group. 189753a5c424SDavid Updegraff 1898c609719bSwdenk- BOOTP Recovery Mode: 1899c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1900c609719bSwdenk 1901c609719bSwdenk If you have many targets in a network that try to 1902c609719bSwdenk boot using BOOTP, you may want to avoid that all 1903c609719bSwdenk systems send out BOOTP requests at precisely the same 1904c609719bSwdenk moment (which would happen for instance at recovery 1905c609719bSwdenk from a power failure, when all systems will try to 1906c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1907c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1908c609719bSwdenk inserted before sending out BOOTP requests. The 19096c33c785SWolfgang Denk following delays are inserted then: 1910c609719bSwdenk 1911c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1912c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1913c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1914c609719bSwdenk 4th and following 1915c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1916c609719bSwdenk 191792ac8accSThierry Reding CONFIG_BOOTP_ID_CACHE_SIZE 191892ac8accSThierry Reding 191992ac8accSThierry Reding BOOTP packets are uniquely identified using a 32-bit ID. The 192092ac8accSThierry Reding server will copy the ID from client requests to responses and 192192ac8accSThierry Reding U-Boot will use this to determine if it is the destination of 192292ac8accSThierry Reding an incoming response. Some servers will check that addresses 192392ac8accSThierry Reding aren't in use before handing them out (usually using an ARP 192492ac8accSThierry Reding ping) and therefore take up to a few hundred milliseconds to 192592ac8accSThierry Reding respond. Network congestion may also influence the time it 192692ac8accSThierry Reding takes for a response to make it back to the client. If that 192792ac8accSThierry Reding time is too long, U-Boot will retransmit requests. In order 192892ac8accSThierry Reding to allow earlier responses to still be accepted after these 192992ac8accSThierry Reding retransmissions, U-Boot's BOOTP client keeps a small cache of 193092ac8accSThierry Reding IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this 193192ac8accSThierry Reding cache. The default is to keep IDs for up to four outstanding 193292ac8accSThierry Reding requests. Increasing this will allow U-Boot to accept offers 193392ac8accSThierry Reding from a BOOTP client in networks with unusually high latency. 193492ac8accSThierry Reding 1935fe389a82Sstroese- DHCP Advanced Options: 19361fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 19371fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1938fe389a82Sstroese 19391fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 19401fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 19411fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 19421fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 19431fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 19441fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 19451fe80d79SJon Loeliger CONFIG_BOOTP_DNS 19461fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 19471fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 19481fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 19491fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 19501fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 19512c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1952fe389a82Sstroese 19535d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 19545d110f0aSWilson Callan environment variable, not the BOOTP server. 1955fe389a82Sstroese 19562c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 19572c00e099SJoe Hershberger after the configured retry count, the call will fail 19582c00e099SJoe Hershberger instead of starting over. This can be used to fail over 19592c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 19602c00e099SJoe Hershberger is not available. 19612c00e099SJoe Hershberger 1962fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1963fe389a82Sstroese serverip from a DHCP server, it is possible that more 1964fe389a82Sstroese than one DNS serverip is offered to the client. 1965fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1966fe389a82Sstroese serverip will be stored in the additional environment 1967fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 1968fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 19691fe80d79SJon Loeliger is defined. 1970fe389a82Sstroese 1971fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1972fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1973fe389a82Sstroese need the hostname of the DHCP requester. 19745d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 19751fe80d79SJon Loeliger of the "hostname" environment variable is passed as 19761fe80d79SJon Loeliger option 12 to the DHCP server. 1977fe389a82Sstroese 1978d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1979d9a2f416SAras Vaichas 1980d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1981d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1982d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1983d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1984d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1985d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1986d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1987d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1988d9a2f416SAras Vaichas that one of the retries will be successful but note that 1989d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1990d9a2f416SAras Vaichas this delay. 1991d9a2f416SAras Vaichas 1992d22c338eSJoe Hershberger - Link-local IP address negotiation: 1993d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1994d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1995d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1996d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1997d22c338eSJoe Hershberger 1998d22c338eSJoe Hershberger See doc/README.link-local for more information. 1999d22c338eSJoe Hershberger 2000a3d991bdSwdenk - CDP Options: 2001a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 2002a3d991bdSwdenk 2003a3d991bdSwdenk The device id used in CDP trigger frames. 2004a3d991bdSwdenk 2005a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 2006a3d991bdSwdenk 2007a3d991bdSwdenk A two character string which is prefixed to the MAC address 2008a3d991bdSwdenk of the device. 2009a3d991bdSwdenk 2010a3d991bdSwdenk CONFIG_CDP_PORT_ID 2011a3d991bdSwdenk 2012a3d991bdSwdenk A printf format string which contains the ascii name of 2013a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 201411ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 2015a3d991bdSwdenk 2016a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 2017a3d991bdSwdenk 2018a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 2019a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 2020a3d991bdSwdenk 2021a3d991bdSwdenk CONFIG_CDP_VERSION 2022a3d991bdSwdenk 2023a3d991bdSwdenk An ascii string containing the version of the software. 2024a3d991bdSwdenk 2025a3d991bdSwdenk CONFIG_CDP_PLATFORM 2026a3d991bdSwdenk 2027a3d991bdSwdenk An ascii string containing the name of the platform. 2028a3d991bdSwdenk 2029a3d991bdSwdenk CONFIG_CDP_TRIGGER 2030a3d991bdSwdenk 2031a3d991bdSwdenk A 32bit integer sent on the trigger. 2032a3d991bdSwdenk 2033a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 2034a3d991bdSwdenk 2035a3d991bdSwdenk A 16bit integer containing the power consumption of the 2036a3d991bdSwdenk device in .1 of milliwatts. 2037a3d991bdSwdenk 2038a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 2039a3d991bdSwdenk 2040a3d991bdSwdenk A byte containing the id of the VLAN. 2041a3d991bdSwdenk 204279267eddSUri Mashiach- Status LED: CONFIG_LED_STATUS 2043c609719bSwdenk 2044c609719bSwdenk Several configurations allow to display the current 2045c609719bSwdenk status using a LED. For instance, the LED will blink 2046c609719bSwdenk fast while running U-Boot code, stop blinking as 2047c609719bSwdenk soon as a reply to a BOOTP request was received, and 2048c609719bSwdenk start blinking slow once the Linux kernel is running 2049c609719bSwdenk (supported by a status LED driver in the Linux 205079267eddSUri Mashiach kernel). Defining CONFIG_LED_STATUS enables this 2051c609719bSwdenk feature in U-Boot. 2052c609719bSwdenk 20531df7bbbaSIgor Grinberg Additional options: 20541df7bbbaSIgor Grinberg 205579267eddSUri Mashiach CONFIG_LED_STATUS_GPIO 20561df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 20571df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 205879267eddSUri Mashiach status LED backend implementation. Define CONFIG_LED_STATUS_GPIO 20591df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 20601df7bbbaSIgor Grinberg 20619dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 20629dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 20639dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 20649dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 20659dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 20669dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 20679dfdcdfeSIgor Grinberg 2068c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 2069c609719bSwdenk 2070c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 2071c609719bSwdenk on those systems that support this (optional) 2072c609719bSwdenk feature, like the TQM8xxL modules. 2073c609719bSwdenk 20743f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 2075c609719bSwdenk 20763f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 20773f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 20783f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 20793f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 20803f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 20813f4978c7SHeiko Schocher interface. 20823f4978c7SHeiko Schocher 20833f4978c7SHeiko Schocher ported i2c driver to the new framework: 2084ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 2085ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 2086ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2087ea818dbbSHeiko Schocher for defining speed and slave address 2088ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 2089ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2090ea818dbbSHeiko Schocher for defining speed and slave address 2091ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 2092ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2093ea818dbbSHeiko Schocher for defining speed and slave address 2094ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2095ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2096ea818dbbSHeiko Schocher for defining speed and slave address 20973f4978c7SHeiko Schocher 209800f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 209900f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 210000f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 210100f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 210200f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 210300f792e0SHeiko Schocher bus. 210400f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 210500f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 210600f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 210700f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 210800f792e0SHeiko Schocher second bus. 210900f792e0SHeiko Schocher 21101f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 21111f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 21121f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 21131f2ba722SSimon Glass 100000 and the slave addr 0! 21141f2ba722SSimon Glass 2115880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 2116880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 2117880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2118880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2119880540deSDirk Eibach 2120fac96408Strem - drivers/i2c/i2c_mxc.c 2121fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 212203544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 212303544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 212403544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 212503544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 2126fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2127fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2128fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2129fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2130fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2131fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 213203544c66SAlbert ARIBAUD \\(3ADEV\\) - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED 213303544c66SAlbert ARIBAUD \\(3ADEV\\) - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE 2134b445bbb4SJeremiah Mahler If those defines are not set, default value is 100000 2135fac96408Strem for speed, and 0 for slave. 2136fac96408Strem 21371086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 21381086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 21391086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 21401086bfa9SNobuhiro Iwamatsu 21411086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 21421086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 21431086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 21441086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 21451086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 21461086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 21471086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 21481086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 21491086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 21501086bfa9SNobuhiro Iwamatsu 21512035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 21522035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 21532035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 21542035d77dSNobuhiro Iwamatsu 21552035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 21562035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 21572035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 21582035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 21592035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 21602035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 21612035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 21622035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 21632035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 21642035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 2165b445bbb4SJeremiah Mahler - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses 21662035d77dSNobuhiro Iwamatsu 21676789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 21686789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 21696789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 21706789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 21716789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 21726789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 21736789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 21746789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 21756789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 21766789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 21776789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 21786789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 21796789e84eSHeiko Schocher 21800bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 21810bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 21820bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 21830bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 21840bdffe71SHeiko Schocher 2185e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 2186e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 2187e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 2188e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 2189e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 2190e717fc6dSNaveen Krishna Ch 2191b46226bdSDirk Eibach - drivers/i2c/ihs_i2c.c 2192b46226bdSDirk Eibach - activate this driver with CONFIG_SYS_I2C_IHS 2193b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 2194b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 2195b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 2196b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 2197b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 2198b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 2199b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 2200b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 2201b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 2202b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 2203b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 2204b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 2205071be896SDirk Eibach - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL 2206071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 2207071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 2208071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 2209071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 2210071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 2211071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 2212071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 2213071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 2214b46226bdSDirk Eibach 22153f4978c7SHeiko Schocher additional defines: 22163f4978c7SHeiko Schocher 22173f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 2218945a18e6SSimon Glass Hold the number of i2c buses you want to use. 22193f4978c7SHeiko Schocher 22203f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 22213f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 22223f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 22233f4978c7SHeiko Schocher omit this define. 22243f4978c7SHeiko Schocher 22253f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 22263f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 22273f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 22283f4978c7SHeiko Schocher define. 22293f4978c7SHeiko Schocher 22303f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 2231b445bbb4SJeremiah Mahler hold a list of buses you want to use, only used if 22323f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 22333f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 22343f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 22353f4978c7SHeiko Schocher 22363f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 22373f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 22383f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 22393f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 22403f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 22413f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 22423f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 22433f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 22443f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 22453f4978c7SHeiko Schocher } 22463f4978c7SHeiko Schocher 22473f4978c7SHeiko Schocher which defines 22483f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 2249ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2250ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2251ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2252ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2253ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 22543f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 2255ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2256ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 22573f4978c7SHeiko Schocher 22583f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 22593f4978c7SHeiko Schocher 2260ea818dbbSHeiko Schocher- Legacy I2C Support: CONFIG_HARD_I2C 22613f4978c7SHeiko Schocher 22623f4978c7SHeiko Schocher NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 22633f4978c7SHeiko Schocher provides the following compelling advantages: 22643f4978c7SHeiko Schocher 22653f4978c7SHeiko Schocher - more than one i2c adapter is usable 22663f4978c7SHeiko Schocher - approved multibus support 22673f4978c7SHeiko Schocher - better i2c mux support 22683f4978c7SHeiko Schocher 22693f4978c7SHeiko Schocher ** Please consider updating your I2C driver now. ** 22703f4978c7SHeiko Schocher 2271ea818dbbSHeiko Schocher These enable legacy I2C serial bus commands. Defining 2272ea818dbbSHeiko Schocher CONFIG_HARD_I2C will include the appropriate I2C driver 2273ea818dbbSHeiko Schocher for the selected CPU. 2274c609719bSwdenk 2275b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 2276602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 2277b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 2278b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 2279c609719bSwdenk command line interface. 2280c609719bSwdenk 2281bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 2282c609719bSwdenk 2283b37c7e5eSwdenk There are several other quantities that must also be 2284ea818dbbSHeiko Schocher defined when you define CONFIG_HARD_I2C. 2285c609719bSwdenk 22866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 2287b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 22886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 228911ccc33fSMarcel Ziswiler the CPU's i2c node address). 2290c609719bSwdenk 22918d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 2292a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 22938d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 22948d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 22958d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 2296b37c7e5eSwdenk 22975da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 22985da71efaSEric Millbrandt 22995da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 23005da71efaSEric Millbrandt chips might think that the current transfer is still 23015da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 23025da71efaSEric Millbrandt commands until the slave device responds. 23035da71efaSEric Millbrandt 2304b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 2305b37c7e5eSwdenk 2306ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2307b37c7e5eSwdenk then the following macros need to be defined (examples are 2308b37c7e5eSwdenk from include/configs/lwmon.h): 2309c609719bSwdenk 2310c609719bSwdenk I2C_INIT 2311c609719bSwdenk 2312b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 2313c609719bSwdenk controller or configure ports. 2314c609719bSwdenk 2315b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2316b37c7e5eSwdenk 2317c609719bSwdenk I2C_PORT 2318c609719bSwdenk 2319c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 2320c609719bSwdenk assumes both bits are on the same port). Valid values 2321c609719bSwdenk are 0..3 for ports A..D. 2322c609719bSwdenk 2323c609719bSwdenk I2C_ACTIVE 2324c609719bSwdenk 2325c609719bSwdenk The code necessary to make the I2C data line active 2326c609719bSwdenk (driven). If the data line is open collector, this 2327c609719bSwdenk define can be null. 2328c609719bSwdenk 2329b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2330b37c7e5eSwdenk 2331c609719bSwdenk I2C_TRISTATE 2332c609719bSwdenk 2333c609719bSwdenk The code necessary to make the I2C data line tri-stated 2334c609719bSwdenk (inactive). If the data line is open collector, this 2335c609719bSwdenk define can be null. 2336c609719bSwdenk 2337b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2338b37c7e5eSwdenk 2339c609719bSwdenk I2C_READ 2340c609719bSwdenk 2341472d5460SYork Sun Code that returns true if the I2C data line is high, 2342472d5460SYork Sun false if it is low. 2343c609719bSwdenk 2344b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2345b37c7e5eSwdenk 2346c609719bSwdenk I2C_SDA(bit) 2347c609719bSwdenk 2348472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2349472d5460SYork Sun is false, it clears it (low). 2350c609719bSwdenk 2351b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2352b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2353b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2354b37c7e5eSwdenk 2355c609719bSwdenk I2C_SCL(bit) 2356c609719bSwdenk 2357472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2358472d5460SYork Sun is false, it clears it (low). 2359c609719bSwdenk 2360b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2361b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2362b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2363b37c7e5eSwdenk 2364c609719bSwdenk I2C_DELAY 2365c609719bSwdenk 2366c609719bSwdenk This delay is invoked four times per clock cycle so this 2367c609719bSwdenk controls the rate of data transfer. The data rate thus 2368b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2369b37c7e5eSwdenk like: 2370b37c7e5eSwdenk 2371b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2372c609719bSwdenk 2373793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2374793b5726SMike Frysinger 2375793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2376793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2377793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2378793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2379793b5726SMike Frysinger 2380793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2381793b5726SMike Frysinger the generic GPIO functions. 2382793b5726SMike Frysinger 23836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 238447cd00faSwdenk 238547cd00faSwdenk When a board is reset during an i2c bus transfer 238647cd00faSwdenk chips might think that the current transfer is still 238747cd00faSwdenk in progress. On some boards it is possible to access 238847cd00faSwdenk the i2c SCLK line directly, either by using the 238947cd00faSwdenk processor pin as a GPIO or by having a second pin 239047cd00faSwdenk connected to the bus. If this option is defined a 239147cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 239247cd00faSwdenk is run early in the boot sequence. 239347cd00faSwdenk 239426a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 239526a33504SRichard Retanubun 239626a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 239726a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 239826a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 239926a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 240026a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 240126a33504SRichard Retanubun controller provide such a method. It is called at the end of 240226a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 240326a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 240426a33504SRichard Retanubun 240517ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 240617ea1177Swdenk 240717ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 240817ea1177Swdenk in u-boot bd_info structure based on u-boot environment 240917ea1177Swdenk variable "i2cfast". (see also i2cfast) 241017ea1177Swdenk 2411bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2412bb99ad6dSBen Warren 2413bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2414bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2415bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2416bb99ad6dSBen Warren Note that bus numbering is zero-based. 2417bb99ad6dSBen Warren 24186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2419bb99ad6dSBen Warren 2420bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 24210f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 24220f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 24230f89c54bSPeter Tyser a 1D array of device addresses 2424bb99ad6dSBen Warren 2425bb99ad6dSBen Warren e.g. 2426bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 24276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2428bb99ad6dSBen Warren 2429bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2430bb99ad6dSBen Warren 2431bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 2432945a18e6SSimon Glass #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2433bb99ad6dSBen Warren 2434bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2435bb99ad6dSBen Warren 24366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2437be5e6181STimur Tabi 2438be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2439be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2440be5e6181STimur Tabi 24416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 24420dc018ecSStefan Roese 24430dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 24440dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 24450dc018ecSStefan Roese 24466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 24470dc018ecSStefan Roese 24480dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 24490dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 24500dc018ecSStefan Roese 24516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 24529ebbb54fSVictor Gallardo 24539ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 24549ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 24559ebbb54fSVictor Gallardo specified DTT device. 24569ebbb54fSVictor Gallardo 24572ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 24582ac6985aSAndrew Dyer 24592ac6985aSAndrew Dyer defining this will force the i2c_read() function in 24602ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 24612ac6985aSAndrew Dyer between writing the address pointer and reading the 24622ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 24632ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 24642ac6985aSAndrew Dyer devices can use either method, but some require one or 24652ac6985aSAndrew Dyer the other. 2466be5e6181STimur Tabi 2467c609719bSwdenk- SPI Support: CONFIG_SPI 2468c609719bSwdenk 2469c609719bSwdenk Enables SPI driver (so far only tested with 2470c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2471c609719bSwdenk D/As on the SACSng board) 2472c609719bSwdenk 24736639562eSYoshihiro Shimoda CONFIG_SH_SPI 24746639562eSYoshihiro Shimoda 24756639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 24766639562eSYoshihiro Shimoda only SH7757 is supported. 24776639562eSYoshihiro Shimoda 2478c609719bSwdenk CONFIG_SOFT_SPI 2479c609719bSwdenk 2480c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2481c609719bSwdenk using hardware support. This is a general purpose 2482c609719bSwdenk driver that only requires three general I/O port pins 2483c609719bSwdenk (two outputs, one input) to function. If this is 2484c609719bSwdenk defined, the board configuration must define several 2485c609719bSwdenk SPI configuration items (port pins to use, etc). For 2486c609719bSwdenk an example, see include/configs/sacsng.h. 2487c609719bSwdenk 248804a9e118SBen Warren CONFIG_HARD_SPI 248904a9e118SBen Warren 249004a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 249104a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 249204a9e118SBen Warren must define a list of chip-select function pointers. 249304a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 249404a9e118SBen Warren example, see include/configs/mpc8349emds.h. 249504a9e118SBen Warren 249638254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 249738254f45SGuennadi Liakhovetski 249838254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 24992e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 250038254f45SGuennadi Liakhovetski 2501f659b573SHeiko Schocher CONFIG_SYS_SPI_MXC_WAIT 2502f659b573SHeiko Schocher Timeout for waiting until spi transfer completed. 2503f659b573SHeiko Schocher default: (CONFIG_SYS_HZ/100) /* 10 ms */ 2504f659b573SHeiko Schocher 25050133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 25060133502eSMatthias Fuchs 25070133502eSMatthias Fuchs Enables FPGA subsystem. 25080133502eSMatthias Fuchs 25090133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 25100133502eSMatthias Fuchs 25110133502eSMatthias Fuchs Enables support for specific chip vendors. 25120133502eSMatthias Fuchs (ALTERA, XILINX) 25130133502eSMatthias Fuchs 25140133502eSMatthias Fuchs CONFIG_FPGA_<family> 25150133502eSMatthias Fuchs 25160133502eSMatthias Fuchs Enables support for FPGA family. 25170133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 25180133502eSMatthias Fuchs 25190133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2520c609719bSwdenk 2521c609719bSwdenk Specify the number of FPGA devices to support. 2522c609719bSwdenk 252364e809afSSiva Durga Prasad Paladugu CONFIG_CMD_FPGA_LOADMK 252464e809afSSiva Durga Prasad Paladugu 252564e809afSSiva Durga Prasad Paladugu Enable support for fpga loadmk command 252664e809afSSiva Durga Prasad Paladugu 252767193864SMichal Simek CONFIG_CMD_FPGA_LOADP 252867193864SMichal Simek 252967193864SMichal Simek Enable support for fpga loadp command - load partial bitstream 253067193864SMichal Simek 253167193864SMichal Simek CONFIG_CMD_FPGA_LOADBP 253267193864SMichal Simek 253367193864SMichal Simek Enable support for fpga loadbp command - load partial bitstream 253467193864SMichal Simek (Xilinx only) 253567193864SMichal Simek 25366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2537c609719bSwdenk 2538c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2539c609719bSwdenk 25406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2541c609719bSwdenk 2542c609719bSwdenk Enable checks on FPGA configuration interface busy 2543c609719bSwdenk status by the configuration function. This option 2544c609719bSwdenk will require a board or device specific function to 2545c609719bSwdenk be written. 2546c609719bSwdenk 2547c609719bSwdenk CONFIG_FPGA_DELAY 2548c609719bSwdenk 2549c609719bSwdenk If defined, a function that provides delays in the FPGA 2550c609719bSwdenk configuration driver. 2551c609719bSwdenk 25526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2553c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2554c609719bSwdenk 25556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2556c609719bSwdenk 2557c609719bSwdenk Check for configuration errors during FPGA bitfile 2558c609719bSwdenk loading. For example, abort during Virtex II 2559c609719bSwdenk configuration if the INIT_B line goes low (which 2560c609719bSwdenk indicated a CRC error). 2561c609719bSwdenk 25626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2563c609719bSwdenk 2564b445bbb4SJeremiah Mahler Maximum time to wait for the INIT_B line to de-assert 2565b445bbb4SJeremiah Mahler after PROB_B has been de-asserted during a Virtex II 2566c609719bSwdenk FPGA configuration sequence. The default time is 500 256711ccc33fSMarcel Ziswiler ms. 2568c609719bSwdenk 25696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2570c609719bSwdenk 2571b445bbb4SJeremiah Mahler Maximum time to wait for BUSY to de-assert during 257211ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2573c609719bSwdenk 25746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2575c609719bSwdenk 2576c609719bSwdenk Time to wait after FPGA configuration. The default is 257711ccc33fSMarcel Ziswiler 200 ms. 2578c609719bSwdenk 2579c609719bSwdenk- Configuration Management: 2580b2b8a696SStefan Roese CONFIG_BUILD_TARGET 2581b2b8a696SStefan Roese 2582b2b8a696SStefan Roese Some SoCs need special image types (e.g. U-Boot binary 2583b2b8a696SStefan Roese with a special header) as build targets. By defining 2584b2b8a696SStefan Roese CONFIG_BUILD_TARGET in the SoC / board header, this 2585b2b8a696SStefan Roese special image will be automatically built upon calling 25866de80f21SSimon Glass make / buildman. 2587b2b8a696SStefan Roese 2588c609719bSwdenk CONFIG_IDENT_STRING 2589c609719bSwdenk 2590c609719bSwdenk If defined, this string will be added to the U-Boot 2591c609719bSwdenk version information (U_BOOT_VERSION) 2592c609719bSwdenk 2593c609719bSwdenk- Vendor Parameter Protection: 2594c609719bSwdenk 2595c609719bSwdenk U-Boot considers the values of the environment 2596c609719bSwdenk variables "serial#" (Board Serial Number) and 25977152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2598c609719bSwdenk are set once by the board vendor / manufacturer, and 2599c609719bSwdenk protects these variables from casual modification by 2600c609719bSwdenk the user. Once set, these variables are read-only, 2601c609719bSwdenk and write or delete attempts are rejected. You can 260211ccc33fSMarcel Ziswiler change this behaviour: 2603c609719bSwdenk 2604c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2605c609719bSwdenk file, the write protection for vendor parameters is 260647cd00faSwdenk completely disabled. Anybody can change or delete 2607c609719bSwdenk these parameters. 2608c609719bSwdenk 260992ac5208SJoe Hershberger Alternatively, if you define _both_ an ethaddr in the 261092ac5208SJoe Hershberger default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 261111ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2612c609719bSwdenk which can be changed exactly ONCE by the user. [The 2613c609719bSwdenk serial# is unaffected by this, i. e. it remains 2614c609719bSwdenk read-only.] 2615c609719bSwdenk 26162598090bSJoe Hershberger The same can be accomplished in a more flexible way 26172598090bSJoe Hershberger for any variable by configuring the type of access 26182598090bSJoe Hershberger to allow for those variables in the ".flags" variable 26192598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 26202598090bSJoe Hershberger 2621c609719bSwdenk- Protected RAM: 2622c609719bSwdenk CONFIG_PRAM 2623c609719bSwdenk 2624c609719bSwdenk Define this variable to enable the reservation of 2625c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2626c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2627c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2628c609719bSwdenk this default value by defining an environment 2629c609719bSwdenk variable "pram" to the number of kB you want to 2630c609719bSwdenk reserve. Note that the board info structure will 2631c609719bSwdenk still show the full amount of RAM. If pRAM is 2632c609719bSwdenk reserved, a new environment variable "mem" will 2633c609719bSwdenk automatically be defined to hold the amount of 2634c609719bSwdenk remaining RAM in a form that can be passed as boot 2635c609719bSwdenk argument to Linux, for instance like that: 2636c609719bSwdenk 2637fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2638c609719bSwdenk saveenv 2639c609719bSwdenk 2640c609719bSwdenk This way you can tell Linux not to use this memory, 2641c609719bSwdenk either, which results in a memory region that will 2642c609719bSwdenk not be affected by reboots. 2643c609719bSwdenk 2644c609719bSwdenk *WARNING* If your board configuration uses automatic 2645c609719bSwdenk detection of the RAM size, you must make sure that 2646c609719bSwdenk this memory test is non-destructive. So far, the 2647c609719bSwdenk following board configurations are known to be 2648c609719bSwdenk "pRAM-clean": 2649c609719bSwdenk 26501b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 26511b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2652544d97e9SWolfgang Denk FLAGADM, TQM8260 2653c609719bSwdenk 265440fef049SGabe Black- Access to physical memory region (> 4GB) 265540fef049SGabe Black Some basic support is provided for operations on memory not 265640fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 265740fef049SGabe Black support access to more than 4GB of memory on 32-bit 265840fef049SGabe Black machines using physical address extension or similar. 265940fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 266040fef049SGabe Black currently only supports clearing the memory. 266140fef049SGabe Black 2662c609719bSwdenk- Error Recovery: 2663c609719bSwdenk CONFIG_PANIC_HANG 2664c609719bSwdenk 2665c609719bSwdenk Define this variable to stop the system in case of a 2666c609719bSwdenk fatal error, so that you have to reset it manually. 2667c609719bSwdenk This is probably NOT a good idea for an embedded 266811ccc33fSMarcel Ziswiler system where you want the system to reboot 2669c609719bSwdenk automatically as fast as possible, but it may be 2670c609719bSwdenk useful during development since you can try to debug 2671c609719bSwdenk the conditions that lead to the situation. 2672c609719bSwdenk 2673c609719bSwdenk CONFIG_NET_RETRY_COUNT 2674c609719bSwdenk 2675c609719bSwdenk This variable defines the number of retries for 2676c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2677c609719bSwdenk before giving up the operation. If not defined, a 2678c609719bSwdenk default value of 5 is used. 2679c609719bSwdenk 268040cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 268140cb90eeSGuennadi Liakhovetski 268240cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 268340cb90eeSGuennadi Liakhovetski 268448a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 268548a3e999STetsuyuki Kobayashi 268648a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 268748a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 268848a3e999STetsuyuki Kobayashi try longer timeout such as 268948a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 269048a3e999STetsuyuki Kobayashi 2691c609719bSwdenk- Command Interpreter: 26928078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 269304a85b3bSwdenk 269404a85b3bSwdenk Enable auto completion of commands using TAB. 269504a85b3bSwdenk 26966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2697c609719bSwdenk 2698c609719bSwdenk This defines the secondary prompt string, which is 2699c609719bSwdenk printed when the command interpreter needs more input 2700c609719bSwdenk to complete a command. Usually "> ". 2701c609719bSwdenk 2702c609719bSwdenk Note: 2703c609719bSwdenk 2704c609719bSwdenk In the current implementation, the local variables 2705c609719bSwdenk space and global environment variables space are 2706c609719bSwdenk separated. Local variables are those you define by 27073b57fe0aSwdenk simply typing `name=value'. To access a local 2708c609719bSwdenk variable later on, you have write `$name' or 27093b57fe0aSwdenk `${name}'; to execute the contents of a variable 27103b57fe0aSwdenk directly type `$name' at the command prompt. 2711c609719bSwdenk 2712c609719bSwdenk Global environment variables are those you use 2713c609719bSwdenk setenv/printenv to work with. To run a command stored 2714c609719bSwdenk in such a variable, you need to use the run command, 2715c609719bSwdenk and you must not use the '$' sign to access them. 2716c609719bSwdenk 2717c609719bSwdenk To store commands and special characters in a 2718c609719bSwdenk variable, please use double quotation marks 2719c609719bSwdenk surrounding the whole text of the variable, instead 2720c609719bSwdenk of the backslashes before semicolons and special 2721c609719bSwdenk symbols. 2722c609719bSwdenk 2723b445bbb4SJeremiah Mahler- Command Line Editing and History: 2724aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2725aa0c71acSWolfgang Denk 272611ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2727aa0c71acSWolfgang Denk command line input operations 2728aa0c71acSWolfgang Denk 2729f3b267b3SMarek Vasut- Command Line PS1/PS2 support: 2730f3b267b3SMarek Vasut CONFIG_CMDLINE_PS_SUPPORT 2731f3b267b3SMarek Vasut 2732f3b267b3SMarek Vasut Enable support for changing the command prompt string 2733f3b267b3SMarek Vasut at run-time. Only static string is supported so far. 2734f3b267b3SMarek Vasut The string is obtained from environment variables PS1 2735f3b267b3SMarek Vasut and PS2. 2736f3b267b3SMarek Vasut 2737a8c7c708Swdenk- Default Environment: 2738c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2739c609719bSwdenk 2740c609719bSwdenk Define this to contain any number of null terminated 2741c609719bSwdenk strings (variable = value pairs) that will be part of 27427152b1d0Swdenk the default environment compiled into the boot image. 27432262cfeeSwdenk 2744c609719bSwdenk For example, place something like this in your 2745c609719bSwdenk board's config file: 2746c609719bSwdenk 2747c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2748c609719bSwdenk "myvar1=value1\0" \ 2749c609719bSwdenk "myvar2=value2\0" 2750c609719bSwdenk 2751c609719bSwdenk Warning: This method is based on knowledge about the 2752c609719bSwdenk internal format how the environment is stored by the 27532262cfeeSwdenk U-Boot code. This is NOT an official, exported 2754c609719bSwdenk interface! Although it is unlikely that this format 27557152b1d0Swdenk will change soon, there is no guarantee either. 2756c609719bSwdenk You better know what you are doing here. 2757c609719bSwdenk 2758c609719bSwdenk Note: overly (ab)use of the default environment is 2759c609719bSwdenk discouraged. Make sure to check other ways to preset 276074de7aefSWolfgang Denk the environment like the "source" command or the 2761c609719bSwdenk boot command first. 2762c609719bSwdenk 27635e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 27645e724ca2SStephen Warren 27655e724ca2SStephen Warren Define this in order to add variables describing the 27665e724ca2SStephen Warren U-Boot build configuration to the default environment. 27675e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 27685e724ca2SStephen Warren 27695e724ca2SStephen Warren Enabling this option will cause the following to be defined: 27705e724ca2SStephen Warren 27715e724ca2SStephen Warren - CONFIG_SYS_ARCH 27725e724ca2SStephen Warren - CONFIG_SYS_CPU 27735e724ca2SStephen Warren - CONFIG_SYS_BOARD 27745e724ca2SStephen Warren - CONFIG_SYS_VENDOR 27755e724ca2SStephen Warren - CONFIG_SYS_SOC 27765e724ca2SStephen Warren 27777e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 27787e27f89fSTom Rini 27797e27f89fSTom Rini Define this in order to add variables describing certain 27807e27f89fSTom Rini run-time determined information about the hardware to the 27817e27f89fSTom Rini environment. These will be named board_name, board_rev. 27827e27f89fSTom Rini 278306fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 278406fd8538SSimon Glass 278506fd8538SSimon Glass Normally the environment is loaded when the board is 2786b445bbb4SJeremiah Mahler initialised so that it is available to U-Boot. This inhibits 278706fd8538SSimon Glass that so that the environment is not available until 278806fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 278906fd8538SSimon Glass this is instead controlled by the value of 279006fd8538SSimon Glass /config/load-environment. 279106fd8538SSimon Glass 27923b10cf12SChris Packham- Parallel Flash support: 27933b10cf12SChris Packham CONFIG_SYS_NO_FLASH 27943b10cf12SChris Packham 2795a187559eSBin Meng Traditionally U-Boot was run on systems with parallel NOR 27963b10cf12SChris Packham flash. This option is used to disable support for parallel NOR 27973b10cf12SChris Packham flash. This option should be defined if the board does not have 27983b10cf12SChris Packham parallel flash. 27993b10cf12SChris Packham 28003b10cf12SChris Packham If this option is not defined one of the generic flash drivers 28013b10cf12SChris Packham (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be 28023b10cf12SChris Packham selected or the board must provide an implementation of the 28033b10cf12SChris Packham flash API (see include/flash.h). 28043b10cf12SChris Packham 2805a8c7c708Swdenk- DataFlash Support: 28062abbe075Swdenk CONFIG_HAS_DATAFLASH 28072abbe075Swdenk 28082abbe075Swdenk Defining this option enables DataFlash features and 28092abbe075Swdenk allows to read/write in Dataflash via the standard 28102abbe075Swdenk commands cp, md... 28112abbe075Swdenk 2812f61ec45eSEric Nelson- Serial Flash support 2813f61ec45eSEric Nelson CONFIG_CMD_SF 2814f61ec45eSEric Nelson 2815f61ec45eSEric Nelson Defining this option enables SPI flash commands 2816f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2817f61ec45eSEric Nelson 2818f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2819f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2820f61ec45eSEric Nelson commands. 2821f61ec45eSEric Nelson 2822f61ec45eSEric Nelson The following defaults may be provided by the platform 2823f61ec45eSEric Nelson to handle the common case when only a single serial 2824f61ec45eSEric Nelson flash is present on the system. 2825f61ec45eSEric Nelson 2826f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2827f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2828f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2829f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2830f61ec45eSEric Nelson 283124007273SSimon Glass CONFIG_CMD_SF_TEST 283224007273SSimon Glass 283324007273SSimon Glass Define this option to include a destructive SPI flash 283424007273SSimon Glass test ('sf test'). 283524007273SSimon Glass 2836b902e07cSJagannadha Sutradharudu Teki CONFIG_SF_DUAL_FLASH Dual flash memories 2837b902e07cSJagannadha Sutradharudu Teki 2838b902e07cSJagannadha Sutradharudu Teki Define this option to use dual flash support where two flash 2839b902e07cSJagannadha Sutradharudu Teki memories can be connected with a given cs line. 2840b445bbb4SJeremiah Mahler Currently Xilinx Zynq qspi supports these type of connections. 2841b902e07cSJagannadha Sutradharudu Teki 28423f85ce27Swdenk- SystemACE Support: 28433f85ce27Swdenk CONFIG_SYSTEMACE 28443f85ce27Swdenk 28453f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 28463f85ce27Swdenk chips attached via some sort of local bus. The address 284711ccc33fSMarcel Ziswiler of the chip must also be defined in the 28486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 28493f85ce27Swdenk 28503f85ce27Swdenk #define CONFIG_SYSTEMACE 28516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 28523f85ce27Swdenk 28533f85ce27Swdenk When SystemACE support is added, the "ace" device type 28543f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 28553f85ce27Swdenk 2856ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2857ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2858ecb0ccd9SWolfgang Denk 285928cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2860ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 286128cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2862ecb0ccd9SWolfgang Denk number generator is used. 2863ecb0ccd9SWolfgang Denk 286428cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 286528cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 286628cb9375SWolfgang Denk defined, the normal port 69 is used. 286728cb9375SWolfgang Denk 286828cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2869ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2870ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2871ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2872ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2873ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2874ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2875ecb0ccd9SWolfgang Denk 2876bf36c5d5SSimon Glass- Hashing support: 2877bf36c5d5SSimon Glass CONFIG_CMD_HASH 2878bf36c5d5SSimon Glass 2879bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 2880bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2881bf36c5d5SSimon Glass 2882bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 2883bf36c5d5SSimon Glass 2884bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 2885bf36c5d5SSimon Glass size a little. 2886bf36c5d5SSimon Glass 288794e3c8c4Sgaurav rana CONFIG_SHA1 - This option enables support of hashing using SHA1 288894e3c8c4Sgaurav rana algorithm. The hash is calculated in software. 288994e3c8c4Sgaurav rana CONFIG_SHA256 - This option enables support of hashing using 289094e3c8c4Sgaurav rana SHA256 algorithm. The hash is calculated in software. 289194e3c8c4Sgaurav rana CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration 289294e3c8c4Sgaurav rana for SHA1/SHA256 hashing. 289394e3c8c4Sgaurav rana This affects the 'hash' command and also the 289494e3c8c4Sgaurav rana hash_lookup_algo() function. 289594e3c8c4Sgaurav rana CONFIG_SHA_PROG_HW_ACCEL - This option enables 289694e3c8c4Sgaurav rana hardware-acceleration for SHA1/SHA256 progressive hashing. 289794e3c8c4Sgaurav rana Data can be streamed in a block at a time and the hashing 289894e3c8c4Sgaurav rana is performed in hardware. 2899bf36c5d5SSimon Glass 2900bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 2901bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 2902bf36c5d5SSimon Glass 2903a11f1873SRobert Winkler- Freescale i.MX specific commands: 2904a11f1873SRobert Winkler CONFIG_CMD_HDMIDETECT 2905a11f1873SRobert Winkler This enables 'hdmidet' command which returns true if an 2906a11f1873SRobert Winkler HDMI monitor is detected. This command is i.MX 6 specific. 2907a11f1873SRobert Winkler 2908a11f1873SRobert Winkler CONFIG_CMD_BMODE 2909a11f1873SRobert Winkler This enables the 'bmode' (bootmode) command for forcing 2910a11f1873SRobert Winkler a boot from specific media. 2911a11f1873SRobert Winkler 2912a11f1873SRobert Winkler This is useful for forcing the ROM's usb downloader to 2913a11f1873SRobert Winkler activate upon a watchdog reset which is nice when iterating 2914a11f1873SRobert Winkler on U-Boot. Using the reset button or running bmode normal 2915a11f1873SRobert Winkler will set it back to normal. This command currently 2916a11f1873SRobert Winkler supports i.MX53 and i.MX6. 2917a11f1873SRobert Winkler 29189e50c406SHeiko Schocher- bootcount support: 29199e50c406SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 29209e50c406SHeiko Schocher 29219e50c406SHeiko Schocher This enables the bootcounter support, see: 29229e50c406SHeiko Schocher http://www.denx.de/wiki/DULG/UBootBootCountLimit 29239e50c406SHeiko Schocher 29249e50c406SHeiko Schocher CONFIG_AT91SAM9XE 29259e50c406SHeiko Schocher enable special bootcounter support on at91sam9xe based boards. 29269e50c406SHeiko Schocher CONFIG_BLACKFIN 29279e50c406SHeiko Schocher enable special bootcounter support on blackfin based boards. 29289e50c406SHeiko Schocher CONFIG_SOC_DA8XX 29299e50c406SHeiko Schocher enable special bootcounter support on da850 based boards. 29309e50c406SHeiko Schocher CONFIG_BOOTCOUNT_RAM 29319e50c406SHeiko Schocher enable support for the bootcounter in RAM 29329e50c406SHeiko Schocher CONFIG_BOOTCOUNT_I2C 29339e50c406SHeiko Schocher enable support for the bootcounter on an i2c (like RTC) device. 29349e50c406SHeiko Schocher CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 29359e50c406SHeiko Schocher CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 29369e50c406SHeiko Schocher the bootcounter. 29379e50c406SHeiko Schocher CONFIG_BOOTCOUNT_ALEN = address len 293819c402afSSimon Glass 2939a8c7c708Swdenk- Show boot progress: 2940c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2941c609719bSwdenk 2942c609719bSwdenk Defining this option allows to add some board- 2943c609719bSwdenk specific code (calling a user-provided function 2944c609719bSwdenk "show_boot_progress(int)") that enables you to show 2945c609719bSwdenk the system's boot progress on some display (for 2946c609719bSwdenk example, some LED's) on your board. At the moment, 2947c609719bSwdenk the following checkpoints are implemented: 2948c609719bSwdenk 294994fd1316SSimon Glass 29501372cce2SMarian BalakowiczLegacy uImage format: 29511372cce2SMarian Balakowicz 2952c609719bSwdenk Arg Where When 2953c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2954c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2955c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2956c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2957c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2958c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2959c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2960c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2961c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 29621372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2963c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2964c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2965c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2966c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 29671372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2968c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 29691372cce2SMarian Balakowicz 29701372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 29711372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 29721372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 29731372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 29741372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 29751372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 29761372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 297711ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 29781372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 29791372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 29801372cce2SMarian Balakowicz 2981ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2982c609719bSwdenk 2983a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 298463e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 298563e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 298663e73c9aSwdenk 2987566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2988566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2989566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2990566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2991566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2992566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2993566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2994566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2995566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2996566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2997566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2998566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2999566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 3000566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 3001566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 3002566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 3003566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 3004566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 3005566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 3006566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 3007566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 3008566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 3009566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 3010566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 3011566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 3012566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 3013566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 3014566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 3015566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 3016566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 3017566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 3018566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 3019566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 3020566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 3021566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 3022566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 3023566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 3024566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 3025566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 3026566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 3027566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 3028566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 3029566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 3030566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 3031566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 3032566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 3033566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 3034c609719bSwdenk 3035566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 3036c609719bSwdenk 3037566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 3038566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 3039566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 3040206c60cbSwdenk 3041566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 3042bc0571fcSJoe Hershberger 80 common/cmd_net.c before calling net_loop() 3043bc0571fcSJoe Hershberger -81 common/cmd_net.c some error in net_loop() occurred 3044bc0571fcSJoe Hershberger 81 common/cmd_net.c net_loop() back without error 3045566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 3046566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 304774de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 304874de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 3049566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 3050c609719bSwdenk 30511372cce2SMarian BalakowiczFIT uImage format: 30521372cce2SMarian Balakowicz 30531372cce2SMarian Balakowicz Arg Where When 30541372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 30551372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 30561372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 30571372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 30581372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 30591372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 3060f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 30611372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 30621372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 30631372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 30641372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 30651372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 306611ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 306711ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 30681372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 30691372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 30701372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 30711372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 30721372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 30731372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 30741372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 30751372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 30761372cce2SMarian Balakowicz 30771372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 30781372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 30791372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 308011ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 30811372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 30821372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 30831372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 30841372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 30851372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 30861372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 30871372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 30881372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 30891372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 30901372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 30911372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 30921372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 30931372cce2SMarian Balakowicz 309411ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 30951372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 30961372cce2SMarian Balakowicz 309711ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 30981372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 30991372cce2SMarian Balakowicz 310011ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 31011372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 31021372cce2SMarian Balakowicz 310321d29f7fSHeiko Schocher- legacy image format: 310421d29f7fSHeiko Schocher CONFIG_IMAGE_FORMAT_LEGACY 310521d29f7fSHeiko Schocher enables the legacy image format support in U-Boot. 310621d29f7fSHeiko Schocher 310721d29f7fSHeiko Schocher Default: 310821d29f7fSHeiko Schocher enabled if CONFIG_FIT_SIGNATURE is not defined. 310921d29f7fSHeiko Schocher 311021d29f7fSHeiko Schocher CONFIG_DISABLE_IMAGE_LEGACY 311121d29f7fSHeiko Schocher disable the legacy image format 311221d29f7fSHeiko Schocher 311321d29f7fSHeiko Schocher This define is introduced, as the legacy image format is 311421d29f7fSHeiko Schocher enabled per default for backward compatibility. 311521d29f7fSHeiko Schocher 3116d95f6ec7SGabe Black- FIT image support: 31179a4f479bSDirk Eibach CONFIG_FIT_DISABLE_SHA256 31189a4f479bSDirk Eibach Supporting SHA256 hashes has quite an impact on binary size. 31199a4f479bSDirk Eibach For constrained systems sha256 hash support can be disabled 31209a4f479bSDirk Eibach with this option. 31219a4f479bSDirk Eibach 312273223f0eSSimon Glass TODO(sjg@chromium.org): Adjust this option to be positive, 312373223f0eSSimon Glass and move it to Kconfig 312473223f0eSSimon Glass 31254cf2609bSWolfgang Denk- Standalone program support: 31264cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 31274cf2609bSWolfgang Denk 31286feff899SWolfgang Denk This option defines a board specific value for the 31296feff899SWolfgang Denk address where standalone program gets loaded, thus 31306feff899SWolfgang Denk overwriting the architecture dependent default 31314cf2609bSWolfgang Denk settings. 31324cf2609bSWolfgang Denk 31334cf2609bSWolfgang Denk- Frame Buffer Address: 31344cf2609bSWolfgang Denk CONFIG_FB_ADDR 31354cf2609bSWolfgang Denk 31364cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 313744a53b57SWolfgang Denk address for frame buffer. This is typically the case 313844a53b57SWolfgang Denk when using a graphics controller has separate video 313944a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 314044a53b57SWolfgang Denk the given address instead of dynamically reserving it 314144a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 314244a53b57SWolfgang Denk the memory for the frame buffer depending on the 314344a53b57SWolfgang Denk configured panel size. 31444cf2609bSWolfgang Denk 31454cf2609bSWolfgang Denk Please see board_init_f function. 31464cf2609bSWolfgang Denk 3147cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 3148cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 3149cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 3150cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 3151cccfc2abSDetlev Zundel 3152cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 3153cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 3154cccfc2abSDetlev Zundel 3155cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 3156cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 3157cccfc2abSDetlev Zundel 3158cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 3159cccfc2abSDetlev Zundel Needed for mtdparts command support. 3160cccfc2abSDetlev Zundel 3161cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 3162cccfc2abSDetlev Zundel 3163cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 3164cccfc2abSDetlev Zundel kernel. Needed for UBI support. 3165cccfc2abSDetlev Zundel 316670c219cdSJoe Hershberger- UBI support 316770c219cdSJoe Hershberger CONFIG_CMD_UBI 316870c219cdSJoe Hershberger 316970c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 317070c219cdSJoe Hershberger with the UBI flash translation layer 317170c219cdSJoe Hershberger 317270c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 317370c219cdSJoe Hershberger 3174147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 3175147162daSJoe Hershberger 3176147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 3177147162daSJoe Hershberger warnings and errors enabled. 3178147162daSJoe Hershberger 3179ff94bc40SHeiko Schocher 3180ff94bc40SHeiko Schocher CONFIG_MTD_UBI_WL_THRESHOLD 3181ff94bc40SHeiko Schocher This parameter defines the maximum difference between the highest 3182ff94bc40SHeiko Schocher erase counter value and the lowest erase counter value of eraseblocks 3183ff94bc40SHeiko Schocher of UBI devices. When this threshold is exceeded, UBI starts performing 3184ff94bc40SHeiko Schocher wear leveling by means of moving data from eraseblock with low erase 3185ff94bc40SHeiko Schocher counter to eraseblocks with high erase counter. 3186ff94bc40SHeiko Schocher 3187ff94bc40SHeiko Schocher The default value should be OK for SLC NAND flashes, NOR flashes and 3188ff94bc40SHeiko Schocher other flashes which have eraseblock life-cycle 100000 or more. 3189ff94bc40SHeiko Schocher However, in case of MLC NAND flashes which typically have eraseblock 3190ff94bc40SHeiko Schocher life-cycle less than 10000, the threshold should be lessened (e.g., 3191ff94bc40SHeiko Schocher to 128 or 256, although it does not have to be power of 2). 3192ff94bc40SHeiko Schocher 3193ff94bc40SHeiko Schocher default: 4096 3194ff94bc40SHeiko Schocher 3195ff94bc40SHeiko Schocher CONFIG_MTD_UBI_BEB_LIMIT 3196ff94bc40SHeiko Schocher This option specifies the maximum bad physical eraseblocks UBI 3197ff94bc40SHeiko Schocher expects on the MTD device (per 1024 eraseblocks). If the 3198ff94bc40SHeiko Schocher underlying flash does not admit of bad eraseblocks (e.g. NOR 3199ff94bc40SHeiko Schocher flash), this value is ignored. 3200ff94bc40SHeiko Schocher 3201ff94bc40SHeiko Schocher NAND datasheets often specify the minimum and maximum NVM 3202ff94bc40SHeiko Schocher (Number of Valid Blocks) for the flashes' endurance lifetime. 3203ff94bc40SHeiko Schocher The maximum expected bad eraseblocks per 1024 eraseblocks 3204ff94bc40SHeiko Schocher then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", 3205ff94bc40SHeiko Schocher which gives 20 for most NANDs (MaxNVB is basically the total 3206ff94bc40SHeiko Schocher count of eraseblocks on the chip). 3207ff94bc40SHeiko Schocher 3208ff94bc40SHeiko Schocher To put it differently, if this value is 20, UBI will try to 3209ff94bc40SHeiko Schocher reserve about 1.9% of physical eraseblocks for bad blocks 3210ff94bc40SHeiko Schocher handling. And that will be 1.9% of eraseblocks on the entire 3211ff94bc40SHeiko Schocher NAND chip, not just the MTD partition UBI attaches. This means 3212ff94bc40SHeiko Schocher that if you have, say, a NAND flash chip admits maximum 40 bad 3213ff94bc40SHeiko Schocher eraseblocks, and it is split on two MTD partitions of the same 3214ff94bc40SHeiko Schocher size, UBI will reserve 40 eraseblocks when attaching a 3215ff94bc40SHeiko Schocher partition. 3216ff94bc40SHeiko Schocher 3217ff94bc40SHeiko Schocher default: 20 3218ff94bc40SHeiko Schocher 3219ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP 3220ff94bc40SHeiko Schocher Fastmap is a mechanism which allows attaching an UBI device 3221ff94bc40SHeiko Schocher in nearly constant time. Instead of scanning the whole MTD device it 3222ff94bc40SHeiko Schocher only has to locate a checkpoint (called fastmap) on the device. 3223ff94bc40SHeiko Schocher The on-flash fastmap contains all information needed to attach 3224ff94bc40SHeiko Schocher the device. Using fastmap makes only sense on large devices where 3225ff94bc40SHeiko Schocher attaching by scanning takes long. UBI will not automatically install 3226ff94bc40SHeiko Schocher a fastmap on old images, but you can set the UBI parameter 3227ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note 3228ff94bc40SHeiko Schocher that fastmap-enabled images are still usable with UBI implementations 3229ff94bc40SHeiko Schocher without fastmap support. On typical flash devices the whole fastmap 3230ff94bc40SHeiko Schocher fits into one PEB. UBI will reserve PEBs to hold two fastmaps. 3231ff94bc40SHeiko Schocher 3232ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT 3233ff94bc40SHeiko Schocher Set this parameter to enable fastmap automatically on images 3234ff94bc40SHeiko Schocher without a fastmap. 3235ff94bc40SHeiko Schocher default: 0 3236ff94bc40SHeiko Schocher 32370195a7bbSHeiko Schocher CONFIG_MTD_UBI_FM_DEBUG 32380195a7bbSHeiko Schocher Enable UBI fastmap debug 32390195a7bbSHeiko Schocher default: 0 32400195a7bbSHeiko Schocher 324170c219cdSJoe Hershberger- UBIFS support 324270c219cdSJoe Hershberger CONFIG_CMD_UBIFS 324370c219cdSJoe Hershberger 324470c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 324570c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 324670c219cdSJoe Hershberger 324770c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 324870c219cdSJoe Hershberger 3249147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 3250147162daSJoe Hershberger 3251147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 3252147162daSJoe Hershberger warnings and errors enabled. 3253147162daSJoe Hershberger 32546a11cf48SDaniel Schwierzeck- SPL framework 32556a11cf48SDaniel Schwierzeck CONFIG_SPL 32566a11cf48SDaniel Schwierzeck Enable building of SPL globally. 32576a11cf48SDaniel Schwierzeck 325895579793STom Rini CONFIG_SPL_LDSCRIPT 325995579793STom Rini LDSCRIPT for linking the SPL binary. 326095579793STom Rini 32616ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 32626ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 32636ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 32646ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 32658960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 32666ebc3461SAlbert ARIBAUD must not be both defined at the same time. 32676ebc3461SAlbert ARIBAUD 326895579793STom Rini CONFIG_SPL_MAX_SIZE 32696ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 32706ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 32716ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 32726ebc3461SAlbert ARIBAUD not exceed it. 327395579793STom Rini 32746a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 32756a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 32766a11cf48SDaniel Schwierzeck 327794a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 327894a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 327994a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 328094a45bb1SScott Wood 328195579793STom Rini CONFIG_SPL_BSS_START_ADDR 328295579793STom Rini Link address for the BSS within the SPL binary. 328395579793STom Rini 328495579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 32856ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 32866ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 32876ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 32888960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 32896ebc3461SAlbert ARIBAUD must not be both defined at the same time. 329095579793STom Rini 329195579793STom Rini CONFIG_SPL_STACK 329295579793STom Rini Adress of the start of the stack SPL will use 329395579793STom Rini 32948c80eb3bSAlbert ARIBAUD \(3ADEV\) CONFIG_SPL_PANIC_ON_RAW_IMAGE 32958c80eb3bSAlbert ARIBAUD \(3ADEV\) When defined, SPL will panic() if the image it has 32968c80eb3bSAlbert ARIBAUD \(3ADEV\) loaded does not have a signature. 32978c80eb3bSAlbert ARIBAUD \(3ADEV\) Defining this is useful when code which loads images 32988c80eb3bSAlbert ARIBAUD \(3ADEV\) in SPL cannot guarantee that absolutely all read errors 32998c80eb3bSAlbert ARIBAUD \(3ADEV\) will be caught. 33008c80eb3bSAlbert ARIBAUD \(3ADEV\) An example is the LPC32XX MLC NAND driver, which will 33018c80eb3bSAlbert ARIBAUD \(3ADEV\) consider that a completely unreadable NAND block is bad, 33028c80eb3bSAlbert ARIBAUD \(3ADEV\) and thus should be skipped silently. 33038c80eb3bSAlbert ARIBAUD \(3ADEV\) 3304e0727515SMarek Vasut CONFIG_SPL_ABORT_ON_RAW_IMAGE 3305e0727515SMarek Vasut When defined, SPL will proceed to another boot method 3306e0727515SMarek Vasut if the image it has loaded does not have a signature. 3307e0727515SMarek Vasut 330894a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 330994a45bb1SScott Wood Adress of the start of the stack SPL will use after 331094a45bb1SScott Wood relocation. If unspecified, this is equal to 331194a45bb1SScott Wood CONFIG_SPL_STACK. 331294a45bb1SScott Wood 331395579793STom Rini CONFIG_SYS_SPL_MALLOC_START 331495579793STom Rini Starting address of the malloc pool used in SPL. 33159ac4fc82SFabio Estevam When this option is set the full malloc is used in SPL and 33169ac4fc82SFabio Estevam it is set up by spl_init() and before that, the simple malloc() 33179ac4fc82SFabio Estevam can be used if CONFIG_SYS_MALLOC_F is defined. 331895579793STom Rini 331995579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 332095579793STom Rini The size of the malloc pool used in SPL. 33216a11cf48SDaniel Schwierzeck 332247f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 332347f7bcaeSTom Rini Enable the SPL framework under common/. This framework 332447f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 332547f7bcaeSTom Rini NAND loading of the Linux Kernel. 332647f7bcaeSTom Rini 33279607faf2STom Rini CONFIG_SPL_OS_BOOT 33289607faf2STom Rini Enable booting directly to an OS from SPL. 33299607faf2STom Rini See also: doc/README.falcon 33309607faf2STom Rini 3331861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 3332861a86f4STom Rini For ARM, enable an optional function to print more information 3333861a86f4STom Rini about the running system. 3334861a86f4STom Rini 33354b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 33364b919725SScott Wood Arch init code should be built for a very small image 33374b919725SScott Wood 3338b97300b6SPaul Kocialkowski CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION 3339b97300b6SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3340b97300b6SPaul Kocialkowski used in raw mode 3341b97300b6SPaul Kocialkowski 33422b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 33432b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 33442b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 33452b75b0adSPeter Korsgaard 33462b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 33472b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 33482b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 33492b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 33502b75b0adSPeter Korsgaard (for falcon mode) 33512b75b0adSPeter Korsgaard 3352e2ccdf89SPaul Kocialkowski CONFIG_SYS_MMCSD_FS_BOOT_PARTITION 3353e2ccdf89SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3354e2ccdf89SPaul Kocialkowski used in fs mode 3355e2ccdf89SPaul Kocialkowski 3356fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_PAYLOAD_NAME 3357fae81c72SGuillaume GARDET Filename to read to load U-Boot when reading from filesystem 3358fae81c72SGuillaume GARDET 3359fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_KERNEL_NAME 33607ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 3361fae81c72SGuillaume GARDET from filesystem (for Falcon mode) 33627ad2cc79SPeter Korsgaard 3363fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_ARGS_NAME 33647ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 3365fae81c72SGuillaume GARDET when reading from filesystem (for Falcon mode) 33667ad2cc79SPeter Korsgaard 336706f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 336806f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 336906f60ae3SScott Wood start.S waits for the rest of the SPL to load before 337006f60ae3SScott Wood continuing (the hardware starts execution after just 337106f60ae3SScott Wood loading the first page rather than the full 4K). 337206f60ae3SScott Wood 3373651fcf60SPrabhakar Kushwaha CONFIG_SPL_SKIP_RELOCATE 3374651fcf60SPrabhakar Kushwaha Avoid SPL relocation 3375651fcf60SPrabhakar Kushwaha 33766f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 33776f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 33786f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 33796f2f01b9SScott Wood 33806f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 33816f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 33826f2f01b9SScott Wood 33836f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 33846f2f01b9SScott Wood Include standard software ECC in the SPL 33856f2f01b9SScott Wood 338695579793STom Rini CONFIG_SPL_NAND_SIMPLE 33877d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 33887d4b7955SScott Wood expose the cmd_ctrl() interface. 338995579793STom Rini 33906f4e7d3cSThomas Gleixner CONFIG_SPL_UBI 33916f4e7d3cSThomas Gleixner Support for a lightweight UBI (fastmap) scanner and 33926f4e7d3cSThomas Gleixner loader 33936f4e7d3cSThomas Gleixner 33940c3117b1SHeiko Schocher CONFIG_SPL_NAND_RAW_ONLY 33950c3117b1SHeiko Schocher Support to boot only raw u-boot.bin images. Use this only 33960c3117b1SHeiko Schocher if you need to save space. 33970c3117b1SHeiko Schocher 33987c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 33997c8eea59SYing Zhang Set for common ddr init with serial presence detect in 34007c8eea59SYing Zhang SPL binary. 34017c8eea59SYing Zhang 340295579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 340395579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 340495579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 340595579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 340695579793STom Rini CONFIG_SYS_NAND_ECCBYTES 340795579793STom Rini Defines the size and behavior of the NAND that SPL uses 34087d4b7955SScott Wood to read U-Boot 340995579793STom Rini 3410fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 3411fbe76ae4SPrabhakar Kushwaha Add support NAND boot 3412fbe76ae4SPrabhakar Kushwaha 341395579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 34147d4b7955SScott Wood Location in NAND to read U-Boot from 34157d4b7955SScott Wood 34167d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 34177d4b7955SScott Wood Location in memory to load U-Boot to 34187d4b7955SScott Wood 34197d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 34207d4b7955SScott Wood Size of image to load 342195579793STom Rini 342295579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 34237d4b7955SScott Wood Entry point in loaded image to jump to 342495579793STom Rini 342595579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 342695579793STom Rini Define this if you need to first read the OOB and then the 3427b445bbb4SJeremiah Mahler data. This is used, for example, on davinci platforms. 342895579793STom Rini 342995579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 343095579793STom Rini Support for an OMAP3-specific set of functions to return the 343195579793STom Rini ID and MFR of the first attached NAND chip, if present. 343295579793STom Rini 3433c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3434c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3435c57b953dSPavel Machek 343674752baaSScott Wood CONFIG_SPL_PAD_TO 34376113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 34386113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 34396113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 34406113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 34416113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 344274752baaSScott Wood 3443ca2fca22SScott Wood CONFIG_SPL_TARGET 3444ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3445ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3446ca2fca22SScott Wood example if more than one image needs to be produced. 3447ca2fca22SScott Wood 344887ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 344987ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 345087ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 345187ebee39SSimon Glass option to re-enable it. This will affect the output of the 345287ebee39SSimon Glass bootm command when booting a FIT image. 345387ebee39SSimon Glass 34543aa29de0SYing Zhang- TPL framework 34553aa29de0SYing Zhang CONFIG_TPL 34563aa29de0SYing Zhang Enable building of TPL globally. 34573aa29de0SYing Zhang 34583aa29de0SYing Zhang CONFIG_TPL_PAD_TO 34593aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 34603aa29de0SYing Zhang the TPL payload. By default, this is defined as 34613aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 34623aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 34633aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 34643aa29de0SYing Zhang 3465a8c7c708Swdenk- Interrupt support (PPC): 3466a8c7c708Swdenk 3467a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3468a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 346911ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3470a8c7c708Swdenk should set decrementer_count to appropriate value. If 347111ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3472a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 347311ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3474a8c7c708Swdenk specific handling. If board has watchdog / status_led 3475a8c7c708Swdenk / other_activity_monitor it works automatically from 3476a8c7c708Swdenk general timer_interrupt(). 3477a8c7c708Swdenk 3478c609719bSwdenk 34799660e442SHelmut RaigerBoard initialization settings: 34809660e442SHelmut Raiger------------------------------ 34819660e442SHelmut Raiger 34829660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 34839660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 34849660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 34859660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 34869660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 34879660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 34889660e442SHelmut Raiger 34899660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 34909660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 34919660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 34929660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3493c609719bSwdenk 3494c609719bSwdenkConfiguration Settings: 3495c609719bSwdenk----------------------- 3496c609719bSwdenk 34974d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 34984d1fd7f1SYork Sun Optionally it can be defined to support 64-bit memory commands. 34994d1fd7f1SYork Sun 35006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3501c609719bSwdenk undefine this when you're short of memory. 3502c609719bSwdenk 35032fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 35042fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 35052fb2604dSPeter Tyser 35066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3507c609719bSwdenk prompt for user input. 3508c609719bSwdenk 35096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3510c609719bSwdenk 35116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3512c609719bSwdenk 35136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3514c609719bSwdenk 35156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3516c609719bSwdenk the application (usually a Linux kernel) when it is 3517c609719bSwdenk booted 3518c609719bSwdenk 35196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3520c609719bSwdenk List of legal baudrate settings for this board. 3521c609719bSwdenk 35226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3523c609719bSwdenk Begin and End addresses of the area used by the 3524c609719bSwdenk simple memory test. 3525c609719bSwdenk 35266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3527c609719bSwdenk Enable an alternate, more extensive memory test. 3528c609719bSwdenk 35296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 35305f535fe1Swdenk Scratch address used by the alternate memory test 35315f535fe1Swdenk You only need to set this if address zero isn't writeable 35325f535fe1Swdenk 3533e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE 3534e61a7534SYork Sun Only implemented for ARMv8 for now. 3535e8149522SYork Sun If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory 3536e8149522SYork Sun is substracted from total RAM and won't be reported to OS. 3537e8149522SYork Sun This memory can be used as secure memory. A variable 3538e61a7534SYork Sun gd->arch.secure_ram is used to track the location. In systems 3539e8149522SYork Sun the RAM base is not zero, or RAM is divided into banks, 3540e8149522SYork Sun this variable needs to be recalcuated to get the address. 3541e8149522SYork Sun 3542aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE: 35436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 354414f73ca6SStefan Roese this specified memory area will get subtracted from the top 354511ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 354614f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 354714f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 354814f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 35495e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 355014f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 35515e12e75dSStefan Roese will have to get fixed in Linux additionally. 355214f73ca6SStefan Roese 355314f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 355414f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 355514f73ca6SStefan Roese be touched. 355614f73ca6SStefan Roese 355714f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 355814f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 355914f73ca6SStefan Roese then the end address of the Linux memory will be located at a 356014f73ca6SStefan Roese non page size aligned address and this could cause major 356114f73ca6SStefan Roese problems. 356214f73ca6SStefan Roese 35636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3564c609719bSwdenk Enable temporary baudrate change while serial download 3565c609719bSwdenk 35666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3567c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3568c609719bSwdenk 35696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3570c609719bSwdenk Physical start address of Flash memory. 3571c609719bSwdenk 35726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3573c609719bSwdenk Physical start address of boot monitor code (set by 3574c609719bSwdenk make config files to be same as the text base address 357514d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 35766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3577c609719bSwdenk 35786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 35793b57fe0aSwdenk Size of memory reserved for monitor code, used to 35803b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 35813b57fe0aSwdenk embedded within the U-Boot image, or in a separate 35823b57fe0aSwdenk flash sector. 3583c609719bSwdenk 35846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3585c609719bSwdenk Size of DRAM reserved for malloc() use. 3586c609719bSwdenk 3587d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN 3588d59476b6SSimon Glass Size of the malloc() pool for use before relocation. If 3589d59476b6SSimon Glass this is defined, then a very simple malloc() implementation 3590d59476b6SSimon Glass will become available before relocation. The address is just 3591d59476b6SSimon Glass below the global data, and the stack is moved down to make 3592d59476b6SSimon Glass space. 3593d59476b6SSimon Glass 3594d59476b6SSimon Glass This feature allocates regions with increasing addresses 3595d59476b6SSimon Glass within the region. calloc() is supported, but realloc() 3596d59476b6SSimon Glass is not available. free() is supported but does nothing. 3597b445bbb4SJeremiah Mahler The memory will be freed (or in fact just forgotten) when 3598d59476b6SSimon Glass U-Boot relocates itself. 3599d59476b6SSimon Glass 360038687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE 360138687ae6SSimon Glass Provides a simple and small malloc() and calloc() for those 360238687ae6SSimon Glass boards which do not use the full malloc in SPL (which is 360338687ae6SSimon Glass enabled with CONFIG_SYS_SPL_MALLOC_START). 360438687ae6SSimon Glass 36051dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY: 36061dfdd9baSThierry Reding Size of non-cached memory area. This area of memory will be 36071dfdd9baSThierry Reding typically located right below the malloc() area and mapped 36081dfdd9baSThierry Reding uncached in the MMU. This is useful for drivers that would 36091dfdd9baSThierry Reding otherwise require a lot of explicit cache maintenance. For 36101dfdd9baSThierry Reding some drivers it's also impossible to properly maintain the 36111dfdd9baSThierry Reding cache. For example if the regions that need to be flushed 36121dfdd9baSThierry Reding are not a multiple of the cache-line size, *and* padding 36131dfdd9baSThierry Reding cannot be allocated between the regions to align them (i.e. 36141dfdd9baSThierry Reding if the HW requires a contiguous array of regions, and the 36151dfdd9baSThierry Reding size of each region is not cache-aligned), then a flush of 36161dfdd9baSThierry Reding one region may result in overwriting data that hardware has 36171dfdd9baSThierry Reding written to another region in the same cache-line. This can 36181dfdd9baSThierry Reding happen for example in network drivers where descriptors for 36191dfdd9baSThierry Reding buffers are typically smaller than the CPU cache-line (e.g. 36201dfdd9baSThierry Reding 16 bytes vs. 32 or 64 bytes). 36211dfdd9baSThierry Reding 36221dfdd9baSThierry Reding Non-cached memory is only supported on 32-bit ARM at present. 36231dfdd9baSThierry Reding 36246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 362515940c9aSStefan Roese Normally compressed uImages are limited to an 362615940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 36276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 362815940c9aSStefan Roese to adjust this setting to your needs. 3629c609719bSwdenk 36306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3631c609719bSwdenk Maximum size of memory mapped by the startup code of 3632c609719bSwdenk the Linux kernel; all data that must be processed by 36337d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 36347d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 36351bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 36367d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3637c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3638c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3639c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3640c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3641c609719bSwdenk 3642fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3643fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3644fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3645fca43cc8SJohn Rigby is enabled. 3646fca43cc8SJohn Rigby 3647fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3648fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3649fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3650fca43cc8SJohn Rigby 3651fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3652fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3653fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3654fca43cc8SJohn Rigby 36556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3656c609719bSwdenk Max number of Flash memory banks 3657c609719bSwdenk 36586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3659c609719bSwdenk Max number of sectors on a Flash chip 3660c609719bSwdenk 36616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3662c609719bSwdenk Timeout for Flash erase operations (in ms) 3663c609719bSwdenk 36646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3665c609719bSwdenk Timeout for Flash write operations (in ms) 3666c609719bSwdenk 36676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 36688564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 36698564acf9Swdenk 36706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 36718564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 36728564acf9Swdenk 36736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 36748564acf9Swdenk If defined, hardware flash sectors protection is used 36758564acf9Swdenk instead of U-Boot software protection. 36768564acf9Swdenk 36776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3678c609719bSwdenk 3679c609719bSwdenk Enable TFTP transfers directly to flash memory; 3680c609719bSwdenk without this option such a download has to be 3681c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3682c609719bSwdenk copy from RAM to flash. 3683c609719bSwdenk 3684c609719bSwdenk The two-step approach is usually more reliable, since 3685c609719bSwdenk you can check if the download worked before you erase 368611ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 368711ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3688c609719bSwdenk downloaded image) this option may be very useful. 3689c609719bSwdenk 36906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3691c609719bSwdenk Define if the flash driver uses extra elements in the 36925653fc33Swdenk common flash structure for storing flash geometry. 36935653fc33Swdenk 369400b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 36955653fc33Swdenk This option also enables the building of the cfi_flash driver 36965653fc33Swdenk in the drivers directory 369753cf9435Sstroese 369891809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 369991809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 370091809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 370191809ed5SPiotr Ziecik to the MTD layer. 370291809ed5SPiotr Ziecik 37036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 370496ef831fSGuennadi Liakhovetski Use buffered writes to flash. 370596ef831fSGuennadi Liakhovetski 370696ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 370796ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 370896ef831fSGuennadi Liakhovetski write commands. 370996ef831fSGuennadi Liakhovetski 37106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 37115568e613SStefan Roese If this option is defined, the common CFI flash doesn't 37125568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 37135568e613SStefan Roese is useful, if some of the configured banks are only 37145568e613SStefan Roese optionally available. 37155568e613SStefan Roese 37169a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 37179a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 37189a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 37199a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 37209a042e9cSJerry Van Baren 3721352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3722352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3723352ef3f1SStefan Roese against the source after the write operation. An error message 3724352ef3f1SStefan Roese will be printed when the contents are not identical. 3725352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3726352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3727352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3728352ef3f1SStefan Roese this option if you really know what you are doing. 3729352ef3f1SStefan Roese 37306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 373111ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 373211ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 373353cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 373453cf9435Sstroese buffers can be full shortly after enabling the interface 373511ccc33fSMarcel Ziswiler on high Ethernet traffic. 373653cf9435Sstroese Defaults to 4 if not defined. 3737c609719bSwdenk 3738ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3739ea882bafSWolfgang Denk 3740ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3741ea882bafSWolfgang Denk internally to store the environment settings. The default 3742ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3743ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3744ea882bafSWolfgang Denk lib/hashtable.c for details. 3745ea882bafSWolfgang Denk 37462598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 37472598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 37481bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 37492598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 37502598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 37512598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 37522598090bSJoe Hershberger 37532598090bSJoe Hershberger The format of the list is: 37542598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3755b445bbb4SJeremiah Mahler access_attribute = [a|r|o|c] 3756b445bbb4SJeremiah Mahler attributes = type_attribute[access_attribute] 37572598090bSJoe Hershberger entry = variable_name[:attributes] 37582598090bSJoe Hershberger list = entry[,list] 37592598090bSJoe Hershberger 37602598090bSJoe Hershberger The type attributes are: 37612598090bSJoe Hershberger s - String (default) 37622598090bSJoe Hershberger d - Decimal 37632598090bSJoe Hershberger x - Hexadecimal 37642598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 37652598090bSJoe Hershberger i - IP address 37662598090bSJoe Hershberger m - MAC address 37672598090bSJoe Hershberger 3768267541f7SJoe Hershberger The access attributes are: 3769267541f7SJoe Hershberger a - Any (default) 3770267541f7SJoe Hershberger r - Read-only 3771267541f7SJoe Hershberger o - Write-once 3772267541f7SJoe Hershberger c - Change-default 3773267541f7SJoe Hershberger 37742598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 37752598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 3776b445bbb4SJeremiah Mahler environment variable in the default or embedded environment. 37772598090bSJoe Hershberger 37782598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 37792598090bSJoe Hershberger Define this to a list (string) to define validation that 37802598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 37812598090bSJoe Hershberger environment variable. To override a setting in the static 37822598090bSJoe Hershberger list, simply add an entry for the same variable name to the 37832598090bSJoe Hershberger ".flags" variable. 37842598090bSJoe Hershberger 3785bdf1fe4eSJoe Hershberger If CONFIG_REGEX is defined, the variable_name above is evaluated as a 3786bdf1fe4eSJoe Hershberger regular expression. This allows multiple variables to define the same 3787bdf1fe4eSJoe Hershberger flags without explicitly listing them for each variable. 3788bdf1fe4eSJoe Hershberger 3789267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3790267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3791267541f7SJoe Hershberger access flags. 3792267541f7SJoe Hershberger 37930b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 37940b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 37950b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 3796b445bbb4SJeremiah Mahler the value can be calculated on a given board. 3797632efa74SSimon Glass 37980d296cc2SGabe Black- CONFIG_USE_STDINT 37990d296cc2SGabe Black If stdint.h is available with your toolchain you can define this 38000d296cc2SGabe Black option to enable it. You can provide option 'USE_STDINT=1' when 38010d296cc2SGabe Black building U-Boot to enable this. 38020d296cc2SGabe Black 3803c609719bSwdenkThe following definitions that deal with the placement and management 3804c609719bSwdenkof environment data (variable area); in general, we support the 3805c609719bSwdenkfollowing configurations: 3806c609719bSwdenk 3807c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3808c3eb3fe4SMike Frysinger 3809c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3810c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3811c3eb3fe4SMike Frysinger 38125a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 3813c609719bSwdenk 3814c609719bSwdenk Define this if the environment is in flash memory. 3815c609719bSwdenk 3816c609719bSwdenk a) The environment occupies one whole flash sector, which is 3817c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 3818c609719bSwdenk happens usually with "bottom boot sector" or "top boot 3819c609719bSwdenk sector" type flash chips, which have several smaller 3820c609719bSwdenk sectors at the start or the end. For instance, such a 3821c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3822c609719bSwdenk such a case you would place the environment in one of the 3823c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 3824c609719bSwdenk "top boot sector" type flash chips, you would put the 3825c609719bSwdenk environment in one of the last sectors, leaving a gap 3826c609719bSwdenk between U-Boot and the environment. 3827c609719bSwdenk 38280e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 3829c609719bSwdenk 3830c609719bSwdenk Offset of environment data (variable area) to the 3831c609719bSwdenk beginning of flash memory; for instance, with bottom boot 3832c609719bSwdenk type flash chips the second sector can be used: the offset 3833c609719bSwdenk for this sector is given here. 3834c609719bSwdenk 38356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3836c609719bSwdenk 38370e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 3838c609719bSwdenk 3839c609719bSwdenk This is just another way to specify the start address of 3840c609719bSwdenk the flash sector containing the environment (instead of 38410e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 3842c609719bSwdenk 38430e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 3844c609719bSwdenk 3845c609719bSwdenk Size of the sector containing the environment. 3846c609719bSwdenk 3847c609719bSwdenk 3848c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 3849c609719bSwdenk In such a case you don't want to spend a whole sector for 3850c609719bSwdenk the environment. 3851c609719bSwdenk 38520e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3853c609719bSwdenk 38545a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 38550e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3856c609719bSwdenk of this flash sector for the environment. This saves 3857c609719bSwdenk memory for the RAM copy of the environment. 3858c609719bSwdenk 3859c609719bSwdenk It may also save flash memory if you decide to use this 3860c609719bSwdenk when your environment is "embedded" within U-Boot code, 3861c609719bSwdenk since then the remainder of the flash sector could be used 3862c609719bSwdenk for U-Boot code. It should be pointed out that this is 3863c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 3864c609719bSwdenk updating the environment in flash makes it always 3865c609719bSwdenk necessary to erase the WHOLE sector. If something goes 3866c609719bSwdenk wrong before the contents has been restored from a copy in 3867c609719bSwdenk RAM, your target system will be dead. 3868c609719bSwdenk 38690e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 38700e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 3871c609719bSwdenk 3872c609719bSwdenk These settings describe a second storage area used to hold 387311ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 38743e38691eSwdenk a valid backup copy in case there is a power failure during 3875c609719bSwdenk a "saveenv" operation. 3876c609719bSwdenk 3877c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 3878c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 3879c609719bSwdenkaccordingly! 3880c609719bSwdenk 3881c609719bSwdenk 38829314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 3883c609719bSwdenk 3884c609719bSwdenk Define this if you have some non-volatile memory device 3885c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 3886c609719bSwdenk environment. 3887c609719bSwdenk 38880e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 38890e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3890c609719bSwdenk 389111ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 3892c609719bSwdenk want to use for environment. It is assumed that this memory 3893c609719bSwdenk can just be read and written to, without any special 3894c609719bSwdenk provision. 3895c609719bSwdenk 3896c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3897b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the 389811ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3899c609719bSwdenkU-Boot will hang. 3900c609719bSwdenk 3901c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3902c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3903c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3904c609719bSwdenkto save the current settings. 3905c609719bSwdenk 3906c609719bSwdenk 3907bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 3908c609719bSwdenk 3909c609719bSwdenk Use this if you have an EEPROM or similar serial access 3910c609719bSwdenk device and a driver for it. 3911c609719bSwdenk 39120e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 39130e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 3914c609719bSwdenk 3915c609719bSwdenk These two #defines specify the offset and size of the 3916c609719bSwdenk environment area within the total memory of your EEPROM. 3917c609719bSwdenk 39186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 3919c609719bSwdenk If defined, specified the chip address of the EEPROM device. 3920c609719bSwdenk The default address is zero. 3921c609719bSwdenk 3922189d257bSChristian Gmeiner - CONFIG_SYS_I2C_EEPROM_BUS: 3923189d257bSChristian Gmeiner If defined, specified the i2c bus of the EEPROM device. 3924189d257bSChristian Gmeiner 39256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3926c609719bSwdenk If defined, the number of bits used to address bytes in a 3927c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 3928c609719bSwdenk would require six bits. 3929c609719bSwdenk 39306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3931c609719bSwdenk If defined, the number of milliseconds to delay between 3932c609719bSwdenk page writes. The default is zero milliseconds. 3933c609719bSwdenk 39346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3935c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 3936c609719bSwdenk that this is NOT the chip address length! 3937c609719bSwdenk 39386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 39395cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 39405cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 39415cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 39425cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 39435cf91d6bSwdenk byte chips. 39445cf91d6bSwdenk 39455cf91d6bSwdenk Note that we consider the length of the address field to 39465cf91d6bSwdenk still be one byte because the extra address bits are hidden 39475cf91d6bSwdenk in the chip address. 39485cf91d6bSwdenk 39496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 3950c609719bSwdenk The size in bytes of the EEPROM device. 3951c609719bSwdenk 3952548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 3953548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 3954548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 3955548738b4SHeiko Schocher 3956548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 3957548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 3958548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 3959548738b4SHeiko Schocher EEPROM. For example: 3960548738b4SHeiko Schocher 3961ea818dbbSHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS 1 3962548738b4SHeiko Schocher 3963548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 3964548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 3965c609719bSwdenk 3966057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 39675779d8d9Swdenk 39685779d8d9Swdenk Define this if you have a DataFlash memory device which you 39695779d8d9Swdenk want to use for the environment. 39705779d8d9Swdenk 39710e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 39720e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 39730e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 39745779d8d9Swdenk 39755779d8d9Swdenk These three #defines specify the offset and size of the 39765779d8d9Swdenk environment area within the total memory of your DataFlash placed 39775779d8d9Swdenk at the specified address. 39785779d8d9Swdenk 3979bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH: 3980bd83b592SWu, Josh 3981bd83b592SWu, Josh Define this if you have a SPI Flash memory device which you 3982bd83b592SWu, Josh want to use for the environment. 3983bd83b592SWu, Josh 3984bd83b592SWu, Josh - CONFIG_ENV_OFFSET: 3985bd83b592SWu, Josh - CONFIG_ENV_SIZE: 3986bd83b592SWu, Josh 3987bd83b592SWu, Josh These two #defines specify the offset and size of the 3988bd83b592SWu, Josh environment area within the SPI Flash. CONFIG_ENV_OFFSET must be 3989bd83b592SWu, Josh aligned to an erase sector boundary. 3990bd83b592SWu, Josh 3991bd83b592SWu, Josh - CONFIG_ENV_SECT_SIZE: 3992bd83b592SWu, Josh 3993bd83b592SWu, Josh Define the SPI flash's sector size. 3994bd83b592SWu, Josh 3995bd83b592SWu, Josh - CONFIG_ENV_OFFSET_REDUND (optional): 3996bd83b592SWu, Josh 3997bd83b592SWu, Josh This setting describes a second storage area of CONFIG_ENV_SIZE 3998bd83b592SWu, Josh size used to hold a redundant copy of the environment data, so 3999bd83b592SWu, Josh that there is a valid backup copy in case there is a power failure 40009dd05fb8SSimon Glass during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be 4001bd83b592SWu, Josh aligned to an erase sector boundary. 4002bd83b592SWu, Josh 4003bd83b592SWu, Josh - CONFIG_ENV_SPI_BUS (optional): 4004bd83b592SWu, Josh - CONFIG_ENV_SPI_CS (optional): 4005bd83b592SWu, Josh 4006bd83b592SWu, Josh Define the SPI bus and chip select. If not defined they will be 0. 4007bd83b592SWu, Josh 4008bd83b592SWu, Josh - CONFIG_ENV_SPI_MAX_HZ (optional): 4009bd83b592SWu, Josh 4010bd83b592SWu, Josh Define the SPI max work clock. If not defined then use 1MHz. 4011bd83b592SWu, Josh 4012bd83b592SWu, Josh - CONFIG_ENV_SPI_MODE (optional): 4013bd83b592SWu, Josh 4014bd83b592SWu, Josh Define the SPI work mode. If not defined then use SPI_MODE_3. 4015bd83b592SWu, Josh 40160a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 40170a85a9e7SLiu Gang 40180a85a9e7SLiu Gang Define this if you have a remote memory space which you 40190a85a9e7SLiu Gang want to use for the local device's environment. 40200a85a9e7SLiu Gang 40210a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 40220a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 40230a85a9e7SLiu Gang 40240a85a9e7SLiu Gang These two #defines specify the address and size of the 40250a85a9e7SLiu Gang environment area within the remote memory space. The 40260a85a9e7SLiu Gang local device can get the environment from remote memory 4027fc54c7faSLiu Gang space by SRIO or PCIE links. 40280a85a9e7SLiu Gang 40290a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 40300a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 4031fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 4032fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 40330a85a9e7SLiu Gang 403451bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 403513a5695bSwdenk 403613a5695bSwdenk Define this if you have a NAND device which you want to use 403713a5695bSwdenk for the environment. 403813a5695bSwdenk 40390e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 40400e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 404113a5695bSwdenk 404213a5695bSwdenk These two #defines specify the offset and size of the environment 4043fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 4044fdd813deSScott Wood aligned to an erase block boundary. 40455779d8d9Swdenk 4046fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 4047e443c944SMarkus Klotzbuecher 40480e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 4049fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 4050fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 40519dd05fb8SSimon Glass during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be 4052fdd813deSScott Wood aligned to an erase block boundary. 4053e443c944SMarkus Klotzbuecher 4054fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 4055fdd813deSScott Wood 4056fdd813deSScott Wood Specifies the length of the region in which the environment 4057fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 4058fdd813deSScott Wood block size. Specifying a range with more erase blocks than 4059fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 4060fdd813deSScott Wood the range to be avoided. 4061fdd813deSScott Wood 4062fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 4063fdd813deSScott Wood 4064fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 4065fdd813deSScott Wood environment from block zero's out-of-band data. The 4066fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 4067fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 4068fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 4069e443c944SMarkus Klotzbuecher 4070b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 4071b74ab737SGuennadi Liakhovetski 4072b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 4073b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 4074b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 4075b74ab737SGuennadi Liakhovetski 40762b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 40772b74433fSJoe Hershberger 40782b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 40792b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 40802b74433fSJoe Hershberger accesses, which is important on NAND. 40812b74433fSJoe Hershberger 40822b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 40832b74433fSJoe Hershberger 40842b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 40852b74433fSJoe Hershberger 40862b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 40872b74433fSJoe Hershberger 40882b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 40892b74433fSJoe Hershberger environment in. 40902b74433fSJoe Hershberger 4091785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 4092785881f7SJoe Hershberger 4093785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 4094785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 4095785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 4096785881f7SJoe Hershberger 40972b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 40982b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 40992b74433fSJoe Hershberger 41002b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 41012b74433fSJoe Hershberger when storing the env in UBI. 41022b74433fSJoe Hershberger 4103d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT: 4104d1db76f1SWu, Josh Define this if you want to use the FAT file system for the environment. 4105d1db76f1SWu, Josh 4106d1db76f1SWu, Josh - FAT_ENV_INTERFACE: 4107d1db76f1SWu, Josh 4108d1db76f1SWu, Josh Define this to a string that is the name of the block device. 4109d1db76f1SWu, Josh 411041987784SNicolae Rosia - FAT_ENV_DEVICE_AND_PART: 4111d1db76f1SWu, Josh 4112d1db76f1SWu, Josh Define this to a string to specify the partition of the device. It can 4113d1db76f1SWu, Josh be as following: 4114d1db76f1SWu, Josh 4115d1db76f1SWu, Josh "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1) 4116d1db76f1SWu, Josh - "D:P": device D partition P. Error occurs if device D has no 4117d1db76f1SWu, Josh partition table. 4118d1db76f1SWu, Josh - "D:0": device D. 4119d1db76f1SWu, Josh - "D" or "D:": device D partition 1 if device D has partition 4120d1db76f1SWu, Josh table, or the whole device D if has no partition 4121d1db76f1SWu, Josh table. 4122d1db76f1SWu, Josh - "D:auto": first partition in device D with bootable flag set. 4123b445bbb4SJeremiah Mahler If none, first valid partition in device D. If no 4124d1db76f1SWu, Josh partition table then means device D. 4125d1db76f1SWu, Josh 4126d1db76f1SWu, Josh - FAT_ENV_FILE: 4127d1db76f1SWu, Josh 4128d1db76f1SWu, Josh It's a string of the FAT file name. This file use to store the 4129b445bbb4SJeremiah Mahler environment. 4130d1db76f1SWu, Josh 4131d1db76f1SWu, Josh - CONFIG_FAT_WRITE: 4132b445bbb4SJeremiah Mahler This should be defined. Otherwise it cannot save the environment file. 4133d1db76f1SWu, Josh 413406e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 413506e4ae5fSStephen Warren 413606e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 413706e4ae5fSStephen Warren environment. 413806e4ae5fSStephen Warren 413906e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 414006e4ae5fSStephen Warren 414106e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 414206e4ae5fSStephen Warren 414306e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 414406e4ae5fSStephen Warren 414506e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 414606e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 414706e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 414806e4ae5fSStephen Warren 414906e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 415006e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 415106e4ae5fSStephen Warren 415206e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 415306e4ae5fSStephen Warren area within the specified MMC device. 415406e4ae5fSStephen Warren 41555c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 41565c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 41575c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 41585c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 41595c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 41605c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 41615c088ee8SStephen Warren maximum possible space before it, to store other data. 41625c088ee8SStephen Warren 416306e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 416406e4ae5fSStephen Warren MMC sector boundary. 416506e4ae5fSStephen Warren 416606e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 416706e4ae5fSStephen Warren 416806e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 416906e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 417006e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 417106e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 417206e4ae5fSStephen Warren 41735c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 41745c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 41755c088ee8SStephen Warren 417606e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 417706e4ae5fSStephen Warren an MMC sector boundary. 417806e4ae5fSStephen Warren 417906e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 418006e4ae5fSStephen Warren 418106e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 418206e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 418306e4ae5fSStephen Warren CONFIG_ENV_SIZE. 418406e4ae5fSStephen Warren 41856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 4186c609719bSwdenk 4187c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 4188c609719bSwdenk area is used at an early stage (ROM part) if the environment 4189c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 4190c609719bSwdenk scratch DPRAM area. It is used between the two initialization 4191c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4192c609719bSwdenk to be a good choice since it makes it far enough from the 4193c609719bSwdenk start of the data area as well as from the stack pointer. 4194c609719bSwdenk 4195e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 4196c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 4197cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 4198c609719bSwdenkuntil then to read environment variables. 4199c609719bSwdenk 420085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 420185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 420285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 420385ec0bccSwdenknecessary, because the first environment variable we need is the 420485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 420585ec0bccSwdenkhave any device yet where we could complain.] 4206c609719bSwdenk 4207c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 4208c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 420985ec0bccSwdenkuse the "saveenv" command to store a valid environment. 4210c609719bSwdenk 42116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4212fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 4213fc3e2165Swdenk 42146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4215fc3e2165Swdenk also needs to be defined. 4216fc3e2165Swdenk 42176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 4218fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 4219c609719bSwdenk 4220f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 4221f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 4222f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 4223f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 4224f5675aa5SRon Madrid space for already greatly restricted images, including but not 4225f5675aa5SRon Madrid limited to NAND_SPL configurations. 4226f5675aa5SRon Madrid 4227b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 4228b2b92f53SSimon Glass Display information about the board that U-Boot is running on 4229b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 4230b2b92f53SSimon Glass to do this. 4231b2b92f53SSimon Glass 4232e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 4233e2e3e2b1SSimon Glass Similar to the previous option, but display this information 4234e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 4235e2e3e2b1SSimon Glass present. 4236e2e3e2b1SSimon Glass 4237feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT: 4238feb85801SSascha Silbe Maximum size of the U-Boot image. When defined, the 4239feb85801SSascha Silbe build system checks that the actual size does not 4240feb85801SSascha Silbe exceed it. 4241feb85801SSascha Silbe 4242c609719bSwdenkLow Level (hardware related) configuration options: 4243dc7c9a1aSwdenk--------------------------------------------------- 4244c609719bSwdenk 42456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 4246c609719bSwdenk Cache Line Size of the CPU. 4247c609719bSwdenk 42486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 4249c609719bSwdenk Default address of the IMMR after system reset. 42502535d602Swdenk 42512535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 42522535d602Swdenk and RPXsuper) to be able to adjust the position of 42532535d602Swdenk the IMMR register after a reset. 4254c609719bSwdenk 4255e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 4256e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 4257e46fedfeSTimur Tabi PowerPC SOCs. 4258e46fedfeSTimur Tabi 4259e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 4260e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 4261e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4262e46fedfeSTimur Tabi 4263e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4264e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 4265e46fedfeSTimur Tabi 4266e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 4267e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 4268e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 4269e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 4270e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4271e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 4272e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 4273e46fedfeSTimur Tabi 4274e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4275e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4276e46fedfeSTimur Tabi 4277e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4278e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4279e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 4280e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4281e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4282e46fedfeSTimur Tabi 4283e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4284e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4285e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4286e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4287e46fedfeSTimur Tabi 4288e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4289e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4290e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 4291e46fedfeSTimur Tabi 42927f6c2cbcSwdenk- Floppy Disk Support: 42936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 42947f6c2cbcSwdenk 42957f6c2cbcSwdenk the default drive number (default value 0) 42967f6c2cbcSwdenk 42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 42987f6c2cbcSwdenk 429911ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 43007f6c2cbcSwdenk (default value 1) 43017f6c2cbcSwdenk 43026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 43037f6c2cbcSwdenk 43047f6c2cbcSwdenk defines the offset of register from address. It 43057f6c2cbcSwdenk depends on which part of the data bus is connected to 430611ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 43077f6c2cbcSwdenk 43086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 43096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 43107f6c2cbcSwdenk default value. 43117f6c2cbcSwdenk 43126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 43137f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 43147f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 4315b445bbb4SJeremiah Mahler source code. It is used to make hardware-dependent 43167f6c2cbcSwdenk initializations. 43177f6c2cbcSwdenk 43180abddf82SMacpaul Lin- CONFIG_IDE_AHB: 43190abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 43200abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 43210abddf82SMacpaul Lin When software is doing ATA command and data transfer to 43220abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 43230abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 4324b445bbb4SJeremiah Mahler is required. 43250abddf82SMacpaul Lin 43266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 432725d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 432825d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 4329c609719bSwdenk 43306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 4331c609719bSwdenk 43327152b1d0Swdenk Start address of memory area that can be used for 4333c609719bSwdenk initial data and stack; please note that this must be 4334c609719bSwdenk writable memory that is working WITHOUT special 4335c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 4336c609719bSwdenk will become available only after programming the 4337c609719bSwdenk memory controller and running certain initialization 4338c609719bSwdenk sequences. 4339c609719bSwdenk 4340c609719bSwdenk U-Boot uses the following memory types: 4341c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4342c609719bSwdenk - MPC824X: data cache 4343c609719bSwdenk - PPC4xx: data cache 4344c609719bSwdenk 43456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 4346c609719bSwdenk 4347c609719bSwdenk Offset of the initial data structure in the memory 43486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 43496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4350c609719bSwdenk data is located at the end of the available space 4351553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 4352acd51f9dSSimon Glass GENERATED_GBL_DATA_SIZE), and the initial stack is just 43536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 43546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 4355c609719bSwdenk 4356c609719bSwdenk Note: 4357c609719bSwdenk On the MPC824X (or other systems that use the data 4358c609719bSwdenk cache for initial memory) the address chosen for 43596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4360c609719bSwdenk point to an otherwise UNUSED address space between 4361c609719bSwdenk the top of RAM and the start of the PCI space. 4362c609719bSwdenk 43636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4364c609719bSwdenk 43656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4366c609719bSwdenk 43676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4368c609719bSwdenk 43696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4370c609719bSwdenk 43716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4372c609719bSwdenk 43736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4374c609719bSwdenk 43756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 4376c609719bSwdenk SDRAM timing 4377c609719bSwdenk 43786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 4379c609719bSwdenk periodic timer for refresh 4380c609719bSwdenk 43816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 4382c609719bSwdenk 43836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 43846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 43856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 43866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 4387c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4388c609719bSwdenk 4389c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 43906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 43916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4392c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4393c609719bSwdenk 43946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 43956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4396c609719bSwdenk Machine Mode Register and Memory Periodic Timer 4397c609719bSwdenk Prescaler definitions (SDRAM timing) 4398c609719bSwdenk 43996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4400c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 4401c609719bSwdenk define relocation offset in DPRAM [DSP2] 4402c609719bSwdenk 44036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4404b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 4405b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 4406b423d055SHeiko Schocher 44076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4408c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 4409c609719bSwdenk define relocation offset in DPRAM [SCC4] 4410c609719bSwdenk 44116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4412ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 4413ea909b76Swdenk (Power On Self Tests). This definition overrides 4414ea909b76Swdenk #define'd default value in commproc.h resp. 4415ea909b76Swdenk cpm_8260.h. 4416ea909b76Swdenk 44176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 44186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 44196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 44206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 44216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 44226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 44236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 44246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4425a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 44265d232d0eSwdenk 44279cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 44289cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 44299cacf4fcSDirk Eibach required. 44309cacf4fcSDirk Eibach 443169fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 4432b445bbb4SJeremiah Mahler Only scan through and get the devices on the buses. 443369fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 443469fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 443569fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 443669fd2d3bSAndrew Sharp by coreboot or similar. 443769fd2d3bSAndrew Sharp 4438842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 4439842033e6SGabor Juhos Enable support for indirect PCI bridges. 4440842033e6SGabor Juhos 4441a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 4442a09b9b68SKumar Gala Chip has SRIO or not 4443a09b9b68SKumar Gala 4444a09b9b68SKumar Gala- CONFIG_SRIO1: 4445a09b9b68SKumar Gala Board has SRIO 1 port available 4446a09b9b68SKumar Gala 4447a09b9b68SKumar Gala- CONFIG_SRIO2: 4448a09b9b68SKumar Gala Board has SRIO 2 port available 4449a09b9b68SKumar Gala 4450c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 4451c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 4452c8b28152SLiu Gang 4453a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 4454a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 4455a09b9b68SKumar Gala 4456a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 4457a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 4458a09b9b68SKumar Gala 4459a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 4460a09b9b68SKumar Gala Size of SRIO port 'n' memory region 4461a09b9b68SKumar Gala 446266bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 446366bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 446466bd1846SFabio Estevam a 16 bit bus. 446566bd1846SFabio Estevam Not all NAND drivers use this symbol. 4466a430e916SFabio Estevam Example of drivers that use it: 446766bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 4468a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 4469eced4626SAlex Waterman 4470eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 4471eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 4472eced4626SAlex Waterman a default value will be used. 4473eced4626SAlex Waterman 4474bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 4475218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 4476218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 4477218ca724SWolfgang Denk 4478bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 4479bb99ad6dSBen Warren I2C address of the SPD EEPROM 4480bb99ad6dSBen Warren 44816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4482218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4483218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4484218ca724SWolfgang Denk to something your driver can deal with. 4485bb99ad6dSBen Warren 44861b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 44871b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 44881b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 44891b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 44901b3e3c4fSYork Sun header files or board specific files. 44911b3e3c4fSYork Sun 44926f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 44936f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 44946f5e1dc5SYork Sun 4495e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH 4496e32d59a2SYork Sun Enable sync of refresh for multiple controllers. 4497e32d59a2SYork Sun 44984516ff81SYork Sun- CONFIG_FSL_DDR_BIST 44994516ff81SYork Sun Enable built-in memory test for Freescale DDR controllers. 45004516ff81SYork Sun 45016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4502218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4503218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 45042ad6b513STimur Tabi 4505c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4506c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4507c26e454dSwdenk 4508c26e454dSwdenk- CONFIG_FEC[12]_PHY 4509c26e454dSwdenk Define to the hardcoded PHY address which corresponds 45106e592385Swdenk to the given FEC; i. e. 4511c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4512c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4513c26e454dSwdenk 4514c26e454dSwdenk When set to -1, means to probe for first available. 4515c26e454dSwdenk 4516c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4517c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4518c26e454dSwdenk (so program the FEC to ignore it). 4519c26e454dSwdenk 4520c26e454dSwdenk- CONFIG_RMII 4521c26e454dSwdenk Enable RMII mode for all FECs. 4522c26e454dSwdenk Note that this is a global option, we can't 4523c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4524c26e454dSwdenk 45255cf91d6bSwdenk- CONFIG_CRC32_VERIFY 45265cf91d6bSwdenk Add a verify option to the crc32 command. 45275cf91d6bSwdenk The syntax is: 45285cf91d6bSwdenk 45295cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 45305cf91d6bSwdenk 45315cf91d6bSwdenk Where address/count indicate a memory area 45325cf91d6bSwdenk and crc32 is the correct crc32 which the 45335cf91d6bSwdenk area should have. 45345cf91d6bSwdenk 453556523f12Swdenk- CONFIG_LOOPW 453656523f12Swdenk Add the "loopw" memory command. This only takes effect if 4537602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 453856523f12Swdenk 45397b466641Sstroese- CONFIG_MX_CYCLIC 45407b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 45417b466641Sstroese "md/mw" commands. 45427b466641Sstroese Examples: 45437b466641Sstroese 45447b466641Sstroese => mdc.b 10 4 500 45457b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 45467b466641Sstroese 45477b466641Sstroese => mwc.l 100 12345678 10 45487b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 45497b466641Sstroese 45507b466641Sstroese This only takes effect if the memory commands are activated 4551602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 45527b466641Sstroese 45538aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4554afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4555e03f3169SWolfgang Denk low level initializations (like setting up the memory 4556e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4557e03f3169SWolfgang Denk relocate itself into RAM. 45588aa1a2d1Swdenk 4559e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4560e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4561e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4562e03f3169SWolfgang Denk these initializations itself. 45638aa1a2d1Swdenk 4564b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY 4565b5bd0982SSimon Glass [ARM926EJ-S only] This allows just the call to lowlevel_init() 456690211f77Syeongjun Kim to be skipped. The normal CP15 init (such as enabling the 4567b5bd0982SSimon Glass instruction cache) is still performed. 4568b5bd0982SSimon Glass 4569401bb30bSAneesh V- CONFIG_SPL_BUILD 4570df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4571df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4572df81238bSMagnus Lilja compiling a NAND SPL. 4573400558b5Swdenk 45743aa29de0SYing Zhang- CONFIG_TPL_BUILD 45753aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 45763aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 45773aa29de0SYing Zhang It is loaded by the SPL. 45783aa29de0SYing Zhang 45795df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 45805df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 45815df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 45825df572f0SYing Zhang previous 4k of the .text section. 45835df572f0SYing Zhang 45844213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 45854213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 45864213fc29SSimon Glass effective address. It is therefore not necessary to regard 45874213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 45884213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 45894213fc29SSimon Glass it maintains its own little RAM buffer which contains all 45904213fc29SSimon Glass addressable memory. This option causes some memory accesses 45914213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 45924213fc29SSimon Glass 4593588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4594588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4595588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4596b16f521aSGabe Black 4597fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4598fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4599fc33705eSMark Jackson 4600fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 46015b5ece9eSGabe Black 460216678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 460316678eb4SHeiko Schocher Enables the RTC32K OSC on AM33xx based plattforms 460416678eb4SHeiko Schocher 4605999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 4606999d7d32SKaricheri, Muralidharan Option to disable subpage write in NAND driver 4607999d7d32SKaricheri, Muralidharan driver that uses this: 4608999d7d32SKaricheri, Muralidharan drivers/mtd/nand/davinci_nand.c 4609999d7d32SKaricheri, Muralidharan 4610f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4611f2717b47STimur Tabi----------------------------------- 4612f2717b47STimur Tabi 4613f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4614f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4615f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4616f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4617f2717b47STimur Tabiwithin that device. 4618f2717b47STimur Tabi 4619dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR 4620dcf1d774SZhao Qiang The address in the storage device where the FMAN microcode is located. The 4621dcf1d774SZhao Qiang meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4622dcf1d774SZhao Qiang is also specified. 4623dcf1d774SZhao Qiang 4624dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR 4625dcf1d774SZhao Qiang The address in the storage device where the QE microcode is located. The 4626f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4627f2717b47STimur Tabi is also specified. 4628f2717b47STimur Tabi 4629f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4630f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4631f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4632f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4633f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4634f2717b47STimur Tabi 4635f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4636f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4637f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4638f2717b47STimur Tabi virtual address in NOR flash. 4639f2717b47STimur Tabi 4640f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4641f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4642f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4643f2717b47STimur Tabi 4644f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4645f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4646f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4647f2717b47STimur Tabi 4648292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4649292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4650292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4651fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4652fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4653fc54c7faSLiu Gang master's memory space. 4654f2717b47STimur Tabi 4655b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support: 4656b940ca64SJ. German Rivera--------------------------------------------------------- 4657b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of 4658b940ca64SJ. German Rivera"firmware". 4659b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros 4660b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address 4661b940ca64SJ. German Riverawithin that device. 4662b940ca64SJ. German Rivera 4663b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET 4664b940ca64SJ. German Rivera Enable the MC driver for Layerscape SoCs. 4665b940ca64SJ. German Rivera 46665c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support: 46675c055089SPrabhakar Kushwaha------------------------------------------- 46685c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of 46695c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom. 46705c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting. 46715c055089SPrabhakar Kushwaha 4672c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN 4673c0492141SYork Sun Define alignment of reserved memory MC requires 46745c055089SPrabhakar Kushwaha 4675f3f431a7SPaul KocialkowskiReproducible builds 4676f3f431a7SPaul Kocialkowski------------------- 4677f3f431a7SPaul Kocialkowski 4678f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build 4679f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value. 4680f3f431a7SPaul Kocialkowski 4681f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable. 4682f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration 4683f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot. 4684f3f431a7SPaul Kocialkowski 4685f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. 4686f3f431a7SPaul Kocialkowski 4687c609719bSwdenkBuilding the Software: 4688c609719bSwdenk====================== 4689c609719bSwdenk 4690218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4691218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4692218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4693218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4694218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4695218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4696c609719bSwdenk 4697218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4698218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4699218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4700218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4701218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4702c609719bSwdenk 4703218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4704218ca724SWolfgang Denk $ export CROSS_COMPILE 4705c609719bSwdenk 47062f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 47072f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 47082f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 47092f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 47102f8d396bSPeter Tyser 47112f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 47122f8d396bSPeter Tyser 47132f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 47142f8d396bSPeter Tyser be executed on computers running Windows. 47152f8d396bSPeter Tyser 4716c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4717c609719bSwdenksources you must configure U-Boot for one specific board type. This 4718c609719bSwdenkis done by typing: 4719c609719bSwdenk 4720ab584d67SHolger Freyther make NAME_defconfig 4721c609719bSwdenk 4722ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu- 47234d675ae6SMichael Jonesrations; see boards.cfg for supported names. 472454387ac9Swdenk 4725c609719bSwdenkNote: for some board special configuration names may exist; check if 4726c609719bSwdenk additional information is available from the board vendor; for 47272729af9dSwdenk instance, the TQM823L systems are available without (standard) 47282729af9dSwdenk or with LCD support. You can select such additional "features" 472911ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 4730c609719bSwdenk 4731ab584d67SHolger Freyther make TQM823L_defconfig 47322729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 4733c609719bSwdenk 4734ab584d67SHolger Freyther make TQM823L_LCD_defconfig 4735c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 4736c609719bSwdenk 4737c609719bSwdenk etc. 4738c609719bSwdenk 4739c609719bSwdenk 4740c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 47417152b1d0Swdenkimages ready for download to / installation on your system: 4742c609719bSwdenk 4743c609719bSwdenk- "u-boot.bin" is a raw binary image 4744c609719bSwdenk- "u-boot" is an image in ELF binary format 4745c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 4746c609719bSwdenk 4747baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 4748baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 4749baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 4750baf31249SMarian Balakowicz 4751baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 4752baf31249SMarian Balakowicz 4753baf31249SMarian Balakowicz make O=/tmp/build distclean 4754ab584d67SHolger Freyther make O=/tmp/build NAME_defconfig 4755baf31249SMarian Balakowicz make O=/tmp/build all 4756baf31249SMarian Balakowicz 4757adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location: 4758baf31249SMarian Balakowicz 4759adbba996STimo Ketola export KBUILD_OUTPUT=/tmp/build 4760baf31249SMarian Balakowicz make distclean 4761ab584d67SHolger Freyther make NAME_defconfig 4762baf31249SMarian Balakowicz make all 4763baf31249SMarian Balakowicz 4764adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment 4765baf31249SMarian Balakowiczvariable. 4766baf31249SMarian Balakowicz 4767c609719bSwdenk 4768c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 4769c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 4770c609719bSwdenknative "make". 4771c609719bSwdenk 4772c609719bSwdenk 4773c609719bSwdenkIf the system board that you have is not listed, then you will need 4774c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 4775c609719bSwdenksteps: 4776c609719bSwdenk 47773c1496cdSPhil Sutter1. Create a new directory to hold your board specific code. Add any 477885ec0bccSwdenk files you need. In your board directory, you will need at least 47793c1496cdSPhil Sutter the "Makefile" and a "<board>.c". 47803c1496cdSPhil Sutter2. Create a new configuration file "include/configs/<board>.h" for 47813c1496cdSPhil Sutter your board. 4782c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 4783c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 4784ab584d67SHolger Freyther4. Run "make <board>_defconfig" with your new name. 4785c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 4786c609719bSwdenk to be installed on your target system. 478785ec0bccSwdenk6. Debug and solve any problems that might arise. 4788c609719bSwdenk [Of course, this last step is much harder than it sounds.] 4789c609719bSwdenk 4790c609719bSwdenk 4791c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 4792c609719bSwdenk============================================================== 4793c609719bSwdenk 4794c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 4795c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 4796c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 4797c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 4798218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 4799c609719bSwdenk 4800c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 4801c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 4802c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 48036de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will 48046de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this 48056de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H' 48066de80f21SSimon Glassfor documentation. 4807baf31249SMarian Balakowicz 4808baf31249SMarian Balakowicz 4809c609719bSwdenkSee also "U-Boot Porting Guide" below. 4810c609719bSwdenk 4811c609719bSwdenk 4812c609719bSwdenkMonitor Commands - Overview: 4813c609719bSwdenk============================ 4814c609719bSwdenk 4815c609719bSwdenkgo - start application at address 'addr' 4816c609719bSwdenkrun - run commands in an environment variable 4817c609719bSwdenkbootm - boot application image from memory 4818c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 481944f074c7SMarek Vasutbootz - boot zImage from memory 4820c609719bSwdenktftpboot- boot image via network using TFTP protocol 4821c609719bSwdenk and env variables "ipaddr" and "serverip" 4822c609719bSwdenk (and eventually "gatewayip") 48231fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 4824c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 4825c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4826c609719bSwdenkloads - load S-Record file over serial line 4827c609719bSwdenkloadb - load binary file over serial line (kermit mode) 4828c609719bSwdenkmd - memory display 4829c609719bSwdenkmm - memory modify (auto-incrementing) 4830c609719bSwdenknm - memory modify (constant address) 4831c609719bSwdenkmw - memory write (fill) 4832c609719bSwdenkcp - memory copy 4833c609719bSwdenkcmp - memory compare 4834c609719bSwdenkcrc32 - checksum calculation 48350f89c54bSPeter Tyseri2c - I2C sub-system 4836c609719bSwdenksspi - SPI utility commands 4837c609719bSwdenkbase - print or set address offset 4838c609719bSwdenkprintenv- print environment variables 4839c609719bSwdenksetenv - set environment variables 4840c609719bSwdenksaveenv - save environment variables to persistent storage 4841c609719bSwdenkprotect - enable or disable FLASH write protection 4842c609719bSwdenkerase - erase FLASH memory 4843c609719bSwdenkflinfo - print FLASH memory information 484410635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 4845c609719bSwdenkbdinfo - print Board Info structure 4846c609719bSwdenkiminfo - print header information for application image 4847c609719bSwdenkconinfo - print console devices and informations 4848c609719bSwdenkide - IDE sub-system 4849c609719bSwdenkloop - infinite loop on address range 485056523f12Swdenkloopw - infinite write loop on address range 4851c609719bSwdenkmtest - simple RAM test 4852c609719bSwdenkicache - enable or disable instruction cache 4853c609719bSwdenkdcache - enable or disable data cache 4854c609719bSwdenkreset - Perform RESET of the CPU 4855c609719bSwdenkecho - echo args to console 4856c609719bSwdenkversion - print monitor version 4857c609719bSwdenkhelp - print online help 4858c609719bSwdenk? - alias for 'help' 4859c609719bSwdenk 4860c609719bSwdenk 4861c609719bSwdenkMonitor Commands - Detailed Description: 4862c609719bSwdenk======================================== 4863c609719bSwdenk 4864c609719bSwdenkTODO. 4865c609719bSwdenk 4866c609719bSwdenkFor now: just type "help <command>". 4867c609719bSwdenk 4868c609719bSwdenk 4869c609719bSwdenkEnvironment Variables: 4870c609719bSwdenk====================== 4871c609719bSwdenk 4872c609719bSwdenkU-Boot supports user configuration using Environment Variables which 4873c609719bSwdenkcan be made persistent by saving to Flash memory. 4874c609719bSwdenk 4875c609719bSwdenkEnvironment Variables are set using "setenv", printed using 4876c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 4877c609719bSwdenkwithout a value can be used to delete a variable from the 4878c609719bSwdenkenvironment. As long as you don't save the environment you are 4879c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 4880c609719bSwdenkenvironment is erased by accident, a default environment is provided. 4881c609719bSwdenk 4882c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 4883c96f86eeSWolfgang Denk 4884c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 4885c609719bSwdenk 4886c609719bSwdenk baudrate - see CONFIG_BAUDRATE 4887c609719bSwdenk 4888c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 4889c609719bSwdenk 4890c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 4891c609719bSwdenk 4892c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 4893c609719bSwdenk 4894c609719bSwdenk bootfile - Name of the image to load with TFTP 4895c609719bSwdenk 48967d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 48977d721e34SBartlomiej Sieka command can be restricted. This variable is given as 48987d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 48997d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 49007d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 49017d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 4902c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4903c3624e6eSGrant Likely bootm_mapsize. 4904c3624e6eSGrant Likely 4905c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4906c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 4907c3624e6eSGrant Likely defines the size of the memory region starting at base 4908c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 4909c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4910c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 4911c3624e6eSGrant Likely used otherwise. 49127d721e34SBartlomiej Sieka 49137d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 49147d721e34SBartlomiej Sieka command can be restricted. This variable is given as 49157d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 49167d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 49177d721e34SBartlomiej Sieka environment variable. 49187d721e34SBartlomiej Sieka 49194bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 49204bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 49214bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 49224bae9090SBartlomiej Sieka 4923c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 4924c609719bSwdenk "bootp" will just load perform a lookup of the 4925c609719bSwdenk configuration from the BOOTP server, but not try to 4926c609719bSwdenk load any image using TFTP 4927c609719bSwdenk 4928c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 4929c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 4930c609719bSwdenk be automatically started (by internally calling 4931c609719bSwdenk "bootm") 4932c609719bSwdenk 49334a6fd34bSwdenk If set to "no", a standalone image passed to the 49344a6fd34bSwdenk "bootm" command will be copied to the load address 49354a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 49364a6fd34bSwdenk This can be used to load and uncompress arbitrary 49374a6fd34bSwdenk data. 49384a6fd34bSwdenk 4939a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 4940a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 4941fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 4942fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 4943fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 4944fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 4945fa34f6b2SShawn Guo device tree blob be copied to the maximum address 4946fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 4947fa34f6b2SShawn Guo access it during the boot procedure. 4948fa34f6b2SShawn Guo 4949a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 4950a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 4951a28afca5SDavid A. Long to work it must reside in writable memory, have 4952a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 4953a28afca5SDavid A. Long add the information it needs into it, and the memory 4954a28afca5SDavid A. Long must be accessible by the kernel. 4955a28afca5SDavid A. Long 4956eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 4957eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 4958eea63e05SSimon Glass defined. 4959eea63e05SSimon Glass 496017ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 496117ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 496217ea1177Swdenk mode (400kHZ). This environment variable is used in 496317ea1177Swdenk initialization code. So, for changes to be effective 496417ea1177Swdenk it must be saved and board must be reset. 496517ea1177Swdenk 4966c609719bSwdenk initrd_high - restrict positioning of initrd images: 4967c609719bSwdenk If this variable is not set, initrd images will be 4968c609719bSwdenk copied to the highest possible address in RAM; this 4969c609719bSwdenk is usually what you want since it allows for 4970c609719bSwdenk maximum initrd size. If for some reason you want to 4971c609719bSwdenk make sure that the initrd image is loaded below the 49726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4973c609719bSwdenk variable to a value of "no" or "off" or "0". 4974c609719bSwdenk Alternatively, you can set it to a maximum upper 4975c609719bSwdenk address to use (U-Boot will still check that it 4976c609719bSwdenk does not overwrite the U-Boot stack and data). 4977c609719bSwdenk 4978c609719bSwdenk For instance, when you have a system with 16 MB 49797152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 4980c609719bSwdenk you can do this by adding "mem=12M" to the value of 4981c609719bSwdenk the "bootargs" variable. However, now you must make 49827152b1d0Swdenk sure that the initrd image is placed in the first 4983c609719bSwdenk 12 MB as well - this can be done with 4984c609719bSwdenk 4985c609719bSwdenk setenv initrd_high 00c00000 4986c609719bSwdenk 498738b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 498838b99261Swdenk indication to U-Boot that all addresses are legal 498938b99261Swdenk for the Linux kernel, including addresses in flash 499038b99261Swdenk memory. In this case U-Boot will NOT COPY the 499138b99261Swdenk ramdisk at all. This may be useful to reduce the 499238b99261Swdenk boot time on your system, but requires that this 499338b99261Swdenk feature is supported by your Linux kernel. 499438b99261Swdenk 4995c609719bSwdenk ipaddr - IP address; needed for tftpboot command 4996c609719bSwdenk 4997c609719bSwdenk loadaddr - Default load address for commands like "bootp", 4998dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 4999c609719bSwdenk 5000c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 5001c609719bSwdenk 5002c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 5003c609719bSwdenk 5004c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 5005c609719bSwdenk 5006c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 5007c609719bSwdenk 5008c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 5009c609719bSwdenk 5010e2a53458SMike Frysinger ethprime - controls which interface is used first. 5011a3d991bdSwdenk 5012e2a53458SMike Frysinger ethact - controls which interface is currently active. 5013e2a53458SMike Frysinger For example you can do the following 5014a3d991bdSwdenk 501548690d80SHeiko Schocher => setenv ethact FEC 501648690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 501748690d80SHeiko Schocher => setenv ethact SCC 501848690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 5019a3d991bdSwdenk 5020e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 5021e1692577SMatthias Fuchs available network interfaces. 5022e1692577SMatthias Fuchs It just stays at the currently selected interface. 5023e1692577SMatthias Fuchs 5024a3d991bdSwdenk netretry - When set to "no" each network operation will 5025a3d991bdSwdenk either succeed or fail without retrying. 50266e592385Swdenk When set to "once" the network operation will 50276e592385Swdenk fail when all the available network interfaces 50286e592385Swdenk are tried once without success. 5029a3d991bdSwdenk Useful on scripts which control the retry operation 5030a3d991bdSwdenk themselves. 5031a3d991bdSwdenk 5032b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 5033a1cf027aSJean-Christophe PLAGNIOL-VILLARD 5034b445bbb4SJeremiah Mahler silent_linux - If set then Linux will be told to boot silently, by 50358d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 50368d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 50378d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 50388d51aacdSSimon Glass is silent. 50398d51aacdSSimon Glass 5040f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpsrcp - If this is set, the value is used for TFTP's 5041ecb0ccd9SWolfgang Denk UDP source port. 5042ecb0ccd9SWolfgang Denk 5043f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpdstp - If this is set, the value is used for TFTP's UDP 504428cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 504528cb9375SWolfgang Denk 5046c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 5047c96f86eeSWolfgang Denk we use the TFTP server's default block size 5048c96f86eeSWolfgang Denk 5049c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 5050c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 5051c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 5052c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 5053c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 5054c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 5055c96f86eeSWolfgang Denk with unreliable TFTP servers. 5056c96f86eeSWolfgang Denk 5057f5fb7346SAlbert ARIBAUD \(3ADEV\) tftptimeoutcountmax - maximum count of TFTP timeouts (no 5058f5fb7346SAlbert ARIBAUD \(3ADEV\) unit, minimum value = 0). Defines how many timeouts 5059f5fb7346SAlbert ARIBAUD \(3ADEV\) can happen during a single file transfer before that 5060f5fb7346SAlbert ARIBAUD \(3ADEV\) transfer is aborted. The default is 10, and 0 means 5061f5fb7346SAlbert ARIBAUD \(3ADEV\) 'no timeouts allowed'. Increasing this value may help 5062f5fb7346SAlbert ARIBAUD \(3ADEV\) downloads succeed with high packet loss rates, or with 5063f5fb7346SAlbert ARIBAUD \(3ADEV\) unreliable TFTP servers or client hardware. 5064f5fb7346SAlbert ARIBAUD \(3ADEV\) 5065a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 506611ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 5067a3d991bdSwdenk VLAN tagged frames. 5068c609719bSwdenk 506950768f5bSAlexandre Messier bootpretryperiod - Period during which BOOTP/DHCP sends retries. 507050768f5bSAlexandre Messier Unsigned value, in milliseconds. If not set, the period will 507150768f5bSAlexandre Messier be either the default (28000), or a value based on 507250768f5bSAlexandre Messier CONFIG_NET_RETRY_COUNT, if defined. This value has 507350768f5bSAlexandre Messier precedence over the valu based on CONFIG_NET_RETRY_COUNT. 507450768f5bSAlexandre Messier 5075dc0b7b0eSJason HobbsThe following image location variables contain the location of images 5076dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 5077dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 5078dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 5079dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 5080dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 5081dc0b7b0eSJason Hobbsflash or offset in NAND flash. 5082dc0b7b0eSJason Hobbs 5083dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 5084aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some 5085dc0b7b0eSJason Hobbsboards use these variables for other purposes. 5086dc0b7b0eSJason Hobbs 5087dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 5088dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 5089dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 5090dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 5091dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 5092dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 5093dc0b7b0eSJason Hobbs 5094c609719bSwdenkThe following environment variables may be used and automatically 5095c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 5096c609719bSwdenkdepending the information provided by your boot server: 5097c609719bSwdenk 5098c609719bSwdenk bootfile - see above 5099c609719bSwdenk dnsip - IP address of your Domain Name Server 5100fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 5101c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 5102c609719bSwdenk hostname - Target hostname 5103c609719bSwdenk ipaddr - see above 5104c609719bSwdenk netmask - Subnet Mask 5105c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 5106c609719bSwdenk serverip - see above 5107c609719bSwdenk 5108c609719bSwdenk 5109c609719bSwdenkThere are two special Environment Variables: 5110c609719bSwdenk 5111c609719bSwdenk serial# - contains hardware identification information such 5112c609719bSwdenk as type string and/or serial number 5113c609719bSwdenk ethaddr - Ethernet address 5114c609719bSwdenk 5115c609719bSwdenkThese variables can be set only once (usually during manufacturing of 5116c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 5117c609719bSwdenkonce they have been set once. 5118c609719bSwdenk 5119c609719bSwdenk 5120c1551ea8SstroeseFurther special Environment Variables: 5121c1551ea8Sstroese 5122c1551ea8Sstroese ver - Contains the U-Boot version string as printed 5123c1551ea8Sstroese with the "version" command. This variable is 5124c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 5125c1551ea8Sstroese 5126c1551ea8Sstroese 5127c609719bSwdenkPlease note that changes to some configuration parameters may take 5128c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 5129c609719bSwdenk 5130c609719bSwdenk 5131170ab110SJoe HershbergerCallback functions for environment variables: 5132170ab110SJoe Hershberger--------------------------------------------- 5133170ab110SJoe Hershberger 5134170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 5135b445bbb4SJeremiah Mahlerwhen their values are changed. This functionality allows functions to 5136170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 5137170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 5138170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 5139170ab110SJoe Hershberger 5140170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 5141170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 5142170ab110SJoe Hershberger 5143170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 5144170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 5145170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 5146170ab110SJoe Hershbergerassociations. The list must be in the following format: 5147170ab110SJoe Hershberger 5148170ab110SJoe Hershberger entry = variable_name[:callback_name] 5149170ab110SJoe Hershberger list = entry[,list] 5150170ab110SJoe Hershberger 5151170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 5152170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 5153170ab110SJoe Hershberger 5154170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 5155170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 5156170ab110SJoe Hershbergeroverride any association in the static list. You can define 5157170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 5158b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment. 5159170ab110SJoe Hershberger 5160bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a 5161bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to 5162bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out. 5163bdf1fe4eSJoe Hershberger 5164170ab110SJoe Hershberger 5165f07771ccSwdenkCommand Line Parsing: 5166f07771ccSwdenk===================== 5167f07771ccSwdenk 5168f07771ccSwdenkThere are two different command line parsers available with U-Boot: 51697152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 5170f07771ccSwdenk 5171f07771ccSwdenkOld, simple command line parser: 5172f07771ccSwdenk-------------------------------- 5173f07771ccSwdenk 5174f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 5175f07771ccSwdenk- several commands on one line, separated by ';' 5176fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 5177f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 5178f07771ccSwdenk for example: 5179fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 5180f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 5181f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 5182f07771ccSwdenk 5183f07771ccSwdenkHush shell: 5184f07771ccSwdenk----------- 5185f07771ccSwdenk 5186f07771ccSwdenk- similar to Bourne shell, with control structures like 5187f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 5188f07771ccSwdenk until...do...done, ... 5189f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 5190f07771ccSwdenk commands) and local shell variables (through standard shell syntax 5191f07771ccSwdenk "name=value"); only environment variables can be used with "run" 5192f07771ccSwdenk command 5193f07771ccSwdenk 5194f07771ccSwdenkGeneral rules: 5195f07771ccSwdenk-------------- 5196f07771ccSwdenk 5197f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 5198f07771ccSwdenk command) contains several commands separated by semicolon, and 5199f07771ccSwdenk one of these commands fails, then the remaining commands will be 5200f07771ccSwdenk executed anyway. 5201f07771ccSwdenk 5202f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 520311ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 5204f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 5205f07771ccSwdenk variables are not executed. 5206f07771ccSwdenk 5207c609719bSwdenkNote for Redundant Ethernet Interfaces: 5208c609719bSwdenk======================================= 5209c609719bSwdenk 521011ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 5211c609719bSwdenksuch configurations and is capable of automatic selection of a 52127152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 5213c609719bSwdenk 5214c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 5215c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5216c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 5217c609719bSwdenk 5218c609719bSwdenkIf the network interface stores some valid MAC address (for instance 5219c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 5220c609719bSwdenkding setting in the environment; if the corresponding environment 5221c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 5222c609719bSwdenk 5223c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 5224c609719bSwdenk environment, the SROM's address is used. 5225c609719bSwdenk 5226c609719bSwdenko If there is no valid address in the SROM, and a definition in the 5227c609719bSwdenk environment exists, then the value from the environment variable is 5228c609719bSwdenk used. 5229c609719bSwdenk 5230c609719bSwdenko If both the SROM and the environment contain a MAC address, and 5231c609719bSwdenk both addresses are the same, this MAC address is used. 5232c609719bSwdenk 5233c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 5234c609719bSwdenk addresses differ, the value from the environment is used and a 5235c609719bSwdenk warning is printed. 5236c609719bSwdenk 5237c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 5238bef1014bSJoe Hershberger is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case 5239bef1014bSJoe Hershberger a random, locally-assigned MAC is used. 5240c609719bSwdenk 5241ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5242ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 5243ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 5244ecee9324SBen WarrenThe naming convention is as follows: 5245ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5246c609719bSwdenk 5247c609719bSwdenkImage Formats: 5248c609719bSwdenk============== 5249c609719bSwdenk 52503310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 52513310c549SMarian Balakowiczimages in two formats: 52523310c549SMarian Balakowicz 52533310c549SMarian BalakowiczNew uImage format (FIT) 52543310c549SMarian Balakowicz----------------------- 52553310c549SMarian Balakowicz 52563310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 52573310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 52583310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 52593310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 52603310c549SMarian Balakowicz 52613310c549SMarian Balakowicz 52623310c549SMarian BalakowiczOld uImage format 52633310c549SMarian Balakowicz----------------- 52643310c549SMarian Balakowicz 52653310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 52663310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 52673310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 5268c609719bSwdenk 5269c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5270c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5271f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5272f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5273f5ed9e39SPeter Tyser INTEGRITY). 52747b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5275afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5276afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5277c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 5278c609719bSwdenk* Load Address 5279c609719bSwdenk* Entry Point 5280c609719bSwdenk* Image Name 5281c609719bSwdenk* Image Timestamp 5282c609719bSwdenk 5283c609719bSwdenkThe header is marked by a special Magic Number, and both the header 5284c609719bSwdenkand the data portions of the image are secured against corruption by 5285c609719bSwdenkCRC32 checksums. 5286c609719bSwdenk 5287c609719bSwdenk 5288c609719bSwdenkLinux Support: 5289c609719bSwdenk============== 5290c609719bSwdenk 5291c609719bSwdenkAlthough U-Boot should support any OS or standalone application 52927152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 5293c609719bSwdenkU-Boot. 5294c609719bSwdenk 5295c609719bSwdenkU-Boot includes many features that so far have been part of some 5296c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 5297c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 5298c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 52997152b1d0Swdenkserves several purposes: 5300c609719bSwdenk 5301c609719bSwdenk- the same features can be used for other OS or standalone 5302c609719bSwdenk applications (for instance: using compressed images to reduce the 5303c609719bSwdenk Flash memory footprint) 5304c609719bSwdenk 5305c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 53067152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 5307c609719bSwdenk 5308c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 5309c609719bSwdenk images; of course this also means that different kernel images can 5310c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 5311c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 5312c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 5313c609719bSwdenk software is easier now. 5314c609719bSwdenk 5315c609719bSwdenk 5316c609719bSwdenkLinux HOWTO: 5317c609719bSwdenk============ 5318c609719bSwdenk 5319c609719bSwdenkPorting Linux to U-Boot based systems: 5320c609719bSwdenk--------------------------------------- 5321c609719bSwdenk 5322c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 5323c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 5324c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 5325c609719bSwdenkLinux :-). 5326c609719bSwdenk 5327a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5328c609719bSwdenk 5329c609719bSwdenkJust make sure your machine specific header file (for instance 5330c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 53311dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 53321dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 53336d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 5334c609719bSwdenk 53352eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers. 53362eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there 53372eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See 53382eb31b13SSimon Glassdoc/driver-model. 53392eb31b13SSimon Glass 5340c609719bSwdenk 5341c609719bSwdenkConfiguring the Linux kernel: 5342c609719bSwdenk----------------------------- 5343c609719bSwdenk 5344c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 5345c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 5346c609719bSwdenk 5347c609719bSwdenk 5348c609719bSwdenkBuilding a Linux Image: 5349c609719bSwdenk----------------------- 5350c609719bSwdenk 535124ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 535224ee89b9Swdenknot used. If you use recent kernel source, a new build target 535324ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 535424ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 535524ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 535624ee89b9Swdenk100% compatible format. 5357c609719bSwdenk 5358c609719bSwdenkExample: 5359c609719bSwdenk 5360ab584d67SHolger Freyther make TQM850L_defconfig 5361c609719bSwdenk make oldconfig 5362c609719bSwdenk make dep 536324ee89b9Swdenk make uImage 5364c609719bSwdenk 536524ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 536624ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 536724ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 5368c609719bSwdenk 536924ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 537024ee89b9Swdenk 537124ee89b9Swdenk* convert the kernel into a raw binary image: 537224ee89b9Swdenk 537324ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 537424ee89b9Swdenk -R .note -R .comment \ 537524ee89b9Swdenk -S vmlinux linux.bin 537624ee89b9Swdenk 537724ee89b9Swdenk* compress the binary image: 537824ee89b9Swdenk 537924ee89b9Swdenk gzip -9 linux.bin 538024ee89b9Swdenk 538124ee89b9Swdenk* package compressed binary image for U-Boot: 538224ee89b9Swdenk 538324ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 538424ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 538524ee89b9Swdenk -d linux.bin.gz uImage 538624ee89b9Swdenk 538724ee89b9Swdenk 538824ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 538924ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 539024ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 539124ee89b9Swdenkbyte header containing information about target architecture, 539224ee89b9Swdenkoperating system, image type, compression method, entry points, time 539324ee89b9Swdenkstamp, CRC32 checksums, etc. 539424ee89b9Swdenk 539524ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 539624ee89b9Swdenkprint the header information, or to build new images. 5397c609719bSwdenk 5398c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 5399c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 5400c609719bSwdenkchecksum verification: 5401c609719bSwdenk 5402c609719bSwdenk tools/mkimage -l image 5403c609719bSwdenk -l ==> list image header information 5404c609719bSwdenk 5405c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 5406c609719bSwdenkfrom a "data file" which is used as image payload: 5407c609719bSwdenk 5408c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5409c609719bSwdenk -n name -d data_file image 5410c609719bSwdenk -A ==> set architecture to 'arch' 5411c609719bSwdenk -O ==> set operating system to 'os' 5412c609719bSwdenk -T ==> set image type to 'type' 5413c609719bSwdenk -C ==> set compression type 'comp' 5414c609719bSwdenk -a ==> set load address to 'addr' (hex) 5415c609719bSwdenk -e ==> set entry point to 'ep' (hex) 5416c609719bSwdenk -n ==> set image name to 'name' 5417c609719bSwdenk -d ==> use image data from 'datafile' 5418c609719bSwdenk 541969459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 542069459791Swdenkaddress (0x00000000), but the entry point address depends on the 542169459791Swdenkkernel version: 5422c609719bSwdenk 5423c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 542424ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 5425c609719bSwdenk 5426c609719bSwdenkSo a typical call to build a U-Boot image would read: 5427c609719bSwdenk 542824ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 542924ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5430a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 543124ee89b9Swdenk > examples/uImage.TQM850L 543224ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5433c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5434c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5435c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5436c609719bSwdenk Load Address: 0x00000000 543724ee89b9Swdenk Entry Point: 0x00000000 5438c609719bSwdenk 5439c609719bSwdenkTo verify the contents of the image (or check for corruption): 5440c609719bSwdenk 544124ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 544224ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5443c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5444c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5445c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5446c609719bSwdenk Load Address: 0x00000000 544724ee89b9Swdenk Entry Point: 0x00000000 5448c609719bSwdenk 5449c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 5450c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 5451c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 5452c609719bSwdenkneed to be uncompressed: 5453c609719bSwdenk 5454a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 545524ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 545624ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5457a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 545824ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 545924ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5460c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5461c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 5462c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5463c609719bSwdenk Load Address: 0x00000000 546424ee89b9Swdenk Entry Point: 0x00000000 5465c609719bSwdenk 5466c609719bSwdenk 5467c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 5468c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 5469c609719bSwdenk 5470c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 5471c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 5472c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5473c609719bSwdenk Image Name: Simple Ramdisk Image 5474c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 5475c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5476c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5477c609719bSwdenk Load Address: 0x00000000 5478c609719bSwdenk Entry Point: 0x00000000 5479c609719bSwdenk 5480a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5481a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 5482a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 5483a804b5ceSGuilherme Maciel Ferreirafrom the image: 5484a804b5ceSGuilherme Maciel Ferreira 5485f41f5b7cSGuilherme Maciel Ferreira tools/dumpimage -i image -T type -p position data_file 5486f41f5b7cSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file' 5487f41f5b7cSGuilherme Maciel Ferreira -T ==> set image type to 'type' 5488f41f5b7cSGuilherme Maciel Ferreira -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' 5489a804b5ceSGuilherme Maciel Ferreira 5490c609719bSwdenk 5491c609719bSwdenkInstalling a Linux Image: 5492c609719bSwdenk------------------------- 5493c609719bSwdenk 5494c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 5495c609719bSwdenkyou must convert the image to S-Record format: 5496c609719bSwdenk 5497c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 5498c609719bSwdenk 5499c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 5500c609719bSwdenkimage header, so the resulting S-Record file will be relative to 5501c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 5502c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 5503c609719bSwdenkcommand. 5504c609719bSwdenk 5505c609719bSwdenkExample: install the image to address 0x40100000 (which on the 5506c609719bSwdenkTQM8xxL is in the first Flash bank): 5507c609719bSwdenk 5508c609719bSwdenk => erase 40100000 401FFFFF 5509c609719bSwdenk 5510c609719bSwdenk .......... done 5511c609719bSwdenk Erased 8 sectors 5512c609719bSwdenk 5513c609719bSwdenk => loads 40100000 5514c609719bSwdenk ## Ready for S-Record download ... 5515c609719bSwdenk ~>examples/image.srec 5516c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5517c609719bSwdenk ... 5518c609719bSwdenk 15989 15990 15991 15992 5519c609719bSwdenk [file transfer complete] 5520c609719bSwdenk [connected] 5521c609719bSwdenk ## Start Addr = 0x00000000 5522c609719bSwdenk 5523c609719bSwdenk 5524c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 5525c609719bSwdenkthis includes a checksum verification so you can be sure no data 5526c609719bSwdenkcorruption happened: 5527c609719bSwdenk 5528c609719bSwdenk => imi 40100000 5529c609719bSwdenk 5530c609719bSwdenk ## Checking Image at 40100000 ... 5531c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5532c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5533c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5534c609719bSwdenk Load Address: 00000000 5535c609719bSwdenk Entry Point: 0000000c 5536c609719bSwdenk Verifying Checksum ... OK 5537c609719bSwdenk 5538c609719bSwdenk 5539c609719bSwdenkBoot Linux: 5540c609719bSwdenk----------- 5541c609719bSwdenk 5542c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 5543c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 5544c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 5545c609719bSwdenkparameters. You can check and modify this variable using the 5546c609719bSwdenk"printenv" and "setenv" commands: 5547c609719bSwdenk 5548c609719bSwdenk 5549c609719bSwdenk => printenv bootargs 5550c609719bSwdenk bootargs=root=/dev/ram 5551c609719bSwdenk 5552c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5553c609719bSwdenk 5554c609719bSwdenk => printenv bootargs 5555c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5556c609719bSwdenk 5557c609719bSwdenk => bootm 40020000 5558c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5559c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5560c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5561c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5562c609719bSwdenk Load Address: 00000000 5563c609719bSwdenk Entry Point: 0000000c 5564c609719bSwdenk Verifying Checksum ... OK 5565c609719bSwdenk Uncompressing Kernel Image ... OK 5566c609719bSwdenk 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 5567c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5568c609719bSwdenk time_init: decrementer frequency = 187500000/60 5569c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5570c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5571c609719bSwdenk ... 5572c609719bSwdenk 557311ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 55747152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5575c609719bSwdenkformat!) to the "bootm" command: 5576c609719bSwdenk 5577c609719bSwdenk => imi 40100000 40200000 5578c609719bSwdenk 5579c609719bSwdenk ## Checking Image at 40100000 ... 5580c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5581c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5582c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5583c609719bSwdenk Load Address: 00000000 5584c609719bSwdenk Entry Point: 0000000c 5585c609719bSwdenk Verifying Checksum ... OK 5586c609719bSwdenk 5587c609719bSwdenk ## Checking Image at 40200000 ... 5588c609719bSwdenk Image Name: Simple Ramdisk Image 5589c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5590c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5591c609719bSwdenk Load Address: 00000000 5592c609719bSwdenk Entry Point: 00000000 5593c609719bSwdenk Verifying Checksum ... OK 5594c609719bSwdenk 5595c609719bSwdenk => bootm 40100000 40200000 5596c609719bSwdenk ## Booting Linux kernel at 40100000 ... 5597c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5598c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5599c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5600c609719bSwdenk Load Address: 00000000 5601c609719bSwdenk Entry Point: 0000000c 5602c609719bSwdenk Verifying Checksum ... OK 5603c609719bSwdenk Uncompressing Kernel Image ... OK 5604c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 5605c609719bSwdenk Image Name: Simple Ramdisk Image 5606c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5607c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5608c609719bSwdenk Load Address: 00000000 5609c609719bSwdenk Entry Point: 00000000 5610c609719bSwdenk Verifying Checksum ... OK 5611c609719bSwdenk Loading Ramdisk ... OK 5612c609719bSwdenk 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 5613c609719bSwdenk Boot arguments: root=/dev/ram 5614c609719bSwdenk time_init: decrementer frequency = 187500000/60 5615c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5616c609719bSwdenk ... 5617c609719bSwdenk RAMDISK: Compressed image found at block 0 5618c609719bSwdenk VFS: Mounted root (ext2 filesystem). 5619c609719bSwdenk 5620c609719bSwdenk bash# 5621c609719bSwdenk 56220267768eSMatthew McClintockBoot Linux and pass a flat device tree: 56230267768eSMatthew McClintock----------- 56240267768eSMatthew McClintock 56250267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 56260267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 56270267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 56280267768eSMatthew McClintockflat device tree: 56290267768eSMatthew McClintock 56300267768eSMatthew McClintock=> print oftaddr 56310267768eSMatthew McClintockoftaddr=0x300000 56320267768eSMatthew McClintock=> print oft 56330267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 56340267768eSMatthew McClintock=> tftp $oftaddr $oft 56350267768eSMatthew McClintockSpeed: 1000, full duplex 56360267768eSMatthew McClintockUsing TSEC0 device 56370267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 56380267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 56390267768eSMatthew McClintockLoad address: 0x300000 56400267768eSMatthew McClintockLoading: # 56410267768eSMatthew McClintockdone 56420267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 56430267768eSMatthew McClintock=> tftp $loadaddr $bootfile 56440267768eSMatthew McClintockSpeed: 1000, full duplex 56450267768eSMatthew McClintockUsing TSEC0 device 56460267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 56470267768eSMatthew McClintockFilename 'uImage'. 56480267768eSMatthew McClintockLoad address: 0x200000 56490267768eSMatthew McClintockLoading:############ 56500267768eSMatthew McClintockdone 56510267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 56520267768eSMatthew McClintock=> print loadaddr 56530267768eSMatthew McClintockloadaddr=200000 56540267768eSMatthew McClintock=> print oftaddr 56550267768eSMatthew McClintockoftaddr=0x300000 56560267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 56570267768eSMatthew McClintock## Booting image at 00200000 ... 56580267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 56590267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 56600267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 56610267768eSMatthew McClintock Load Address: 00000000 56620267768eSMatthew McClintock Entry Point: 00000000 56630267768eSMatthew McClintock Verifying Checksum ... OK 56640267768eSMatthew McClintock Uncompressing Kernel Image ... OK 56650267768eSMatthew McClintockBooting using flat device tree at 0x300000 56660267768eSMatthew McClintockUsing MPC85xx ADS machine description 56670267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 56680267768eSMatthew McClintock[snip] 56690267768eSMatthew McClintock 56700267768eSMatthew McClintock 56716069ff26SwdenkMore About U-Boot Image Types: 56726069ff26Swdenk------------------------------ 56736069ff26Swdenk 56746069ff26SwdenkU-Boot supports the following image types: 56756069ff26Swdenk 56766069ff26Swdenk "Standalone Programs" are directly runnable in the environment 56776069ff26Swdenk provided by U-Boot; it is expected that (if they behave 56786069ff26Swdenk well) you can continue to work in U-Boot after return from 56796069ff26Swdenk the Standalone Program. 56806069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 56816069ff26Swdenk will take over control completely. Usually these programs 56826069ff26Swdenk will install their own set of exception handlers, device 56836069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 56846069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 56856069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 56866069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 56876069ff26Swdenk being started. 56886069ff26Swdenk "Multi-File Images" contain several images, typically an OS 56896069ff26Swdenk (Linux) kernel image and one or more data images like 56906069ff26Swdenk RAMDisks. This construct is useful for instance when you want 56916069ff26Swdenk to boot over the network using BOOTP etc., where the boot 56926069ff26Swdenk server provides just a single image file, but you want to get 56936069ff26Swdenk for instance an OS kernel and a RAMDisk image. 56946069ff26Swdenk 56956069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 56966069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 56976069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 56986069ff26Swdenk Immediately after the terminating 0 follow the images, one by 56996069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 57006069ff26Swdenk a multiple of 4 bytes). 57016069ff26Swdenk 57026069ff26Swdenk "Firmware Images" are binary images containing firmware (like 57036069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 57046069ff26Swdenk flash memory. 57056069ff26Swdenk 57066069ff26Swdenk "Script files" are command sequences that will be executed by 57076069ff26Swdenk U-Boot's command interpreter; this feature is especially 57086069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 57096069ff26Swdenk as command interpreter. 57106069ff26Swdenk 571144f074c7SMarek VasutBooting the Linux zImage: 571244f074c7SMarek Vasut------------------------- 571344f074c7SMarek Vasut 571444f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 571544f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 571644f074c7SMarek Vasutas the syntax of "bootm" command. 571744f074c7SMarek Vasut 57188ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5719017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 5720017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 5721017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 5722017e1f3fSMarek Vasut 5723c609719bSwdenk 5724c609719bSwdenkStandalone HOWTO: 5725c609719bSwdenk================= 5726c609719bSwdenk 5727c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 5728c609719bSwdenkrun "standalone" applications, which can use some resources of 5729c609719bSwdenkU-Boot like console I/O functions or interrupt services. 5730c609719bSwdenk 5731c609719bSwdenkTwo simple examples are included with the sources: 5732c609719bSwdenk 5733c609719bSwdenk"Hello World" Demo: 5734c609719bSwdenk------------------- 5735c609719bSwdenk 5736c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 5737c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 5738c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 5739c609719bSwdenklike that: 5740c609719bSwdenk 5741c609719bSwdenk => loads 5742c609719bSwdenk ## Ready for S-Record download ... 5743c609719bSwdenk ~>examples/hello_world.srec 5744c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5745c609719bSwdenk [file transfer complete] 5746c609719bSwdenk [connected] 5747c609719bSwdenk ## Start Addr = 0x00040004 5748c609719bSwdenk 5749c609719bSwdenk => go 40004 Hello World! This is a test. 5750c609719bSwdenk ## Starting application at 0x00040004 ... 5751c609719bSwdenk Hello World 5752c609719bSwdenk argc = 7 5753c609719bSwdenk argv[0] = "40004" 5754c609719bSwdenk argv[1] = "Hello" 5755c609719bSwdenk argv[2] = "World!" 5756c609719bSwdenk argv[3] = "This" 5757c609719bSwdenk argv[4] = "is" 5758c609719bSwdenk argv[5] = "a" 5759c609719bSwdenk argv[6] = "test." 5760c609719bSwdenk argv[7] = "<NULL>" 5761c609719bSwdenk Hit any key to exit ... 5762c609719bSwdenk 5763c609719bSwdenk ## Application terminated, rc = 0x0 5764c609719bSwdenk 5765c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 5766c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 5767c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 5768c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 5769c609719bSwdenkcharacter, but this is just a demo program. The application can be 5770c609719bSwdenkcontrolled by the following keys: 5771c609719bSwdenk 5772c609719bSwdenk ? - print current values og the CPM Timer registers 5773c609719bSwdenk b - enable interrupts and start timer 5774c609719bSwdenk e - stop timer and disable interrupts 5775c609719bSwdenk q - quit application 5776c609719bSwdenk 5777c609719bSwdenk => loads 5778c609719bSwdenk ## Ready for S-Record download ... 5779c609719bSwdenk ~>examples/timer.srec 5780c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 5781c609719bSwdenk [file transfer complete] 5782c609719bSwdenk [connected] 5783c609719bSwdenk ## Start Addr = 0x00040004 5784c609719bSwdenk 5785c609719bSwdenk => go 40004 5786c609719bSwdenk ## Starting application at 0x00040004 ... 5787c609719bSwdenk TIMERS=0xfff00980 5788c609719bSwdenk Using timer 1 5789c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5790c609719bSwdenk 5791c609719bSwdenkHit 'b': 5792c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 5793c609719bSwdenk Enabling timer 5794c609719bSwdenkHit '?': 5795c609719bSwdenk [q, b, e, ?] ........ 5796c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5797c609719bSwdenkHit '?': 5798c609719bSwdenk [q, b, e, ?] . 5799c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5800c609719bSwdenkHit '?': 5801c609719bSwdenk [q, b, e, ?] . 5802c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5803c609719bSwdenkHit '?': 5804c609719bSwdenk [q, b, e, ?] . 5805c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5806c609719bSwdenkHit 'e': 5807c609719bSwdenk [q, b, e, ?] ...Stopping timer 5808c609719bSwdenkHit 'q': 5809c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 5810c609719bSwdenk 5811c609719bSwdenk 581285ec0bccSwdenkMinicom warning: 581385ec0bccSwdenk================ 581485ec0bccSwdenk 58157152b1d0SwdenkOver time, many people have reported problems when trying to use the 581685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 581785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 5818f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 581985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 5820e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 5821e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5822e53515a2SKarl O. Pincfor help with kermit. 5823e53515a2SKarl O. Pinc 582485ec0bccSwdenk 582552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 582652f52c14Swdenkconfiguration to your "File transfer protocols" section: 582752f52c14Swdenk 582852f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 582952f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 583052f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 583152f52c14Swdenk 583252f52c14Swdenk 5833c609719bSwdenkNetBSD Notes: 5834c609719bSwdenk============= 5835c609719bSwdenk 5836c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 5837c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 5838c609719bSwdenk 5839c609719bSwdenkBuilding requires a cross environment; it is known to work on 5840c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5841c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 5842c609719bSwdenkNote that the cross-powerpc package does not install include files; 5843c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 5844c609719bSwdenkmissing. This file has to be installed and patched manually: 5845c609719bSwdenk 5846c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 5847c609719bSwdenk # mkdir powerpc 5848c609719bSwdenk # ln -s powerpc machine 5849c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5850c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5851c609719bSwdenk 5852c609719bSwdenkNative builds *don't* work due to incompatibilities between native 5853c609719bSwdenkand U-Boot include files. 5854c609719bSwdenk 5855c609719bSwdenkBooting assumes that (the first part of) the image booted is a 5856c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 5857c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 5858c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 58592a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5860c609719bSwdenk 5861c609719bSwdenk 5862c609719bSwdenkImplementation Internals: 5863c609719bSwdenk========================= 5864c609719bSwdenk 5865c609719bSwdenkThe following is not intended to be a complete description of every 5866c609719bSwdenkimplementation detail. However, it should help to understand the 5867c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 5868c609719bSwdenkhardware. 5869c609719bSwdenk 5870c609719bSwdenk 5871c609719bSwdenkInitial Stack, Global Data: 5872c609719bSwdenk--------------------------- 5873c609719bSwdenk 5874c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 5875c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 5876c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 5877c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 5878c609719bSwdenkis not initialized as zero. To be able to get a C environment working 5879c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 5880c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 5881c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 5882c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 5883c609719bSwdenklocked as (mis-) used as memory, etc. 5884c609719bSwdenk 58857152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 58860668236bSWolfgang Denk U-Boot mailing list: 588743d9616cSwdenk 588843d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 588943d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 589043d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 589143d9616cSwdenk ... 589243d9616cSwdenk 589343d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 589443d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 589543d9616cSwdenk require any physical RAM backing up the cache. The cleverness 589643d9616cSwdenk is that the cache is being used as a temporary supply of 589743d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 589811ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 589943d9616cSwdenk can see how this works by studying the cache architecture and 590043d9616cSwdenk operation in the architecture and processor-specific manuals. 590143d9616cSwdenk 590243d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 590343d9616cSwdenk is another option for the system designer to use as an 590411ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 590543d9616cSwdenk option should work for you. Using CS 4 should be fine if your 590643d9616cSwdenk board designers haven't used it for something that would 590743d9616cSwdenk cause you grief during the initial boot! It is frequently not 590843d9616cSwdenk used. 590943d9616cSwdenk 59106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 591143d9616cSwdenk with your processor/board/system design. The default value 591243d9616cSwdenk you will find in any recent u-boot distribution in 59138a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 591443d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 591543d9616cSwdenk it above 400_0000. Just make sure your board has no resources 591643d9616cSwdenk that are supposed to respond to that address! That code in 591743d9616cSwdenk start.S has been around a while and should work as is when 591843d9616cSwdenk you get the config right. 591943d9616cSwdenk 592043d9616cSwdenk -Chris Hallinan 592143d9616cSwdenk DS4.COM, Inc. 592243d9616cSwdenk 5923c609719bSwdenkIt is essential to remember this, since it has some impact on the C 5924c609719bSwdenkcode for the initialization procedures: 5925c609719bSwdenk 5926c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 5927c609719bSwdenk to write it. 5928c609719bSwdenk 5929b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized 5930c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 59317152b1d0Swdenk zation is performed later (when relocating to RAM). 5932c609719bSwdenk 5933c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 5934c609719bSwdenk that. 5935c609719bSwdenk 5936c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 5937b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it 5938c609719bSwdenkturned out that the implementation of U-Boot can be greatly 5939c609719bSwdenksimplified by making a global data structure (gd_t) available to all 5940c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 5941c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 5942c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 5943c609719bSwdenkplace a pointer (gd) to the global data into a register which we 5944c609719bSwdenkreserve for this purpose. 5945c609719bSwdenk 59467152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 5947c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 5948c609719bSwdenkGCC's implementation. 5949c609719bSwdenk 5950c609719bSwdenkFor PowerPC, the following registers have specific use: 5951c609719bSwdenk R1: stack pointer 5952e7670f6cSWolfgang Denk R2: reserved for system use 5953c609719bSwdenk R3-R4: parameter passing and return values 5954c609719bSwdenk R5-R10: parameter passing 5955c609719bSwdenk R13: small data area pointer 5956c609719bSwdenk R30: GOT pointer 5957c609719bSwdenk R31: frame pointer 5958c609719bSwdenk 5959e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 5960e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 5961e6bee808SJoakim Tjernlund going back and forth between asm and C) 5962c609719bSwdenk 5963e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 5964c609719bSwdenk 5965c609719bSwdenk Note: on PPC, we could use a static initializer (since the 5966c609719bSwdenk address of the global data structure is known at compile time), 5967c609719bSwdenk but it turned out that reserving a register results in somewhat 5968c609719bSwdenk smaller code - although the code savings are not that big (on 5969c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 5970c609719bSwdenk 624 text + 127 data). 5971c609719bSwdenk 5972c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 59734c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 59744c58eb55SMike Frysinger 5975c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 59764c58eb55SMike Frysinger 5977c609719bSwdenkOn ARM, the following registers are used: 5978c609719bSwdenk 5979c609719bSwdenk R0: function argument word/integer result 5980c609719bSwdenk R1-R3: function argument word 598112eba1b4SJeroen Hofstee R9: platform specific 598212eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 5983c609719bSwdenk R11: argument (frame) pointer 5984c609719bSwdenk R12: temporary workspace 5985c609719bSwdenk R13: stack pointer 5986c609719bSwdenk R14: link register 5987c609719bSwdenk R15: program counter 5988c609719bSwdenk 598912eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 599012eba1b4SJeroen Hofstee 599112eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 5992c609719bSwdenk 59930df01fd3SThomas ChouOn Nios II, the ABI is documented here: 59940df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 59950df01fd3SThomas Chou 59960df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 59970df01fd3SThomas Chou 59980df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 59990df01fd3SThomas Chou to access small data sections, so gp is free. 60000df01fd3SThomas Chou 6001afc1ce82SMacpaul LinOn NDS32, the following registers are used: 6002afc1ce82SMacpaul Lin 6003afc1ce82SMacpaul Lin R0-R1: argument/return 6004afc1ce82SMacpaul Lin R2-R5: argument 6005afc1ce82SMacpaul Lin R15: temporary register for assembler 6006afc1ce82SMacpaul Lin R16: trampoline register 6007afc1ce82SMacpaul Lin R28: frame pointer (FP) 6008afc1ce82SMacpaul Lin R29: global pointer (GP) 6009afc1ce82SMacpaul Lin R30: link register (LP) 6010afc1ce82SMacpaul Lin R31: stack pointer (SP) 6011afc1ce82SMacpaul Lin PC: program counter (PC) 6012afc1ce82SMacpaul Lin 6013afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 6014afc1ce82SMacpaul Lin 6015d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 6016d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 6017c609719bSwdenk 6018c609719bSwdenkMemory Management: 6019c609719bSwdenk------------------ 6020c609719bSwdenk 6021c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 6022c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 6023c609719bSwdenk 6024c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 6025c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 6026c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 6027c609719bSwdenkphysical memory banks. 6028c609719bSwdenk 6029c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 6030c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 6031c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 6032c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 60336d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 6034c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 6035c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 6036c609719bSwdenk 6037c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 6038c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 6039c609719bSwdenk 6040c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 6041c609719bSwdenkthis: 6042c609719bSwdenk 6043c609719bSwdenk 0x0000 0000 Exception Vector code 6044c609719bSwdenk : 6045c609719bSwdenk 0x0000 1FFF 6046c609719bSwdenk 0x0000 2000 Free for Application Use 6047c609719bSwdenk : 6048c609719bSwdenk : 6049c609719bSwdenk 6050c609719bSwdenk : 6051c609719bSwdenk : 6052c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 6053c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 6054c609719bSwdenk 0x00FC 0000 Malloc Arena 6055c609719bSwdenk : 6056c609719bSwdenk 0x00FD FFFF 6057c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 6058c609719bSwdenk ... eventually: LCD or video framebuffer 6059c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 6060c609719bSwdenk 0x00FF FFFF [End of RAM] 6061c609719bSwdenk 6062c609719bSwdenk 6063c609719bSwdenkSystem Initialization: 6064c609719bSwdenk---------------------- 6065c609719bSwdenk 6066c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 606711ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 6068c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory. 60697152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 6070c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 6071c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 6072c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 6073c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 6074c609719bSwdenkthe caches and the SIU. 6075c609719bSwdenk 6076c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 6077c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 6078c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 6079c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 6080c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 6081c609719bSwdenksimple memory test is run that determines the size of the SDRAM 6082c609719bSwdenkbanks. 6083c609719bSwdenk 6084c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 60857152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 6086c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 6087c609719bSwdenk0x00000000, with any additional banks following immediately to create 6088c609719bSwdenkcontiguous memory starting from 0. 6089c609719bSwdenk 6090c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 6091c609719bSwdenkand allocates memory for use by malloc() and for the global Board 6092c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 6093c609719bSwdenkpages, and the final stack is set up. 6094c609719bSwdenk 6095c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 6096c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 6097c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 6098c609719bSwdenknew address in RAM. 6099c609719bSwdenk 6100c609719bSwdenk 6101c609719bSwdenkU-Boot Porting Guide: 6102c609719bSwdenk---------------------- 6103c609719bSwdenk 6104c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 61056aff3115Swdenklist, October 2002] 6106c609719bSwdenk 6107c609719bSwdenk 6108c609719bSwdenkint main(int argc, char *argv[]) 6109c609719bSwdenk{ 6110c609719bSwdenk sighandler_t no_more_time; 6111c609719bSwdenk 6112c609719bSwdenk signal(SIGALRM, no_more_time); 6113c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 6114c609719bSwdenk 6115c609719bSwdenk if (available_money > available_manpower) { 61166c3fef28SJerry Van Baren Pay consultant to port U-Boot; 6117c609719bSwdenk return 0; 6118c609719bSwdenk } 6119c609719bSwdenk 6120c609719bSwdenk Download latest U-Boot source; 6121c609719bSwdenk 61220668236bSWolfgang Denk Subscribe to u-boot mailing list; 61236aff3115Swdenk 61246c3fef28SJerry Van Baren if (clueless) 6125c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 6126c609719bSwdenk 6127c609719bSwdenk while (learning) { 6128c609719bSwdenk Read the README file in the top level directory; 61297cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 61306c3fef28SJerry Van Baren Read applicable doc/*.README; 6131c609719bSwdenk Read the source, Luke; 61326c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 6133c609719bSwdenk } 6134c609719bSwdenk 61356c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 61366c3fef28SJerry Van Baren Buy a BDI3000; 61376c3fef28SJerry Van Baren else 6138c609719bSwdenk Add a lot of aggravation and time; 6139c609719bSwdenk 61406c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 61416c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 61426c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 61436c3fef28SJerry Van Baren } else { 6144c609719bSwdenk Create your own board support subdirectory; 61456c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 61466c3fef28SJerry Van Baren } 61476c3fef28SJerry Van Baren Edit new board/<myboard> files 61486c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 6149c609719bSwdenk 61506c3fef28SJerry Van Baren while (!accepted) { 6151c609719bSwdenk while (!running) { 6152c609719bSwdenk do { 6153c609719bSwdenk Add / modify source code; 6154c609719bSwdenk } until (compiles); 6155c609719bSwdenk Debug; 6156c609719bSwdenk if (clueless) 6157c609719bSwdenk email("Hi, I am having problems..."); 6158c609719bSwdenk } 61596c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 61606c3fef28SJerry Van Baren if (reasonable critiques) 61616c3fef28SJerry Van Baren Incorporate improvements from email list code review; 61626c3fef28SJerry Van Baren else 61636c3fef28SJerry Van Baren Defend code as written; 61646c3fef28SJerry Van Baren } 6165c609719bSwdenk 6166c609719bSwdenk return 0; 6167c609719bSwdenk} 6168c609719bSwdenk 6169c609719bSwdenkvoid no_more_time (int sig) 6170c609719bSwdenk{ 6171c609719bSwdenk hire_a_guru(); 6172c609719bSwdenk} 6173c609719bSwdenk 6174c609719bSwdenk 6175c609719bSwdenkCoding Standards: 6176c609719bSwdenk----------------- 6177c609719bSwdenk 6178c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 61792c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 61807ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 6181c609719bSwdenk 61822c051651SDetlev ZundelSource files originating from a different project (for example the 61832c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 6184b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those 61852c051651SDetlev Zundelsources. 61862c051651SDetlev Zundel 61872c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 61882c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 61892c051651SDetlev Zundelin your code. 6190c609719bSwdenk 6191c178d3daSwdenkPlease also stick to the following formatting rules: 6192180d3f74Swdenk- remove any trailing white space 61937ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 6194180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 61957ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 6196180d3f74Swdenk- do not add trailing empty lines to source files 6197180d3f74Swdenk 6198c609719bSwdenkSubmissions which do not conform to the standards may be returned 6199c609719bSwdenkwith a request to reformat the changes. 6200c609719bSwdenk 6201c609719bSwdenk 6202c609719bSwdenkSubmitting Patches: 6203c609719bSwdenk------------------- 6204c609719bSwdenk 6205c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 6206c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 6207c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 6208c609719bSwdenk 62090d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 6210218ca724SWolfgang Denk 62110668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 62120668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 62130668236bSWolfgang Denk 6214c609719bSwdenkWhen you send a patch, please include the following information with 6215c609719bSwdenkit: 6216c609719bSwdenk 6217c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 6218c609719bSwdenk this bug. Please try to include a way of demonstrating that the 6219c609719bSwdenk patch actually fixes something. 6220c609719bSwdenk 6221c609719bSwdenk* For new features: a description of the feature and your 6222c609719bSwdenk implementation. 6223c609719bSwdenk 6224c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 6225c609719bSwdenk 62267207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your 62277207b366SRobert P. J. Day information and associated file and directory references. 6228c609719bSwdenk 622927af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 623027af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 6231c609719bSwdenk 6232c609719bSwdenk* If your patch adds new configuration options, don't forget to 6233c609719bSwdenk document these in the README file. 6234c609719bSwdenk 6235218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 6236218ca724SWolfgang Denk recommended) you can easily generate the patch using the 62377ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 6238218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 6239218ca724SWolfgang Denk with some other mail clients. 6240c609719bSwdenk 6241218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 6242218ca724SWolfgang Denk diff does not support these options, then get the latest version of 6243218ca724SWolfgang Denk GNU diff. 62446dff5529Swdenk 6245218ca724SWolfgang Denk The current directory when running this command shall be the parent 6246218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 6247218ca724SWolfgang Denk your patch includes sufficient directory information for the 6248218ca724SWolfgang Denk affected files). 6249218ca724SWolfgang Denk 6250218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 6251218ca724SWolfgang Denk and compressed attachments must not be used. 6252c609719bSwdenk 625352f52c14Swdenk* If one logical set of modifications affects or creates several 625452f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 625552f52c14Swdenk 625652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 625752f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 625852f52c14Swdenk 625952f52c14Swdenk 6260c609719bSwdenkNotes: 6261c609719bSwdenk 62626de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched 6263c609719bSwdenk source tree and make sure that no errors or warnings are reported 6264c609719bSwdenk for any of the boards. 6265c609719bSwdenk 6266c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 6267c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 6268c609719bSwdenk returned with a request to re-formatting / split it. 6269c609719bSwdenk 6270c609719bSwdenk* If you modify existing code, make sure that your new code does not 6271c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 6272c609719bSwdenk When adding new features, these should compile conditionally only 6273c609719bSwdenk (using #ifdef), and the resulting code with the new feature 6274c609719bSwdenk disabled must not need more memory than the old code without your 6275c609719bSwdenk modification. 627690dc6704Swdenk 62770668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 62780668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 62790668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 62800668236bSWolfgang Denk bigger than the size limit should be avoided. 6281