1c609719bSwdenk# 2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013 3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4c609719bSwdenk# 5eca3aeb3SWolfgang Denk# SPDX-License-Identifier: GPL-2.0+ 6c609719bSwdenk# 7c609719bSwdenk 8c609719bSwdenkSummary: 9c609719bSwdenk======== 10c609719bSwdenk 1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 14e86e5a07Swdenkinitialize and test the hardware or to download and run application 15e86e5a07Swdenkcode. 16c609719bSwdenk 17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some 1924ee89b9Swdenkheader files in common, and special provision has been made to 20c609719bSwdenksupport booting of Linux images. 21c609719bSwdenk 22c609719bSwdenkSome attention has been paid to make this software easily 23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 24c609719bSwdenkimplemented with the same call interface, so that it's very easy to 25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 27c609719bSwdenkload and run it dynamically. 28c609719bSwdenk 29c609719bSwdenk 30c609719bSwdenkStatus: 31c609719bSwdenk======= 32c609719bSwdenk 33c609719bSwdenkIn general, all boards for which a configuration option exists in the 34c609719bSwdenkMakefile have been tested to some extent and can be considered 35c609719bSwdenk"working". In fact, many of them are used in production systems. 36c609719bSwdenk 377207b366SRobert P. J. DayIn case of problems see the CHANGELOG file to find out who contributed 387207b366SRobert P. J. Daythe specific port. In addition, there are various MAINTAINERS files 397207b366SRobert P. J. Dayscattered throughout the U-Boot source identifying the people or 407207b366SRobert P. J. Daycompanies responsible for various boards and subsystems. 41c609719bSwdenk 427207b366SRobert P. J. DayNote: As of August, 2010, there is no longer a CHANGELOG file in the 437207b366SRobert P. J. Dayactual U-Boot source tree; however, it can be created dynamically 447207b366SRobert P. J. Dayfrom the Git log using: 45adb9d851SRobert P. J. Day 46adb9d851SRobert P. J. Day make CHANGELOG 47adb9d851SRobert P. J. Day 48c609719bSwdenk 49c609719bSwdenkWhere to get help: 50c609719bSwdenk================== 51c609719bSwdenk 52c609719bSwdenkIn case you have questions about, problems with or contributions for 537207b366SRobert P. J. DayU-Boot, you should send a message to the U-Boot mailing list at 540c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 550c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 560c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 570c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 58c609719bSwdenk 59c609719bSwdenk 60218ca724SWolfgang DenkWhere to get source code: 61218ca724SWolfgang Denk========================= 62218ca724SWolfgang Denk 637207b366SRobert P. J. DayThe U-Boot source code is maintained in the Git repository at 64218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 65218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 66218ca724SWolfgang Denk 67218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 6811ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 69218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 70218ca724SWolfgang Denkdirectory. 71218ca724SWolfgang Denk 72d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 73218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 74218ca724SWolfgang Denk 75218ca724SWolfgang Denk 76c609719bSwdenkWhere we come from: 77c609719bSwdenk=================== 78c609719bSwdenk 79c609719bSwdenk- start from 8xxrom sources 8024ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 81c609719bSwdenk- clean up code 82c609719bSwdenk- make it easier to add custom boards 83c609719bSwdenk- make it possible to add other [PowerPC] CPUs 84c609719bSwdenk- extend functions, especially: 85c609719bSwdenk * Provide extended interface to Linux boot loader 86c609719bSwdenk * S-Record download 87c609719bSwdenk * network boot 8811ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 8924ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 90c609719bSwdenk- add other CPU families (starting with ARM) 9124ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 920d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 9324ee89b9Swdenk 9424ee89b9Swdenk 9524ee89b9SwdenkNames and Spelling: 9624ee89b9Swdenk=================== 9724ee89b9Swdenk 9824ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 9924ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 10024ee89b9Swdenkin source files etc.). Example: 10124ee89b9Swdenk 10224ee89b9Swdenk This is the README file for the U-Boot project. 10324ee89b9Swdenk 10424ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 10524ee89b9Swdenk 10624ee89b9Swdenk include/asm-ppc/u-boot.h 10724ee89b9Swdenk 10824ee89b9Swdenk #include <asm/u-boot.h> 10924ee89b9Swdenk 11024ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 11124ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 11224ee89b9Swdenk 11324ee89b9Swdenk U_BOOT_VERSION u_boot_logo 11424ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 115c609719bSwdenk 116c609719bSwdenk 11793f19cc0SwdenkVersioning: 11893f19cc0Swdenk=========== 11993f19cc0Swdenk 120360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 121360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 122360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 123360d883aSThomas Webernames consisting of the calendar year and month of the release date. 124360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 125360d883aSThomas Weberreleases in "stable" maintenance trees. 12693f19cc0Swdenk 127360d883aSThomas WeberExamples: 128360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 129360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 130360d883aSThomas Weber U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 13193f19cc0Swdenk 13293f19cc0Swdenk 133c609719bSwdenkDirectory Hierarchy: 134c609719bSwdenk==================== 135c609719bSwdenk 1368d321b81SPeter Tyser/arch Architecture specific files 1376eae68e4SMasahiro Yamada /arc Files generic to ARC architecture 1388d321b81SPeter Tyser /arm Files generic to ARM architecture 1398d321b81SPeter Tyser /avr32 Files generic to AVR32 architecture 1408d321b81SPeter Tyser /blackfin Files generic to Analog Devices Blackfin architecture 1418d321b81SPeter Tyser /m68k Files generic to m68k architecture 1428d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1438d321b81SPeter Tyser /mips Files generic to MIPS architecture 144afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 1458d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 14633c7731bSRobert P. J. Day /openrisc Files generic to OpenRISC architecture 147a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1487207b366SRobert P. J. Day /sandbox Files generic to HW-independent "sandbox" 1498d321b81SPeter Tyser /sh Files generic to SH architecture 1508d321b81SPeter Tyser /sparc Files generic to SPARC architecture 15133c7731bSRobert P. J. Day /x86 Files generic to x86 architecture 1528d321b81SPeter Tyser/api Machine/arch independent API for external apps 1538d321b81SPeter Tyser/board Board dependent files 1548d321b81SPeter Tyser/common Misc architecture independent functions 1557207b366SRobert P. J. Day/configs Board default configuration files 1568d321b81SPeter Tyser/disk Code for disk drive partition handling 1578d321b81SPeter Tyser/doc Documentation (don't expect too much) 1588d321b81SPeter Tyser/drivers Commonly used device drivers 15933c7731bSRobert P. J. Day/dts Contains Makefile for building internal U-Boot fdt. 1608d321b81SPeter Tyser/examples Example code for standalone applications, etc. 1618d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 1628d321b81SPeter Tyser/include Header Files 1637207b366SRobert P. J. Day/lib Library routines generic to all architectures 1647207b366SRobert P. J. Day/Licenses Various license files 1658d321b81SPeter Tyser/net Networking code 1668d321b81SPeter Tyser/post Power On Self Test 1677207b366SRobert P. J. Day/scripts Various build scripts and Makefiles 1687207b366SRobert P. J. Day/test Various unit test files 1698d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 170c609719bSwdenk 171c609719bSwdenkSoftware Configuration: 172c609719bSwdenk======================= 173c609719bSwdenk 174c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 175c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 176c609719bSwdenk 177c609719bSwdenkThere are two classes of configuration variables: 178c609719bSwdenk 179c609719bSwdenk* Configuration _OPTIONS_: 180c609719bSwdenk These are selectable by the user and have names beginning with 181c609719bSwdenk "CONFIG_". 182c609719bSwdenk 183c609719bSwdenk* Configuration _SETTINGS_: 184c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 185c609719bSwdenk you don't know what you're doing; they have names beginning with 1866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 187c609719bSwdenk 1887207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating 1897207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently, 1907207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel, 1917207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your 1927207b366SRobert P. J. Daybuild. 193c609719bSwdenk 194c609719bSwdenk 195c609719bSwdenkSelection of Processor Architecture and Board Type: 196c609719bSwdenk--------------------------------------------------- 197c609719bSwdenk 198c609719bSwdenkFor all supported boards there are ready-to-use default 199ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig". 200c609719bSwdenk 201c609719bSwdenkExample: For a TQM823L module type: 202c609719bSwdenk 203c609719bSwdenk cd u-boot 204ab584d67SHolger Freyther make TQM823L_defconfig 205c609719bSwdenk 2067207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board 2077207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file 2087207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards. 209c609719bSwdenk 21075b3c3aaSSimon GlassSandbox Environment: 21175b3c3aaSSimon Glass-------------------- 21275b3c3aaSSimon Glass 21375b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox' 21475b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture- 21575b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to 21675b3c3aaSSimon Glassrun some of U-Boot's tests. 21775b3c3aaSSimon Glass 2186b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details. 21975b3c3aaSSimon Glass 22075b3c3aaSSimon Glass 221db910353SSimon GlassBoard Initialisation Flow: 222db910353SSimon Glass-------------------------- 223db910353SSimon Glass 224db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both 2257207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules). 226db910353SSimon Glass 2277207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in 2287207b366SRobert P. J. Daymore detail later in this file. 2297207b366SRobert P. J. Day 2307207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names 2317207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures 2327207b366SRobert P. J. Daymay not conform to this. At least most ARM boards which use 2337207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this. 2347207b366SRobert P. J. Day 2357207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly 2367207b366SRobert P. J. DayCPU-specific) start.S file, such as: 2377207b366SRobert P. J. Day 2387207b366SRobert P. J. Day - arch/arm/cpu/armv7/start.S 2397207b366SRobert P. J. Day - arch/powerpc/cpu/mpc83xx/start.S 2407207b366SRobert P. J. Day - arch/mips/cpu/start.S 2417207b366SRobert P. J. Day 2427207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and 2437207b366SRobert P. J. Daylimitations of each of these functions are described below. 244db910353SSimon Glass 245db910353SSimon Glasslowlevel_init(): 246db910353SSimon Glass - purpose: essential init to permit execution to reach board_init_f() 247db910353SSimon Glass - no global_data or BSS 248db910353SSimon Glass - there is no stack (ARMv7 may have one but it will soon be removed) 249db910353SSimon Glass - must not set up SDRAM or use console 250db910353SSimon Glass - must only do the bare minimum to allow execution to continue to 251db910353SSimon Glass board_init_f() 252db910353SSimon Glass - this is almost never needed 253db910353SSimon Glass - return normally from this function 254db910353SSimon Glass 255db910353SSimon Glassboard_init_f(): 256db910353SSimon Glass - purpose: set up the machine ready for running board_init_r(): 257db910353SSimon Glass i.e. SDRAM and serial UART 258db910353SSimon Glass - global_data is available 259db910353SSimon Glass - stack is in SRAM 260db910353SSimon Glass - BSS is not available, so you cannot use global/static variables, 261db910353SSimon Glass only stack variables and global_data 262db910353SSimon Glass 263db910353SSimon Glass Non-SPL-specific notes: 264db910353SSimon Glass - dram_init() is called to set up DRAM. If already done in SPL this 265db910353SSimon Glass can do nothing 266db910353SSimon Glass 267db910353SSimon Glass SPL-specific notes: 268db910353SSimon Glass - you can override the entire board_init_f() function with your own 269db910353SSimon Glass version as needed. 270db910353SSimon Glass - preloader_console_init() can be called here in extremis 271db910353SSimon Glass - should set up SDRAM, and anything needed to make the UART work 272db910353SSimon Glass - these is no need to clear BSS, it will be done by crt0.S 273db910353SSimon Glass - must return normally from this function (don't call board_init_r() 274db910353SSimon Glass directly) 275db910353SSimon Glass 276db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at 277db910353SSimon Glassthis point the stack and global_data are relocated to below 278db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of 279db910353SSimon Glassmemory. 280db910353SSimon Glass 281db910353SSimon Glassboard_init_r(): 282db910353SSimon Glass - purpose: main execution, common code 283db910353SSimon Glass - global_data is available 284db910353SSimon Glass - SDRAM is available 285db910353SSimon Glass - BSS is available, all static/global variables can be used 286db910353SSimon Glass - execution eventually continues to main_loop() 287db910353SSimon Glass 288db910353SSimon Glass Non-SPL-specific notes: 289db910353SSimon Glass - U-Boot is relocated to the top of memory and is now running from 290db910353SSimon Glass there. 291db910353SSimon Glass 292db910353SSimon Glass SPL-specific notes: 293db910353SSimon Glass - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and 294db910353SSimon Glass CONFIG_SPL_STACK_R_ADDR points into SDRAM 295db910353SSimon Glass - preloader_console_init() can be called here - typically this is 296db910353SSimon Glass done by defining CONFIG_SPL_BOARD_INIT and then supplying a 297db910353SSimon Glass spl_board_init() function containing this call 298db910353SSimon Glass - loads U-Boot or (in falcon mode) Linux 299db910353SSimon Glass 300db910353SSimon Glass 301db910353SSimon Glass 302c609719bSwdenkConfiguration Options: 303c609719bSwdenk---------------------- 304c609719bSwdenk 305c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 306c609719bSwdenksuch information is kept in a configuration file 307c609719bSwdenk"include/configs/<board_name>.h". 308c609719bSwdenk 309c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 310c609719bSwdenk"include/configs/TQM823L.h". 311c609719bSwdenk 312c609719bSwdenk 3137f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 3147f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 3157f6c2cbcSwdenkbuild a config tool - later. 3167f6c2cbcSwdenk 3177f6c2cbcSwdenk 318c609719bSwdenkThe following options need to be configured: 319c609719bSwdenk 3202628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 321c609719bSwdenk 3222628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 3236ccec449SWolfgang Denk 3246ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 32509ea0de0SHaavard Skinnemoen Define exactly one, e.g. CONFIG_ATSTK1002 326c609719bSwdenk 327c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined) 328c609719bSwdenk Define exactly one of 329c609719bSwdenk CONFIG_CMA286_60_OLD 330c609719bSwdenk--- FIXME --- not tested yet: 331c609719bSwdenk CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 332c609719bSwdenk CONFIG_CMA287_23, CONFIG_CMA287_50 333c609719bSwdenk 334c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined) 335c609719bSwdenk Define exactly one of 336c609719bSwdenk CONFIG_CMA101, CONFIG_CMA102 337c609719bSwdenk 338c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 339c609719bSwdenk Define one or more of 340c609719bSwdenk CONFIG_CMA302 341c609719bSwdenk 342c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 343c609719bSwdenk Define one or more of 344c609719bSwdenk CONFIG_LCD_HEARTBEAT - update a character position on 34511ccc33fSMarcel Ziswiler the LCD display every second with 346c609719bSwdenk a "rotator" |\-/|\-/ 347c609719bSwdenk 348cf946c6dSLei Wen- Marvell Family Member 349cf946c6dSLei Wen CONFIG_SYS_MVFS - define it if you want to enable 350cf946c6dSLei Wen multiple fs option at one time 351cf946c6dSLei Wen for marvell soc family 352cf946c6dSLei Wen 35311ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU) 35466ca92a5Swdenk CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 35566ca92a5Swdenk get_gclk_freq() cannot work 3565da627a4Swdenk e.g. if there is no 32KHz 3575da627a4Swdenk reference PIT/RTC clock 35866ca92a5Swdenk CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 35966ca92a5Swdenk or XTAL/EXTAL) 360c609719bSwdenk 36166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 3626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MIN 3636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_8xx_CPUCLK_MAX 36466ca92a5Swdenk CONFIG_8xx_CPUCLK_DEFAULT 36575d1ea7fSwdenk See doc/README.MPC866 36675d1ea7fSwdenk 3676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MEASURE_CPUCLK 36875d1ea7fSwdenk 36975d1ea7fSwdenk Define this to measure the actual CPU clock instead 37075d1ea7fSwdenk of relying on the correctness of the configured 37175d1ea7fSwdenk values. Mostly useful for board bringup to make sure 37275d1ea7fSwdenk the PLL is locked at the intended frequency. Note 37375d1ea7fSwdenk that this requires a (stable) reference clock (32 kHz 3746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD RTC clock or CONFIG_SYS_8XX_XIN) 37575d1ea7fSwdenk 376506f3918SHeiko Schocher CONFIG_SYS_DELAYED_ICACHE 377506f3918SHeiko Schocher 378506f3918SHeiko Schocher Define this option if you want to enable the 379506f3918SHeiko Schocher ICache only when Code runs from RAM. 380506f3918SHeiko Schocher 38166412c63SKumar Gala- 85xx CPU Options: 382ffd06e02SYork Sun CONFIG_SYS_PPC64 383ffd06e02SYork Sun 384ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 385ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 386ffd06e02SYork Sun compliance, among other possible reasons. 387ffd06e02SYork Sun 38866412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 38966412c63SKumar Gala 39066412c63SKumar Gala Defines the core time base clock divider ratio compared to the 39166412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 39266412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 39366412c63SKumar Gala 3948f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3958f29084aSKumar Gala 3968f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3978f29084aSKumar Gala tree nodes for the given platform. 3988f29084aSKumar Gala 399afa6b551SPrabhakar Kushwaha CONFIG_SYS_PPC_E500_DEBUG_TLB 400afa6b551SPrabhakar Kushwaha 401afa6b551SPrabhakar Kushwaha Enables a temporary TLB entry to be used during boot to work 402afa6b551SPrabhakar Kushwaha around limitations in e500v1 and e500v2 external debugger 403afa6b551SPrabhakar Kushwaha support. This reduces the portions of the boot code where 404afa6b551SPrabhakar Kushwaha breakpoints and single stepping do not work. The value of this 405afa6b551SPrabhakar Kushwaha symbol should be set to the TLB1 entry to be used for this 406afa6b551SPrabhakar Kushwaha purpose. 407afa6b551SPrabhakar Kushwaha 40833eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 40933eee330SScott Wood 41033eee330SScott Wood Enables a workaround for erratum A004510. If set, 41133eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 41233eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 41333eee330SScott Wood 41433eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 41533eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 41633eee330SScott Wood 41733eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 41833eee330SScott Wood for which the A004510 workaround should be applied. 41933eee330SScott Wood 42033eee330SScott Wood The rest of SVR is either not relevant to the decision 42133eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 42233eee330SScott Wood p2041) or is implied by the build target, which controls 42333eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 42433eee330SScott Wood 42533eee330SScott Wood See Freescale App Note 4493 for more information about 42633eee330SScott Wood this erratum. 42733eee330SScott Wood 42874fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 42974fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 430b445bbb4SJeremiah Mahler required during NOR boot. 43174fa22edSPrabhakar Kushwaha 4329f074e67SPrabhakar Kushwaha CONFIG_A008044_WORKAROUND 4339f074e67SPrabhakar Kushwaha Enables a workaround for T1040/T1042 erratum A008044. It is only 434b445bbb4SJeremiah Mahler required during NAND boot and valid for Rev 1.0 SoC revision 4359f074e67SPrabhakar Kushwaha 43633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 43733eee330SScott Wood 43833eee330SScott Wood This is the value to write into CCSR offset 0x18600 43933eee330SScott Wood according to the A004510 workaround. 44033eee330SScott Wood 44164501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 44264501c66SPriyanka Jain This value denotes start offset of DDR memory which is 44364501c66SPriyanka Jain connected exclusively to the DSP cores. 44464501c66SPriyanka Jain 445765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 446765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 447765b0bdbSPriyanka Jain which is directly connected to the DSP core. 448765b0bdbSPriyanka Jain 44964501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 45064501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 45164501c66SPriyanka Jain connected to the DSP core. 45264501c66SPriyanka Jain 453765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 454765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 455765b0bdbSPriyanka Jain 456b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 457b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 458b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 459b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 460b135991aSPriyanka Jain 461fb4a2409SAneesh Bansal CONFIG_SYS_CPC_REINIT_F 462fb4a2409SAneesh Bansal This CONFIG is defined when the CPC is configured as SRAM at the 463a187559eSBin Meng time of U-Boot entry and is required to be re-initialized. 464fb4a2409SAneesh Bansal 465aade2004STang Yuantian CONFIG_DEEP_SLEEP 466b445bbb4SJeremiah Mahler Indicates this SoC supports deep sleep feature. If deep sleep is 467aade2004STang Yuantian supported, core will start to execute uboot when wakes up. 468aade2004STang Yuantian 4696cb461b4SDaniel Schwierzeck- Generic CPU options: 4702a1680e3SYork Sun CONFIG_SYS_GENERIC_GLOBAL_DATA 4712a1680e3SYork Sun Defines global data is initialized in generic board board_init_f(). 4722a1680e3SYork Sun If this macro is defined, global data is created and cleared in 4732a1680e3SYork Sun generic board board_init_f(). Without this macro, architecture/board 4742a1680e3SYork Sun should initialize global data before calling board_init_f(). 4752a1680e3SYork Sun 4766cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4776cb461b4SDaniel Schwierzeck 4786cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4796cb461b4SDaniel Schwierzeck values is arch specific. 4806cb461b4SDaniel Schwierzeck 4815614e71bSYork Sun CONFIG_SYS_FSL_DDR 4825614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4835614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4845614e71bSYork Sun SoCs. 4855614e71bSYork Sun 4865614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4875614e71bSYork Sun Freescale DDR memory-mapped register base. 4885614e71bSYork Sun 4895614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4905614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4915614e71bSYork Sun deskew training are not available. 4925614e71bSYork Sun 4935614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4945614e71bSYork Sun Freescale DDR1 controller. 4955614e71bSYork Sun 4965614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4975614e71bSYork Sun Freescale DDR2 controller. 4985614e71bSYork Sun 4995614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 5005614e71bSYork Sun Freescale DDR3 controller. 5015614e71bSYork Sun 50234e026f9SYork Sun CONFIG_SYS_FSL_DDRC_GEN4 50334e026f9SYork Sun Freescale DDR4 controller. 50434e026f9SYork Sun 5059ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 5069ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 5079ac4ffbdSYork Sun 5085614e71bSYork Sun CONFIG_SYS_FSL_DDR1 5095614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 5105614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 5115614e71bSYork Sun implemetation. 5125614e71bSYork Sun 5135614e71bSYork Sun CONFIG_SYS_FSL_DDR2 5145614e71bSYork Sun Board config to use DDR2. It can be eanbeld for SoCs with 5155614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 5165614e71bSYork Sun implementation. 5175614e71bSYork Sun 5185614e71bSYork Sun CONFIG_SYS_FSL_DDR3 5195614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 52034e026f9SYork Sun Freescale DDR3 or DDR3L controllers. 52134e026f9SYork Sun 52234e026f9SYork Sun CONFIG_SYS_FSL_DDR3L 52334e026f9SYork Sun Board config to use DDR3L. It can be enabled for SoCs with 52434e026f9SYork Sun DDR3L controllers. 52534e026f9SYork Sun 52634e026f9SYork Sun CONFIG_SYS_FSL_DDR4 52734e026f9SYork Sun Board config to use DDR4. It can be enabled for SoCs with 52834e026f9SYork Sun DDR4 controllers. 5295614e71bSYork Sun 5301b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_BE 5311b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Big Endian 5321b4175d6SPrabhakar Kushwaha 5331b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_LE 5341b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Little Endian 5351b4175d6SPrabhakar Kushwaha 536690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_PBI 537690e4258SPrabhakar Kushwaha It enables addition of RCW (Power on reset configuration) in built image. 538690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 539690e4258SPrabhakar Kushwaha 540690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_RCW 541690e4258SPrabhakar Kushwaha It adds PBI(pre-boot instructions) commands in u-boot build image. 542690e4258SPrabhakar Kushwaha PBI commands can be used to configure SoC before it starts the execution. 543690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 544690e4258SPrabhakar Kushwaha 54589ad7be8SPrabhakar Kushwaha CONFIG_SPL_FSL_PBL 54689ad7be8SPrabhakar Kushwaha It adds a target to create boot binary having SPL binary in PBI format 54789ad7be8SPrabhakar Kushwaha concatenated with u-boot binary. 54889ad7be8SPrabhakar Kushwaha 5494e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_BE 5504e5b1bd0SYork Sun Defines the DDR controller register space as Big Endian 5514e5b1bd0SYork Sun 5524e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_LE 5534e5b1bd0SYork Sun Defines the DDR controller register space as Little Endian 5544e5b1bd0SYork Sun 5556b9e309aSYork Sun CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 5566b9e309aSYork Sun Physical address from the view of DDR controllers. It is the 5576b9e309aSYork Sun same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 5586b9e309aSYork Sun it could be different for ARM SoCs. 5596b9e309aSYork Sun 5606b1e1254SYork Sun CONFIG_SYS_FSL_DDR_INTLV_256B 5616b1e1254SYork Sun DDR controller interleaving on 256-byte. This is a special 5626b1e1254SYork Sun interleaving mode, handled by Dickens for Freescale layerscape 5636b1e1254SYork Sun SoCs with ARM core. 5646b1e1254SYork Sun 5651d71efbbSYork Sun CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS 5661d71efbbSYork Sun Number of controllers used as main memory. 5671d71efbbSYork Sun 5681d71efbbSYork Sun CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS 5691d71efbbSYork Sun Number of controllers used for other than main memory. 5701d71efbbSYork Sun 57144937214SPrabhakar Kushwaha CONFIG_SYS_FSL_HAS_DP_DDR 57244937214SPrabhakar Kushwaha Defines the SoC has DP-DDR used for DPAA. 57344937214SPrabhakar Kushwaha 574028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_BE 575028dbb8dSRuchika Gupta Defines the SEC controller register space as Big Endian 576028dbb8dSRuchika Gupta 577028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_LE 578028dbb8dSRuchika Gupta Defines the SEC controller register space as Little Endian 579028dbb8dSRuchika Gupta 5800b953ffcSMarkus Klotzbuecher- Intel Monahans options: 5816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 5820b953ffcSMarkus Klotzbuecher 5830b953ffcSMarkus Klotzbuecher Defines the Monahans run mode to oscillator 5840b953ffcSMarkus Klotzbuecher ratio. Valid values are 8, 16, 24, 31. The core 5850b953ffcSMarkus Klotzbuecher frequency is this value multiplied by 13 MHz. 5860b953ffcSMarkus Klotzbuecher 5876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 5880b953ffcSMarkus Klotzbuecher 5890b953ffcSMarkus Klotzbuecher Defines the Monahans turbo mode to oscillator 5900b953ffcSMarkus Klotzbuecher ratio. Valid values are 1 (default if undefined) and 5910b953ffcSMarkus Klotzbuecher 2. The core frequency as calculated above is multiplied 5920b953ffcSMarkus Klotzbuecher by this value. 5930b953ffcSMarkus Klotzbuecher 59492bbd64eSDaniel Schwierzeck- MIPS CPU options: 59592bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 59692bbd64eSDaniel Schwierzeck 59792bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 59892bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 59992bbd64eSDaniel Schwierzeck relocation. 60092bbd64eSDaniel Schwierzeck 60192bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 60292bbd64eSDaniel Schwierzeck 60392bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 60492bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 60592bbd64eSDaniel Schwierzeck Possible values are: 60692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 60792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 60892bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 60992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 61092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 61192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 61292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 61392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 61492bbd64eSDaniel Schwierzeck 61592bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 61692bbd64eSDaniel Schwierzeck 61792bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 61892bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 61992bbd64eSDaniel Schwierzeck 62092bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 62192bbd64eSDaniel Schwierzeck 62292bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 62392bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 62492bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 62592bbd64eSDaniel Schwierzeck 626b67d8816SChristian Riesch- ARM options: 627b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 628b67d8816SChristian Riesch 629b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 630b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 631b67d8816SChristian Riesch 6325356f545SAneesh V CONFIG_SYS_THUMB_BUILD 6335356f545SAneesh V 6345356f545SAneesh V Use this flag to build U-Boot using the Thumb instruction 6355356f545SAneesh V set for ARM architectures. Thumb instruction set provides 6365356f545SAneesh V better code density. For ARM architectures that support 6375356f545SAneesh V Thumb2 this flag will result in Thumb2 code generated by 6385356f545SAneesh V GCC. 6395356f545SAneesh V 640c5d4752cSStephen Warren CONFIG_ARM_ERRATA_716044 6410678587fSStephen Warren CONFIG_ARM_ERRATA_742230 6420678587fSStephen Warren CONFIG_ARM_ERRATA_743622 6430678587fSStephen Warren CONFIG_ARM_ERRATA_751472 644b7588e3bSNitin Garg CONFIG_ARM_ERRATA_761320 645e392b923SIan Campbell CONFIG_ARM_ERRATA_773022 646e392b923SIan Campbell CONFIG_ARM_ERRATA_774769 647e392b923SIan Campbell CONFIG_ARM_ERRATA_794072 6480678587fSStephen Warren 6490678587fSStephen Warren If set, the workarounds for these ARM errata are applied early 6500678587fSStephen Warren during U-Boot startup. Note that these options force the 6510678587fSStephen Warren workarounds to be applied; no CPU-type/version detection 6520678587fSStephen Warren exists, unlike the similar options in the Linux kernel. Do not 6530678587fSStephen Warren set these options unless they apply! 6540678587fSStephen Warren 655207774b2SYork Sun COUNTER_FREQUENCY 656207774b2SYork Sun Generic timer clock source frequency. 657207774b2SYork Sun 658207774b2SYork Sun COUNTER_FREQUENCY_REAL 659207774b2SYork Sun Generic timer clock source frequency if the real clock is 660207774b2SYork Sun different from COUNTER_FREQUENCY, and can only be determined 661207774b2SYork Sun at run time. 662207774b2SYork Sun 663c616a0dfSNishanth Menon NOTE: The following can be machine specific errata. These 664c616a0dfSNishanth Menon do have ability to provide rudimentary version and machine 665c616a0dfSNishanth Menon specific checks, but expect no product checks. 6665902f4ceSNishanth Menon CONFIG_ARM_ERRATA_430973 667b45c48a7SNishanth Menon CONFIG_ARM_ERRATA_454179 6689b4d65f9SNishanth Menon CONFIG_ARM_ERRATA_621766 669c616a0dfSNishanth Menon CONFIG_ARM_ERRATA_798870 670a615d0beSNishanth Menon CONFIG_ARM_ERRATA_801819 671c616a0dfSNishanth Menon 67273c38934SStephen Warren- Tegra SoC options: 67373c38934SStephen Warren CONFIG_TEGRA_SUPPORT_NON_SECURE 67473c38934SStephen Warren 67573c38934SStephen Warren Support executing U-Boot in non-secure (NS) mode. Certain 67673c38934SStephen Warren impossible actions will be skipped if the CPU is in NS mode, 67773c38934SStephen Warren such as ARM architectural timer initialization. 67873c38934SStephen Warren 6795da627a4Swdenk- Linux Kernel Interface: 680c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 681c609719bSwdenk 682c609719bSwdenk U-Boot stores all clock information in Hz 683c609719bSwdenk internally. For binary compatibility with older Linux 684c609719bSwdenk kernels (which expect the clocks passed in the 685c609719bSwdenk bd_info data to be in MHz) the environment variable 686c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 687c609719bSwdenk converts clock data to MHZ before passing it to the 688c609719bSwdenk Linux kernel. 689c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 690c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 691c609719bSwdenk default environment. 692c609719bSwdenk 6935da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 6945da627a4Swdenk 695b445bbb4SJeremiah Mahler When transferring memsize parameter to Linux, some versions 6965da627a4Swdenk expect it to be in bytes, others in MB. 6975da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 6985da627a4Swdenk 699fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 700f57f70aaSWolfgang Denk 701f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 702213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 703213bf8c8SGerald Van Baren concepts). 704213bf8c8SGerald Van Baren 705213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 706213bf8c8SGerald Van Baren * New libfdt-based support 707213bf8c8SGerald Van Baren * Adds the "fdt" command 7083bb342fcSKim Phillips * The bootm command automatically updates the fdt 709213bf8c8SGerald Van Baren 710b55ae402SMarcel Ziswiler OF_CPU - The proper name of the cpus node (only required for 711b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 712b55ae402SMarcel Ziswiler OF_SOC - The proper name of the soc node (only required for 713b55ae402SMarcel Ziswiler MPC512X and MPC5xxx based boards). 714f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 715c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 716f57f70aaSWolfgang Denk 71711ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 71811ccc33fSMarcel Ziswiler addresses 7193bb342fcSKim Phillips 7204e253137SKumar Gala CONFIG_OF_BOARD_SETUP 7214e253137SKumar Gala 7224e253137SKumar Gala Board code has addition modification that it wants to make 7234e253137SKumar Gala to the flat device tree before handing it off to the kernel 7246705d81eSwdenk 725c654b517SSimon Glass CONFIG_OF_SYSTEM_SETUP 726c654b517SSimon Glass 727c654b517SSimon Glass Other code has addition modification that it wants to make 728c654b517SSimon Glass to the flat device tree before handing it off to the kernel. 729c654b517SSimon Glass This causes ft_system_setup() to be called before booting 730c654b517SSimon Glass the kernel. 731c654b517SSimon Glass 7320267768eSMatthew McClintock CONFIG_OF_BOOT_CPU 7330267768eSMatthew McClintock 73411ccc33fSMarcel Ziswiler This define fills in the correct boot CPU in the boot 7350267768eSMatthew McClintock param header, the default value is zero if undefined. 7360267768eSMatthew McClintock 7373887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 7383887c3fbSHeiko Schocher 7393887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 7403887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 7413887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 7423887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 7433887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 7443887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 7453887c3fbSHeiko Schocher 7467eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 7477eb29398SIgor Grinberg 7487eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 7497eb29398SIgor Grinberg machine type and must be used to specify the machine type 7507eb29398SIgor Grinberg number as it appears in the ARM machine registry 7517eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 7527eb29398SIgor Grinberg Only boards that have multiple machine types supported 7537eb29398SIgor Grinberg in a single configuration file and the machine type is 7547eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 7557eb29398SIgor Grinberg 7560b2f4ecaSNiklaus Giger- vxWorks boot parameters: 7570b2f4ecaSNiklaus Giger 7580b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 7599e98b7e3SBin Meng environments variables: bootdev, bootfile, ipaddr, netmask, 7609e98b7e3SBin Meng serverip, gatewayip, hostname, othbootargs. 7610b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 7620b2f4ecaSNiklaus Giger 7630b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 7640b2f4ecaSNiklaus Giger the defaults discussed just above. 7650b2f4ecaSNiklaus Giger 7662c451f78SAneesh V- Cache Configuration: 7672c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 7682c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 7692c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 7702c451f78SAneesh V 77193bc2193SAneesh V- Cache Configuration for ARM: 77293bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 77393bc2193SAneesh V controller 77493bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 77593bc2193SAneesh V controller register space 77693bc2193SAneesh V 7776705d81eSwdenk- Serial Ports: 77848d0192fSAndreas Engel CONFIG_PL010_SERIAL 7796705d81eSwdenk 7806705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 7816705d81eSwdenk 78248d0192fSAndreas Engel CONFIG_PL011_SERIAL 7836705d81eSwdenk 7846705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 7856705d81eSwdenk 7866705d81eSwdenk CONFIG_PL011_CLOCK 7876705d81eSwdenk 7886705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 7896705d81eSwdenk the clock speed of the UARTs. 7906705d81eSwdenk 7916705d81eSwdenk CONFIG_PL01x_PORTS 7926705d81eSwdenk 7936705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 7946705d81eSwdenk define this to a list of base addresses for each (supported) 7956705d81eSwdenk port. See e.g. include/configs/versatile.h 7966705d81eSwdenk 797d57dee57SKaricheri, Muralidharan CONFIG_SERIAL_HW_FLOW_CONTROL 798d57dee57SKaricheri, Muralidharan 799d57dee57SKaricheri, Muralidharan Define this variable to enable hw flow control in serial driver. 800d57dee57SKaricheri, Muralidharan Current user of this option is drivers/serial/nsl16550.c driver 8016705d81eSwdenk 802c609719bSwdenk- Console Interface: 803c609719bSwdenk Depending on board, define exactly one serial port 804c609719bSwdenk (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 805c609719bSwdenk CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 806c609719bSwdenk console by defining CONFIG_8xx_CONS_NONE 807c609719bSwdenk 808c609719bSwdenk Note: if CONFIG_8xx_CONS_NONE is defined, the serial 809c609719bSwdenk port routines must be defined elsewhere 810c609719bSwdenk (i.e. serial_init(), serial_getc(), ...) 811c609719bSwdenk 812c609719bSwdenk CONFIG_CFB_CONSOLE 813c609719bSwdenk Enables console device for a color framebuffer. Needs following 814c53043b7SWolfgang Denk defines (cf. smiLynxEM, i8042) 815c609719bSwdenk VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 816c609719bSwdenk (default big endian) 817c609719bSwdenk VIDEO_HW_RECTFILL graphic chip supports 818c609719bSwdenk rectangle fill 819c609719bSwdenk (cf. smiLynxEM) 820c609719bSwdenk VIDEO_HW_BITBLT graphic chip supports 821c609719bSwdenk bit-blit (cf. smiLynxEM) 822c609719bSwdenk VIDEO_VISIBLE_COLS visible pixel columns 823c609719bSwdenk (cols=pitch) 824c609719bSwdenk VIDEO_VISIBLE_ROWS visible pixel rows 825c609719bSwdenk VIDEO_PIXEL_SIZE bytes per pixel 826c609719bSwdenk VIDEO_DATA_FORMAT graphic data format 827c609719bSwdenk (0-5, cf. cfb_console.c) 828c609719bSwdenk VIDEO_FB_ADRS framebuffer address 829c609719bSwdenk VIDEO_KBD_INIT_FCT keyboard int fct 83039f615edSSimon Glass (i.e. rx51_kp_init()) 831c609719bSwdenk VIDEO_TSTC_FCT test char fct 83239f615edSSimon Glass (i.e. rx51_kp_tstc) 833c609719bSwdenk VIDEO_GETC_FCT get char fct 83439f615edSSimon Glass (i.e. rx51_kp_getc) 835c609719bSwdenk CONFIG_VIDEO_LOGO display Linux logo in 836c609719bSwdenk upper left corner 837a6c7ad2fSwdenk CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 838a6c7ad2fSwdenk linux_logo.h for logo. 839a6c7ad2fSwdenk Requires CONFIG_VIDEO_LOGO 840c609719bSwdenk CONFIG_CONSOLE_EXTRA_INFO 84111ccc33fSMarcel Ziswiler additional board info beside 842c609719bSwdenk the logo 843c609719bSwdenk 84433a35bbbSPali Rohár When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 84533a35bbbSPali Rohár a limited number of ANSI escape sequences (cursor control, 84633a35bbbSPali Rohár erase functions and limited graphics rendition control). 84733a35bbbSPali Rohár 848c609719bSwdenk When CONFIG_CFB_CONSOLE is defined, video console is 849c609719bSwdenk default i/o. Serial console can be forced with 850c609719bSwdenk environment 'console=serial'. 851c609719bSwdenk 852a3ad8e26Swdenk When CONFIG_SILENT_CONSOLE is defined, all console 853a3ad8e26Swdenk messages (by U-Boot and Linux!) can be silenced with 854a3ad8e26Swdenk the "silent" environment variable. See 855a3ad8e26Swdenk doc/README.silent for more information. 856a3ad8e26Swdenk 85745ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default 85845ae2546SHeiko Schocher is 0x00. 85945ae2546SHeiko Schocher CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default 86045ae2546SHeiko Schocher is 0xa0. 86145ae2546SHeiko Schocher 862c609719bSwdenk- Console Baudrate: 863c609719bSwdenk CONFIG_BAUDRATE - in bps 864c609719bSwdenk Select one of the baudrates listed in 8656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 8666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 867c609719bSwdenk 868c92fac91SHeiko Schocher- Console Rx buffer length 869c92fac91SHeiko Schocher With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 870c92fac91SHeiko Schocher the maximum receive buffer length for the SMC. 8712b3f12c2SHeiko Schocher This option is actual only for 82xx and 8xx possible. 872c92fac91SHeiko Schocher If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 873c92fac91SHeiko Schocher must be defined, to setup the maximum idle timeout for 874c92fac91SHeiko Schocher the SMC. 875c92fac91SHeiko Schocher 8769558b48aSGraeme Russ- Pre-Console Buffer: 8779558b48aSGraeme Russ Prior to the console being initialised (i.e. serial UART 8789558b48aSGraeme Russ initialised etc) all console output is silently discarded. 8799558b48aSGraeme Russ Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 8809558b48aSGraeme Russ buffer any console messages prior to the console being 8819558b48aSGraeme Russ initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 8829558b48aSGraeme Russ bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 8839558b48aSGraeme Russ a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 8849558b48aSGraeme Russ bytes are output before the console is initialised, the 8859558b48aSGraeme Russ earlier bytes are discarded. 8869558b48aSGraeme Russ 887a8552c7cSHans de Goede Note that when printing the buffer a copy is made on the 888a8552c7cSHans de Goede stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack. 889a8552c7cSHans de Goede 8909558b48aSGraeme Russ 'Sane' compilers will generate smaller code if 8919558b48aSGraeme Russ CONFIG_PRE_CON_BUF_SZ is a power of 2 8929558b48aSGraeme Russ 893c609719bSwdenk- Autoboot Command: 894c609719bSwdenk CONFIG_BOOTCOMMAND 895c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 896c609719bSwdenk define a command string that is automatically executed 897c609719bSwdenk when no character is read on the console interface 898c609719bSwdenk within "Boot Delay" after reset. 899c609719bSwdenk 900c609719bSwdenk CONFIG_BOOTARGS 901c609719bSwdenk This can be used to pass arguments to the bootm 902c609719bSwdenk command. The value of CONFIG_BOOTARGS goes into the 903c609719bSwdenk environment value "bootargs". 904c609719bSwdenk 905c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 906c609719bSwdenk The value of these goes into the environment as 907c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 908c609719bSwdenk as a convenience, when switching between booting from 90911ccc33fSMarcel Ziswiler RAM and NFS. 910c609719bSwdenk 911eda0ba38SHeiko Schocher- Bootcount: 912eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 913eda0ba38SHeiko Schocher Implements a mechanism for detecting a repeating reboot 914eda0ba38SHeiko Schocher cycle, see: 915eda0ba38SHeiko Schocher http://www.denx.de/wiki/view/DULG/UBootBootCountLimit 916eda0ba38SHeiko Schocher 917eda0ba38SHeiko Schocher CONFIG_BOOTCOUNT_ENV 918eda0ba38SHeiko Schocher If no softreset save registers are found on the hardware 919eda0ba38SHeiko Schocher "bootcount" is stored in the environment. To prevent a 920eda0ba38SHeiko Schocher saveenv on all reboots, the environment variable 921eda0ba38SHeiko Schocher "upgrade_available" is used. If "upgrade_available" is 922eda0ba38SHeiko Schocher 0, "bootcount" is always 0, if "upgrade_available" is 923eda0ba38SHeiko Schocher 1 "bootcount" is incremented in the environment. 924eda0ba38SHeiko Schocher So the Userspace Applikation must set the "upgrade_available" 925eda0ba38SHeiko Schocher and "bootcount" variable to 0, if a boot was successfully. 926eda0ba38SHeiko Schocher 927c609719bSwdenk- Pre-Boot Commands: 928c609719bSwdenk CONFIG_PREBOOT 929c609719bSwdenk 930c609719bSwdenk When this option is #defined, the existence of the 931c609719bSwdenk environment variable "preboot" will be checked 932c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 933c609719bSwdenk countdown and/or running the auto-boot command resp. 934c609719bSwdenk entering interactive mode. 935c609719bSwdenk 936c609719bSwdenk This feature is especially useful when "preboot" is 937c609719bSwdenk automatically generated or modified. For an example 938c609719bSwdenk see the LWMON board specific code: here "preboot" is 939c609719bSwdenk modified when the user holds down a certain 940c609719bSwdenk combination of keys on the (special) keyboard when 941c609719bSwdenk booting the systems 942c609719bSwdenk 943c609719bSwdenk- Serial Download Echo Mode: 944c609719bSwdenk CONFIG_LOADS_ECHO 945c609719bSwdenk If defined to 1, all characters received during a 946c609719bSwdenk serial download (using the "loads" command) are 947c609719bSwdenk echoed back. This might be needed by some terminal 948c609719bSwdenk emulations (like "cu"), but may as well just take 949c609719bSwdenk time on others. This setting #define's the initial 950c609719bSwdenk value of the "loads_echo" environment variable. 951c609719bSwdenk 952602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 953c609719bSwdenk CONFIG_KGDB_BAUDRATE 954c609719bSwdenk Select one of the baudrates listed in 9556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 956c609719bSwdenk 957c609719bSwdenk- Monitor Functions: 958602ad3b3SJon Loeliger Monitor commands can be included or excluded 959602ad3b3SJon Loeliger from the build by using the #include files 960c6c621bdSStephen Warren <config_cmd_all.h> and #undef'ing unwanted 961ef0f2f57SJoe Hershberger commands, or adding #define's for wanted commands. 962c609719bSwdenk 963602ad3b3SJon Loeliger The default command configuration includes all commands 964602ad3b3SJon Loeliger except those marked below with a "*". 965602ad3b3SJon Loeliger 966b401b73dSMarek Vasut CONFIG_CMD_AES AES 128 CBC encrypt/decrypt 967602ad3b3SJon Loeliger CONFIG_CMD_ASKENV * ask for env variable 968602ad3b3SJon Loeliger CONFIG_CMD_BDI bdinfo 969602ad3b3SJon Loeliger CONFIG_CMD_BEDBUG * Include BedBug Debugger 970602ad3b3SJon Loeliger CONFIG_CMD_BMP * BMP support 971602ad3b3SJon Loeliger CONFIG_CMD_BSP * Board specific commands 972602ad3b3SJon Loeliger CONFIG_CMD_BOOTD bootd 973d2b2ffe3STom Rini CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support 974602ad3b3SJon Loeliger CONFIG_CMD_CACHE * icache, dcache 97508d0d6f3SMichal Simek CONFIG_CMD_CLK * clock command support 976602ad3b3SJon Loeliger CONFIG_CMD_CONSOLE coninfo 977710b9938SMike Frysinger CONFIG_CMD_CRC32 * crc32 978602ad3b3SJon Loeliger CONFIG_CMD_DATE * support for RTC, date/time... 979602ad3b3SJon Loeliger CONFIG_CMD_DHCP * DHCP support 980602ad3b3SJon Loeliger CONFIG_CMD_DIAG * Diagnostics 981a7c93104SPeter Tyser CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 982a7c93104SPeter Tyser CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 983a7c93104SPeter Tyser CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 984a7c93104SPeter Tyser CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 985602ad3b3SJon Loeliger CONFIG_CMD_DTT * Digital Therm and Thermostat 986602ad3b3SJon Loeliger CONFIG_CMD_ECHO echo arguments 987246c6922SPeter Tyser CONFIG_CMD_EDITENV edit env variable 988602ad3b3SJon Loeliger CONFIG_CMD_EEPROM * EEPROM read/write support 989aa9e6044SNikita Kiryanov CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands 990602ad3b3SJon Loeliger CONFIG_CMD_ELF * bootelf, bootvx 9915e2b3e0cSJoe Hershberger CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 992fffad71bSJoe Hershberger CONFIG_CMD_ENV_FLAGS * display details about env flags 99388733e2cSAndrew Ruder CONFIG_CMD_ENV_EXISTS * check existence of env variable 9940c79cda0SMike Frysinger CONFIG_CMD_EXPORTENV * export the environment 99503e2ecf6SStephen Warren CONFIG_CMD_EXT2 * ext2 command support 99603e2ecf6SStephen Warren CONFIG_CMD_EXT4 * ext4 command support 99716f4d933SStephen Warren CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls) 99816f4d933SStephen Warren that work for multiple fs types 99959e890efSChristian Gmeiner CONFIG_CMD_FS_UUID * Look up a filesystem UUID 1000bdab39d3SMike Frysinger CONFIG_CMD_SAVEENV saveenv 1001602ad3b3SJon Loeliger CONFIG_CMD_FDC * Floppy Disk Support 100203e2ecf6SStephen Warren CONFIG_CMD_FAT * FAT command support 1003602ad3b3SJon Loeliger CONFIG_CMD_FLASH flinfo, erase, protect 1004602ad3b3SJon Loeliger CONFIG_CMD_FPGA FPGA device initialization support 10054d98b5c8SVincent Stehlé CONFIG_CMD_FUSE * Device fuse support 100653fdc7efSAnton Staaf CONFIG_CMD_GETTIME * Get time since boot 1007a641b979SMike Frysinger CONFIG_CMD_GO * the 'go' command (exec code) 1008a000b795SKim Phillips CONFIG_CMD_GREPENV * search environment 1009bf36c5d5SSimon Glass CONFIG_CMD_HASH * calculate hash / digest 1010602ad3b3SJon Loeliger CONFIG_CMD_I2C * I2C serial bus support 1011602ad3b3SJon Loeliger CONFIG_CMD_IDE * IDE harddisk support 1012602ad3b3SJon Loeliger CONFIG_CMD_IMI iminfo 10138fdf1e0fSVipin Kumar CONFIG_CMD_IMLS List all images found in NOR flash 10144d98b5c8SVincent Stehlé CONFIG_CMD_IMLS_NAND * List all images found in NAND flash 1015602ad3b3SJon Loeliger CONFIG_CMD_IMMAP * IMMR dump support 1016aa53233aSSimon Glass CONFIG_CMD_IOTRACE * I/O tracing for debugging 10170c79cda0SMike Frysinger CONFIG_CMD_IMPORTENV * import an environment 1018c167cc02SJoe Hershberger CONFIG_CMD_INI * import data from an ini file into the env 1019602ad3b3SJon Loeliger CONFIG_CMD_IRQ * irqinfo 1020602ad3b3SJon Loeliger CONFIG_CMD_ITEST Integer/string test of 2 values 1021602ad3b3SJon Loeliger CONFIG_CMD_JFFS2 * JFFS2 Support 1022602ad3b3SJon Loeliger CONFIG_CMD_KGDB * kgdb 10234d98b5c8SVincent Stehlé CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader) 1024d22c338eSJoe Hershberger CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 1025d22c338eSJoe Hershberger (169.254.*.*) 1026602ad3b3SJon Loeliger CONFIG_CMD_LOADB loadb 1027602ad3b3SJon Loeliger CONFIG_CMD_LOADS loads 10284d98b5c8SVincent Stehlé CONFIG_CMD_MD5SUM * print md5 message digest 102902c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 103015a33e49SSimon Glass CONFIG_CMD_MEMINFO * Display detailed memory information 1031602ad3b3SJon Loeliger CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 1032a2681707SWolfgang Denk loop, loopw 10334d98b5c8SVincent Stehlé CONFIG_CMD_MEMTEST * mtest 1034602ad3b3SJon Loeliger CONFIG_CMD_MISC Misc functions like sleep etc 1035602ad3b3SJon Loeliger CONFIG_CMD_MMC * MMC memory mapped support 1036602ad3b3SJon Loeliger CONFIG_CMD_MII * MII utility commands 103768d7d651SStefan Roese CONFIG_CMD_MTDPARTS * MTD partition support 1038602ad3b3SJon Loeliger CONFIG_CMD_NAND * NAND support 1039602ad3b3SJon Loeliger CONFIG_CMD_NET bootp, tftpboot, rarpboot 10404d98b5c8SVincent Stehlé CONFIG_CMD_NFS NFS support 1041e92739d3SPeter Tyser CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 1042e92739d3SPeter Tyser CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 1043602ad3b3SJon Loeliger CONFIG_CMD_PCI * pciinfo 1044602ad3b3SJon Loeliger CONFIG_CMD_PCMCIA * PCMCIA support 1045602ad3b3SJon Loeliger CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 1046602ad3b3SJon Loeliger host 1047602ad3b3SJon Loeliger CONFIG_CMD_PORTIO * Port I/O 1048ff048ea9SKenneth Waters CONFIG_CMD_READ * Read raw data from partition 1049602ad3b3SJon Loeliger CONFIG_CMD_REGINFO * Register dump 1050602ad3b3SJon Loeliger CONFIG_CMD_RUN run command in env variable 1051d304931fSSimon Glass CONFIG_CMD_SANDBOX * sb command to access sandbox features 1052602ad3b3SJon Loeliger CONFIG_CMD_SAVES * save S record dump 1053c649e3c9SSimon Glass CONFIG_SCSI * SCSI Support 1054602ad3b3SJon Loeliger CONFIG_CMD_SDRAM * print SDRAM configuration information 1055602ad3b3SJon Loeliger (requires CONFIG_CMD_I2C) 1056602ad3b3SJon Loeliger CONFIG_CMD_SETGETDCR Support for DCR Register access 1057602ad3b3SJon Loeliger (4xx only) 1058f61ec45eSEric Nelson CONFIG_CMD_SF * Read/write/erase SPI NOR flash 10594d98b5c8SVincent Stehlé CONFIG_CMD_SHA1SUM * print sha1 memory digest 106002c9aa1dSRobin Getz (requires CONFIG_CMD_MEMORY) 10617d861d95SBob Liu CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x 106274de7aefSWolfgang Denk CONFIG_CMD_SOURCE "source" command Support 1063602ad3b3SJon Loeliger CONFIG_CMD_SPI * SPI serial bus support 10647a83af07SLuca Ceresoli CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 10651fb7cd49SSimon Glass CONFIG_CMD_TFTPPUT * TFTP put command (upload) 1066da83bcd7SJoe Hershberger CONFIG_CMD_TIME * run command and report execution time (ARM specific) 1067da83bcd7SJoe Hershberger CONFIG_CMD_TIMER * access to the system tick timer 1068602ad3b3SJon Loeliger CONFIG_CMD_USB * USB support 1069602ad3b3SJon Loeliger CONFIG_CMD_CDP * Cisco Discover Protocol support 1070c8339f51SMarek Vasut CONFIG_CMD_MFSL * Microblaze FSL support 10714d98b5c8SVincent Stehlé CONFIG_CMD_XIMG Load part of Multi Image 107289c8230dSPrzemyslaw Marczak CONFIG_CMD_UUID * Generate random UUID or GUID string 1073c609719bSwdenk 1074c609719bSwdenk EXAMPLE: If you want all functions except of network 1075c609719bSwdenk support you can write: 1076c609719bSwdenk 1077602ad3b3SJon Loeliger #include "config_cmd_all.h" 1078602ad3b3SJon Loeliger #undef CONFIG_CMD_NET 1079c609719bSwdenk 1080213bf8c8SGerald Van Baren Other Commands: 1081213bf8c8SGerald Van Baren fdt (flattened device tree) command: CONFIG_OF_LIBFDT 1082c609719bSwdenk 1083c609719bSwdenk Note: Don't enable the "icache" and "dcache" commands 1084602ad3b3SJon Loeliger (configuration option CONFIG_CMD_CACHE) unless you know 1085c609719bSwdenk what you (and your U-Boot users) are doing. Data 1086c609719bSwdenk cache cannot be enabled on systems like the 8xx or 1087c609719bSwdenk 8260 (where accesses to the IMMR region must be 1088c609719bSwdenk uncached), and it cannot be disabled on all other 1089c609719bSwdenk systems where we (mis-) use the data cache to hold an 1090c609719bSwdenk initial stack and some data. 1091c609719bSwdenk 1092c609719bSwdenk 1093c609719bSwdenk XXX - this list needs to get updated! 1094c609719bSwdenk 1095302a6487SSimon Glass- Removal of commands 1096302a6487SSimon Glass If no commands are needed to boot, you can disable 1097302a6487SSimon Glass CONFIG_CMDLINE to remove them. In this case, the command line 1098302a6487SSimon Glass will not be available, and when U-Boot wants to execute the 1099302a6487SSimon Glass boot command (on start-up) it will call board_run_command() 1100302a6487SSimon Glass instead. This can reduce image size significantly for very 1101302a6487SSimon Glass simple boot procedures. 1102302a6487SSimon Glass 1103a5ecbe62SWolfgang Denk- Regular expression support: 1104a5ecbe62SWolfgang Denk CONFIG_REGEX 1105a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 1106a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 1107a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 1108a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 1109a5ecbe62SWolfgang Denk 111045ba8077SSimon Glass- Device tree: 111145ba8077SSimon Glass CONFIG_OF_CONTROL 111245ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 111345ba8077SSimon Glass to configure its devices, instead of relying on statically 111445ba8077SSimon Glass compiled #defines in the board file. This option is 111545ba8077SSimon Glass experimental and only available on a few boards. The device 111645ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 111745ba8077SSimon Glass 11182c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 11192c0f79e4SSimon Glass be done using one of the two options below: 1120bbb0b128SSimon Glass 1121bbb0b128SSimon Glass CONFIG_OF_EMBED 1122bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 1123bbb0b128SSimon Glass binary in its image. This device tree file should be in the 1124bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 1125bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 1126bbb0b128SSimon Glass the global data structure as gd->blob. 112745ba8077SSimon Glass 11282c0f79e4SSimon Glass CONFIG_OF_SEPARATE 11292c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 11302c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 11312c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 11322c0f79e4SSimon Glass 11332c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 11342c0f79e4SSimon Glass 11352c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 11362c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 11372c0f79e4SSimon Glass still use the individual files if you need something more 11382c0f79e4SSimon Glass exotic. 11392c0f79e4SSimon Glass 1140c609719bSwdenk- Watchdog: 1141c609719bSwdenk CONFIG_WATCHDOG 1142c609719bSwdenk If this variable is defined, it enables watchdog 11436abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 11446abe6fb6SDetlev Zundel specific code for a watchdog. For the 8xx and 8260 11456abe6fb6SDetlev Zundel CPUs, the SIU Watchdog feature is enabled in the SYPCR 11466abe6fb6SDetlev Zundel register. When supported for a specific SoC is 11476abe6fb6SDetlev Zundel available, then no further board specific code should 11486abe6fb6SDetlev Zundel be needed to use it. 11496abe6fb6SDetlev Zundel 11506abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 11516abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 11526abe6fb6SDetlev Zundel SoC, then define this variable and provide board 11536abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 1154c609719bSwdenk 11557bae0d6fSHeiko Schocher CONFIG_AT91_HW_WDT_TIMEOUT 11567bae0d6fSHeiko Schocher specify the timeout in seconds. default 2 seconds. 11577bae0d6fSHeiko Schocher 1158c1551ea8Sstroese- U-Boot Version: 1159c1551ea8Sstroese CONFIG_VERSION_VARIABLE 1160c1551ea8Sstroese If this variable is defined, an environment variable 1161c1551ea8Sstroese named "ver" is created by U-Boot showing the U-Boot 1162c1551ea8Sstroese version as printed by the "version" command. 1163a1ea8e51SBenoît Thébaudeau Any change to this variable will be reverted at the 1164a1ea8e51SBenoît Thébaudeau next reset. 1165c1551ea8Sstroese 1166c609719bSwdenk- Real-Time Clock: 1167c609719bSwdenk 1168602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 1169c609719bSwdenk has to be selected, too. Define exactly one of the 1170c609719bSwdenk following options: 1171c609719bSwdenk 1172c609719bSwdenk CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 1173c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 11744e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 1175c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 11761cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 1177c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 11787f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 1179412921d2SMarkus Niebel CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC 11803bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 11819536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 11824c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 11836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 118471d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 118571d19f30SHeiko Schocher RV3029 RTC. 1186c609719bSwdenk 1187b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 1188b37c7e5eSwdenk must also be configured. See I2C Support, below. 1189b37c7e5eSwdenk 1190e92739d3SPeter Tyser- GPIO Support: 1191e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1192e92739d3SPeter Tyser 11935dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 11945dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 11955dec49caSChris Packham pins supported by a particular chip. 11965dec49caSChris Packham 1197e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 1198e92739d3SPeter Tyser must also be configured. See I2C Support, below. 1199e92739d3SPeter Tyser 1200aa53233aSSimon Glass- I/O tracing: 1201aa53233aSSimon Glass When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O 1202aa53233aSSimon Glass accesses and can checksum them or write a list of them out 1203aa53233aSSimon Glass to memory. See the 'iotrace' command for details. This is 1204aa53233aSSimon Glass useful for testing device drivers since it can confirm that 1205aa53233aSSimon Glass the driver behaves the same way before and after a code 1206aa53233aSSimon Glass change. Currently this is supported on sandbox and arm. To 1207aa53233aSSimon Glass add support for your architecture, add '#include <iotrace.h>' 1208aa53233aSSimon Glass to the bottom of arch/<arch>/include/asm/io.h and test. 1209aa53233aSSimon Glass 1210aa53233aSSimon Glass Example output from the 'iotrace stats' command is below. 1211aa53233aSSimon Glass Note that if the trace buffer is exhausted, the checksum will 1212aa53233aSSimon Glass still continue to operate. 1213aa53233aSSimon Glass 1214aa53233aSSimon Glass iotrace is enabled 1215aa53233aSSimon Glass Start: 10000000 (buffer start address) 1216aa53233aSSimon Glass Size: 00010000 (buffer size) 1217aa53233aSSimon Glass Offset: 00000120 (current buffer offset) 1218aa53233aSSimon Glass Output: 10000120 (start + offset) 1219aa53233aSSimon Glass Count: 00000018 (number of trace records) 1220aa53233aSSimon Glass CRC32: 9526fb66 (CRC32 of all trace records) 1221aa53233aSSimon Glass 1222c609719bSwdenk- Timestamp Support: 1223c609719bSwdenk 1224c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 1225c609719bSwdenk (date and time) of an image is printed by image 1226c609719bSwdenk commands like bootm or iminfo. This option is 1227602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 1228c609719bSwdenk 1229923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 1230923c46f9SKarl O. Pinc Zero or more of the following: 1231923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 1232923c46f9SKarl O. Pinc CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1233923c46f9SKarl O. Pinc Intel architecture, USB sticks, etc. 1234923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1235923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1236923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 1237923c46f9SKarl O. Pinc disk/part_efi.c 1238923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1239c609719bSwdenk 1240602ad3b3SJon Loeliger If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1241c649e3c9SSimon Glass CONFIG_SCSI) you must configure support for at 1242923c46f9SKarl O. Pinc least one non-MTD partition type as well. 1243c609719bSwdenk 1244c609719bSwdenk- IDE Reset method: 12454d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 12464d13cbadSwdenk board configurations files but used nowhere! 1247c609719bSwdenk 12484d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 12494d13cbadSwdenk be performed by calling the function 12504d13cbadSwdenk ide_set_reset(int reset) 12514d13cbadSwdenk which has to be defined in a board specific file 1252c609719bSwdenk 1253c609719bSwdenk- ATAPI Support: 1254c609719bSwdenk CONFIG_ATAPI 1255c609719bSwdenk 1256c609719bSwdenk Set this to enable ATAPI support. 1257c609719bSwdenk 1258c40b2956Swdenk- LBA48 Support 1259c40b2956Swdenk CONFIG_LBA48 1260c40b2956Swdenk 1261c40b2956Swdenk Set this to enable support for disks larger than 137GB 12624b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 1263c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 1264c40b2956Swdenk support disks up to 2.1TB. 1265c40b2956Swdenk 12666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 1267c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 1268c40b2956Swdenk Default is 32bit. 1269c40b2956Swdenk 1270c609719bSwdenk- SCSI Support: 1271c609719bSwdenk At the moment only there is only support for the 1272c609719bSwdenk SYM53C8XX SCSI controller; define 1273c609719bSwdenk CONFIG_SCSI_SYM53C8XX to enable it. 1274c609719bSwdenk 12756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 12766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 12776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1278c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 1279c609719bSwdenk devices. 12806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1281c609719bSwdenk 1282447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 1283447c031bSStefan Reinauer SCSI devices found during the last scan. 1284447c031bSStefan Reinauer 1285c609719bSwdenk- NETWORK Support (PCI): 1286682011ffSwdenk CONFIG_E1000 1287ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 1288ce5207e1SKyle Moffett 1289ce5207e1SKyle Moffett CONFIG_E1000_SPI 1290ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 1291ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 1292ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1293ce5207e1SKyle Moffett 1294ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 1295ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 1296ce5207e1SKyle Moffett example with the "sspi" command. 1297ce5207e1SKyle Moffett 1298ce5207e1SKyle Moffett CONFIG_CMD_E1000 1299ce5207e1SKyle Moffett Management command for E1000 devices. When used on devices 1300ce5207e1SKyle Moffett with SPI support you can reprogram the EEPROM from U-Boot. 1301682011ffSwdenk 1302c609719bSwdenk CONFIG_EEPRO100 1303c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 130411ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1305c609719bSwdenk write routine for first time initialisation. 1306c609719bSwdenk 1307c609719bSwdenk CONFIG_TULIP 1308c609719bSwdenk Support for Digital 2114x chips. 1309c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1310c609719bSwdenk modem chip initialisation (KS8761/QS6611). 1311c609719bSwdenk 1312c609719bSwdenk CONFIG_NATSEMI 1313c609719bSwdenk Support for National dp83815 chips. 1314c609719bSwdenk 1315c609719bSwdenk CONFIG_NS8382X 1316c609719bSwdenk Support for National dp8382[01] gigabit chips. 1317c609719bSwdenk 131845219c46Swdenk- NETWORK Support (other): 131945219c46Swdenk 1320c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 1321c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 1322c041e9d2SJens Scharsig 1323c041e9d2SJens Scharsig CONFIG_RMII 1324c041e9d2SJens Scharsig Define this to use reduced MII inteface 1325c041e9d2SJens Scharsig 1326c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 1327c041e9d2SJens Scharsig If this defined, the driver is quiet. 1328c041e9d2SJens Scharsig The driver doen't show link status messages. 1329c041e9d2SJens Scharsig 1330efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 1331efdd7319SRob Herring Support for the Calxeda XGMAC device 1332efdd7319SRob Herring 13333bb46d23SAshok CONFIG_LAN91C96 133445219c46Swdenk Support for SMSC's LAN91C96 chips. 133545219c46Swdenk 133645219c46Swdenk CONFIG_LAN91C96_BASE 133745219c46Swdenk Define this to hold the physical address 133845219c46Swdenk of the LAN91C96's I/O space 133945219c46Swdenk 134045219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 134145219c46Swdenk Define this to enable 32 bit addressing 134245219c46Swdenk 13433bb46d23SAshok CONFIG_SMC91111 1344f39748aeSwdenk Support for SMSC's LAN91C111 chip 1345f39748aeSwdenk 1346f39748aeSwdenk CONFIG_SMC91111_BASE 1347f39748aeSwdenk Define this to hold the physical address 1348f39748aeSwdenk of the device (I/O space) 1349f39748aeSwdenk 1350f39748aeSwdenk CONFIG_SMC_USE_32_BIT 1351f39748aeSwdenk Define this if data bus is 32 bits 1352f39748aeSwdenk 1353f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 1354f39748aeSwdenk Define this to use i/o functions instead of macros 1355f39748aeSwdenk (some hardware wont work with macros) 1356f39748aeSwdenk 1357dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 1358dc02badaSHeiko Schocher Support for davinci emac 1359dc02badaSHeiko Schocher 1360dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1361dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 1362dc02badaSHeiko Schocher 1363b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 1364b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1365b3dbf4a5SMacpaul Lin 1366b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 1367b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 1368b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 1369b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 1370b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 1371b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 1372b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 1373b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1374b3dbf4a5SMacpaul Lin 1375c2fff331SMike Rapoport CONFIG_SMC911X 1376557b377dSJens Gehrlein Support for SMSC's LAN911x and LAN921x chips 1377557b377dSJens Gehrlein 1378c2fff331SMike Rapoport CONFIG_SMC911X_BASE 1379557b377dSJens Gehrlein Define this to hold the physical address 1380557b377dSJens Gehrlein of the device (I/O space) 1381557b377dSJens Gehrlein 1382c2fff331SMike Rapoport CONFIG_SMC911X_32_BIT 1383557b377dSJens Gehrlein Define this if data bus is 32 bits 1384557b377dSJens Gehrlein 1385c2fff331SMike Rapoport CONFIG_SMC911X_16_BIT 1386557b377dSJens Gehrlein Define this if data bus is 16 bits. If your processor 1387557b377dSJens Gehrlein automatically converts one 32 bit word to two 16 bit 1388c2fff331SMike Rapoport words you may also try CONFIG_SMC911X_32_BIT. 1389557b377dSJens Gehrlein 13903d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 13913d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 13923d0075faSYoshihiro Shimoda 13933d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 13943d0075faSYoshihiro Shimoda Define the number of ports to be used 13953d0075faSYoshihiro Shimoda 13963d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 13973d0075faSYoshihiro Shimoda Define the ETH PHY's address 13983d0075faSYoshihiro Shimoda 139968260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 140068260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 140168260aabSYoshihiro Shimoda 1402b2f97cf2SHeiko Schocher- PWM Support: 1403b2f97cf2SHeiko Schocher CONFIG_PWM_IMX 1404b2f97cf2SHeiko Schocher Support for PWM modul on the imx6. 1405b2f97cf2SHeiko Schocher 14065e124724SVadim Bendebury- TPM Support: 140790899cc0SChe-liang Chiou CONFIG_TPM 140890899cc0SChe-liang Chiou Support TPM devices. 140990899cc0SChe-liang Chiou 14100766ad2fSChristophe Ricard CONFIG_TPM_TIS_INFINEON 14110766ad2fSChristophe Ricard Support for Infineon i2c bus TPM devices. Only one device 14121b393db5STom Wai-Hong Tam per system is supported at this time. 14131b393db5STom Wai-Hong Tam 14141b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 14151b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 14161b393db5STom Wai-Hong Tam 14173aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24 14183aa74088SChristophe Ricard Support for STMicroelectronics TPM devices. Requires DM_TPM support. 14193aa74088SChristophe Ricard 14203aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24_I2C 14213aa74088SChristophe Ricard Support for STMicroelectronics ST33ZP24 I2C devices. 14223aa74088SChristophe Ricard Requires TPM_ST33ZP24 and I2C. 14233aa74088SChristophe Ricard 1424b75fdc11SChristophe Ricard CONFIG_TPM_ST33ZP24_SPI 1425b75fdc11SChristophe Ricard Support for STMicroelectronics ST33ZP24 SPI devices. 1426b75fdc11SChristophe Ricard Requires TPM_ST33ZP24 and SPI. 1427b75fdc11SChristophe Ricard 1428c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1429c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1430c01939c7SDirk Eibach 143190899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 14325e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 14335e124724SVadim Bendebury per system is supported at this time. 14345e124724SVadim Bendebury 14355e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 14365e124724SVadim Bendebury Base address where the generic TPM device is mapped 14375e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 14385e124724SVadim Bendebury 0xfed40000. 14395e124724SVadim Bendebury 1440be6c1529SReinhard Pfau CONFIG_CMD_TPM 1441be6c1529SReinhard Pfau Add tpm monitor functions. 1442be6c1529SReinhard Pfau Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also 1443be6c1529SReinhard Pfau provides monitor access to authorized functions. 1444be6c1529SReinhard Pfau 1445be6c1529SReinhard Pfau CONFIG_TPM 1446be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1447be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1448be6c1529SReinhard Pfau Requires support for a TPM device. 1449be6c1529SReinhard Pfau 1450be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1451be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1452be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1453be6c1529SReinhard Pfau 1454c609719bSwdenk- USB Support: 1455c609719bSwdenk At the moment only the UHCI host controller is 14564d13cbadSwdenk supported (PIP405, MIP405, MPC5200); define 1457c609719bSwdenk CONFIG_USB_UHCI to enable it. 1458c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 145930d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1460c609719bSwdenk storage devices. 1461c609719bSwdenk Note: 1462c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1463c609719bSwdenk (TEAC FD-05PUB). 14644d13cbadSwdenk MPC5200 USB requires additional defines: 14654d13cbadSwdenk CONFIG_USB_CLOCK 14664d13cbadSwdenk for 528 MHz Clock: 0x0001bbbb 1467307ecb6dSEric Millbrandt CONFIG_PSC3_USB 1468307ecb6dSEric Millbrandt for USB on PSC3 14694d13cbadSwdenk CONFIG_USB_CONFIG 14704d13cbadSwdenk for differential drivers: 0x00001000 14714d13cbadSwdenk for single ended drivers: 0x00005000 1472307ecb6dSEric Millbrandt for differential drivers on PSC3: 0x00000100 1473307ecb6dSEric Millbrandt for single ended drivers on PSC3: 0x00004100 14746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EVENT_POLL 1475fdcfaa1bSZhang Wei May be defined to allow interrupt polling 1476fdcfaa1bSZhang Wei instead of using asynchronous interrupts 14774d13cbadSwdenk 14789ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 14799ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 14809ab4ce22SSimon Glass 14816e9e0626SOleksandr Tymoshenko CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 14826e9e0626SOleksandr Tymoshenko HW module registers. 14836e9e0626SOleksandr Tymoshenko 148416c8d5e7SWolfgang Denk- USB Device: 148516c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 148616c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 148716c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 148811ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 148916c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 149016c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 149116c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 149216c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 149316c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 149416c8d5e7SWolfgang Denk a Linux host by 149516c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 149616c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 149716c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 149816c8d5e7SWolfgang Denk might be defined in YourBoardName.h 149916c8d5e7SWolfgang Denk 150016c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 150116c8d5e7SWolfgang Denk Define this to build a UDC device 150216c8d5e7SWolfgang Denk 150316c8d5e7SWolfgang Denk CONFIG_USB_TTY 150416c8d5e7SWolfgang Denk Define this to have a tty type of device available to 150516c8d5e7SWolfgang Denk talk to the UDC device 150616c8d5e7SWolfgang Denk 1507f9da0f89SVipin KUMAR CONFIG_USBD_HS 1508f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1509f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1510f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1511f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1512f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1513f9da0f89SVipin KUMAR speed. 1514f9da0f89SVipin KUMAR 15156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 151616c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 151716c8d5e7SWolfgang Denk be set to usbtty. 151816c8d5e7SWolfgang Denk 151916c8d5e7SWolfgang Denk mpc8xx: 15206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_EXTC_CLK 0xBLAH 152116c8d5e7SWolfgang Denk Derive USB clock from external clock "blah" 15226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_EXTC_CLK 0x02 152316c8d5e7SWolfgang Denk 15246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_USB_BRG_CLK 0xBLAH 152516c8d5e7SWolfgang Denk Derive USB clock from brgclk 15266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_USB_BRG_CLK 0x04 152716c8d5e7SWolfgang Denk 152816c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 152916c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 153016c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 153116c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 153216c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 153316c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 153416c8d5e7SWolfgang Denk 153516c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 153616c8d5e7SWolfgang Denk Define this string as the name of your company for 153716c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 153816c8d5e7SWolfgang Denk 153916c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 154016c8d5e7SWolfgang Denk Define this string as the name of your product 154116c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 154216c8d5e7SWolfgang Denk 154316c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 154416c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 154516c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 154616c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 154716c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 154816c8d5e7SWolfgang Denk 154916c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 155016c8d5e7SWolfgang Denk Define this as the unique Product ID 155116c8d5e7SWolfgang Denk for your device 155216c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1553c609719bSwdenk 1554d70a560fSIgor Grinberg- ULPI Layer Support: 1555d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1556d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1557d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1558d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1559d70a560fSIgor Grinberg viewport is supported. 1560d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1561d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 15626d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 15636d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 15646d365ea0SLucas Stach the appropriate value in Hz. 1565c609719bSwdenk 1566c609719bSwdenk- MMC Support: 1567c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1568c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1569c609719bSwdenk accessed from the boot prompt by mapping the device 1570c609719bSwdenk to physical memory similar to flash. Command line is 1571602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1572602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1573c609719bSwdenk 1574afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1575afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1576afb35666SYoshihiro Shimoda 1577afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1578afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1579afb35666SYoshihiro Shimoda 1580afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1581afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1582afb35666SYoshihiro Shimoda 15831fd93c6eSPierre Aubert CONFIG_GENERIC_MMC 15841fd93c6eSPierre Aubert Enable the generic MMC driver 15851fd93c6eSPierre Aubert 15861fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_BOOT 15871fd93c6eSPierre Aubert Enable some additional features of the eMMC boot partitions. 15881fd93c6eSPierre Aubert 15891fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_RPMB 15901fd93c6eSPierre Aubert Enable the commands for reading, writing and programming the 15911fd93c6eSPierre Aubert key for the Replay Protection Memory Block partition in eMMC. 15921fd93c6eSPierre Aubert 1593b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 159401acd6abSPaul Kocialkowski CONFIG_USB_FUNCTION_DFU 1595b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1596b3ba6e94STom Rini 1597b3ba6e94STom Rini CONFIG_CMD_DFU 1598b3ba6e94STom Rini This enables the command "dfu" which is used to have 1599b3ba6e94STom Rini U-Boot create a DFU class device via USB. This command 1600b3ba6e94STom Rini requires that the "dfu_alt_info" environment variable be 1601b3ba6e94STom Rini set and define the alt settings to expose to the host. 1602b3ba6e94STom Rini 1603b3ba6e94STom Rini CONFIG_DFU_MMC 1604b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1605b3ba6e94STom Rini 1606c6631764SPantelis Antoniou CONFIG_DFU_NAND 1607c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1608c6631764SPantelis Antoniou 1609a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1610a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1611a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1612a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1613a9479f04SAfzal Mohammed one that would help mostly the developer. 1614a9479f04SAfzal Mohammed 1615e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1616e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1617e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1618e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1619e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1620e7e75c70SHeiko Schocher 1621ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1622ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1623ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1624ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1625ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1626ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1627ea2453d5SPantelis Antoniou 1628001a8319SHeiko Schocher DFU_DEFAULT_POLL_TIMEOUT 1629001a8319SHeiko Schocher Poll timeout [ms], is the timeout a device can send to the 1630001a8319SHeiko Schocher host. The host must wait for this timeout before sending 1631001a8319SHeiko Schocher a subsequent DFU_GET_STATUS request to the device. 1632001a8319SHeiko Schocher 1633001a8319SHeiko Schocher DFU_MANIFEST_POLL_TIMEOUT 1634001a8319SHeiko Schocher Poll timeout [ms], which the device sends to the host when 1635001a8319SHeiko Schocher entering dfuMANIFEST state. Host waits this timeout, before 1636001a8319SHeiko Schocher sending again an USB request to the device. 1637001a8319SHeiko Schocher 16383aab70afSSebastian Siewior- USB Device Android Fastboot support: 163917da3c0cSPaul Kocialkowski CONFIG_USB_FUNCTION_FASTBOOT 164017da3c0cSPaul Kocialkowski This enables the USB part of the fastboot gadget 164117da3c0cSPaul Kocialkowski 16423aab70afSSebastian Siewior CONFIG_CMD_FASTBOOT 16433aab70afSSebastian Siewior This enables the command "fastboot" which enables the Android 16443aab70afSSebastian Siewior fastboot mode for the platform's USB device. Fastboot is a USB 16453aab70afSSebastian Siewior protocol for downloading images, flashing and device control 16463aab70afSSebastian Siewior used on Android devices. 16473aab70afSSebastian Siewior See doc/README.android-fastboot for more information. 16483aab70afSSebastian Siewior 16493aab70afSSebastian Siewior CONFIG_ANDROID_BOOT_IMAGE 16503aab70afSSebastian Siewior This enables support for booting images which use the Android 16513aab70afSSebastian Siewior image format header. 16523aab70afSSebastian Siewior 1653a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_ADDR 16543aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 16553aab70afSSebastian Siewior downloads. Define this to the starting RAM address to use for 16563aab70afSSebastian Siewior downloaded images. 16573aab70afSSebastian Siewior 1658a588d99aSPaul Kocialkowski CONFIG_FASTBOOT_BUF_SIZE 16593aab70afSSebastian Siewior The fastboot protocol requires a large memory buffer for 16603aab70afSSebastian Siewior downloads. This buffer should be as large as possible for a 16613aab70afSSebastian Siewior platform. Define this to the size available RAM for fastboot. 16623aab70afSSebastian Siewior 1663d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH 1664d1b5ed07SSteve Rae The fastboot protocol includes a "flash" command for writing 1665d1b5ed07SSteve Rae the downloaded image to a non-volatile storage device. Define 1666d1b5ed07SSteve Rae this to enable the "fastboot flash" command. 1667d1b5ed07SSteve Rae 1668d1b5ed07SSteve Rae CONFIG_FASTBOOT_FLASH_MMC_DEV 1669d1b5ed07SSteve Rae The fastboot "flash" command requires additional information 1670d1b5ed07SSteve Rae regarding the non-volatile storage device. Define this to 1671d1b5ed07SSteve Rae the eMMC device that fastboot should use to store the image. 1672d1b5ed07SSteve Rae 16730ff7e585SSteve Rae CONFIG_FASTBOOT_GPT_NAME 16740ff7e585SSteve Rae The fastboot "flash" command supports writing the downloaded 16750ff7e585SSteve Rae image to the Protective MBR and the Primary GUID Partition 16760ff7e585SSteve Rae Table. (Additionally, this downloaded image is post-processed 16770ff7e585SSteve Rae to generate and write the Backup GUID Partition Table.) 16780ff7e585SSteve Rae This occurs when the specified "partition name" on the 16790ff7e585SSteve Rae "fastboot flash" command line matches this value. 16800ff7e585SSteve Rae Default is GPT_ENTRY_NAME (currently "gpt") if undefined. 16810ff7e585SSteve Rae 16826705d81eSwdenk- Journaling Flash filesystem support: 16836705d81eSwdenk CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 16846705d81eSwdenk CONFIG_JFFS2_NAND_DEV 16856705d81eSwdenk Define these for a default partition on a NAND device 16866705d81eSwdenk 16876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 16886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 16896705d81eSwdenk Define these for a default partition on a NOR device 16906705d81eSwdenk 16916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS_CUSTOM_PART 16926705d81eSwdenk Define this to create an own partition. You have to provide a 16936705d81eSwdenk function struct part_info* jffs2_part_info(int part_num) 16946705d81eSwdenk 16956705d81eSwdenk If you define only one JFFS2 partition you may also want to 16966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_JFFS_SINGLE_PART 1 16976705d81eSwdenk to disable the command chpart. This is the default when you 16986705d81eSwdenk have not defined a custom partition 16996705d81eSwdenk 1700c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support: 1701c30a15e5SDonggeun Kim CONFIG_FAT_WRITE 1702656f4c65SDonggeun Kim 1703656f4c65SDonggeun Kim Define this to enable support for saving memory data as a 1704656f4c65SDonggeun Kim file in FAT formatted partition. 1705656f4c65SDonggeun Kim 1706656f4c65SDonggeun Kim This will also enable the command "fatwrite" enabling the 1707656f4c65SDonggeun Kim user to write files to FAT. 1708c30a15e5SDonggeun Kim 170984cd9327SGabe BlackCBFS (Coreboot Filesystem) support 171084cd9327SGabe Black CONFIG_CMD_CBFS 171184cd9327SGabe Black 171284cd9327SGabe Black Define this to enable support for reading from a Coreboot 171384cd9327SGabe Black filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 171484cd9327SGabe Black and cbfsload. 171584cd9327SGabe Black 17164f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size: 17174f0d1a2aSSiva Durga Prasad Paladugu CONFIG_FS_FAT_MAX_CLUSTSIZE 17184f0d1a2aSSiva Durga Prasad Paladugu 17194f0d1a2aSSiva Durga Prasad Paladugu Define the max cluster size for fat operations else 17204f0d1a2aSSiva Durga Prasad Paladugu a default value of 65536 will be defined. 17214f0d1a2aSSiva Durga Prasad Paladugu 1722c609719bSwdenk- Keyboard Support: 172339f615edSSimon Glass See Kconfig help for available keyboard drivers. 172439f615edSSimon Glass 172539f615edSSimon Glass CONFIG_KEYBOARD 172639f615edSSimon Glass 172739f615edSSimon Glass Define this to enable a custom keyboard support. 172839f615edSSimon Glass This simply calls drv_keyboard_init() which must be 172939f615edSSimon Glass defined in your board-specific files. This option is deprecated 173039f615edSSimon Glass and is only used by novena. For new boards, use driver model 173139f615edSSimon Glass instead. 1732c609719bSwdenk 1733c609719bSwdenk- Video support: 1734c609719bSwdenk CONFIG_VIDEO 1735c609719bSwdenk 1736c609719bSwdenk Define this to enable video support (for output to 1737c609719bSwdenk video). 1738c609719bSwdenk 1739c609719bSwdenk CONFIG_VIDEO_CT69000 1740c609719bSwdenk 1741c609719bSwdenk Enable Chips & Technologies 69000 Video chip 1742c609719bSwdenk 1743c609719bSwdenk CONFIG_VIDEO_SMI_LYNXEM 1744eeb1b77bSwdenk Enable Silicon Motion SMI 712/710/810 Video chip. The 1745eeb1b77bSwdenk video output is selected via environment 'videoout' 1746eeb1b77bSwdenk (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1747eeb1b77bSwdenk assumed. 1748c609719bSwdenk 1749eeb1b77bSwdenk For the CT69000 and SMI_LYNXEM drivers, videomode is 175011ccc33fSMarcel Ziswiler selected via environment 'videomode'. Two different ways 1751eeb1b77bSwdenk are possible: 1752eeb1b77bSwdenk - "videomode=num" 'num' is a standard LiLo mode numbers. 1753eeb1b77bSwdenk Following standard modes are supported (* is default): 1754eeb1b77bSwdenk 1755eeb1b77bSwdenk Colors 640x480 800x600 1024x768 1152x864 1280x1024 1756eeb1b77bSwdenk -------------+--------------------------------------------- 1757eeb1b77bSwdenk 8 bits | 0x301* 0x303 0x305 0x161 0x307 1758eeb1b77bSwdenk 15 bits | 0x310 0x313 0x316 0x162 0x319 1759eeb1b77bSwdenk 16 bits | 0x311 0x314 0x317 0x163 0x31A 1760eeb1b77bSwdenk 24 bits | 0x312 0x315 0x318 ? 0x31B 1761eeb1b77bSwdenk -------------+--------------------------------------------- 1762c609719bSwdenk (i.e. setenv videomode 317; saveenv; reset;) 1763c609719bSwdenk 1764eeb1b77bSwdenk - "videomode=bootargs" all the video parameters are parsed 17657817cb20SMarcel Ziswiler from the bootargs. (See drivers/video/videomodes.c) 1766eeb1b77bSwdenk 1767eeb1b77bSwdenk 1768a6c7ad2fSwdenk CONFIG_VIDEO_SED13806 1769a6c7ad2fSwdenk Enable Epson SED13806 driver. This driver supports 8bpp 1770a6c7ad2fSwdenk and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1771a6c7ad2fSwdenk or CONFIG_VIDEO_SED13806_16BPP 1772a6c7ad2fSwdenk 17737d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 17747d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 17757d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 17767d3053fbSTimur Tabi support, and should also define these other macros: 17777d3053fbSTimur Tabi 17787d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 17797d3053fbSTimur Tabi CONFIG_VIDEO 17807d3053fbSTimur Tabi CONFIG_CMD_BMP 17817d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 17827d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 17837d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 17847d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 17857d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 17867d3053fbSTimur Tabi 1787ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1788ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 17898eca9439SFabio Estevam boot. See the documentation file doc/README.video for a 1790ba8e76bdSTimur Tabi description of this variable. 17917d3053fbSTimur Tabi 1792c609719bSwdenk- LCD Support: CONFIG_LCD 1793c609719bSwdenk 1794c609719bSwdenk Define this to enable LCD support (for output to LCD 1795c609719bSwdenk display); also select one of the supported displays 1796c609719bSwdenk by defining one of these: 1797c609719bSwdenk 179839cf4804SStelian Pop CONFIG_ATMEL_LCD: 179939cf4804SStelian Pop 180039cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 180139cf4804SStelian Pop 1802fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1803c609719bSwdenk 1804fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1805c609719bSwdenk 1806fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1807c609719bSwdenk 1808fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1809fd3103bbSwdenk Active, color, single scan. 1810fd3103bbSwdenk 1811fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1812fd3103bbSwdenk 1813fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1814c609719bSwdenk Active, color, single scan. 1815c609719bSwdenk 1816c609719bSwdenk CONFIG_SHARP_16x9 1817c609719bSwdenk 1818c609719bSwdenk Sharp 320x240. Active, color, single scan. 1819c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1820c609719bSwdenk 1821c609719bSwdenk CONFIG_SHARP_LQ64D341 1822c609719bSwdenk 1823c609719bSwdenk Sharp LQ64D341 display, 640x480. 1824c609719bSwdenk Active, color, single scan. 1825c609719bSwdenk 1826c609719bSwdenk CONFIG_HLD1045 1827c609719bSwdenk 1828c609719bSwdenk HLD1045 display, 640x480. 1829c609719bSwdenk Active, color, single scan. 1830c609719bSwdenk 1831c609719bSwdenk CONFIG_OPTREX_BW 1832c609719bSwdenk 1833c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1834c609719bSwdenk or 1835c609719bSwdenk Hitachi LMG6912RPFC-00T 1836c609719bSwdenk or 1837c609719bSwdenk Hitachi SP14Q002 1838c609719bSwdenk 1839c609719bSwdenk 320x240. Black & white. 1840c609719bSwdenk 1841c609719bSwdenk Normally display is black on white background; define 18426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1843c609719bSwdenk 1844676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1845676d319eSSimon Glass 1846b445bbb4SJeremiah Mahler Normally the LCD is page-aligned (typically 4KB). If this is 1847676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1848676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1849676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1850676d319eSSimon Glass a per-section basis. 1851676d319eSSimon Glass 18520d89efefSSimon Glass CONFIG_CONSOLE_SCROLL_LINES 18530d89efefSSimon Glass 18540d89efefSSimon Glass When the console need to be scrolled, this is the number of 18550d89efefSSimon Glass lines to scroll by. It defaults to 1. Increasing this makes 18560d89efefSSimon Glass the console jump but can help speed up operation when scrolling 18570d89efefSSimon Glass is slow. 1858676d319eSSimon Glass 1859604c7d4aSHannes Petermaier CONFIG_LCD_ROTATION 1860604c7d4aSHannes Petermaier 1861604c7d4aSHannes Petermaier Sometimes, for example if the display is mounted in portrait 1862604c7d4aSHannes Petermaier mode or even if it's mounted landscape but rotated by 180degree, 1863604c7d4aSHannes Petermaier we need to rotate our content of the display relative to the 1864604c7d4aSHannes Petermaier framebuffer, so that user can read the messages which are 1865604c7d4aSHannes Petermaier printed out. 1866604c7d4aSHannes Petermaier Once CONFIG_LCD_ROTATION is defined, the lcd_console will be 1867604c7d4aSHannes Petermaier initialized with a given rotation from "vl_rot" out of 1868604c7d4aSHannes Petermaier "vidinfo_t" which is provided by the board specific code. 1869604c7d4aSHannes Petermaier The value for vl_rot is coded as following (matching to 1870604c7d4aSHannes Petermaier fbcon=rotate:<n> linux-kernel commandline): 1871604c7d4aSHannes Petermaier 0 = no rotation respectively 0 degree 1872604c7d4aSHannes Petermaier 1 = 90 degree rotation 1873604c7d4aSHannes Petermaier 2 = 180 degree rotation 1874604c7d4aSHannes Petermaier 3 = 270 degree rotation 1875604c7d4aSHannes Petermaier 1876604c7d4aSHannes Petermaier If CONFIG_LCD_ROTATION is not defined, the console will be 1877604c7d4aSHannes Petermaier initialized with 0degree rotation. 1878604c7d4aSHannes Petermaier 187945d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 188045d7f525STom Wai-Hong Tam 188145d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 188245d7f525STom Wai-Hong Tam 1883735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1884735987c5STom Wai-Hong Tam 1885735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1886735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1887735987c5STom Wai-Hong Tam 18887152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1889d791b1dcSwdenk 1890d791b1dcSwdenk If this option is set, the environment is checked for 1891d791b1dcSwdenk a variable "splashimage". If found, the usual display 1892d791b1dcSwdenk of logo, copyright and system information on the LCD 1893e94d2cd9Swdenk is suppressed and the BMP image at the address 1894d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1895d791b1dcSwdenk console is redirected to the "nulldev", too. This 1896d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1897d791b1dcSwdenk loaded very quickly after power-on. 1898d791b1dcSwdenk 1899c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1900c0880485SNikita Kiryanov 1901c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1902c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1903ab5645f1SFabio Estevam (see doc/README.displaying-bmps). 1904c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1905c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1906c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1907c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1908c0880485SNikita Kiryanov there is no need to set this option. 1909c0880485SNikita Kiryanov 19101ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 19111ca298ceSMatthias Weisser 19121ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 19131ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 19141ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 19151ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 19161ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 19171ca298ceSMatthias Weisser specify 'm' for centering the image. 19181ca298ceSMatthias Weisser 19191ca298ceSMatthias Weisser Example: 19201ca298ceSMatthias Weisser setenv splashpos m,m 19211ca298ceSMatthias Weisser => image at center of screen 19221ca298ceSMatthias Weisser 19231ca298ceSMatthias Weisser setenv splashpos 30,20 19241ca298ceSMatthias Weisser => image at x = 30 and y = 20 19251ca298ceSMatthias Weisser 19261ca298ceSMatthias Weisser setenv splashpos -10,m 19271ca298ceSMatthias Weisser => vertically centered image 19281ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 19291ca298ceSMatthias Weisser 193098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 193198f4a3dfSStefan Roese 193298f4a3dfSStefan Roese If this option is set, additionally to standard BMP 193398f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 193498f4a3dfSStefan Roese splashscreen support or the bmp command. 193598f4a3dfSStefan Roese 1936d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1937d5011762SAnatolij Gustschin 1938d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1939d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1940d5011762SAnatolij Gustschin bmp command. 1941d5011762SAnatolij Gustschin 1942b445bbb4SJeremiah Mahler- Do compressing for memory range: 1943f2b96dfbSLei Wen CONFIG_CMD_ZIP 1944f2b96dfbSLei Wen 1945f2b96dfbSLei Wen If this option is set, it would use zlib deflate method 1946f2b96dfbSLei Wen to compress the specified memory at its best effort. 1947f2b96dfbSLei Wen 1948c29fdfc1Swdenk- Compression support: 19498ef70478SKees Cook CONFIG_GZIP 19508ef70478SKees Cook 19518ef70478SKees Cook Enabled by default to support gzip compressed images. 19528ef70478SKees Cook 1953c29fdfc1Swdenk CONFIG_BZIP2 1954c29fdfc1Swdenk 1955c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1956c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1957c29fdfc1Swdenk compressed images are supported. 1958c29fdfc1Swdenk 1959c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 19606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1961c29fdfc1Swdenk be at least 4MB. 1962d791b1dcSwdenk 1963fc9c1727SLuigi 'Comio' Mantellini CONFIG_LZMA 1964fc9c1727SLuigi 'Comio' Mantellini 1965fc9c1727SLuigi 'Comio' Mantellini If this option is set, support for lzma compressed 1966fc9c1727SLuigi 'Comio' Mantellini images is included. 1967fc9c1727SLuigi 'Comio' Mantellini 1968fc9c1727SLuigi 'Comio' Mantellini Note: The LZMA algorithm adds between 2 and 4KB of code and it 1969fc9c1727SLuigi 'Comio' Mantellini requires an amount of dynamic memory that is given by the 1970fc9c1727SLuigi 'Comio' Mantellini formula: 1971fc9c1727SLuigi 'Comio' Mantellini 1972fc9c1727SLuigi 'Comio' Mantellini (1846 + 768 << (lc + lp)) * sizeof(uint16) 1973fc9c1727SLuigi 'Comio' Mantellini 1974fc9c1727SLuigi 'Comio' Mantellini Where lc and lp stand for, respectively, Literal context bits 1975fc9c1727SLuigi 'Comio' Mantellini and Literal pos bits. 1976fc9c1727SLuigi 'Comio' Mantellini 1977fc9c1727SLuigi 'Comio' Mantellini This value is upper-bounded by 14MB in the worst case. Anyway, 1978fc9c1727SLuigi 'Comio' Mantellini for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1979fc9c1727SLuigi 'Comio' Mantellini total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1980fc9c1727SLuigi 'Comio' Mantellini a very small buffer. 1981fc9c1727SLuigi 'Comio' Mantellini 1982fc9c1727SLuigi 'Comio' Mantellini Use the lzmainfo tool to determinate the lc and lp values and 1983fc9c1727SLuigi 'Comio' Mantellini then calculate the amount of needed dynamic memory (ensuring 19846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the appropriate CONFIG_SYS_MALLOC_LEN value). 1985fc9c1727SLuigi 'Comio' Mantellini 19868ef70478SKees Cook CONFIG_LZO 19878ef70478SKees Cook 19888ef70478SKees Cook If this option is set, support for LZO compressed images 19898ef70478SKees Cook is included. 19908ef70478SKees Cook 199117ea1177Swdenk- MII/PHY support: 199217ea1177Swdenk CONFIG_PHY_ADDR 199317ea1177Swdenk 199417ea1177Swdenk The address of PHY on MII bus. 199517ea1177Swdenk 199617ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 199717ea1177Swdenk 199817ea1177Swdenk The clock frequency of the MII bus 199917ea1177Swdenk 200017ea1177Swdenk CONFIG_PHY_GIGE 200117ea1177Swdenk 200217ea1177Swdenk If this option is set, support for speed/duplex 200311ccc33fSMarcel Ziswiler detection of gigabit PHY is included. 200417ea1177Swdenk 200517ea1177Swdenk CONFIG_PHY_RESET_DELAY 200617ea1177Swdenk 200717ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 200817ea1177Swdenk reset before any MII register access is possible. 200917ea1177Swdenk For such PHY, set this option to the usec delay 201017ea1177Swdenk required. (minimum 300usec for LXT971A) 201117ea1177Swdenk 201217ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 201317ea1177Swdenk 201417ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 201517ea1177Swdenk command issued before MII status register can be read 201617ea1177Swdenk 2017c609719bSwdenk- IP address: 2018c609719bSwdenk CONFIG_IPADDR 2019c609719bSwdenk 2020c609719bSwdenk Define a default value for the IP address to use for 202111ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 2022c609719bSwdenk determined through e.g. bootp. 20231ebcd654SWolfgang Denk (Environment variable "ipaddr") 2024c609719bSwdenk 2025c609719bSwdenk- Server IP address: 2026c609719bSwdenk CONFIG_SERVERIP 2027c609719bSwdenk 2028c609719bSwdenk Defines a default value for the IP address of a TFTP 2029c609719bSwdenk server to contact when using the "tftboot" command. 20301ebcd654SWolfgang Denk (Environment variable "serverip") 2031c609719bSwdenk 203297cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 203397cfe861SRobin Getz 203497cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 203597cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 203697cfe861SRobin Getz 20371ebcd654SWolfgang Denk- Gateway IP address: 20381ebcd654SWolfgang Denk CONFIG_GATEWAYIP 20391ebcd654SWolfgang Denk 20401ebcd654SWolfgang Denk Defines a default value for the IP address of the 20411ebcd654SWolfgang Denk default router where packets to other networks are 20421ebcd654SWolfgang Denk sent to. 20431ebcd654SWolfgang Denk (Environment variable "gatewayip") 20441ebcd654SWolfgang Denk 20451ebcd654SWolfgang Denk- Subnet mask: 20461ebcd654SWolfgang Denk CONFIG_NETMASK 20471ebcd654SWolfgang Denk 20481ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 20491ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 20501ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 20511ebcd654SWolfgang Denk forwarded through a router. 20521ebcd654SWolfgang Denk (Environment variable "netmask") 20531ebcd654SWolfgang Denk 205453a5c424SDavid Updegraff- Multicast TFTP Mode: 205553a5c424SDavid Updegraff CONFIG_MCAST_TFTP 205653a5c424SDavid Updegraff 205753a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 205853a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 205911ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 206053a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 206153a5c424SDavid Updegraff multicast group. 206253a5c424SDavid Updegraff 2063c609719bSwdenk- BOOTP Recovery Mode: 2064c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 2065c609719bSwdenk 2066c609719bSwdenk If you have many targets in a network that try to 2067c609719bSwdenk boot using BOOTP, you may want to avoid that all 2068c609719bSwdenk systems send out BOOTP requests at precisely the same 2069c609719bSwdenk moment (which would happen for instance at recovery 2070c609719bSwdenk from a power failure, when all systems will try to 2071c609719bSwdenk boot, thus flooding the BOOTP server. Defining 2072c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 2073c609719bSwdenk inserted before sending out BOOTP requests. The 20746c33c785SWolfgang Denk following delays are inserted then: 2075c609719bSwdenk 2076c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 2077c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 2078c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 2079c609719bSwdenk 4th and following 2080c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 2081c609719bSwdenk 208292ac8accSThierry Reding CONFIG_BOOTP_ID_CACHE_SIZE 208392ac8accSThierry Reding 208492ac8accSThierry Reding BOOTP packets are uniquely identified using a 32-bit ID. The 208592ac8accSThierry Reding server will copy the ID from client requests to responses and 208692ac8accSThierry Reding U-Boot will use this to determine if it is the destination of 208792ac8accSThierry Reding an incoming response. Some servers will check that addresses 208892ac8accSThierry Reding aren't in use before handing them out (usually using an ARP 208992ac8accSThierry Reding ping) and therefore take up to a few hundred milliseconds to 209092ac8accSThierry Reding respond. Network congestion may also influence the time it 209192ac8accSThierry Reding takes for a response to make it back to the client. If that 209292ac8accSThierry Reding time is too long, U-Boot will retransmit requests. In order 209392ac8accSThierry Reding to allow earlier responses to still be accepted after these 209492ac8accSThierry Reding retransmissions, U-Boot's BOOTP client keeps a small cache of 209592ac8accSThierry Reding IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this 209692ac8accSThierry Reding cache. The default is to keep IDs for up to four outstanding 209792ac8accSThierry Reding requests. Increasing this will allow U-Boot to accept offers 209892ac8accSThierry Reding from a BOOTP client in networks with unusually high latency. 209992ac8accSThierry Reding 2100fe389a82Sstroese- DHCP Advanced Options: 21011fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 21021fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 2103fe389a82Sstroese 21041fe80d79SJon Loeliger CONFIG_BOOTP_SUBNETMASK 21051fe80d79SJon Loeliger CONFIG_BOOTP_GATEWAY 21061fe80d79SJon Loeliger CONFIG_BOOTP_HOSTNAME 21071fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 21081fe80d79SJon Loeliger CONFIG_BOOTP_BOOTPATH 21091fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 21101fe80d79SJon Loeliger CONFIG_BOOTP_DNS 21111fe80d79SJon Loeliger CONFIG_BOOTP_DNS2 21121fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 21131fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 21141fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 21151fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 21162c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 2117fe389a82Sstroese 21185d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 21195d110f0aSWilson Callan environment variable, not the BOOTP server. 2120fe389a82Sstroese 21212c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 21222c00e099SJoe Hershberger after the configured retry count, the call will fail 21232c00e099SJoe Hershberger instead of starting over. This can be used to fail over 21242c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 21252c00e099SJoe Hershberger is not available. 21262c00e099SJoe Hershberger 2127fe389a82Sstroese CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 2128fe389a82Sstroese serverip from a DHCP server, it is possible that more 2129fe389a82Sstroese than one DNS serverip is offered to the client. 2130fe389a82Sstroese If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 2131fe389a82Sstroese serverip will be stored in the additional environment 2132fe389a82Sstroese variable "dnsip2". The first DNS serverip is always 2133fe389a82Sstroese stored in the variable "dnsip", when CONFIG_BOOTP_DNS 21341fe80d79SJon Loeliger is defined. 2135fe389a82Sstroese 2136fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 2137fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 2138fe389a82Sstroese need the hostname of the DHCP requester. 21395d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 21401fe80d79SJon Loeliger of the "hostname" environment variable is passed as 21411fe80d79SJon Loeliger option 12 to the DHCP server. 2142fe389a82Sstroese 2143d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 2144d9a2f416SAras Vaichas 2145d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 2146d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 2147d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 2148d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 2149d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 2150d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 2151d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 2152d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 2153d9a2f416SAras Vaichas that one of the retries will be successful but note that 2154d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 2155d9a2f416SAras Vaichas this delay. 2156d9a2f416SAras Vaichas 2157d22c338eSJoe Hershberger - Link-local IP address negotiation: 2158d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 2159d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 2160d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 2161d22c338eSJoe Hershberger to exist in all environments that the device must operate. 2162d22c338eSJoe Hershberger 2163d22c338eSJoe Hershberger See doc/README.link-local for more information. 2164d22c338eSJoe Hershberger 2165a3d991bdSwdenk - CDP Options: 2166a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 2167a3d991bdSwdenk 2168a3d991bdSwdenk The device id used in CDP trigger frames. 2169a3d991bdSwdenk 2170a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 2171a3d991bdSwdenk 2172a3d991bdSwdenk A two character string which is prefixed to the MAC address 2173a3d991bdSwdenk of the device. 2174a3d991bdSwdenk 2175a3d991bdSwdenk CONFIG_CDP_PORT_ID 2176a3d991bdSwdenk 2177a3d991bdSwdenk A printf format string which contains the ascii name of 2178a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 217911ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 2180a3d991bdSwdenk 2181a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 2182a3d991bdSwdenk 2183a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 2184a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 2185a3d991bdSwdenk 2186a3d991bdSwdenk CONFIG_CDP_VERSION 2187a3d991bdSwdenk 2188a3d991bdSwdenk An ascii string containing the version of the software. 2189a3d991bdSwdenk 2190a3d991bdSwdenk CONFIG_CDP_PLATFORM 2191a3d991bdSwdenk 2192a3d991bdSwdenk An ascii string containing the name of the platform. 2193a3d991bdSwdenk 2194a3d991bdSwdenk CONFIG_CDP_TRIGGER 2195a3d991bdSwdenk 2196a3d991bdSwdenk A 32bit integer sent on the trigger. 2197a3d991bdSwdenk 2198a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 2199a3d991bdSwdenk 2200a3d991bdSwdenk A 16bit integer containing the power consumption of the 2201a3d991bdSwdenk device in .1 of milliwatts. 2202a3d991bdSwdenk 2203a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 2204a3d991bdSwdenk 2205a3d991bdSwdenk A byte containing the id of the VLAN. 2206a3d991bdSwdenk 2207c609719bSwdenk- Status LED: CONFIG_STATUS_LED 2208c609719bSwdenk 2209c609719bSwdenk Several configurations allow to display the current 2210c609719bSwdenk status using a LED. For instance, the LED will blink 2211c609719bSwdenk fast while running U-Boot code, stop blinking as 2212c609719bSwdenk soon as a reply to a BOOTP request was received, and 2213c609719bSwdenk start blinking slow once the Linux kernel is running 2214c609719bSwdenk (supported by a status LED driver in the Linux 2215c609719bSwdenk kernel). Defining CONFIG_STATUS_LED enables this 2216c609719bSwdenk feature in U-Boot. 2217c609719bSwdenk 22181df7bbbaSIgor Grinberg Additional options: 22191df7bbbaSIgor Grinberg 22201df7bbbaSIgor Grinberg CONFIG_GPIO_LED 22211df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 22221df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 22231df7bbbaSIgor Grinberg status LED backend implementation. Define CONFIG_GPIO_LED 22241df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 22251df7bbbaSIgor Grinberg 22269dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 22279dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 22289dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 22299dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 22309dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 22319dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 22329dfdcdfeSIgor Grinberg 2233c609719bSwdenk- CAN Support: CONFIG_CAN_DRIVER 2234c609719bSwdenk 2235c609719bSwdenk Defining CONFIG_CAN_DRIVER enables CAN driver support 2236c609719bSwdenk on those systems that support this (optional) 2237c609719bSwdenk feature, like the TQM8xxL modules. 2238c609719bSwdenk 22393f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 2240c609719bSwdenk 22413f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 22423f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 22433f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 22443f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 22453f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 22463f4978c7SHeiko Schocher interface. 22473f4978c7SHeiko Schocher 22483f4978c7SHeiko Schocher ported i2c driver to the new framework: 2249ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 2250ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 2251ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2252ea818dbbSHeiko Schocher for defining speed and slave address 2253ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 2254ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2255ea818dbbSHeiko Schocher for defining speed and slave address 2256ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 2257ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2258ea818dbbSHeiko Schocher for defining speed and slave address 2259ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2260ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2261ea818dbbSHeiko Schocher for defining speed and slave address 22623f4978c7SHeiko Schocher 226300f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 226400f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 226500f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 226600f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 226700f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 226800f792e0SHeiko Schocher bus. 226900f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 227000f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 227100f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 227200f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 227300f792e0SHeiko Schocher second bus. 227400f792e0SHeiko Schocher 22751f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 22761f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 22771f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 22781f2ba722SSimon Glass 100000 and the slave addr 0! 22791f2ba722SSimon Glass 2280880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 2281880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 2282880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2283880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2284880540deSDirk Eibach 2285fac96408Strem - drivers/i2c/i2c_mxc.c 2286fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 228703544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 228803544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 228903544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 229003544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 2291fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2292fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2293fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2294fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2295fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2296fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 229703544c66SAlbert ARIBAUD \\(3ADEV\\) - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED 229803544c66SAlbert ARIBAUD \\(3ADEV\\) - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE 2299b445bbb4SJeremiah Mahler If those defines are not set, default value is 100000 2300fac96408Strem for speed, and 0 for slave. 2301fac96408Strem 23021086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 23031086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 23041086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 23051086bfa9SNobuhiro Iwamatsu 23061086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 23071086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 23081086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 23091086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 23101086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 23111086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 23121086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 23131086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 23141086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 23151086bfa9SNobuhiro Iwamatsu 23162035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 23172035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 23182035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 23192035d77dSNobuhiro Iwamatsu 23202035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 23212035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 23222035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 23232035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 23242035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 23252035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 23262035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 23272035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 23282035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 23292035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 23302035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5 23312035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5 2332b445bbb4SJeremiah Mahler - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses 23332035d77dSNobuhiro Iwamatsu 23346789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 23356789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 23366789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 23376789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 23386789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 23396789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 23406789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 23416789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 23426789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 23436789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 23446789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 23456789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 23466789e84eSHeiko Schocher 23470bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 23480bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 23490bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 23500bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 23510bdffe71SHeiko Schocher 2352e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 2353e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 2354e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 2355e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 2356e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 2357e717fc6dSNaveen Krishna Ch 2358b46226bdSDirk Eibach - drivers/i2c/ihs_i2c.c 2359b46226bdSDirk Eibach - activate this driver with CONFIG_SYS_I2C_IHS 2360b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 2361b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 2362b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 2363b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 2364b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 2365b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 2366b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 2367b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 2368b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 2369b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 2370b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 2371b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 2372071be896SDirk Eibach - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL 2373071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 2374071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 2375071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 2376071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 2377071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 2378071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 2379071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 2380071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 2381b46226bdSDirk Eibach 23823f4978c7SHeiko Schocher additional defines: 23833f4978c7SHeiko Schocher 23843f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 2385b445bbb4SJeremiah Mahler Hold the number of i2c buses you want to use. If you 23863f4978c7SHeiko Schocher don't use/have i2c muxes on your i2c bus, this 23873f4978c7SHeiko Schocher is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 23883f4978c7SHeiko Schocher omit this define. 23893f4978c7SHeiko Schocher 23903f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 23913f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 23923f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 23933f4978c7SHeiko Schocher omit this define. 23943f4978c7SHeiko Schocher 23953f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 23963f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 23973f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 23983f4978c7SHeiko Schocher define. 23993f4978c7SHeiko Schocher 24003f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 2401b445bbb4SJeremiah Mahler hold a list of buses you want to use, only used if 24023f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 24033f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 24043f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 24053f4978c7SHeiko Schocher 24063f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 24073f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 24083f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 24093f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 24103f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 24113f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 24123f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 24133f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 24143f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 24153f4978c7SHeiko Schocher } 24163f4978c7SHeiko Schocher 24173f4978c7SHeiko Schocher which defines 24183f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 2419ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2420ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2421ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2422ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2423ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 24243f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 2425ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2426ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 24273f4978c7SHeiko Schocher 24283f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 24293f4978c7SHeiko Schocher 2430ea818dbbSHeiko Schocher- Legacy I2C Support: CONFIG_HARD_I2C 24313f4978c7SHeiko Schocher 24323f4978c7SHeiko Schocher NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 24333f4978c7SHeiko Schocher provides the following compelling advantages: 24343f4978c7SHeiko Schocher 24353f4978c7SHeiko Schocher - more than one i2c adapter is usable 24363f4978c7SHeiko Schocher - approved multibus support 24373f4978c7SHeiko Schocher - better i2c mux support 24383f4978c7SHeiko Schocher 24393f4978c7SHeiko Schocher ** Please consider updating your I2C driver now. ** 24403f4978c7SHeiko Schocher 2441ea818dbbSHeiko Schocher These enable legacy I2C serial bus commands. Defining 2442ea818dbbSHeiko Schocher CONFIG_HARD_I2C will include the appropriate I2C driver 2443ea818dbbSHeiko Schocher for the selected CPU. 2444c609719bSwdenk 2445b37c7e5eSwdenk This will allow you to use i2c commands at the u-boot 2446602ad3b3SJon Loeliger command line (as long as you set CONFIG_CMD_I2C in 2447b37c7e5eSwdenk CONFIG_COMMANDS) and communicate with i2c based realtime 2448b37c7e5eSwdenk clock chips. See common/cmd_i2c.c for a description of the 2449c609719bSwdenk command line interface. 2450c609719bSwdenk 2451bb99ad6dSBen Warren CONFIG_HARD_I2C selects a hardware I2C controller. 2452c609719bSwdenk 2453b37c7e5eSwdenk There are several other quantities that must also be 2454ea818dbbSHeiko Schocher defined when you define CONFIG_HARD_I2C. 2455c609719bSwdenk 24566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD In both cases you will need to define CONFIG_SYS_I2C_SPEED 2457b37c7e5eSwdenk to be the frequency (in Hz) at which you wish your i2c bus 24586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 245911ccc33fSMarcel Ziswiler the CPU's i2c node address). 2460c609719bSwdenk 24618d321b81SPeter Tyser Now, the u-boot i2c code for the mpc8xx 2462a47a12beSStefan Roese (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 24638d321b81SPeter Tyser and so its address should therefore be cleared to 0 (See, 24648d321b81SPeter Tyser eg, MPC823e User's Manual p.16-473). So, set 24658d321b81SPeter Tyser CONFIG_SYS_I2C_SLAVE to 0. 2466b37c7e5eSwdenk 24675da71efaSEric Millbrandt CONFIG_SYS_I2C_INIT_MPC5XXX 24685da71efaSEric Millbrandt 24695da71efaSEric Millbrandt When a board is reset during an i2c bus transfer 24705da71efaSEric Millbrandt chips might think that the current transfer is still 24715da71efaSEric Millbrandt in progress. Reset the slave devices by sending start 24725da71efaSEric Millbrandt commands until the slave device responds. 24735da71efaSEric Millbrandt 2474b37c7e5eSwdenk That's all that's required for CONFIG_HARD_I2C. 2475b37c7e5eSwdenk 2476ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2477b37c7e5eSwdenk then the following macros need to be defined (examples are 2478b37c7e5eSwdenk from include/configs/lwmon.h): 2479c609719bSwdenk 2480c609719bSwdenk I2C_INIT 2481c609719bSwdenk 2482b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 2483c609719bSwdenk controller or configure ports. 2484c609719bSwdenk 2485b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2486b37c7e5eSwdenk 2487c609719bSwdenk I2C_PORT 2488c609719bSwdenk 2489c609719bSwdenk (Only for MPC8260 CPU). The I/O port to use (the code 2490c609719bSwdenk assumes both bits are on the same port). Valid values 2491c609719bSwdenk are 0..3 for ports A..D. 2492c609719bSwdenk 2493c609719bSwdenk I2C_ACTIVE 2494c609719bSwdenk 2495c609719bSwdenk The code necessary to make the I2C data line active 2496c609719bSwdenk (driven). If the data line is open collector, this 2497c609719bSwdenk define can be null. 2498c609719bSwdenk 2499b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2500b37c7e5eSwdenk 2501c609719bSwdenk I2C_TRISTATE 2502c609719bSwdenk 2503c609719bSwdenk The code necessary to make the I2C data line tri-stated 2504c609719bSwdenk (inactive). If the data line is open collector, this 2505c609719bSwdenk define can be null. 2506c609719bSwdenk 2507b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2508b37c7e5eSwdenk 2509c609719bSwdenk I2C_READ 2510c609719bSwdenk 2511472d5460SYork Sun Code that returns true if the I2C data line is high, 2512472d5460SYork Sun false if it is low. 2513c609719bSwdenk 2514b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2515b37c7e5eSwdenk 2516c609719bSwdenk I2C_SDA(bit) 2517c609719bSwdenk 2518472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 2519472d5460SYork Sun is false, it clears it (low). 2520c609719bSwdenk 2521b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 2522b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2523b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 2524b37c7e5eSwdenk 2525c609719bSwdenk I2C_SCL(bit) 2526c609719bSwdenk 2527472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 2528472d5460SYork Sun is false, it clears it (low). 2529c609719bSwdenk 2530b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 2531b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2532b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 2533b37c7e5eSwdenk 2534c609719bSwdenk I2C_DELAY 2535c609719bSwdenk 2536c609719bSwdenk This delay is invoked four times per clock cycle so this 2537c609719bSwdenk controls the rate of data transfer. The data rate thus 2538b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 2539b37c7e5eSwdenk like: 2540b37c7e5eSwdenk 2541b37c7e5eSwdenk #define I2C_DELAY udelay(2) 2542c609719bSwdenk 2543793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2544793b5726SMike Frysinger 2545793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 2546793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 2547793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 2548793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 2549793b5726SMike Frysinger 2550793b5726SMike Frysinger You should define these to the GPIO value as given directly to 2551793b5726SMike Frysinger the generic GPIO functions. 2552793b5726SMike Frysinger 25536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 255447cd00faSwdenk 255547cd00faSwdenk When a board is reset during an i2c bus transfer 255647cd00faSwdenk chips might think that the current transfer is still 255747cd00faSwdenk in progress. On some boards it is possible to access 255847cd00faSwdenk the i2c SCLK line directly, either by using the 255947cd00faSwdenk processor pin as a GPIO or by having a second pin 256047cd00faSwdenk connected to the bus. If this option is defined a 256147cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 256247cd00faSwdenk is run early in the boot sequence. 256347cd00faSwdenk 256426a33504SRichard Retanubun CONFIG_SYS_I2C_BOARD_LATE_INIT 256526a33504SRichard Retanubun 256626a33504SRichard Retanubun An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 256726a33504SRichard Retanubun defined a custom i2c_board_late_init() routine in 256826a33504SRichard Retanubun boards/xxx/board.c is run AFTER the operations in i2c_init() 256926a33504SRichard Retanubun is completed. This callpoint can be used to unreset i2c bus 257026a33504SRichard Retanubun using CPU i2c controller register accesses for CPUs whose i2c 257126a33504SRichard Retanubun controller provide such a method. It is called at the end of 257226a33504SRichard Retanubun i2c_init() to allow i2c_init operations to setup the i2c bus 257326a33504SRichard Retanubun controller on the CPU (e.g. setting bus speed & slave address). 257426a33504SRichard Retanubun 257517ea1177Swdenk CONFIG_I2CFAST (PPC405GP|PPC405EP only) 257617ea1177Swdenk 257717ea1177Swdenk This option enables configuration of bi_iic_fast[] flags 257817ea1177Swdenk in u-boot bd_info structure based on u-boot environment 257917ea1177Swdenk variable "i2cfast". (see also i2cfast) 258017ea1177Swdenk 2581bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 2582bb99ad6dSBen Warren 2583bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 2584bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 2585bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 2586bb99ad6dSBen Warren Note that bus numbering is zero-based. 2587bb99ad6dSBen Warren 25886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 2589bb99ad6dSBen Warren 2590bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 25910f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 25920f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 25930f89c54bSPeter Tyser a 1D array of device addresses 2594bb99ad6dSBen Warren 2595bb99ad6dSBen Warren e.g. 2596bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 25976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2598bb99ad6dSBen Warren 2599bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 2600bb99ad6dSBen Warren 2601bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 26026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2603bb99ad6dSBen Warren 2604bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2605bb99ad6dSBen Warren 26066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 2607be5e6181STimur Tabi 2608be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 2609be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2610be5e6181STimur Tabi 26116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 26120dc018ecSStefan Roese 26130dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 26140dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 26150dc018ecSStefan Roese 26166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_DTT_BUS_NUM 26170dc018ecSStefan Roese 26180dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the DTT. 26190dc018ecSStefan Roese If not defined, then U-Boot assumes that DTT is on I2C bus 0. 26200dc018ecSStefan Roese 26216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_DTT_ADDR: 26229ebbb54fSVictor Gallardo 26239ebbb54fSVictor Gallardo If defined, specifies the I2C address of the DTT device. 26249ebbb54fSVictor Gallardo If not defined, then U-Boot uses predefined value for 26259ebbb54fSVictor Gallardo specified DTT device. 26269ebbb54fSVictor Gallardo 26272ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 26282ac6985aSAndrew Dyer 26292ac6985aSAndrew Dyer defining this will force the i2c_read() function in 26302ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 26312ac6985aSAndrew Dyer between writing the address pointer and reading the 26322ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 26332ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 26342ac6985aSAndrew Dyer devices can use either method, but some require one or 26352ac6985aSAndrew Dyer the other. 2636be5e6181STimur Tabi 2637c609719bSwdenk- SPI Support: CONFIG_SPI 2638c609719bSwdenk 2639c609719bSwdenk Enables SPI driver (so far only tested with 2640c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 2641c609719bSwdenk D/As on the SACSng board) 2642c609719bSwdenk 26436639562eSYoshihiro Shimoda CONFIG_SH_SPI 26446639562eSYoshihiro Shimoda 26456639562eSYoshihiro Shimoda Enables the driver for SPI controller on SuperH. Currently 26466639562eSYoshihiro Shimoda only SH7757 is supported. 26476639562eSYoshihiro Shimoda 2648c609719bSwdenk CONFIG_SOFT_SPI 2649c609719bSwdenk 2650c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 2651c609719bSwdenk using hardware support. This is a general purpose 2652c609719bSwdenk driver that only requires three general I/O port pins 2653c609719bSwdenk (two outputs, one input) to function. If this is 2654c609719bSwdenk defined, the board configuration must define several 2655c609719bSwdenk SPI configuration items (port pins to use, etc). For 2656c609719bSwdenk an example, see include/configs/sacsng.h. 2657c609719bSwdenk 265804a9e118SBen Warren CONFIG_HARD_SPI 265904a9e118SBen Warren 266004a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 266104a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 266204a9e118SBen Warren must define a list of chip-select function pointers. 266304a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 266404a9e118SBen Warren example, see include/configs/mpc8349emds.h. 266504a9e118SBen Warren 266638254f45SGuennadi Liakhovetski CONFIG_MXC_SPI 266738254f45SGuennadi Liakhovetski 266838254f45SGuennadi Liakhovetski Enables the driver for the SPI controllers on i.MX and MXC 26692e3cd1cdSFabio Estevam SoCs. Currently i.MX31/35/51 are supported. 267038254f45SGuennadi Liakhovetski 2671f659b573SHeiko Schocher CONFIG_SYS_SPI_MXC_WAIT 2672f659b573SHeiko Schocher Timeout for waiting until spi transfer completed. 2673f659b573SHeiko Schocher default: (CONFIG_SYS_HZ/100) /* 10 ms */ 2674f659b573SHeiko Schocher 26750133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 26760133502eSMatthias Fuchs 26770133502eSMatthias Fuchs Enables FPGA subsystem. 26780133502eSMatthias Fuchs 26790133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 26800133502eSMatthias Fuchs 26810133502eSMatthias Fuchs Enables support for specific chip vendors. 26820133502eSMatthias Fuchs (ALTERA, XILINX) 26830133502eSMatthias Fuchs 26840133502eSMatthias Fuchs CONFIG_FPGA_<family> 26850133502eSMatthias Fuchs 26860133502eSMatthias Fuchs Enables support for FPGA family. 26870133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 26880133502eSMatthias Fuchs 26890133502eSMatthias Fuchs CONFIG_FPGA_COUNT 2690c609719bSwdenk 2691c609719bSwdenk Specify the number of FPGA devices to support. 2692c609719bSwdenk 269364e809afSSiva Durga Prasad Paladugu CONFIG_CMD_FPGA_LOADMK 269464e809afSSiva Durga Prasad Paladugu 269564e809afSSiva Durga Prasad Paladugu Enable support for fpga loadmk command 269664e809afSSiva Durga Prasad Paladugu 269767193864SMichal Simek CONFIG_CMD_FPGA_LOADP 269867193864SMichal Simek 269967193864SMichal Simek Enable support for fpga loadp command - load partial bitstream 270067193864SMichal Simek 270167193864SMichal Simek CONFIG_CMD_FPGA_LOADBP 270267193864SMichal Simek 270367193864SMichal Simek Enable support for fpga loadbp command - load partial bitstream 270467193864SMichal Simek (Xilinx only) 270567193864SMichal Simek 27066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 2707c609719bSwdenk 2708c609719bSwdenk Enable printing of hash marks during FPGA configuration. 2709c609719bSwdenk 27106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 2711c609719bSwdenk 2712c609719bSwdenk Enable checks on FPGA configuration interface busy 2713c609719bSwdenk status by the configuration function. This option 2714c609719bSwdenk will require a board or device specific function to 2715c609719bSwdenk be written. 2716c609719bSwdenk 2717c609719bSwdenk CONFIG_FPGA_DELAY 2718c609719bSwdenk 2719c609719bSwdenk If defined, a function that provides delays in the FPGA 2720c609719bSwdenk configuration driver. 2721c609719bSwdenk 27226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2723c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2724c609719bSwdenk 27256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2726c609719bSwdenk 2727c609719bSwdenk Check for configuration errors during FPGA bitfile 2728c609719bSwdenk loading. For example, abort during Virtex II 2729c609719bSwdenk configuration if the INIT_B line goes low (which 2730c609719bSwdenk indicated a CRC error). 2731c609719bSwdenk 27326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2733c609719bSwdenk 2734b445bbb4SJeremiah Mahler Maximum time to wait for the INIT_B line to de-assert 2735b445bbb4SJeremiah Mahler after PROB_B has been de-asserted during a Virtex II 2736c609719bSwdenk FPGA configuration sequence. The default time is 500 273711ccc33fSMarcel Ziswiler ms. 2738c609719bSwdenk 27396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2740c609719bSwdenk 2741b445bbb4SJeremiah Mahler Maximum time to wait for BUSY to de-assert during 274211ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2743c609719bSwdenk 27446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2745c609719bSwdenk 2746c609719bSwdenk Time to wait after FPGA configuration. The default is 274711ccc33fSMarcel Ziswiler 200 ms. 2748c609719bSwdenk 2749c609719bSwdenk- Configuration Management: 2750b2b8a696SStefan Roese CONFIG_BUILD_TARGET 2751b2b8a696SStefan Roese 2752b2b8a696SStefan Roese Some SoCs need special image types (e.g. U-Boot binary 2753b2b8a696SStefan Roese with a special header) as build targets. By defining 2754b2b8a696SStefan Roese CONFIG_BUILD_TARGET in the SoC / board header, this 2755b2b8a696SStefan Roese special image will be automatically built upon calling 2756b2b8a696SStefan Roese make / MAKEALL. 2757b2b8a696SStefan Roese 2758c609719bSwdenk CONFIG_IDENT_STRING 2759c609719bSwdenk 2760c609719bSwdenk If defined, this string will be added to the U-Boot 2761c609719bSwdenk version information (U_BOOT_VERSION) 2762c609719bSwdenk 2763c609719bSwdenk- Vendor Parameter Protection: 2764c609719bSwdenk 2765c609719bSwdenk U-Boot considers the values of the environment 2766c609719bSwdenk variables "serial#" (Board Serial Number) and 27677152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2768c609719bSwdenk are set once by the board vendor / manufacturer, and 2769c609719bSwdenk protects these variables from casual modification by 2770c609719bSwdenk the user. Once set, these variables are read-only, 2771c609719bSwdenk and write or delete attempts are rejected. You can 277211ccc33fSMarcel Ziswiler change this behaviour: 2773c609719bSwdenk 2774c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2775c609719bSwdenk file, the write protection for vendor parameters is 277647cd00faSwdenk completely disabled. Anybody can change or delete 2777c609719bSwdenk these parameters. 2778c609719bSwdenk 277992ac5208SJoe Hershberger Alternatively, if you define _both_ an ethaddr in the 278092ac5208SJoe Hershberger default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 278111ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2782c609719bSwdenk which can be changed exactly ONCE by the user. [The 2783c609719bSwdenk serial# is unaffected by this, i. e. it remains 2784c609719bSwdenk read-only.] 2785c609719bSwdenk 27862598090bSJoe Hershberger The same can be accomplished in a more flexible way 27872598090bSJoe Hershberger for any variable by configuring the type of access 27882598090bSJoe Hershberger to allow for those variables in the ".flags" variable 27892598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 27902598090bSJoe Hershberger 2791c609719bSwdenk- Protected RAM: 2792c609719bSwdenk CONFIG_PRAM 2793c609719bSwdenk 2794c609719bSwdenk Define this variable to enable the reservation of 2795c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2796c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2797c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2798c609719bSwdenk this default value by defining an environment 2799c609719bSwdenk variable "pram" to the number of kB you want to 2800c609719bSwdenk reserve. Note that the board info structure will 2801c609719bSwdenk still show the full amount of RAM. If pRAM is 2802c609719bSwdenk reserved, a new environment variable "mem" will 2803c609719bSwdenk automatically be defined to hold the amount of 2804c609719bSwdenk remaining RAM in a form that can be passed as boot 2805c609719bSwdenk argument to Linux, for instance like that: 2806c609719bSwdenk 2807fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2808c609719bSwdenk saveenv 2809c609719bSwdenk 2810c609719bSwdenk This way you can tell Linux not to use this memory, 2811c609719bSwdenk either, which results in a memory region that will 2812c609719bSwdenk not be affected by reboots. 2813c609719bSwdenk 2814c609719bSwdenk *WARNING* If your board configuration uses automatic 2815c609719bSwdenk detection of the RAM size, you must make sure that 2816c609719bSwdenk this memory test is non-destructive. So far, the 2817c609719bSwdenk following board configurations are known to be 2818c609719bSwdenk "pRAM-clean": 2819c609719bSwdenk 28201b0757ecSWolfgang Denk IVMS8, IVML24, SPD8xx, TQM8xxL, 28211b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 2822544d97e9SWolfgang Denk FLAGADM, TQM8260 2823c609719bSwdenk 282440fef049SGabe Black- Access to physical memory region (> 4GB) 282540fef049SGabe Black Some basic support is provided for operations on memory not 282640fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 282740fef049SGabe Black support access to more than 4GB of memory on 32-bit 282840fef049SGabe Black machines using physical address extension or similar. 282940fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 283040fef049SGabe Black currently only supports clearing the memory. 283140fef049SGabe Black 2832c609719bSwdenk- Error Recovery: 2833c609719bSwdenk CONFIG_PANIC_HANG 2834c609719bSwdenk 2835c609719bSwdenk Define this variable to stop the system in case of a 2836c609719bSwdenk fatal error, so that you have to reset it manually. 2837c609719bSwdenk This is probably NOT a good idea for an embedded 283811ccc33fSMarcel Ziswiler system where you want the system to reboot 2839c609719bSwdenk automatically as fast as possible, but it may be 2840c609719bSwdenk useful during development since you can try to debug 2841c609719bSwdenk the conditions that lead to the situation. 2842c609719bSwdenk 2843c609719bSwdenk CONFIG_NET_RETRY_COUNT 2844c609719bSwdenk 2845c609719bSwdenk This variable defines the number of retries for 2846c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2847c609719bSwdenk before giving up the operation. If not defined, a 2848c609719bSwdenk default value of 5 is used. 2849c609719bSwdenk 285040cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 285140cb90eeSGuennadi Liakhovetski 285240cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 285340cb90eeSGuennadi Liakhovetski 285448a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 285548a3e999STetsuyuki Kobayashi 285648a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 285748a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 285848a3e999STetsuyuki Kobayashi try longer timeout such as 285948a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 286048a3e999STetsuyuki Kobayashi 2861c609719bSwdenk- Command Interpreter: 28628078f1a5SWolfgang Denk CONFIG_AUTO_COMPLETE 286304a85b3bSwdenk 286404a85b3bSwdenk Enable auto completion of commands using TAB. 286504a85b3bSwdenk 28666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2867c609719bSwdenk 2868c609719bSwdenk This defines the secondary prompt string, which is 2869c609719bSwdenk printed when the command interpreter needs more input 2870c609719bSwdenk to complete a command. Usually "> ". 2871c609719bSwdenk 2872c609719bSwdenk Note: 2873c609719bSwdenk 2874c609719bSwdenk In the current implementation, the local variables 2875c609719bSwdenk space and global environment variables space are 2876c609719bSwdenk separated. Local variables are those you define by 28773b57fe0aSwdenk simply typing `name=value'. To access a local 2878c609719bSwdenk variable later on, you have write `$name' or 28793b57fe0aSwdenk `${name}'; to execute the contents of a variable 28803b57fe0aSwdenk directly type `$name' at the command prompt. 2881c609719bSwdenk 2882c609719bSwdenk Global environment variables are those you use 2883c609719bSwdenk setenv/printenv to work with. To run a command stored 2884c609719bSwdenk in such a variable, you need to use the run command, 2885c609719bSwdenk and you must not use the '$' sign to access them. 2886c609719bSwdenk 2887c609719bSwdenk To store commands and special characters in a 2888c609719bSwdenk variable, please use double quotation marks 2889c609719bSwdenk surrounding the whole text of the variable, instead 2890c609719bSwdenk of the backslashes before semicolons and special 2891c609719bSwdenk symbols. 2892c609719bSwdenk 2893b445bbb4SJeremiah Mahler- Command Line Editing and History: 2894aa0c71acSWolfgang Denk CONFIG_CMDLINE_EDITING 2895aa0c71acSWolfgang Denk 289611ccc33fSMarcel Ziswiler Enable editing and History functions for interactive 2897aa0c71acSWolfgang Denk command line input operations 2898aa0c71acSWolfgang Denk 2899f3b267b3SMarek Vasut- Command Line PS1/PS2 support: 2900f3b267b3SMarek Vasut CONFIG_CMDLINE_PS_SUPPORT 2901f3b267b3SMarek Vasut 2902f3b267b3SMarek Vasut Enable support for changing the command prompt string 2903f3b267b3SMarek Vasut at run-time. Only static string is supported so far. 2904f3b267b3SMarek Vasut The string is obtained from environment variables PS1 2905f3b267b3SMarek Vasut and PS2. 2906f3b267b3SMarek Vasut 2907a8c7c708Swdenk- Default Environment: 2908c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2909c609719bSwdenk 2910c609719bSwdenk Define this to contain any number of null terminated 2911c609719bSwdenk strings (variable = value pairs) that will be part of 29127152b1d0Swdenk the default environment compiled into the boot image. 29132262cfeeSwdenk 2914c609719bSwdenk For example, place something like this in your 2915c609719bSwdenk board's config file: 2916c609719bSwdenk 2917c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2918c609719bSwdenk "myvar1=value1\0" \ 2919c609719bSwdenk "myvar2=value2\0" 2920c609719bSwdenk 2921c609719bSwdenk Warning: This method is based on knowledge about the 2922c609719bSwdenk internal format how the environment is stored by the 29232262cfeeSwdenk U-Boot code. This is NOT an official, exported 2924c609719bSwdenk interface! Although it is unlikely that this format 29257152b1d0Swdenk will change soon, there is no guarantee either. 2926c609719bSwdenk You better know what you are doing here. 2927c609719bSwdenk 2928c609719bSwdenk Note: overly (ab)use of the default environment is 2929c609719bSwdenk discouraged. Make sure to check other ways to preset 293074de7aefSWolfgang Denk the environment like the "source" command or the 2931c609719bSwdenk boot command first. 2932c609719bSwdenk 29335e724ca2SStephen Warren CONFIG_ENV_VARS_UBOOT_CONFIG 29345e724ca2SStephen Warren 29355e724ca2SStephen Warren Define this in order to add variables describing the 29365e724ca2SStephen Warren U-Boot build configuration to the default environment. 29375e724ca2SStephen Warren These will be named arch, cpu, board, vendor, and soc. 29385e724ca2SStephen Warren 29395e724ca2SStephen Warren Enabling this option will cause the following to be defined: 29405e724ca2SStephen Warren 29415e724ca2SStephen Warren - CONFIG_SYS_ARCH 29425e724ca2SStephen Warren - CONFIG_SYS_CPU 29435e724ca2SStephen Warren - CONFIG_SYS_BOARD 29445e724ca2SStephen Warren - CONFIG_SYS_VENDOR 29455e724ca2SStephen Warren - CONFIG_SYS_SOC 29465e724ca2SStephen Warren 29477e27f89fSTom Rini CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 29487e27f89fSTom Rini 29497e27f89fSTom Rini Define this in order to add variables describing certain 29507e27f89fSTom Rini run-time determined information about the hardware to the 29517e27f89fSTom Rini environment. These will be named board_name, board_rev. 29527e27f89fSTom Rini 295306fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 295406fd8538SSimon Glass 295506fd8538SSimon Glass Normally the environment is loaded when the board is 2956b445bbb4SJeremiah Mahler initialised so that it is available to U-Boot. This inhibits 295706fd8538SSimon Glass that so that the environment is not available until 295806fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 295906fd8538SSimon Glass this is instead controlled by the value of 296006fd8538SSimon Glass /config/load-environment. 296106fd8538SSimon Glass 29623b10cf12SChris Packham- Parallel Flash support: 29633b10cf12SChris Packham CONFIG_SYS_NO_FLASH 29643b10cf12SChris Packham 2965a187559eSBin Meng Traditionally U-Boot was run on systems with parallel NOR 29663b10cf12SChris Packham flash. This option is used to disable support for parallel NOR 29673b10cf12SChris Packham flash. This option should be defined if the board does not have 29683b10cf12SChris Packham parallel flash. 29693b10cf12SChris Packham 29703b10cf12SChris Packham If this option is not defined one of the generic flash drivers 29713b10cf12SChris Packham (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be 29723b10cf12SChris Packham selected or the board must provide an implementation of the 29733b10cf12SChris Packham flash API (see include/flash.h). 29743b10cf12SChris Packham 2975a8c7c708Swdenk- DataFlash Support: 29762abbe075Swdenk CONFIG_HAS_DATAFLASH 29772abbe075Swdenk 29782abbe075Swdenk Defining this option enables DataFlash features and 29792abbe075Swdenk allows to read/write in Dataflash via the standard 29802abbe075Swdenk commands cp, md... 29812abbe075Swdenk 2982f61ec45eSEric Nelson- Serial Flash support 2983f61ec45eSEric Nelson CONFIG_CMD_SF 2984f61ec45eSEric Nelson 2985f61ec45eSEric Nelson Defining this option enables SPI flash commands 2986f61ec45eSEric Nelson 'sf probe/read/write/erase/update'. 2987f61ec45eSEric Nelson 2988f61ec45eSEric Nelson Usage requires an initial 'probe' to define the serial 2989f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2990f61ec45eSEric Nelson commands. 2991f61ec45eSEric Nelson 2992f61ec45eSEric Nelson The following defaults may be provided by the platform 2993f61ec45eSEric Nelson to handle the common case when only a single serial 2994f61ec45eSEric Nelson flash is present on the system. 2995f61ec45eSEric Nelson 2996f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2997f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2998f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2999f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 3000f61ec45eSEric Nelson 300124007273SSimon Glass CONFIG_CMD_SF_TEST 300224007273SSimon Glass 300324007273SSimon Glass Define this option to include a destructive SPI flash 300424007273SSimon Glass test ('sf test'). 300524007273SSimon Glass 3006b902e07cSJagannadha Sutradharudu Teki CONFIG_SF_DUAL_FLASH Dual flash memories 3007b902e07cSJagannadha Sutradharudu Teki 3008b902e07cSJagannadha Sutradharudu Teki Define this option to use dual flash support where two flash 3009b902e07cSJagannadha Sutradharudu Teki memories can be connected with a given cs line. 3010b445bbb4SJeremiah Mahler Currently Xilinx Zynq qspi supports these type of connections. 3011b902e07cSJagannadha Sutradharudu Teki 30123f85ce27Swdenk- SystemACE Support: 30133f85ce27Swdenk CONFIG_SYSTEMACE 30143f85ce27Swdenk 30153f85ce27Swdenk Adding this option adds support for Xilinx SystemACE 30163f85ce27Swdenk chips attached via some sort of local bus. The address 301711ccc33fSMarcel Ziswiler of the chip must also be defined in the 30186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SYSTEMACE_BASE macro. For example: 30193f85ce27Swdenk 30203f85ce27Swdenk #define CONFIG_SYSTEMACE 30216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 30223f85ce27Swdenk 30233f85ce27Swdenk When SystemACE support is added, the "ace" device type 30243f85ce27Swdenk becomes available to the fat commands, i.e. fatls. 30253f85ce27Swdenk 3026ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 3027ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 3028ecb0ccd9SWolfgang Denk 302928cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 3030ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 303128cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 3032ecb0ccd9SWolfgang Denk number generator is used. 3033ecb0ccd9SWolfgang Denk 303428cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 303528cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 303628cb9375SWolfgang Denk defined, the normal port 69 is used. 303728cb9375SWolfgang Denk 303828cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 3039ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 3040ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 3041ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 3042ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 3043ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 3044ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 3045ecb0ccd9SWolfgang Denk 3046bf36c5d5SSimon Glass- Hashing support: 3047bf36c5d5SSimon Glass CONFIG_CMD_HASH 3048bf36c5d5SSimon Glass 3049bf36c5d5SSimon Glass This enables a generic 'hash' command which can produce 3050bf36c5d5SSimon Glass hashes / digests from a few algorithms (e.g. SHA1, SHA256). 3051bf36c5d5SSimon Glass 3052bf36c5d5SSimon Glass CONFIG_HASH_VERIFY 3053bf36c5d5SSimon Glass 3054bf36c5d5SSimon Glass Enable the hash verify command (hash -v). This adds to code 3055bf36c5d5SSimon Glass size a little. 3056bf36c5d5SSimon Glass 305794e3c8c4Sgaurav rana CONFIG_SHA1 - This option enables support of hashing using SHA1 305894e3c8c4Sgaurav rana algorithm. The hash is calculated in software. 305994e3c8c4Sgaurav rana CONFIG_SHA256 - This option enables support of hashing using 306094e3c8c4Sgaurav rana SHA256 algorithm. The hash is calculated in software. 306194e3c8c4Sgaurav rana CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration 306294e3c8c4Sgaurav rana for SHA1/SHA256 hashing. 306394e3c8c4Sgaurav rana This affects the 'hash' command and also the 306494e3c8c4Sgaurav rana hash_lookup_algo() function. 306594e3c8c4Sgaurav rana CONFIG_SHA_PROG_HW_ACCEL - This option enables 306694e3c8c4Sgaurav rana hardware-acceleration for SHA1/SHA256 progressive hashing. 306794e3c8c4Sgaurav rana Data can be streamed in a block at a time and the hashing 306894e3c8c4Sgaurav rana is performed in hardware. 3069bf36c5d5SSimon Glass 3070bf36c5d5SSimon Glass Note: There is also a sha1sum command, which should perhaps 3071bf36c5d5SSimon Glass be deprecated in favour of 'hash sha1'. 3072bf36c5d5SSimon Glass 3073a11f1873SRobert Winkler- Freescale i.MX specific commands: 3074a11f1873SRobert Winkler CONFIG_CMD_HDMIDETECT 3075a11f1873SRobert Winkler This enables 'hdmidet' command which returns true if an 3076a11f1873SRobert Winkler HDMI monitor is detected. This command is i.MX 6 specific. 3077a11f1873SRobert Winkler 3078a11f1873SRobert Winkler CONFIG_CMD_BMODE 3079a11f1873SRobert Winkler This enables the 'bmode' (bootmode) command for forcing 3080a11f1873SRobert Winkler a boot from specific media. 3081a11f1873SRobert Winkler 3082a11f1873SRobert Winkler This is useful for forcing the ROM's usb downloader to 3083a11f1873SRobert Winkler activate upon a watchdog reset which is nice when iterating 3084a11f1873SRobert Winkler on U-Boot. Using the reset button or running bmode normal 3085a11f1873SRobert Winkler will set it back to normal. This command currently 3086a11f1873SRobert Winkler supports i.MX53 and i.MX6. 3087a11f1873SRobert Winkler 30889e50c406SHeiko Schocher- bootcount support: 30899e50c406SHeiko Schocher CONFIG_BOOTCOUNT_LIMIT 30909e50c406SHeiko Schocher 30919e50c406SHeiko Schocher This enables the bootcounter support, see: 30929e50c406SHeiko Schocher http://www.denx.de/wiki/DULG/UBootBootCountLimit 30939e50c406SHeiko Schocher 30949e50c406SHeiko Schocher CONFIG_AT91SAM9XE 30959e50c406SHeiko Schocher enable special bootcounter support on at91sam9xe based boards. 30969e50c406SHeiko Schocher CONFIG_BLACKFIN 30979e50c406SHeiko Schocher enable special bootcounter support on blackfin based boards. 30989e50c406SHeiko Schocher CONFIG_SOC_DA8XX 30999e50c406SHeiko Schocher enable special bootcounter support on da850 based boards. 31009e50c406SHeiko Schocher CONFIG_BOOTCOUNT_RAM 31019e50c406SHeiko Schocher enable support for the bootcounter in RAM 31029e50c406SHeiko Schocher CONFIG_BOOTCOUNT_I2C 31039e50c406SHeiko Schocher enable support for the bootcounter on an i2c (like RTC) device. 31049e50c406SHeiko Schocher CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 31059e50c406SHeiko Schocher CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 31069e50c406SHeiko Schocher the bootcounter. 31079e50c406SHeiko Schocher CONFIG_BOOTCOUNT_ALEN = address len 310819c402afSSimon Glass 3109a8c7c708Swdenk- Show boot progress: 3110c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 3111c609719bSwdenk 3112c609719bSwdenk Defining this option allows to add some board- 3113c609719bSwdenk specific code (calling a user-provided function 3114c609719bSwdenk "show_boot_progress(int)") that enables you to show 3115c609719bSwdenk the system's boot progress on some display (for 3116c609719bSwdenk example, some LED's) on your board. At the moment, 3117c609719bSwdenk the following checkpoints are implemented: 3118c609719bSwdenk 311994fd1316SSimon Glass 31201372cce2SMarian BalakowiczLegacy uImage format: 31211372cce2SMarian Balakowicz 3122c609719bSwdenk Arg Where When 3123c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 3124c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 3125c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 3126c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 3127c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 3128c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 3129c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 3130c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 3131c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 31321372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 3133c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 3134c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 3135c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 3136c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 31371372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 3138c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 31391372cce2SMarian Balakowicz 31401372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 31411372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 31421372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 31431372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 31441372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 31451372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 31461372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 314711ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 31481372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 31491372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 31501372cce2SMarian Balakowicz 3151ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 3152c609719bSwdenk 3153a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 315463e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 315563e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 315663e73c9aSwdenk 3157566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 3158566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 3159566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 3160566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 3161566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 3162566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 3163566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 3164566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 3165566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 3166566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 3167566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 3168566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 3169566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 3170566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 3171566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 3172566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 3173566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 3174566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 3175566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 3176566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 3177566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 3178566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 3179566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 3180566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 3181566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 3182566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 3183566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 3184566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 3185566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 3186566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 3187566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 3188566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 3189566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 3190566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 3191566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 3192566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 3193566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 3194566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 3195566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 3196566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 3197566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 3198566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 3199566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 3200566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 3201566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 3202566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 3203566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 3204c609719bSwdenk 3205566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 3206c609719bSwdenk 3207566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 3208566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 3209566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 3210206c60cbSwdenk 3211566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 3212bc0571fcSJoe Hershberger 80 common/cmd_net.c before calling net_loop() 3213bc0571fcSJoe Hershberger -81 common/cmd_net.c some error in net_loop() occurred 3214bc0571fcSJoe Hershberger 81 common/cmd_net.c net_loop() back without error 3215566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 3216566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 321774de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 321874de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 3219566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 3220c609719bSwdenk 32211372cce2SMarian BalakowiczFIT uImage format: 32221372cce2SMarian Balakowicz 32231372cce2SMarian Balakowicz Arg Where When 32241372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 32251372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 32261372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 32271372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 32281372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 32291372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 3230f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 32311372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 32321372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 32331372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 32341372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 32351372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 323611ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 323711ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 32381372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 32391372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 32401372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 32411372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 32421372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 32431372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 32441372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 32451372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 32461372cce2SMarian Balakowicz 32471372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 32481372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 32491372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 325011ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 32511372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 32521372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 32531372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 32541372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 32551372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 32561372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 32571372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 32581372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 32591372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 32601372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 32611372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 32621372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 32631372cce2SMarian Balakowicz 326411ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 32651372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 32661372cce2SMarian Balakowicz 326711ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 32681372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 32691372cce2SMarian Balakowicz 327011ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 32711372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 32721372cce2SMarian Balakowicz 327321d29f7fSHeiko Schocher- legacy image format: 327421d29f7fSHeiko Schocher CONFIG_IMAGE_FORMAT_LEGACY 327521d29f7fSHeiko Schocher enables the legacy image format support in U-Boot. 327621d29f7fSHeiko Schocher 327721d29f7fSHeiko Schocher Default: 327821d29f7fSHeiko Schocher enabled if CONFIG_FIT_SIGNATURE is not defined. 327921d29f7fSHeiko Schocher 328021d29f7fSHeiko Schocher CONFIG_DISABLE_IMAGE_LEGACY 328121d29f7fSHeiko Schocher disable the legacy image format 328221d29f7fSHeiko Schocher 328321d29f7fSHeiko Schocher This define is introduced, as the legacy image format is 328421d29f7fSHeiko Schocher enabled per default for backward compatibility. 328521d29f7fSHeiko Schocher 3286d95f6ec7SGabe Black- FIT image support: 32879a4f479bSDirk Eibach CONFIG_FIT_DISABLE_SHA256 32889a4f479bSDirk Eibach Supporting SHA256 hashes has quite an impact on binary size. 32899a4f479bSDirk Eibach For constrained systems sha256 hash support can be disabled 32909a4f479bSDirk Eibach with this option. 32919a4f479bSDirk Eibach 329273223f0eSSimon Glass TODO(sjg@chromium.org): Adjust this option to be positive, 329373223f0eSSimon Glass and move it to Kconfig 329473223f0eSSimon Glass 32954cf2609bSWolfgang Denk- Standalone program support: 32964cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 32974cf2609bSWolfgang Denk 32986feff899SWolfgang Denk This option defines a board specific value for the 32996feff899SWolfgang Denk address where standalone program gets loaded, thus 33006feff899SWolfgang Denk overwriting the architecture dependent default 33014cf2609bSWolfgang Denk settings. 33024cf2609bSWolfgang Denk 33034cf2609bSWolfgang Denk- Frame Buffer Address: 33044cf2609bSWolfgang Denk CONFIG_FB_ADDR 33054cf2609bSWolfgang Denk 33064cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 330744a53b57SWolfgang Denk address for frame buffer. This is typically the case 330844a53b57SWolfgang Denk when using a graphics controller has separate video 330944a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 331044a53b57SWolfgang Denk the given address instead of dynamically reserving it 331144a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 331244a53b57SWolfgang Denk the memory for the frame buffer depending on the 331344a53b57SWolfgang Denk configured panel size. 33144cf2609bSWolfgang Denk 33154cf2609bSWolfgang Denk Please see board_init_f function. 33164cf2609bSWolfgang Denk 3317cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 3318cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 3319cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 3320cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 3321cccfc2abSDetlev Zundel 3322cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 3323cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 3324cccfc2abSDetlev Zundel 3325cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 3326cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 3327cccfc2abSDetlev Zundel 3328cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 3329cccfc2abSDetlev Zundel Needed for mtdparts command support. 3330cccfc2abSDetlev Zundel 3331cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 3332cccfc2abSDetlev Zundel 3333cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 3334cccfc2abSDetlev Zundel kernel. Needed for UBI support. 3335cccfc2abSDetlev Zundel 333670c219cdSJoe Hershberger- UBI support 333770c219cdSJoe Hershberger CONFIG_CMD_UBI 333870c219cdSJoe Hershberger 333970c219cdSJoe Hershberger Adds commands for interacting with MTD partitions formatted 334070c219cdSJoe Hershberger with the UBI flash translation layer 334170c219cdSJoe Hershberger 334270c219cdSJoe Hershberger Requires also defining CONFIG_RBTREE 334370c219cdSJoe Hershberger 3344147162daSJoe Hershberger CONFIG_UBI_SILENCE_MSG 3345147162daSJoe Hershberger 3346147162daSJoe Hershberger Make the verbose messages from UBI stop printing. This leaves 3347147162daSJoe Hershberger warnings and errors enabled. 3348147162daSJoe Hershberger 3349ff94bc40SHeiko Schocher 3350ff94bc40SHeiko Schocher CONFIG_MTD_UBI_WL_THRESHOLD 3351ff94bc40SHeiko Schocher This parameter defines the maximum difference between the highest 3352ff94bc40SHeiko Schocher erase counter value and the lowest erase counter value of eraseblocks 3353ff94bc40SHeiko Schocher of UBI devices. When this threshold is exceeded, UBI starts performing 3354ff94bc40SHeiko Schocher wear leveling by means of moving data from eraseblock with low erase 3355ff94bc40SHeiko Schocher counter to eraseblocks with high erase counter. 3356ff94bc40SHeiko Schocher 3357ff94bc40SHeiko Schocher The default value should be OK for SLC NAND flashes, NOR flashes and 3358ff94bc40SHeiko Schocher other flashes which have eraseblock life-cycle 100000 or more. 3359ff94bc40SHeiko Schocher However, in case of MLC NAND flashes which typically have eraseblock 3360ff94bc40SHeiko Schocher life-cycle less than 10000, the threshold should be lessened (e.g., 3361ff94bc40SHeiko Schocher to 128 or 256, although it does not have to be power of 2). 3362ff94bc40SHeiko Schocher 3363ff94bc40SHeiko Schocher default: 4096 3364ff94bc40SHeiko Schocher 3365ff94bc40SHeiko Schocher CONFIG_MTD_UBI_BEB_LIMIT 3366ff94bc40SHeiko Schocher This option specifies the maximum bad physical eraseblocks UBI 3367ff94bc40SHeiko Schocher expects on the MTD device (per 1024 eraseblocks). If the 3368ff94bc40SHeiko Schocher underlying flash does not admit of bad eraseblocks (e.g. NOR 3369ff94bc40SHeiko Schocher flash), this value is ignored. 3370ff94bc40SHeiko Schocher 3371ff94bc40SHeiko Schocher NAND datasheets often specify the minimum and maximum NVM 3372ff94bc40SHeiko Schocher (Number of Valid Blocks) for the flashes' endurance lifetime. 3373ff94bc40SHeiko Schocher The maximum expected bad eraseblocks per 1024 eraseblocks 3374ff94bc40SHeiko Schocher then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", 3375ff94bc40SHeiko Schocher which gives 20 for most NANDs (MaxNVB is basically the total 3376ff94bc40SHeiko Schocher count of eraseblocks on the chip). 3377ff94bc40SHeiko Schocher 3378ff94bc40SHeiko Schocher To put it differently, if this value is 20, UBI will try to 3379ff94bc40SHeiko Schocher reserve about 1.9% of physical eraseblocks for bad blocks 3380ff94bc40SHeiko Schocher handling. And that will be 1.9% of eraseblocks on the entire 3381ff94bc40SHeiko Schocher NAND chip, not just the MTD partition UBI attaches. This means 3382ff94bc40SHeiko Schocher that if you have, say, a NAND flash chip admits maximum 40 bad 3383ff94bc40SHeiko Schocher eraseblocks, and it is split on two MTD partitions of the same 3384ff94bc40SHeiko Schocher size, UBI will reserve 40 eraseblocks when attaching a 3385ff94bc40SHeiko Schocher partition. 3386ff94bc40SHeiko Schocher 3387ff94bc40SHeiko Schocher default: 20 3388ff94bc40SHeiko Schocher 3389ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP 3390ff94bc40SHeiko Schocher Fastmap is a mechanism which allows attaching an UBI device 3391ff94bc40SHeiko Schocher in nearly constant time. Instead of scanning the whole MTD device it 3392ff94bc40SHeiko Schocher only has to locate a checkpoint (called fastmap) on the device. 3393ff94bc40SHeiko Schocher The on-flash fastmap contains all information needed to attach 3394ff94bc40SHeiko Schocher the device. Using fastmap makes only sense on large devices where 3395ff94bc40SHeiko Schocher attaching by scanning takes long. UBI will not automatically install 3396ff94bc40SHeiko Schocher a fastmap on old images, but you can set the UBI parameter 3397ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note 3398ff94bc40SHeiko Schocher that fastmap-enabled images are still usable with UBI implementations 3399ff94bc40SHeiko Schocher without fastmap support. On typical flash devices the whole fastmap 3400ff94bc40SHeiko Schocher fits into one PEB. UBI will reserve PEBs to hold two fastmaps. 3401ff94bc40SHeiko Schocher 3402ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT 3403ff94bc40SHeiko Schocher Set this parameter to enable fastmap automatically on images 3404ff94bc40SHeiko Schocher without a fastmap. 3405ff94bc40SHeiko Schocher default: 0 3406ff94bc40SHeiko Schocher 34070195a7bbSHeiko Schocher CONFIG_MTD_UBI_FM_DEBUG 34080195a7bbSHeiko Schocher Enable UBI fastmap debug 34090195a7bbSHeiko Schocher default: 0 34100195a7bbSHeiko Schocher 341170c219cdSJoe Hershberger- UBIFS support 341270c219cdSJoe Hershberger CONFIG_CMD_UBIFS 341370c219cdSJoe Hershberger 341470c219cdSJoe Hershberger Adds commands for interacting with UBI volumes formatted as 341570c219cdSJoe Hershberger UBIFS. UBIFS is read-only in u-boot. 341670c219cdSJoe Hershberger 341770c219cdSJoe Hershberger Requires UBI support as well as CONFIG_LZO 341870c219cdSJoe Hershberger 3419147162daSJoe Hershberger CONFIG_UBIFS_SILENCE_MSG 3420147162daSJoe Hershberger 3421147162daSJoe Hershberger Make the verbose messages from UBIFS stop printing. This leaves 3422147162daSJoe Hershberger warnings and errors enabled. 3423147162daSJoe Hershberger 34246a11cf48SDaniel Schwierzeck- SPL framework 34256a11cf48SDaniel Schwierzeck CONFIG_SPL 34266a11cf48SDaniel Schwierzeck Enable building of SPL globally. 34276a11cf48SDaniel Schwierzeck 342895579793STom Rini CONFIG_SPL_LDSCRIPT 342995579793STom Rini LDSCRIPT for linking the SPL binary. 343095579793STom Rini 34316ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 34326ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 34336ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 34346ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 34358960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 34366ebc3461SAlbert ARIBAUD must not be both defined at the same time. 34376ebc3461SAlbert ARIBAUD 343895579793STom Rini CONFIG_SPL_MAX_SIZE 34396ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 34406ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 34416ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 34426ebc3461SAlbert ARIBAUD not exceed it. 344395579793STom Rini 34446a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 34456a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 34466a11cf48SDaniel Schwierzeck 344794a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 344894a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 344994a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 345094a45bb1SScott Wood 345195579793STom Rini CONFIG_SPL_BSS_START_ADDR 345295579793STom Rini Link address for the BSS within the SPL binary. 345395579793STom Rini 345495579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 34556ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 34566ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 34576ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 34588960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 34596ebc3461SAlbert ARIBAUD must not be both defined at the same time. 346095579793STom Rini 346195579793STom Rini CONFIG_SPL_STACK 346295579793STom Rini Adress of the start of the stack SPL will use 346395579793STom Rini 34648c80eb3bSAlbert ARIBAUD \(3ADEV\) CONFIG_SPL_PANIC_ON_RAW_IMAGE 34658c80eb3bSAlbert ARIBAUD \(3ADEV\) When defined, SPL will panic() if the image it has 34668c80eb3bSAlbert ARIBAUD \(3ADEV\) loaded does not have a signature. 34678c80eb3bSAlbert ARIBAUD \(3ADEV\) Defining this is useful when code which loads images 34688c80eb3bSAlbert ARIBAUD \(3ADEV\) in SPL cannot guarantee that absolutely all read errors 34698c80eb3bSAlbert ARIBAUD \(3ADEV\) will be caught. 34708c80eb3bSAlbert ARIBAUD \(3ADEV\) An example is the LPC32XX MLC NAND driver, which will 34718c80eb3bSAlbert ARIBAUD \(3ADEV\) consider that a completely unreadable NAND block is bad, 34728c80eb3bSAlbert ARIBAUD \(3ADEV\) and thus should be skipped silently. 34738c80eb3bSAlbert ARIBAUD \(3ADEV\) 3474e0727515SMarek Vasut CONFIG_SPL_ABORT_ON_RAW_IMAGE 3475e0727515SMarek Vasut When defined, SPL will proceed to another boot method 3476e0727515SMarek Vasut if the image it has loaded does not have a signature. 3477e0727515SMarek Vasut 347894a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 347994a45bb1SScott Wood Adress of the start of the stack SPL will use after 348094a45bb1SScott Wood relocation. If unspecified, this is equal to 348194a45bb1SScott Wood CONFIG_SPL_STACK. 348294a45bb1SScott Wood 348395579793STom Rini CONFIG_SYS_SPL_MALLOC_START 348495579793STom Rini Starting address of the malloc pool used in SPL. 34859ac4fc82SFabio Estevam When this option is set the full malloc is used in SPL and 34869ac4fc82SFabio Estevam it is set up by spl_init() and before that, the simple malloc() 34879ac4fc82SFabio Estevam can be used if CONFIG_SYS_MALLOC_F is defined. 348895579793STom Rini 348995579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 349095579793STom Rini The size of the malloc pool used in SPL. 34916a11cf48SDaniel Schwierzeck 349247f7bcaeSTom Rini CONFIG_SPL_FRAMEWORK 349347f7bcaeSTom Rini Enable the SPL framework under common/. This framework 349447f7bcaeSTom Rini supports MMC, NAND and YMODEM loading of U-Boot and NAND 349547f7bcaeSTom Rini NAND loading of the Linux Kernel. 349647f7bcaeSTom Rini 34979607faf2STom Rini CONFIG_SPL_OS_BOOT 34989607faf2STom Rini Enable booting directly to an OS from SPL. 34999607faf2STom Rini See also: doc/README.falcon 35009607faf2STom Rini 3501861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 3502861a86f4STom Rini For ARM, enable an optional function to print more information 3503861a86f4STom Rini about the running system. 3504861a86f4STom Rini 35054b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 35064b919725SScott Wood Arch init code should be built for a very small image 35074b919725SScott Wood 35086a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBCOMMON_SUPPORT 35096a11cf48SDaniel Schwierzeck Support for common/libcommon.o in SPL binary 35106a11cf48SDaniel Schwierzeck 35116a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBDISK_SUPPORT 35126a11cf48SDaniel Schwierzeck Support for disk/libdisk.o in SPL binary 35136a11cf48SDaniel Schwierzeck 35146a11cf48SDaniel Schwierzeck CONFIG_SPL_I2C_SUPPORT 35156a11cf48SDaniel Schwierzeck Support for drivers/i2c/libi2c.o in SPL binary 35166a11cf48SDaniel Schwierzeck 35176a11cf48SDaniel Schwierzeck CONFIG_SPL_GPIO_SUPPORT 35186a11cf48SDaniel Schwierzeck Support for drivers/gpio/libgpio.o in SPL binary 35196a11cf48SDaniel Schwierzeck 35206a11cf48SDaniel Schwierzeck CONFIG_SPL_MMC_SUPPORT 35216a11cf48SDaniel Schwierzeck Support for drivers/mmc/libmmc.o in SPL binary 35226a11cf48SDaniel Schwierzeck 352395579793STom Rini CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 352495579793STom Rini CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 3525e2ccdf89SPaul Kocialkowski Address and partition on the MMC to load U-Boot from 352695579793STom Rini when the MMC is being used in raw mode. 352795579793STom Rini 3528b97300b6SPaul Kocialkowski CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION 3529b97300b6SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3530b97300b6SPaul Kocialkowski used in raw mode 3531b97300b6SPaul Kocialkowski 35322b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 35332b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 35342b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 35352b75b0adSPeter Korsgaard 35362b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 35372b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 35382b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 35392b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 35402b75b0adSPeter Korsgaard (for falcon mode) 35412b75b0adSPeter Korsgaard 3542e2ccdf89SPaul Kocialkowski CONFIG_SYS_MMCSD_FS_BOOT_PARTITION 3543e2ccdf89SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 3544e2ccdf89SPaul Kocialkowski used in fs mode 3545e2ccdf89SPaul Kocialkowski 354695579793STom Rini CONFIG_SPL_FAT_SUPPORT 354795579793STom Rini Support for fs/fat/libfat.o in SPL binary 354895579793STom Rini 3549fae81c72SGuillaume GARDET CONFIG_SPL_EXT_SUPPORT 3550fae81c72SGuillaume GARDET Support for EXT filesystem in SPL binary 355195579793STom Rini 3552fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_PAYLOAD_NAME 3553fae81c72SGuillaume GARDET Filename to read to load U-Boot when reading from filesystem 3554fae81c72SGuillaume GARDET 3555fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_KERNEL_NAME 35567ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 3557fae81c72SGuillaume GARDET from filesystem (for Falcon mode) 35587ad2cc79SPeter Korsgaard 3559fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_ARGS_NAME 35607ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 3561fae81c72SGuillaume GARDET when reading from filesystem (for Falcon mode) 35627ad2cc79SPeter Korsgaard 356306f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 356406f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 356506f60ae3SScott Wood start.S waits for the rest of the SPL to load before 356606f60ae3SScott Wood continuing (the hardware starts execution after just 356706f60ae3SScott Wood loading the first page rather than the full 4K). 356806f60ae3SScott Wood 3569651fcf60SPrabhakar Kushwaha CONFIG_SPL_SKIP_RELOCATE 3570651fcf60SPrabhakar Kushwaha Avoid SPL relocation 3571651fcf60SPrabhakar Kushwaha 35726f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 35736f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 35746f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 35756f2f01b9SScott Wood 35766f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 35776f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 35786f2f01b9SScott Wood 35796f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 35806f2f01b9SScott Wood Include standard software ECC in the SPL 35816f2f01b9SScott Wood 358295579793STom Rini CONFIG_SPL_NAND_SIMPLE 35837d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 35847d4b7955SScott Wood expose the cmd_ctrl() interface. 358595579793STom Rini 35866dd3b566STom Rini CONFIG_SPL_MTD_SUPPORT 35876dd3b566STom Rini Support for the MTD subsystem within SPL. Useful for 35886dd3b566STom Rini environment on NAND support within SPL. 35896dd3b566STom Rini 35900c3117b1SHeiko Schocher CONFIG_SPL_NAND_RAW_ONLY 35910c3117b1SHeiko Schocher Support to boot only raw u-boot.bin images. Use this only 35920c3117b1SHeiko Schocher if you need to save space. 35930c3117b1SHeiko Schocher 3594bb0dc108SYing Zhang CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT 3595bb0dc108SYing Zhang Set for the SPL on PPC mpc8xxx targets, support for 35965614e71bSYork Sun drivers/ddr/fsl/libddr.o in SPL binary. 3597bb0dc108SYing Zhang 35987c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 35997c8eea59SYing Zhang Set for common ddr init with serial presence detect in 36007c8eea59SYing Zhang SPL binary. 36017c8eea59SYing Zhang 360295579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 360395579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 360495579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 360595579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 360695579793STom Rini CONFIG_SYS_NAND_ECCBYTES 360795579793STom Rini Defines the size and behavior of the NAND that SPL uses 36087d4b7955SScott Wood to read U-Boot 360995579793STom Rini 3610fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 3611fbe76ae4SPrabhakar Kushwaha Add support NAND boot 3612fbe76ae4SPrabhakar Kushwaha 361395579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 36147d4b7955SScott Wood Location in NAND to read U-Boot from 36157d4b7955SScott Wood 36167d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 36177d4b7955SScott Wood Location in memory to load U-Boot to 36187d4b7955SScott Wood 36197d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 36207d4b7955SScott Wood Size of image to load 362195579793STom Rini 362295579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 36237d4b7955SScott Wood Entry point in loaded image to jump to 362495579793STom Rini 362595579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 362695579793STom Rini Define this if you need to first read the OOB and then the 3627b445bbb4SJeremiah Mahler data. This is used, for example, on davinci platforms. 362895579793STom Rini 362995579793STom Rini CONFIG_SPL_OMAP3_ID_NAND 363095579793STom Rini Support for an OMAP3-specific set of functions to return the 363195579793STom Rini ID and MFR of the first attached NAND chip, if present. 363295579793STom Rini 36336a11cf48SDaniel Schwierzeck CONFIG_SPL_SERIAL_SUPPORT 36346a11cf48SDaniel Schwierzeck Support for drivers/serial/libserial.o in SPL binary 36356a11cf48SDaniel Schwierzeck 36366a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_FLASH_SUPPORT 36376a11cf48SDaniel Schwierzeck Support for drivers/mtd/spi/libspi_flash.o in SPL binary 36386a11cf48SDaniel Schwierzeck 36396a11cf48SDaniel Schwierzeck CONFIG_SPL_SPI_SUPPORT 36406a11cf48SDaniel Schwierzeck Support for drivers/spi/libspi.o in SPL binary 36416a11cf48SDaniel Schwierzeck 3642c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 3643c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 3644c57b953dSPavel Machek 36456a11cf48SDaniel Schwierzeck CONFIG_SPL_LIBGENERIC_SUPPORT 36466a11cf48SDaniel Schwierzeck Support for lib/libgeneric.o in SPL binary 36471372cce2SMarian Balakowicz 3648ba1bee43SYing Zhang CONFIG_SPL_ENV_SUPPORT 3649ba1bee43SYing Zhang Support for the environment operating in SPL binary 3650ba1bee43SYing Zhang 3651ba1bee43SYing Zhang CONFIG_SPL_NET_SUPPORT 3652ba1bee43SYing Zhang Support for the net/libnet.o in SPL binary. 3653ba1bee43SYing Zhang It conflicts with SPL env from storage medium specified by 3654ba1bee43SYing Zhang CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE 3655ba1bee43SYing Zhang 365674752baaSScott Wood CONFIG_SPL_PAD_TO 36576113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 36586113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 36596113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 36606113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 36616113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 366274752baaSScott Wood 3663ca2fca22SScott Wood CONFIG_SPL_TARGET 3664ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 3665ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 3666ca2fca22SScott Wood example if more than one image needs to be produced. 3667ca2fca22SScott Wood 366887ebee39SSimon Glass CONFIG_FIT_SPL_PRINT 366987ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 367087ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 367187ebee39SSimon Glass option to re-enable it. This will affect the output of the 367287ebee39SSimon Glass bootm command when booting a FIT image. 367387ebee39SSimon Glass 36743aa29de0SYing Zhang- TPL framework 36753aa29de0SYing Zhang CONFIG_TPL 36763aa29de0SYing Zhang Enable building of TPL globally. 36773aa29de0SYing Zhang 36783aa29de0SYing Zhang CONFIG_TPL_PAD_TO 36793aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 36803aa29de0SYing Zhang the TPL payload. By default, this is defined as 36813aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 36823aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 36833aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 36843aa29de0SYing Zhang 3685a8c7c708Swdenk- Interrupt support (PPC): 3686a8c7c708Swdenk 3687a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 3688a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 368911ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 3690a8c7c708Swdenk should set decrementer_count to appropriate value. If 369111ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 3692a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 369311ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 3694a8c7c708Swdenk specific handling. If board has watchdog / status_led 3695a8c7c708Swdenk / other_activity_monitor it works automatically from 3696a8c7c708Swdenk general timer_interrupt(). 3697a8c7c708Swdenk 3698c609719bSwdenk 36999660e442SHelmut RaigerBoard initialization settings: 37009660e442SHelmut Raiger------------------------------ 37019660e442SHelmut Raiger 37029660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 37039660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 37049660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 37059660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 37069660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 37079660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 37089660e442SHelmut Raiger 37099660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 37109660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 37119660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 37129660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3713c609719bSwdenk 3714c609719bSwdenkConfiguration Settings: 3715c609719bSwdenk----------------------- 3716c609719bSwdenk 37174d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 37184d1fd7f1SYork Sun Optionally it can be defined to support 64-bit memory commands. 37194d1fd7f1SYork Sun 37206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3721c609719bSwdenk undefine this when you're short of memory. 3722c609719bSwdenk 37232fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 37242fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 37252fb2604dSPeter Tyser 37266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3727c609719bSwdenk prompt for user input. 3728c609719bSwdenk 37296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3730c609719bSwdenk 37316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 3732c609719bSwdenk 37336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3734c609719bSwdenk 37356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3736c609719bSwdenk the application (usually a Linux kernel) when it is 3737c609719bSwdenk booted 3738c609719bSwdenk 37396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 3740c609719bSwdenk List of legal baudrate settings for this board. 3741c609719bSwdenk 37426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET 3743c609719bSwdenk Suppress display of console information at boot. 3744c609719bSwdenk 37456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV 3746c609719bSwdenk If the board specific function 3747c609719bSwdenk extern int overwrite_console (void); 3748c609719bSwdenk returns 1, the stdin, stderr and stdout are switched to the 3749c609719bSwdenk serial port, else the settings in the environment are used. 3750c609719bSwdenk 37516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3752c609719bSwdenk Enable the call to overwrite_console(). 3753c609719bSwdenk 37546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3755c609719bSwdenk Enable overwrite of previous console environment settings. 3756c609719bSwdenk 37576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3758c609719bSwdenk Begin and End addresses of the area used by the 3759c609719bSwdenk simple memory test. 3760c609719bSwdenk 37616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST: 3762c609719bSwdenk Enable an alternate, more extensive memory test. 3763c609719bSwdenk 37646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 37655f535fe1Swdenk Scratch address used by the alternate memory test 37665f535fe1Swdenk You only need to set this if address zero isn't writeable 37675f535fe1Swdenk 3768e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE 3769*e61a7534SYork Sun Only implemented for ARMv8 for now. 3770e8149522SYork Sun If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory 3771e8149522SYork Sun is substracted from total RAM and won't be reported to OS. 3772e8149522SYork Sun This memory can be used as secure memory. A variable 3773*e61a7534SYork Sun gd->arch.secure_ram is used to track the location. In systems 3774e8149522SYork Sun the RAM base is not zero, or RAM is divided into banks, 3775e8149522SYork Sun this variable needs to be recalcuated to get the address. 3776e8149522SYork Sun 3777aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE: 37786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 377914f73ca6SStefan Roese this specified memory area will get subtracted from the top 378011ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 378114f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 378214f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 378314f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 37845e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 378514f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 37865e12e75dSStefan Roese will have to get fixed in Linux additionally. 378714f73ca6SStefan Roese 378814f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 378914f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 379014f73ca6SStefan Roese be touched. 379114f73ca6SStefan Roese 379214f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 379314f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 379414f73ca6SStefan Roese then the end address of the Linux memory will be located at a 379514f73ca6SStefan Roese non page size aligned address and this could cause major 379614f73ca6SStefan Roese problems. 379714f73ca6SStefan Roese 37986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 3799c609719bSwdenk Enable temporary baudrate change while serial download 3800c609719bSwdenk 38016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 3802c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 3803c609719bSwdenk 38046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE: 3805c609719bSwdenk Physical start address of Motherboard I/O (if using a 3806c609719bSwdenk Cogent motherboard) 3807c609719bSwdenk 38086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 3809c609719bSwdenk Physical start address of Flash memory. 3810c609719bSwdenk 38116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 3812c609719bSwdenk Physical start address of boot monitor code (set by 3813c609719bSwdenk make config files to be same as the text base address 381414d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 38156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 3816c609719bSwdenk 38176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 38183b57fe0aSwdenk Size of memory reserved for monitor code, used to 38193b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 38203b57fe0aSwdenk embedded within the U-Boot image, or in a separate 38213b57fe0aSwdenk flash sector. 3822c609719bSwdenk 38236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 3824c609719bSwdenk Size of DRAM reserved for malloc() use. 3825c609719bSwdenk 3826d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN 3827d59476b6SSimon Glass Size of the malloc() pool for use before relocation. If 3828d59476b6SSimon Glass this is defined, then a very simple malloc() implementation 3829d59476b6SSimon Glass will become available before relocation. The address is just 3830d59476b6SSimon Glass below the global data, and the stack is moved down to make 3831d59476b6SSimon Glass space. 3832d59476b6SSimon Glass 3833d59476b6SSimon Glass This feature allocates regions with increasing addresses 3834d59476b6SSimon Glass within the region. calloc() is supported, but realloc() 3835d59476b6SSimon Glass is not available. free() is supported but does nothing. 3836b445bbb4SJeremiah Mahler The memory will be freed (or in fact just forgotten) when 3837d59476b6SSimon Glass U-Boot relocates itself. 3838d59476b6SSimon Glass 3839e7b14e9aSSimon Glass Pre-relocation malloc() is only supported on ARM and sandbox 384029afe9e6SSimon Glass at present but is fairly easy to enable for other archs. 384129afe9e6SSimon Glass 384238687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE 384338687ae6SSimon Glass Provides a simple and small malloc() and calloc() for those 384438687ae6SSimon Glass boards which do not use the full malloc in SPL (which is 384538687ae6SSimon Glass enabled with CONFIG_SYS_SPL_MALLOC_START). 384638687ae6SSimon Glass 38471dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY: 38481dfdd9baSThierry Reding Size of non-cached memory area. This area of memory will be 38491dfdd9baSThierry Reding typically located right below the malloc() area and mapped 38501dfdd9baSThierry Reding uncached in the MMU. This is useful for drivers that would 38511dfdd9baSThierry Reding otherwise require a lot of explicit cache maintenance. For 38521dfdd9baSThierry Reding some drivers it's also impossible to properly maintain the 38531dfdd9baSThierry Reding cache. For example if the regions that need to be flushed 38541dfdd9baSThierry Reding are not a multiple of the cache-line size, *and* padding 38551dfdd9baSThierry Reding cannot be allocated between the regions to align them (i.e. 38561dfdd9baSThierry Reding if the HW requires a contiguous array of regions, and the 38571dfdd9baSThierry Reding size of each region is not cache-aligned), then a flush of 38581dfdd9baSThierry Reding one region may result in overwriting data that hardware has 38591dfdd9baSThierry Reding written to another region in the same cache-line. This can 38601dfdd9baSThierry Reding happen for example in network drivers where descriptors for 38611dfdd9baSThierry Reding buffers are typically smaller than the CPU cache-line (e.g. 38621dfdd9baSThierry Reding 16 bytes vs. 32 or 64 bytes). 38631dfdd9baSThierry Reding 38641dfdd9baSThierry Reding Non-cached memory is only supported on 32-bit ARM at present. 38651dfdd9baSThierry Reding 38666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 386715940c9aSStefan Roese Normally compressed uImages are limited to an 386815940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 38696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 387015940c9aSStefan Roese to adjust this setting to your needs. 3871c609719bSwdenk 38726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 3873c609719bSwdenk Maximum size of memory mapped by the startup code of 3874c609719bSwdenk the Linux kernel; all data that must be processed by 38757d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 38767d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 38771bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 38787d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 3879c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3880c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 3881c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3882c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 3883c609719bSwdenk 3884fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3885fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 3886fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 3887fca43cc8SJohn Rigby is enabled. 3888fca43cc8SJohn Rigby 3889fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 3890fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 3891fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 3892fca43cc8SJohn Rigby 3893fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 3894fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 3895fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3896fca43cc8SJohn Rigby 38976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 3898c609719bSwdenk Max number of Flash memory banks 3899c609719bSwdenk 39006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 3901c609719bSwdenk Max number of sectors on a Flash chip 3902c609719bSwdenk 39036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 3904c609719bSwdenk Timeout for Flash erase operations (in ms) 3905c609719bSwdenk 39066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 3907c609719bSwdenk Timeout for Flash write operations (in ms) 3908c609719bSwdenk 39096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 39108564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 39118564acf9Swdenk 39126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 39138564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 39148564acf9Swdenk 39156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 39168564acf9Swdenk If defined, hardware flash sectors protection is used 39178564acf9Swdenk instead of U-Boot software protection. 39188564acf9Swdenk 39196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 3920c609719bSwdenk 3921c609719bSwdenk Enable TFTP transfers directly to flash memory; 3922c609719bSwdenk without this option such a download has to be 3923c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 3924c609719bSwdenk copy from RAM to flash. 3925c609719bSwdenk 3926c609719bSwdenk The two-step approach is usually more reliable, since 3927c609719bSwdenk you can check if the download worked before you erase 392811ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 392911ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 3930c609719bSwdenk downloaded image) this option may be very useful. 3931c609719bSwdenk 39326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 3933c609719bSwdenk Define if the flash driver uses extra elements in the 39345653fc33Swdenk common flash structure for storing flash geometry. 39355653fc33Swdenk 393600b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 39375653fc33Swdenk This option also enables the building of the cfi_flash driver 39385653fc33Swdenk in the drivers directory 393953cf9435Sstroese 394091809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 394191809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 394291809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 394391809ed5SPiotr Ziecik to the MTD layer. 394491809ed5SPiotr Ziecik 39456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 394696ef831fSGuennadi Liakhovetski Use buffered writes to flash. 394796ef831fSGuennadi Liakhovetski 394896ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 394996ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 395096ef831fSGuennadi Liakhovetski write commands. 395196ef831fSGuennadi Liakhovetski 39526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 39535568e613SStefan Roese If this option is defined, the common CFI flash doesn't 39545568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 39555568e613SStefan Roese is useful, if some of the configured banks are only 39565568e613SStefan Roese optionally available. 39575568e613SStefan Roese 39589a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 39599a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 39609a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 39619a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 39629a042e9cSJerry Van Baren 3963352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 3964352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 3965352ef3f1SStefan Roese against the source after the write operation. An error message 3966352ef3f1SStefan Roese will be printed when the contents are not identical. 3967352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 3968352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 3969352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 3970352ef3f1SStefan Roese this option if you really know what you are doing. 3971352ef3f1SStefan Roese 39726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 397311ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 397411ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 397553cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 397653cf9435Sstroese buffers can be full shortly after enabling the interface 397711ccc33fSMarcel Ziswiler on high Ethernet traffic. 397853cf9435Sstroese Defaults to 4 if not defined. 3979c609719bSwdenk 3980ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 3981ea882bafSWolfgang Denk 3982ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 3983ea882bafSWolfgang Denk internally to store the environment settings. The default 3984ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 3985ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 3986ea882bafSWolfgang Denk lib/hashtable.c for details. 3987ea882bafSWolfgang Denk 39882598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 39892598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 39901bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 39912598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 39922598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 39932598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 39942598090bSJoe Hershberger 39952598090bSJoe Hershberger The format of the list is: 39962598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 3997b445bbb4SJeremiah Mahler access_attribute = [a|r|o|c] 3998b445bbb4SJeremiah Mahler attributes = type_attribute[access_attribute] 39992598090bSJoe Hershberger entry = variable_name[:attributes] 40002598090bSJoe Hershberger list = entry[,list] 40012598090bSJoe Hershberger 40022598090bSJoe Hershberger The type attributes are: 40032598090bSJoe Hershberger s - String (default) 40042598090bSJoe Hershberger d - Decimal 40052598090bSJoe Hershberger x - Hexadecimal 40062598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 40072598090bSJoe Hershberger i - IP address 40082598090bSJoe Hershberger m - MAC address 40092598090bSJoe Hershberger 4010267541f7SJoe Hershberger The access attributes are: 4011267541f7SJoe Hershberger a - Any (default) 4012267541f7SJoe Hershberger r - Read-only 4013267541f7SJoe Hershberger o - Write-once 4014267541f7SJoe Hershberger c - Change-default 4015267541f7SJoe Hershberger 40162598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 40172598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 4018b445bbb4SJeremiah Mahler environment variable in the default or embedded environment. 40192598090bSJoe Hershberger 40202598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 40212598090bSJoe Hershberger Define this to a list (string) to define validation that 40222598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 40232598090bSJoe Hershberger environment variable. To override a setting in the static 40242598090bSJoe Hershberger list, simply add an entry for the same variable name to the 40252598090bSJoe Hershberger ".flags" variable. 40262598090bSJoe Hershberger 4027bdf1fe4eSJoe Hershberger If CONFIG_REGEX is defined, the variable_name above is evaluated as a 4028bdf1fe4eSJoe Hershberger regular expression. This allows multiple variables to define the same 4029bdf1fe4eSJoe Hershberger flags without explicitly listing them for each variable. 4030bdf1fe4eSJoe Hershberger 4031267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 4032267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 4033267541f7SJoe Hershberger access flags. 4034267541f7SJoe Hershberger 40350b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 40360b1b60c7SLokesh Vutla This is set by OMAP boards for the max time that reset should 40370b1b60c7SLokesh Vutla be asserted. See doc/README.omap-reset-time for details on how 4038b445bbb4SJeremiah Mahler the value can be calculated on a given board. 4039632efa74SSimon Glass 40400d296cc2SGabe Black- CONFIG_USE_STDINT 40410d296cc2SGabe Black If stdint.h is available with your toolchain you can define this 40420d296cc2SGabe Black option to enable it. You can provide option 'USE_STDINT=1' when 40430d296cc2SGabe Black building U-Boot to enable this. 40440d296cc2SGabe Black 4045c609719bSwdenkThe following definitions that deal with the placement and management 4046c609719bSwdenkof environment data (variable area); in general, we support the 4047c609719bSwdenkfollowing configurations: 4048c609719bSwdenk 4049c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 4050c3eb3fe4SMike Frysinger 4051c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 4052c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 4053c3eb3fe4SMike Frysinger 40545a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH: 4055c609719bSwdenk 4056c609719bSwdenk Define this if the environment is in flash memory. 4057c609719bSwdenk 4058c609719bSwdenk a) The environment occupies one whole flash sector, which is 4059c609719bSwdenk "embedded" in the text segment with the U-Boot code. This 4060c609719bSwdenk happens usually with "bottom boot sector" or "top boot 4061c609719bSwdenk sector" type flash chips, which have several smaller 4062c609719bSwdenk sectors at the start or the end. For instance, such a 4063c609719bSwdenk layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 4064c609719bSwdenk such a case you would place the environment in one of the 4065c609719bSwdenk 4 kB sectors - with U-Boot code before and after it. With 4066c609719bSwdenk "top boot sector" type flash chips, you would put the 4067c609719bSwdenk environment in one of the last sectors, leaving a gap 4068c609719bSwdenk between U-Boot and the environment. 4069c609719bSwdenk 40700e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 4071c609719bSwdenk 4072c609719bSwdenk Offset of environment data (variable area) to the 4073c609719bSwdenk beginning of flash memory; for instance, with bottom boot 4074c609719bSwdenk type flash chips the second sector can be used: the offset 4075c609719bSwdenk for this sector is given here. 4076c609719bSwdenk 40776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 4078c609719bSwdenk 40790e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 4080c609719bSwdenk 4081c609719bSwdenk This is just another way to specify the start address of 4082c609719bSwdenk the flash sector containing the environment (instead of 40830e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_OFFSET). 4084c609719bSwdenk 40850e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SECT_SIZE: 4086c609719bSwdenk 4087c609719bSwdenk Size of the sector containing the environment. 4088c609719bSwdenk 4089c609719bSwdenk 4090c609719bSwdenk b) Sometimes flash chips have few, equal sized, BIG sectors. 4091c609719bSwdenk In such a case you don't want to spend a whole sector for 4092c609719bSwdenk the environment. 4093c609719bSwdenk 40940e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 4095c609719bSwdenk 40965a1aceb0SJean-Christophe PLAGNIOL-VILLARD If you use this in combination with CONFIG_ENV_IS_IN_FLASH 40970e8d1586SJean-Christophe PLAGNIOL-VILLARD and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 4098c609719bSwdenk of this flash sector for the environment. This saves 4099c609719bSwdenk memory for the RAM copy of the environment. 4100c609719bSwdenk 4101c609719bSwdenk It may also save flash memory if you decide to use this 4102c609719bSwdenk when your environment is "embedded" within U-Boot code, 4103c609719bSwdenk since then the remainder of the flash sector could be used 4104c609719bSwdenk for U-Boot code. It should be pointed out that this is 4105c609719bSwdenk STRONGLY DISCOURAGED from a robustness point of view: 4106c609719bSwdenk updating the environment in flash makes it always 4107c609719bSwdenk necessary to erase the WHOLE sector. If something goes 4108c609719bSwdenk wrong before the contents has been restored from a copy in 4109c609719bSwdenk RAM, your target system will be dead. 4110c609719bSwdenk 41110e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR_REDUND 41120e8d1586SJean-Christophe PLAGNIOL-VILLARD CONFIG_ENV_SIZE_REDUND 4113c609719bSwdenk 4114c609719bSwdenk These settings describe a second storage area used to hold 411511ccc33fSMarcel Ziswiler a redundant copy of the environment data, so that there is 41163e38691eSwdenk a valid backup copy in case there is a power failure during 4117c609719bSwdenk a "saveenv" operation. 4118c609719bSwdenk 4119c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the 4120c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds* 4121c609719bSwdenkaccordingly! 4122c609719bSwdenk 4123c609719bSwdenk 41249314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM: 4125c609719bSwdenk 4126c609719bSwdenk Define this if you have some non-volatile memory device 4127c609719bSwdenk (NVRAM, battery buffered SRAM) which you want to use for the 4128c609719bSwdenk environment. 4129c609719bSwdenk 41300e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 41310e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 4132c609719bSwdenk 413311ccc33fSMarcel Ziswiler These two #defines are used to determine the memory area you 4134c609719bSwdenk want to use for environment. It is assumed that this memory 4135c609719bSwdenk can just be read and written to, without any special 4136c609719bSwdenk provision. 4137c609719bSwdenk 4138c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 4139b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the 414011ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 4141c609719bSwdenkU-Boot will hang. 4142c609719bSwdenk 4143c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 4144c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 4145c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 4146c609719bSwdenkto save the current settings. 4147c609719bSwdenk 4148c609719bSwdenk 4149bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM: 4150c609719bSwdenk 4151c609719bSwdenk Use this if you have an EEPROM or similar serial access 4152c609719bSwdenk device and a driver for it. 4153c609719bSwdenk 41540e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 41550e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 4156c609719bSwdenk 4157c609719bSwdenk These two #defines specify the offset and size of the 4158c609719bSwdenk environment area within the total memory of your EEPROM. 4159c609719bSwdenk 41606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR: 4161c609719bSwdenk If defined, specified the chip address of the EEPROM device. 4162c609719bSwdenk The default address is zero. 4163c609719bSwdenk 4164189d257bSChristian Gmeiner - CONFIG_SYS_I2C_EEPROM_BUS: 4165189d257bSChristian Gmeiner If defined, specified the i2c bus of the EEPROM device. 4166189d257bSChristian Gmeiner 41676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 4168c609719bSwdenk If defined, the number of bits used to address bytes in a 4169c609719bSwdenk single page in the EEPROM device. A 64 byte page, for example 4170c609719bSwdenk would require six bits. 4171c609719bSwdenk 41726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 4173c609719bSwdenk If defined, the number of milliseconds to delay between 4174c609719bSwdenk page writes. The default is zero milliseconds. 4175c609719bSwdenk 41766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 4177c609719bSwdenk The length in bytes of the EEPROM memory array address. Note 4178c609719bSwdenk that this is NOT the chip address length! 4179c609719bSwdenk 41806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 41815cf91d6bSwdenk EEPROM chips that implement "address overflow" are ones 41825cf91d6bSwdenk like Catalyst 24WC04/08/16 which has 9/10/11 bits of 41835cf91d6bSwdenk address and the extra bits end up in the "chip address" bit 41845cf91d6bSwdenk slots. This makes a 24WC08 (1Kbyte) chip look like four 256 41855cf91d6bSwdenk byte chips. 41865cf91d6bSwdenk 41875cf91d6bSwdenk Note that we consider the length of the address field to 41885cf91d6bSwdenk still be one byte because the extra address bits are hidden 41895cf91d6bSwdenk in the chip address. 41905cf91d6bSwdenk 41916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD - CONFIG_SYS_EEPROM_SIZE: 4192c609719bSwdenk The size in bytes of the EEPROM device. 4193c609719bSwdenk 4194548738b4SHeiko Schocher - CONFIG_ENV_EEPROM_IS_ON_I2C 4195548738b4SHeiko Schocher define this, if you have I2C and SPI activated, and your 4196548738b4SHeiko Schocher EEPROM, which holds the environment, is on the I2C bus. 4197548738b4SHeiko Schocher 4198548738b4SHeiko Schocher - CONFIG_I2C_ENV_EEPROM_BUS 4199548738b4SHeiko Schocher if you have an Environment on an EEPROM reached over 4200548738b4SHeiko Schocher I2C muxes, you can define here, how to reach this 4201548738b4SHeiko Schocher EEPROM. For example: 4202548738b4SHeiko Schocher 4203ea818dbbSHeiko Schocher #define CONFIG_I2C_ENV_EEPROM_BUS 1 4204548738b4SHeiko Schocher 4205548738b4SHeiko Schocher EEPROM which holds the environment, is reached over 4206548738b4SHeiko Schocher a pca9547 i2c mux with address 0x70, channel 3. 4207c609719bSwdenk 4208057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH: 42095779d8d9Swdenk 42105779d8d9Swdenk Define this if you have a DataFlash memory device which you 42115779d8d9Swdenk want to use for the environment. 42125779d8d9Swdenk 42130e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 42140e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_ADDR: 42150e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 42165779d8d9Swdenk 42175779d8d9Swdenk These three #defines specify the offset and size of the 42185779d8d9Swdenk environment area within the total memory of your DataFlash placed 42195779d8d9Swdenk at the specified address. 42205779d8d9Swdenk 4221bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH: 4222bd83b592SWu, Josh 4223bd83b592SWu, Josh Define this if you have a SPI Flash memory device which you 4224bd83b592SWu, Josh want to use for the environment. 4225bd83b592SWu, Josh 4226bd83b592SWu, Josh - CONFIG_ENV_OFFSET: 4227bd83b592SWu, Josh - CONFIG_ENV_SIZE: 4228bd83b592SWu, Josh 4229bd83b592SWu, Josh These two #defines specify the offset and size of the 4230bd83b592SWu, Josh environment area within the SPI Flash. CONFIG_ENV_OFFSET must be 4231bd83b592SWu, Josh aligned to an erase sector boundary. 4232bd83b592SWu, Josh 4233bd83b592SWu, Josh - CONFIG_ENV_SECT_SIZE: 4234bd83b592SWu, Josh 4235bd83b592SWu, Josh Define the SPI flash's sector size. 4236bd83b592SWu, Josh 4237bd83b592SWu, Josh - CONFIG_ENV_OFFSET_REDUND (optional): 4238bd83b592SWu, Josh 4239bd83b592SWu, Josh This setting describes a second storage area of CONFIG_ENV_SIZE 4240bd83b592SWu, Josh size used to hold a redundant copy of the environment data, so 4241bd83b592SWu, Josh that there is a valid backup copy in case there is a power failure 4242bd83b592SWu, Josh during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 4243bd83b592SWu, Josh aligned to an erase sector boundary. 4244bd83b592SWu, Josh 4245bd83b592SWu, Josh - CONFIG_ENV_SPI_BUS (optional): 4246bd83b592SWu, Josh - CONFIG_ENV_SPI_CS (optional): 4247bd83b592SWu, Josh 4248bd83b592SWu, Josh Define the SPI bus and chip select. If not defined they will be 0. 4249bd83b592SWu, Josh 4250bd83b592SWu, Josh - CONFIG_ENV_SPI_MAX_HZ (optional): 4251bd83b592SWu, Josh 4252bd83b592SWu, Josh Define the SPI max work clock. If not defined then use 1MHz. 4253bd83b592SWu, Josh 4254bd83b592SWu, Josh - CONFIG_ENV_SPI_MODE (optional): 4255bd83b592SWu, Josh 4256bd83b592SWu, Josh Define the SPI work mode. If not defined then use SPI_MODE_3. 4257bd83b592SWu, Josh 42580a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE: 42590a85a9e7SLiu Gang 42600a85a9e7SLiu Gang Define this if you have a remote memory space which you 42610a85a9e7SLiu Gang want to use for the local device's environment. 42620a85a9e7SLiu Gang 42630a85a9e7SLiu Gang - CONFIG_ENV_ADDR: 42640a85a9e7SLiu Gang - CONFIG_ENV_SIZE: 42650a85a9e7SLiu Gang 42660a85a9e7SLiu Gang These two #defines specify the address and size of the 42670a85a9e7SLiu Gang environment area within the remote memory space. The 42680a85a9e7SLiu Gang local device can get the environment from remote memory 4269fc54c7faSLiu Gang space by SRIO or PCIE links. 42700a85a9e7SLiu Gang 42710a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 42720a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 4273fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 4274fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 42750a85a9e7SLiu Gang 427651bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND: 427713a5695bSwdenk 427813a5695bSwdenk Define this if you have a NAND device which you want to use 427913a5695bSwdenk for the environment. 428013a5695bSwdenk 42810e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_OFFSET: 42820e8d1586SJean-Christophe PLAGNIOL-VILLARD - CONFIG_ENV_SIZE: 428313a5695bSwdenk 428413a5695bSwdenk These two #defines specify the offset and size of the environment 4285fdd813deSScott Wood area within the first NAND device. CONFIG_ENV_OFFSET must be 4286fdd813deSScott Wood aligned to an erase block boundary. 42875779d8d9Swdenk 4288fdd813deSScott Wood - CONFIG_ENV_OFFSET_REDUND (optional): 4289e443c944SMarkus Klotzbuecher 42900e8d1586SJean-Christophe PLAGNIOL-VILLARD This setting describes a second storage area of CONFIG_ENV_SIZE 4291fdd813deSScott Wood size used to hold a redundant copy of the environment data, so 4292fdd813deSScott Wood that there is a valid backup copy in case there is a power failure 4293fdd813deSScott Wood during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 4294fdd813deSScott Wood aligned to an erase block boundary. 4295e443c944SMarkus Klotzbuecher 4296fdd813deSScott Wood - CONFIG_ENV_RANGE (optional): 4297fdd813deSScott Wood 4298fdd813deSScott Wood Specifies the length of the region in which the environment 4299fdd813deSScott Wood can be written. This should be a multiple of the NAND device's 4300fdd813deSScott Wood block size. Specifying a range with more erase blocks than 4301fdd813deSScott Wood are needed to hold CONFIG_ENV_SIZE allows bad blocks within 4302fdd813deSScott Wood the range to be avoided. 4303fdd813deSScott Wood 4304fdd813deSScott Wood - CONFIG_ENV_OFFSET_OOB (optional): 4305fdd813deSScott Wood 4306fdd813deSScott Wood Enables support for dynamically retrieving the offset of the 4307fdd813deSScott Wood environment from block zero's out-of-band data. The 4308fdd813deSScott Wood "nand env.oob" command can be used to record this offset. 4309fdd813deSScott Wood Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 4310fdd813deSScott Wood using CONFIG_ENV_OFFSET_OOB. 4311e443c944SMarkus Klotzbuecher 4312b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 4313b74ab737SGuennadi Liakhovetski 4314b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 4315b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 4316b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 4317b74ab737SGuennadi Liakhovetski 43182b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI: 43192b74433fSJoe Hershberger 43202b74433fSJoe Hershberger Define this if you have an UBI volume that you want to use for the 43212b74433fSJoe Hershberger environment. This has the benefit of wear-leveling the environment 43222b74433fSJoe Hershberger accesses, which is important on NAND. 43232b74433fSJoe Hershberger 43242b74433fSJoe Hershberger - CONFIG_ENV_UBI_PART: 43252b74433fSJoe Hershberger 43262b74433fSJoe Hershberger Define this to a string that is the mtd partition containing the UBI. 43272b74433fSJoe Hershberger 43282b74433fSJoe Hershberger - CONFIG_ENV_UBI_VOLUME: 43292b74433fSJoe Hershberger 43302b74433fSJoe Hershberger Define this to the name of the volume that you want to store the 43312b74433fSJoe Hershberger environment in. 43322b74433fSJoe Hershberger 4333785881f7SJoe Hershberger - CONFIG_ENV_UBI_VOLUME_REDUND: 4334785881f7SJoe Hershberger 4335785881f7SJoe Hershberger Define this to the name of another volume to store a second copy of 4336785881f7SJoe Hershberger the environment in. This will enable redundant environments in UBI. 4337785881f7SJoe Hershberger It is assumed that both volumes are in the same MTD partition. 4338785881f7SJoe Hershberger 43392b74433fSJoe Hershberger - CONFIG_UBI_SILENCE_MSG 43402b74433fSJoe Hershberger - CONFIG_UBIFS_SILENCE_MSG 43412b74433fSJoe Hershberger 43422b74433fSJoe Hershberger You will probably want to define these to avoid a really noisy system 43432b74433fSJoe Hershberger when storing the env in UBI. 43442b74433fSJoe Hershberger 4345d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT: 4346d1db76f1SWu, Josh Define this if you want to use the FAT file system for the environment. 4347d1db76f1SWu, Josh 4348d1db76f1SWu, Josh - FAT_ENV_INTERFACE: 4349d1db76f1SWu, Josh 4350d1db76f1SWu, Josh Define this to a string that is the name of the block device. 4351d1db76f1SWu, Josh 4352d1db76f1SWu, Josh - FAT_ENV_DEV_AND_PART: 4353d1db76f1SWu, Josh 4354d1db76f1SWu, Josh Define this to a string to specify the partition of the device. It can 4355d1db76f1SWu, Josh be as following: 4356d1db76f1SWu, Josh 4357d1db76f1SWu, Josh "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1) 4358d1db76f1SWu, Josh - "D:P": device D partition P. Error occurs if device D has no 4359d1db76f1SWu, Josh partition table. 4360d1db76f1SWu, Josh - "D:0": device D. 4361d1db76f1SWu, Josh - "D" or "D:": device D partition 1 if device D has partition 4362d1db76f1SWu, Josh table, or the whole device D if has no partition 4363d1db76f1SWu, Josh table. 4364d1db76f1SWu, Josh - "D:auto": first partition in device D with bootable flag set. 4365b445bbb4SJeremiah Mahler If none, first valid partition in device D. If no 4366d1db76f1SWu, Josh partition table then means device D. 4367d1db76f1SWu, Josh 4368d1db76f1SWu, Josh - FAT_ENV_FILE: 4369d1db76f1SWu, Josh 4370d1db76f1SWu, Josh It's a string of the FAT file name. This file use to store the 4371b445bbb4SJeremiah Mahler environment. 4372d1db76f1SWu, Josh 4373d1db76f1SWu, Josh - CONFIG_FAT_WRITE: 4374b445bbb4SJeremiah Mahler This should be defined. Otherwise it cannot save the environment file. 4375d1db76f1SWu, Josh 437606e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC: 437706e4ae5fSStephen Warren 437806e4ae5fSStephen Warren Define this if you have an MMC device which you want to use for the 437906e4ae5fSStephen Warren environment. 438006e4ae5fSStephen Warren 438106e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_DEV: 438206e4ae5fSStephen Warren 438306e4ae5fSStephen Warren Specifies which MMC device the environment is stored in. 438406e4ae5fSStephen Warren 438506e4ae5fSStephen Warren - CONFIG_SYS_MMC_ENV_PART (optional): 438606e4ae5fSStephen Warren 438706e4ae5fSStephen Warren Specifies which MMC partition the environment is stored in. If not 438806e4ae5fSStephen Warren set, defaults to partition 0, the user area. Common values might be 438906e4ae5fSStephen Warren 1 (first MMC boot partition), 2 (second MMC boot partition). 439006e4ae5fSStephen Warren 439106e4ae5fSStephen Warren - CONFIG_ENV_OFFSET: 439206e4ae5fSStephen Warren - CONFIG_ENV_SIZE: 439306e4ae5fSStephen Warren 439406e4ae5fSStephen Warren These two #defines specify the offset and size of the environment 439506e4ae5fSStephen Warren area within the specified MMC device. 439606e4ae5fSStephen Warren 43975c088ee8SStephen Warren If offset is positive (the usual case), it is treated as relative to 43985c088ee8SStephen Warren the start of the MMC partition. If offset is negative, it is treated 43995c088ee8SStephen Warren as relative to the end of the MMC partition. This can be useful if 44005c088ee8SStephen Warren your board may be fitted with different MMC devices, which have 44015c088ee8SStephen Warren different sizes for the MMC partitions, and you always want the 44025c088ee8SStephen Warren environment placed at the very end of the partition, to leave the 44035c088ee8SStephen Warren maximum possible space before it, to store other data. 44045c088ee8SStephen Warren 440506e4ae5fSStephen Warren These two values are in units of bytes, but must be aligned to an 440606e4ae5fSStephen Warren MMC sector boundary. 440706e4ae5fSStephen Warren 440806e4ae5fSStephen Warren - CONFIG_ENV_OFFSET_REDUND (optional): 440906e4ae5fSStephen Warren 441006e4ae5fSStephen Warren Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 441106e4ae5fSStephen Warren hold a redundant copy of the environment data. This provides a 441206e4ae5fSStephen Warren valid backup copy in case the other copy is corrupted, e.g. due 441306e4ae5fSStephen Warren to a power failure during a "saveenv" operation. 441406e4ae5fSStephen Warren 44155c088ee8SStephen Warren This value may also be positive or negative; this is handled in the 44165c088ee8SStephen Warren same way as CONFIG_ENV_OFFSET. 44175c088ee8SStephen Warren 441806e4ae5fSStephen Warren This value is also in units of bytes, but must also be aligned to 441906e4ae5fSStephen Warren an MMC sector boundary. 442006e4ae5fSStephen Warren 442106e4ae5fSStephen Warren - CONFIG_ENV_SIZE_REDUND (optional): 442206e4ae5fSStephen Warren 442306e4ae5fSStephen Warren This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 442406e4ae5fSStephen Warren set. If this value is set, it must be set to the same value as 442506e4ae5fSStephen Warren CONFIG_ENV_SIZE. 442606e4ae5fSStephen Warren 44276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET 4428c609719bSwdenk 4429c609719bSwdenk Defines offset to the initial SPI buffer area in DPRAM. The 4430c609719bSwdenk area is used at an early stage (ROM part) if the environment 4431c609719bSwdenk is configured to reside in the SPI EEPROM: We need a 520 byte 4432c609719bSwdenk scratch DPRAM area. It is used between the two initialization 4433c609719bSwdenk calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4434c609719bSwdenk to be a good choice since it makes it far enough from the 4435c609719bSwdenk start of the data area as well as from the stack pointer. 4436c609719bSwdenk 4437e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 4438c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 4439cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f() 4440c609719bSwdenkuntil then to read environment variables. 4441c609719bSwdenk 444285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 444385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 444485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 444585ec0bccSwdenknecessary, because the first environment variable we need is the 444685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 444785ec0bccSwdenkhave any device yet where we could complain.] 4448c609719bSwdenk 4449c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 4450c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 445185ec0bccSwdenkuse the "saveenv" command to store a valid environment. 4452c609719bSwdenk 44536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4454fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 4455fc3e2165Swdenk 44566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4457fc3e2165Swdenk also needs to be defined. 4458fc3e2165Swdenk 44596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 4460fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 4461c609719bSwdenk 4462f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 4463f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 4464f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 4465f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 4466f5675aa5SRon Madrid space for already greatly restricted images, including but not 4467f5675aa5SRon Madrid limited to NAND_SPL configurations. 4468f5675aa5SRon Madrid 4469b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 4470b2b92f53SSimon Glass Display information about the board that U-Boot is running on 4471b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 4472b2b92f53SSimon Glass to do this. 4473b2b92f53SSimon Glass 4474e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 4475e2e3e2b1SSimon Glass Similar to the previous option, but display this information 4476e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 4477e2e3e2b1SSimon Glass present. 4478e2e3e2b1SSimon Glass 4479feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT: 4480feb85801SSascha Silbe Maximum size of the U-Boot image. When defined, the 4481feb85801SSascha Silbe build system checks that the actual size does not 4482feb85801SSascha Silbe exceed it. 4483feb85801SSascha Silbe 4484c609719bSwdenkLow Level (hardware related) configuration options: 4485dc7c9a1aSwdenk--------------------------------------------------- 4486c609719bSwdenk 44876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 4488c609719bSwdenk Cache Line Size of the CPU. 4489c609719bSwdenk 44906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR: 4491c609719bSwdenk Default address of the IMMR after system reset. 44922535d602Swdenk 44932535d602Swdenk Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 44942535d602Swdenk and RPXsuper) to be able to adjust the position of 44952535d602Swdenk the IMMR register after a reset. 4496c609719bSwdenk 4497e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 4498e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 4499e46fedfeSTimur Tabi PowerPC SOCs. 4500e46fedfeSTimur Tabi 4501e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 4502e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 4503e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4504e46fedfeSTimur Tabi 4505e46fedfeSTimur Tabi CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4506e46fedfeSTimur Tabi for cross-platform code that uses that macro instead. 4507e46fedfeSTimur Tabi 4508e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 4509e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 4510e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 4511e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 4512e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4513e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 4514e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 4515e46fedfeSTimur Tabi 4516e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4517e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4518e46fedfeSTimur Tabi 4519e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4520e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4521e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 4522e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4523e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4524e46fedfeSTimur Tabi 4525e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4526e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4527e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 4528e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 4529e46fedfeSTimur Tabi 4530e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4531e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4532e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 4533e46fedfeSTimur Tabi 45347f6c2cbcSwdenk- Floppy Disk Support: 45356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 45367f6c2cbcSwdenk 45377f6c2cbcSwdenk the default drive number (default value 0) 45387f6c2cbcSwdenk 45396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 45407f6c2cbcSwdenk 454111ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 45427f6c2cbcSwdenk (default value 1) 45437f6c2cbcSwdenk 45446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 45457f6c2cbcSwdenk 45467f6c2cbcSwdenk defines the offset of register from address. It 45477f6c2cbcSwdenk depends on which part of the data bus is connected to 454811ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 45497f6c2cbcSwdenk 45506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 45516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 45527f6c2cbcSwdenk default value. 45537f6c2cbcSwdenk 45546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 45557f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 45567f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 4557b445bbb4SJeremiah Mahler source code. It is used to make hardware-dependent 45587f6c2cbcSwdenk initializations. 45597f6c2cbcSwdenk 45600abddf82SMacpaul Lin- CONFIG_IDE_AHB: 45610abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 45620abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 45630abddf82SMacpaul Lin When software is doing ATA command and data transfer to 45640abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 45650abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 4566b445bbb4SJeremiah Mahler is required. 45670abddf82SMacpaul Lin 45686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 456925d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 457025d6712aSwdenk doing! (11-4) [MPC8xx/82xx systems only] 4571c609719bSwdenk 45726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 4573c609719bSwdenk 45747152b1d0Swdenk Start address of memory area that can be used for 4575c609719bSwdenk initial data and stack; please note that this must be 4576c609719bSwdenk writable memory that is working WITHOUT special 4577c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 4578c609719bSwdenk will become available only after programming the 4579c609719bSwdenk memory controller and running certain initialization 4580c609719bSwdenk sequences. 4581c609719bSwdenk 4582c609719bSwdenk U-Boot uses the following memory types: 4583c609719bSwdenk - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4584c609719bSwdenk - MPC824X: data cache 4585c609719bSwdenk - PPC4xx: data cache 4586c609719bSwdenk 45876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 4588c609719bSwdenk 4589c609719bSwdenk Offset of the initial data structure in the memory 45906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 45916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4592c609719bSwdenk data is located at the end of the available space 4593553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 45946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 45956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 45966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 4597c609719bSwdenk 4598c609719bSwdenk Note: 4599c609719bSwdenk On the MPC824X (or other systems that use the data 4600c609719bSwdenk cache for initial memory) the address chosen for 46016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4602c609719bSwdenk point to an otherwise UNUSED address space between 4603c609719bSwdenk the top of RAM and the start of the PCI space. 4604c609719bSwdenk 46056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4606c609719bSwdenk 46076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4608c609719bSwdenk 46096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4610c609719bSwdenk 46116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4612c609719bSwdenk 46136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4614c609719bSwdenk 46156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4616c609719bSwdenk 46176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 4618c609719bSwdenk SDRAM timing 4619c609719bSwdenk 46206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 4621c609719bSwdenk periodic timer for refresh 4622c609719bSwdenk 46236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER: Debug Event Register (37-47) 4624c609719bSwdenk 46256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 46266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 46276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 46286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 4629c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4630c609719bSwdenk 4631c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 46326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 46336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4634c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4635c609719bSwdenk 46366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 46376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4638c609719bSwdenk Machine Mode Register and Memory Periodic Timer 4639c609719bSwdenk Prescaler definitions (SDRAM timing) 4640c609719bSwdenk 46416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4642c609719bSwdenk enable I2C microcode relocation patch (MPC8xx); 4643c609719bSwdenk define relocation offset in DPRAM [DSP2] 4644c609719bSwdenk 46456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4646b423d055SHeiko Schocher enable SMC microcode relocation patch (MPC8xx); 4647b423d055SHeiko Schocher define relocation offset in DPRAM [SMC1] 4648b423d055SHeiko Schocher 46496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4650c609719bSwdenk enable SPI microcode relocation patch (MPC8xx); 4651c609719bSwdenk define relocation offset in DPRAM [SCC4] 4652c609719bSwdenk 46536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK: 4654c609719bSwdenk Use OSCM clock mode on MBX8xx board. Be careful, 4655c609719bSwdenk wrong setting might damage your board. Read 4656c609719bSwdenk doc/README.MBX before setting this variable! 4657c609719bSwdenk 46586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4659ea909b76Swdenk Offset of the bootmode word in DPRAM used by post 4660ea909b76Swdenk (Power On Self Tests). This definition overrides 4661ea909b76Swdenk #define'd default value in commproc.h resp. 4662ea909b76Swdenk cpm_8260.h. 4663ea909b76Swdenk 46646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 46656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 46666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 46676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 46686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 46696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 46706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 46716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4672a47a12beSStefan Roese Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 46735d232d0eSwdenk 46749cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE: 46759cacf4fcSDirk Eibach Disable PCI-Express on systems where it is supported but not 46769cacf4fcSDirk Eibach required. 46779cacf4fcSDirk Eibach 467869fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 4679b445bbb4SJeremiah Mahler Only scan through and get the devices on the buses. 468069fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 468169fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 468269fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 468369fd2d3bSAndrew Sharp by coreboot or similar. 468469fd2d3bSAndrew Sharp 4685842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 4686842033e6SGabor Juhos Enable support for indirect PCI bridges. 4687842033e6SGabor Juhos 4688a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 4689a09b9b68SKumar Gala Chip has SRIO or not 4690a09b9b68SKumar Gala 4691a09b9b68SKumar Gala- CONFIG_SRIO1: 4692a09b9b68SKumar Gala Board has SRIO 1 port available 4693a09b9b68SKumar Gala 4694a09b9b68SKumar Gala- CONFIG_SRIO2: 4695a09b9b68SKumar Gala Board has SRIO 2 port available 4696a09b9b68SKumar Gala 4697c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 4698c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 4699c8b28152SLiu Gang 4700a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 4701a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 4702a09b9b68SKumar Gala 4703a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 4704a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 4705a09b9b68SKumar Gala 4706a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 4707a09b9b68SKumar Gala Size of SRIO port 'n' memory region 4708a09b9b68SKumar Gala 470966bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 471066bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 471166bd1846SFabio Estevam a 16 bit bus. 471266bd1846SFabio Estevam Not all NAND drivers use this symbol. 4713a430e916SFabio Estevam Example of drivers that use it: 471466bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 4715a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 4716eced4626SAlex Waterman 4717eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 4718eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 4719eced4626SAlex Waterman a default value will be used. 4720eced4626SAlex Waterman 4721bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 4722218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 4723218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 4724218ca724SWolfgang Denk 4725bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 4726bb99ad6dSBen Warren I2C address of the SPD EEPROM 4727bb99ad6dSBen Warren 47286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 4729218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 4730218ca724SWolfgang Denk one, specify here. Note that the value must resolve 4731218ca724SWolfgang Denk to something your driver can deal with. 4732bb99ad6dSBen Warren 47331b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 47341b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 47351b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 47361b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 47371b3e3c4fSYork Sun header files or board specific files. 47381b3e3c4fSYork Sun 47396f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 47406f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 47416f5e1dc5SYork Sun 4742e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH 4743e32d59a2SYork Sun Enable sync of refresh for multiple controllers. 4744e32d59a2SYork Sun 47454516ff81SYork Sun- CONFIG_FSL_DDR_BIST 47464516ff81SYork Sun Enable built-in memory test for Freescale DDR controllers. 47474516ff81SYork Sun 47486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 4749218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 4750218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 47512ad6b513STimur Tabi 4752c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12] 4753c26e454dSwdenk Define to enable FEC[12] on a 8xx series processor. 4754c26e454dSwdenk 4755c26e454dSwdenk- CONFIG_FEC[12]_PHY 4756c26e454dSwdenk Define to the hardcoded PHY address which corresponds 47576e592385Swdenk to the given FEC; i. e. 4758c26e454dSwdenk #define CONFIG_FEC1_PHY 4 4759c26e454dSwdenk means that the PHY with address 4 is connected to FEC1 4760c26e454dSwdenk 4761c26e454dSwdenk When set to -1, means to probe for first available. 4762c26e454dSwdenk 4763c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR 4764c26e454dSwdenk The PHY does not have a RXERR line (RMII only). 4765c26e454dSwdenk (so program the FEC to ignore it). 4766c26e454dSwdenk 4767c26e454dSwdenk- CONFIG_RMII 4768c26e454dSwdenk Enable RMII mode for all FECs. 4769c26e454dSwdenk Note that this is a global option, we can't 4770c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 4771c26e454dSwdenk 47725cf91d6bSwdenk- CONFIG_CRC32_VERIFY 47735cf91d6bSwdenk Add a verify option to the crc32 command. 47745cf91d6bSwdenk The syntax is: 47755cf91d6bSwdenk 47765cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 47775cf91d6bSwdenk 47785cf91d6bSwdenk Where address/count indicate a memory area 47795cf91d6bSwdenk and crc32 is the correct crc32 which the 47805cf91d6bSwdenk area should have. 47815cf91d6bSwdenk 478256523f12Swdenk- CONFIG_LOOPW 478356523f12Swdenk Add the "loopw" memory command. This only takes effect if 4784602ad3b3SJon Loeliger the memory commands are activated globally (CONFIG_CMD_MEM). 478556523f12Swdenk 47867b466641Sstroese- CONFIG_MX_CYCLIC 47877b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 47887b466641Sstroese "md/mw" commands. 47897b466641Sstroese Examples: 47907b466641Sstroese 47917b466641Sstroese => mdc.b 10 4 500 47927b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 47937b466641Sstroese 47947b466641Sstroese => mwc.l 100 12345678 10 47957b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 47967b466641Sstroese 47977b466641Sstroese This only takes effect if the memory commands are activated 4798602ad3b3SJon Loeliger globally (CONFIG_CMD_MEM). 47997b466641Sstroese 48008aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 4801afc1ce82SMacpaul Lin [ARM, NDS32, MIPS only] If this variable is defined, then certain 4802e03f3169SWolfgang Denk low level initializations (like setting up the memory 4803e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 4804e03f3169SWolfgang Denk relocate itself into RAM. 48058aa1a2d1Swdenk 4806e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 4807e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 4808e03f3169SWolfgang Denk other boot loader or by a debugger which performs 4809e03f3169SWolfgang Denk these initializations itself. 48108aa1a2d1Swdenk 4811b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY 4812b5bd0982SSimon Glass [ARM926EJ-S only] This allows just the call to lowlevel_init() 4813b5bd0982SSimon Glass to be skipped. The normal CPU15 init (such as enabling the 4814b5bd0982SSimon Glass instruction cache) is still performed. 4815b5bd0982SSimon Glass 4816401bb30bSAneesh V- CONFIG_SPL_BUILD 4817df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 4818df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 4819df81238bSMagnus Lilja compiling a NAND SPL. 4820400558b5Swdenk 48213aa29de0SYing Zhang- CONFIG_TPL_BUILD 48223aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 48233aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 48243aa29de0SYing Zhang It is loaded by the SPL. 48253aa29de0SYing Zhang 48265df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 48275df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 48285df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 48295df572f0SYing Zhang previous 4k of the .text section. 48305df572f0SYing Zhang 48314213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 48324213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 48334213fc29SSimon Glass effective address. It is therefore not necessary to regard 48344213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 48354213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 48364213fc29SSimon Glass it maintains its own little RAM buffer which contains all 48374213fc29SSimon Glass addressable memory. This option causes some memory accesses 48384213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 48394213fc29SSimon Glass 4840d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY 4841d8834a13SMatthias Weisser CONFIG_USE_ARCH_MEMSET 4842d8834a13SMatthias Weisser If these options are used a optimized version of memcpy/memset will 4843d8834a13SMatthias Weisser be used if available. These functions may be faster under some 4844d8834a13SMatthias Weisser conditions but may increase the binary size. 4845d8834a13SMatthias Weisser 4846588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 4847588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 4848588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 4849b16f521aSGabe Black 4850fc33705eSMark Jackson- CONFIG_SYS_MPUCLK 4851fc33705eSMark Jackson Defines the MPU clock speed (in MHz). 4852fc33705eSMark Jackson 4853fc33705eSMark Jackson NOTE : currently only supported on AM335x platforms. 48545b5ece9eSGabe Black 485516678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 485616678eb4SHeiko Schocher Enables the RTC32K OSC on AM33xx based plattforms 485716678eb4SHeiko Schocher 4858999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 4859999d7d32SKaricheri, Muralidharan Option to disable subpage write in NAND driver 4860999d7d32SKaricheri, Muralidharan driver that uses this: 4861999d7d32SKaricheri, Muralidharan drivers/mtd/nand/davinci_nand.c 4862999d7d32SKaricheri, Muralidharan 4863f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 4864f2717b47STimur Tabi----------------------------------- 4865f2717b47STimur Tabi 4866f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4867f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 4868f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 4869f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 4870f2717b47STimur Tabiwithin that device. 4871f2717b47STimur Tabi 4872dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR 4873dcf1d774SZhao Qiang The address in the storage device where the FMAN microcode is located. The 4874dcf1d774SZhao Qiang meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4875dcf1d774SZhao Qiang is also specified. 4876dcf1d774SZhao Qiang 4877dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR 4878dcf1d774SZhao Qiang The address in the storage device where the QE microcode is located. The 4879f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4880f2717b47STimur Tabi is also specified. 4881f2717b47STimur Tabi 4882f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 4883f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 4884f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 4885f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 4886f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 4887f2717b47STimur Tabi 4888f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4889f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4890f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4891f2717b47STimur Tabi virtual address in NOR flash. 4892f2717b47STimur Tabi 4893f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4894f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 4895f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4896f2717b47STimur Tabi 4897f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4898f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 4899f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4900f2717b47STimur Tabi 4901f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4902f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SPI 4903f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4904f2717b47STimur Tabi 4905292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4906292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 4907292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4908fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4909fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 4910fc54c7faSLiu Gang master's memory space. 4911f2717b47STimur Tabi 4912b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support: 4913b940ca64SJ. German Rivera--------------------------------------------------------- 4914b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of 4915b940ca64SJ. German Rivera"firmware". 4916b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros 4917b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address 4918b940ca64SJ. German Riverawithin that device. 4919b940ca64SJ. German Rivera 4920b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET 4921b940ca64SJ. German Rivera Enable the MC driver for Layerscape SoCs. 4922b940ca64SJ. German Rivera 4923b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_ADDR 4924b940ca64SJ. German Rivera The address in the storage device where the firmware is located. The 4925b940ca64SJ. German Rivera meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro 4926b940ca64SJ. German Rivera is also specified. 4927b940ca64SJ. German Rivera 4928b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_LENGTH 4929b940ca64SJ. German Rivera The maximum possible size of the firmware. The firmware binary format 4930b940ca64SJ. German Rivera has a field that specifies the actual size of the firmware, but it 4931b940ca64SJ. German Rivera might not be possible to read any part of the firmware unless some 4932b940ca64SJ. German Rivera local storage is allocated to hold the entire firmware first. 4933b940ca64SJ. German Rivera 4934b940ca64SJ. German Rivera- CONFIG_SYS_LS_MC_FW_IN_NOR 4935b940ca64SJ. German Rivera Specifies that MC firmware is located in NOR flash, mapped as 4936b940ca64SJ. German Rivera normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the 4937b940ca64SJ. German Rivera virtual address in NOR flash. 4938b940ca64SJ. German Rivera 49395c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support: 49405c055089SPrabhakar Kushwaha------------------------------------------- 49415c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of 49425c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom. 49435c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting. 49445c055089SPrabhakar Kushwaha 49455c055089SPrabhakar Kushwaha- CONFIG_FSL_DEBUG_SERVER 49465c055089SPrabhakar Kushwaha Enable the Debug Server for Layerscape SoCs. 49475c055089SPrabhakar Kushwaha 49485c055089SPrabhakar Kushwaha- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE 49495c055089SPrabhakar Kushwaha Define minimum DDR size required for debug server image 49505c055089SPrabhakar Kushwaha 4951c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN 4952c0492141SYork Sun Define alignment of reserved memory MC requires 49535c055089SPrabhakar Kushwaha 4954f3f431a7SPaul KocialkowskiReproducible builds 4955f3f431a7SPaul Kocialkowski------------------- 4956f3f431a7SPaul Kocialkowski 4957f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build 4958f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value. 4959f3f431a7SPaul Kocialkowski 4960f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable. 4961f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration 4962f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot. 4963f3f431a7SPaul Kocialkowski 4964f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. 4965f3f431a7SPaul Kocialkowski 4966c609719bSwdenkBuilding the Software: 4967c609719bSwdenk====================== 4968c609719bSwdenk 4969218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 4970218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 4971218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 4972218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 4973218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4974218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 4975c609719bSwdenk 4976218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 4977218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 4978218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 4979218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 4980218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 4981c609719bSwdenk 4982218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 4983218ca724SWolfgang Denk $ export CROSS_COMPILE 4984c609719bSwdenk 49852f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 49862f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 49872f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 49882f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 49892f8d396bSPeter Tyser 49902f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 49912f8d396bSPeter Tyser 49922f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 49932f8d396bSPeter Tyser be executed on computers running Windows. 49942f8d396bSPeter Tyser 4995c609719bSwdenkU-Boot is intended to be simple to build. After installing the 4996c609719bSwdenksources you must configure U-Boot for one specific board type. This 4997c609719bSwdenkis done by typing: 4998c609719bSwdenk 4999ab584d67SHolger Freyther make NAME_defconfig 5000c609719bSwdenk 5001ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu- 50024d675ae6SMichael Jonesrations; see boards.cfg for supported names. 500354387ac9Swdenk 5004c609719bSwdenkNote: for some board special configuration names may exist; check if 5005c609719bSwdenk additional information is available from the board vendor; for 50062729af9dSwdenk instance, the TQM823L systems are available without (standard) 50072729af9dSwdenk or with LCD support. You can select such additional "features" 500811ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 5009c609719bSwdenk 5010ab584d67SHolger Freyther make TQM823L_defconfig 50112729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 5012c609719bSwdenk 5013ab584d67SHolger Freyther make TQM823L_LCD_defconfig 5014c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 5015c609719bSwdenk 5016c609719bSwdenk etc. 5017c609719bSwdenk 5018c609719bSwdenk 5019c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 50207152b1d0Swdenkimages ready for download to / installation on your system: 5021c609719bSwdenk 5022c609719bSwdenk- "u-boot.bin" is a raw binary image 5023c609719bSwdenk- "u-boot" is an image in ELF binary format 5024c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 5025c609719bSwdenk 5026baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 5027baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 5028baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 5029baf31249SMarian Balakowicz 5030baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 5031baf31249SMarian Balakowicz 5032baf31249SMarian Balakowicz make O=/tmp/build distclean 5033ab584d67SHolger Freyther make O=/tmp/build NAME_defconfig 5034baf31249SMarian Balakowicz make O=/tmp/build all 5035baf31249SMarian Balakowicz 5036adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location: 5037baf31249SMarian Balakowicz 5038adbba996STimo Ketola export KBUILD_OUTPUT=/tmp/build 5039baf31249SMarian Balakowicz make distclean 5040ab584d67SHolger Freyther make NAME_defconfig 5041baf31249SMarian Balakowicz make all 5042baf31249SMarian Balakowicz 5043adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment 5044baf31249SMarian Balakowiczvariable. 5045baf31249SMarian Balakowicz 5046c609719bSwdenk 5047c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 5048c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 5049c609719bSwdenknative "make". 5050c609719bSwdenk 5051c609719bSwdenk 5052c609719bSwdenkIf the system board that you have is not listed, then you will need 5053c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 5054c609719bSwdenksteps: 5055c609719bSwdenk 50563c1496cdSPhil Sutter1. Create a new directory to hold your board specific code. Add any 505785ec0bccSwdenk files you need. In your board directory, you will need at least 50583c1496cdSPhil Sutter the "Makefile" and a "<board>.c". 50593c1496cdSPhil Sutter2. Create a new configuration file "include/configs/<board>.h" for 50603c1496cdSPhil Sutter your board. 5061c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 5062c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 5063ab584d67SHolger Freyther4. Run "make <board>_defconfig" with your new name. 5064c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 5065c609719bSwdenk to be installed on your target system. 506685ec0bccSwdenk6. Debug and solve any problems that might arise. 5067c609719bSwdenk [Of course, this last step is much harder than it sounds.] 5068c609719bSwdenk 5069c609719bSwdenk 5070c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 5071c609719bSwdenk============================================================== 5072c609719bSwdenk 5073c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 5074c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 5075c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 5076c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 5077218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 5078c609719bSwdenk 5079c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 5080c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 5081c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 5082c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot 5083c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can 50847152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE' 5085218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools 5086218ca724SWolfgang Denkyou can type 5087c609719bSwdenk 5088c609719bSwdenk CROSS_COMPILE=ppc_8xx- MAKEALL 5089c609719bSwdenk 5090c609719bSwdenkor to build on a native PowerPC system you can type 5091c609719bSwdenk 5092c609719bSwdenk CROSS_COMPILE=' ' MAKEALL 5093c609719bSwdenk 5094218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build 5095218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by 5096218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target 5097218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and 5098218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default 5099218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment 5100218ca724SWolfgang Denkvariable. For example: 5101baf31249SMarian Balakowicz 5102baf31249SMarian Balakowicz export BUILD_DIR=/tmp/build 5103baf31249SMarian Balakowicz export MAKEALL_LOGDIR=/tmp/log 5104baf31249SMarian Balakowicz CROSS_COMPILE=ppc_8xx- MAKEALL 5105baf31249SMarian Balakowicz 5106218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build, 5107218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean 5108218ca724SWolfgang Denkduring the whole build process. 5109baf31249SMarian Balakowicz 5110baf31249SMarian Balakowicz 5111c609719bSwdenkSee also "U-Boot Porting Guide" below. 5112c609719bSwdenk 5113c609719bSwdenk 5114c609719bSwdenkMonitor Commands - Overview: 5115c609719bSwdenk============================ 5116c609719bSwdenk 5117c609719bSwdenkgo - start application at address 'addr' 5118c609719bSwdenkrun - run commands in an environment variable 5119c609719bSwdenkbootm - boot application image from memory 5120c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 512144f074c7SMarek Vasutbootz - boot zImage from memory 5122c609719bSwdenktftpboot- boot image via network using TFTP protocol 5123c609719bSwdenk and env variables "ipaddr" and "serverip" 5124c609719bSwdenk (and eventually "gatewayip") 51251fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 5126c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 5127c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 5128c609719bSwdenkloads - load S-Record file over serial line 5129c609719bSwdenkloadb - load binary file over serial line (kermit mode) 5130c609719bSwdenkmd - memory display 5131c609719bSwdenkmm - memory modify (auto-incrementing) 5132c609719bSwdenknm - memory modify (constant address) 5133c609719bSwdenkmw - memory write (fill) 5134c609719bSwdenkcp - memory copy 5135c609719bSwdenkcmp - memory compare 5136c609719bSwdenkcrc32 - checksum calculation 51370f89c54bSPeter Tyseri2c - I2C sub-system 5138c609719bSwdenksspi - SPI utility commands 5139c609719bSwdenkbase - print or set address offset 5140c609719bSwdenkprintenv- print environment variables 5141c609719bSwdenksetenv - set environment variables 5142c609719bSwdenksaveenv - save environment variables to persistent storage 5143c609719bSwdenkprotect - enable or disable FLASH write protection 5144c609719bSwdenkerase - erase FLASH memory 5145c609719bSwdenkflinfo - print FLASH memory information 514610635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 5147c609719bSwdenkbdinfo - print Board Info structure 5148c609719bSwdenkiminfo - print header information for application image 5149c609719bSwdenkconinfo - print console devices and informations 5150c609719bSwdenkide - IDE sub-system 5151c609719bSwdenkloop - infinite loop on address range 515256523f12Swdenkloopw - infinite write loop on address range 5153c609719bSwdenkmtest - simple RAM test 5154c609719bSwdenkicache - enable or disable instruction cache 5155c609719bSwdenkdcache - enable or disable data cache 5156c609719bSwdenkreset - Perform RESET of the CPU 5157c609719bSwdenkecho - echo args to console 5158c609719bSwdenkversion - print monitor version 5159c609719bSwdenkhelp - print online help 5160c609719bSwdenk? - alias for 'help' 5161c609719bSwdenk 5162c609719bSwdenk 5163c609719bSwdenkMonitor Commands - Detailed Description: 5164c609719bSwdenk======================================== 5165c609719bSwdenk 5166c609719bSwdenkTODO. 5167c609719bSwdenk 5168c609719bSwdenkFor now: just type "help <command>". 5169c609719bSwdenk 5170c609719bSwdenk 5171c609719bSwdenkEnvironment Variables: 5172c609719bSwdenk====================== 5173c609719bSwdenk 5174c609719bSwdenkU-Boot supports user configuration using Environment Variables which 5175c609719bSwdenkcan be made persistent by saving to Flash memory. 5176c609719bSwdenk 5177c609719bSwdenkEnvironment Variables are set using "setenv", printed using 5178c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 5179c609719bSwdenkwithout a value can be used to delete a variable from the 5180c609719bSwdenkenvironment. As long as you don't save the environment you are 5181c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 5182c609719bSwdenkenvironment is erased by accident, a default environment is provided. 5183c609719bSwdenk 5184c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 5185c96f86eeSWolfgang Denk 5186c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 5187c609719bSwdenk 5188c609719bSwdenk baudrate - see CONFIG_BAUDRATE 5189c609719bSwdenk 5190c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 5191c609719bSwdenk 5192c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 5193c609719bSwdenk 5194c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 5195c609719bSwdenk 5196c609719bSwdenk bootfile - Name of the image to load with TFTP 5197c609719bSwdenk 51987d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 51997d721e34SBartlomiej Sieka command can be restricted. This variable is given as 52007d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 52017d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 52027d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 52037d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 5204c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 5205c3624e6eSGrant Likely bootm_mapsize. 5206c3624e6eSGrant Likely 5207c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 5208c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 5209c3624e6eSGrant Likely defines the size of the memory region starting at base 5210c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 5211c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 5212c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 5213c3624e6eSGrant Likely used otherwise. 52147d721e34SBartlomiej Sieka 52157d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 52167d721e34SBartlomiej Sieka command can be restricted. This variable is given as 52177d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 52187d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 52197d721e34SBartlomiej Sieka environment variable. 52207d721e34SBartlomiej Sieka 52214bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 52224bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 52234bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 52244bae9090SBartlomiej Sieka 5225c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 5226c609719bSwdenk "bootp" will just load perform a lookup of the 5227c609719bSwdenk configuration from the BOOTP server, but not try to 5228c609719bSwdenk load any image using TFTP 5229c609719bSwdenk 5230c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 5231c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 5232c609719bSwdenk be automatically started (by internally calling 5233c609719bSwdenk "bootm") 5234c609719bSwdenk 52354a6fd34bSwdenk If set to "no", a standalone image passed to the 52364a6fd34bSwdenk "bootm" command will be copied to the load address 52374a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 52384a6fd34bSwdenk This can be used to load and uncompress arbitrary 52394a6fd34bSwdenk data. 52404a6fd34bSwdenk 5241a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 5242a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 5243fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 5244fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 5245fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 5246fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 5247fa34f6b2SShawn Guo device tree blob be copied to the maximum address 5248fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 5249fa34f6b2SShawn Guo access it during the boot procedure. 5250fa34f6b2SShawn Guo 5251a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 5252a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 5253a28afca5SDavid A. Long to work it must reside in writable memory, have 5254a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 5255a28afca5SDavid A. Long add the information it needs into it, and the memory 5256a28afca5SDavid A. Long must be accessible by the kernel. 5257a28afca5SDavid A. Long 5258eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 5259eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 5260eea63e05SSimon Glass defined. 5261eea63e05SSimon Glass 526217ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 526317ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 526417ea1177Swdenk mode (400kHZ). This environment variable is used in 526517ea1177Swdenk initialization code. So, for changes to be effective 526617ea1177Swdenk it must be saved and board must be reset. 526717ea1177Swdenk 5268c609719bSwdenk initrd_high - restrict positioning of initrd images: 5269c609719bSwdenk If this variable is not set, initrd images will be 5270c609719bSwdenk copied to the highest possible address in RAM; this 5271c609719bSwdenk is usually what you want since it allows for 5272c609719bSwdenk maximum initrd size. If for some reason you want to 5273c609719bSwdenk make sure that the initrd image is loaded below the 52746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 5275c609719bSwdenk variable to a value of "no" or "off" or "0". 5276c609719bSwdenk Alternatively, you can set it to a maximum upper 5277c609719bSwdenk address to use (U-Boot will still check that it 5278c609719bSwdenk does not overwrite the U-Boot stack and data). 5279c609719bSwdenk 5280c609719bSwdenk For instance, when you have a system with 16 MB 52817152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 5282c609719bSwdenk you can do this by adding "mem=12M" to the value of 5283c609719bSwdenk the "bootargs" variable. However, now you must make 52847152b1d0Swdenk sure that the initrd image is placed in the first 5285c609719bSwdenk 12 MB as well - this can be done with 5286c609719bSwdenk 5287c609719bSwdenk setenv initrd_high 00c00000 5288c609719bSwdenk 528938b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 529038b99261Swdenk indication to U-Boot that all addresses are legal 529138b99261Swdenk for the Linux kernel, including addresses in flash 529238b99261Swdenk memory. In this case U-Boot will NOT COPY the 529338b99261Swdenk ramdisk at all. This may be useful to reduce the 529438b99261Swdenk boot time on your system, but requires that this 529538b99261Swdenk feature is supported by your Linux kernel. 529638b99261Swdenk 5297c609719bSwdenk ipaddr - IP address; needed for tftpboot command 5298c609719bSwdenk 5299c609719bSwdenk loadaddr - Default load address for commands like "bootp", 5300dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 5301c609719bSwdenk 5302c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 5303c609719bSwdenk 5304c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 5305c609719bSwdenk 5306c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 5307c609719bSwdenk 5308c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 5309c609719bSwdenk 5310c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 5311c609719bSwdenk 5312e2a53458SMike Frysinger ethprime - controls which interface is used first. 5313a3d991bdSwdenk 5314e2a53458SMike Frysinger ethact - controls which interface is currently active. 5315e2a53458SMike Frysinger For example you can do the following 5316a3d991bdSwdenk 531748690d80SHeiko Schocher => setenv ethact FEC 531848690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 531948690d80SHeiko Schocher => setenv ethact SCC 532048690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 5321a3d991bdSwdenk 5322e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 5323e1692577SMatthias Fuchs available network interfaces. 5324e1692577SMatthias Fuchs It just stays at the currently selected interface. 5325e1692577SMatthias Fuchs 5326a3d991bdSwdenk netretry - When set to "no" each network operation will 5327a3d991bdSwdenk either succeed or fail without retrying. 53286e592385Swdenk When set to "once" the network operation will 53296e592385Swdenk fail when all the available network interfaces 53306e592385Swdenk are tried once without success. 5331a3d991bdSwdenk Useful on scripts which control the retry operation 5332a3d991bdSwdenk themselves. 5333a3d991bdSwdenk 5334b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 5335a1cf027aSJean-Christophe PLAGNIOL-VILLARD 5336b445bbb4SJeremiah Mahler silent_linux - If set then Linux will be told to boot silently, by 53378d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 53388d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 53398d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 53408d51aacdSSimon Glass is silent. 53418d51aacdSSimon Glass 5342f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpsrcp - If this is set, the value is used for TFTP's 5343ecb0ccd9SWolfgang Denk UDP source port. 5344ecb0ccd9SWolfgang Denk 5345f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpdstp - If this is set, the value is used for TFTP's UDP 534628cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 534728cb9375SWolfgang Denk 5348c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 5349c96f86eeSWolfgang Denk we use the TFTP server's default block size 5350c96f86eeSWolfgang Denk 5351c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 5352c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 5353c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 5354c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 5355c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 5356c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 5357c96f86eeSWolfgang Denk with unreliable TFTP servers. 5358c96f86eeSWolfgang Denk 5359f5fb7346SAlbert ARIBAUD \(3ADEV\) tftptimeoutcountmax - maximum count of TFTP timeouts (no 5360f5fb7346SAlbert ARIBAUD \(3ADEV\) unit, minimum value = 0). Defines how many timeouts 5361f5fb7346SAlbert ARIBAUD \(3ADEV\) can happen during a single file transfer before that 5362f5fb7346SAlbert ARIBAUD \(3ADEV\) transfer is aborted. The default is 10, and 0 means 5363f5fb7346SAlbert ARIBAUD \(3ADEV\) 'no timeouts allowed'. Increasing this value may help 5364f5fb7346SAlbert ARIBAUD \(3ADEV\) downloads succeed with high packet loss rates, or with 5365f5fb7346SAlbert ARIBAUD \(3ADEV\) unreliable TFTP servers or client hardware. 5366f5fb7346SAlbert ARIBAUD \(3ADEV\) 5367a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 536811ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 5369a3d991bdSwdenk VLAN tagged frames. 5370c609719bSwdenk 537150768f5bSAlexandre Messier bootpretryperiod - Period during which BOOTP/DHCP sends retries. 537250768f5bSAlexandre Messier Unsigned value, in milliseconds. If not set, the period will 537350768f5bSAlexandre Messier be either the default (28000), or a value based on 537450768f5bSAlexandre Messier CONFIG_NET_RETRY_COUNT, if defined. This value has 537550768f5bSAlexandre Messier precedence over the valu based on CONFIG_NET_RETRY_COUNT. 537650768f5bSAlexandre Messier 5377dc0b7b0eSJason HobbsThe following image location variables contain the location of images 5378dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 5379dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 5380dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 5381dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 5382dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 5383dc0b7b0eSJason Hobbsflash or offset in NAND flash. 5384dc0b7b0eSJason Hobbs 5385dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 5386aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some 5387dc0b7b0eSJason Hobbsboards use these variables for other purposes. 5388dc0b7b0eSJason Hobbs 5389dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 5390dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 5391dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 5392dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 5393dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 5394dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 5395dc0b7b0eSJason Hobbs 5396c609719bSwdenkThe following environment variables may be used and automatically 5397c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 5398c609719bSwdenkdepending the information provided by your boot server: 5399c609719bSwdenk 5400c609719bSwdenk bootfile - see above 5401c609719bSwdenk dnsip - IP address of your Domain Name Server 5402fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 5403c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 5404c609719bSwdenk hostname - Target hostname 5405c609719bSwdenk ipaddr - see above 5406c609719bSwdenk netmask - Subnet Mask 5407c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 5408c609719bSwdenk serverip - see above 5409c609719bSwdenk 5410c609719bSwdenk 5411c609719bSwdenkThere are two special Environment Variables: 5412c609719bSwdenk 5413c609719bSwdenk serial# - contains hardware identification information such 5414c609719bSwdenk as type string and/or serial number 5415c609719bSwdenk ethaddr - Ethernet address 5416c609719bSwdenk 5417c609719bSwdenkThese variables can be set only once (usually during manufacturing of 5418c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 5419c609719bSwdenkonce they have been set once. 5420c609719bSwdenk 5421c609719bSwdenk 5422c1551ea8SstroeseFurther special Environment Variables: 5423c1551ea8Sstroese 5424c1551ea8Sstroese ver - Contains the U-Boot version string as printed 5425c1551ea8Sstroese with the "version" command. This variable is 5426c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 5427c1551ea8Sstroese 5428c1551ea8Sstroese 5429c609719bSwdenkPlease note that changes to some configuration parameters may take 5430c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 5431c609719bSwdenk 5432c609719bSwdenk 5433170ab110SJoe HershbergerCallback functions for environment variables: 5434170ab110SJoe Hershberger--------------------------------------------- 5435170ab110SJoe Hershberger 5436170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 5437b445bbb4SJeremiah Mahlerwhen their values are changed. This functionality allows functions to 5438170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 5439170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 5440170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 5441170ab110SJoe Hershberger 5442170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 5443170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 5444170ab110SJoe Hershberger 5445170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 5446170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 5447170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 5448170ab110SJoe Hershbergerassociations. The list must be in the following format: 5449170ab110SJoe Hershberger 5450170ab110SJoe Hershberger entry = variable_name[:callback_name] 5451170ab110SJoe Hershberger list = entry[,list] 5452170ab110SJoe Hershberger 5453170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 5454170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 5455170ab110SJoe Hershberger 5456170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 5457170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 5458170ab110SJoe Hershbergeroverride any association in the static list. You can define 5459170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 5460b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment. 5461170ab110SJoe Hershberger 5462bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a 5463bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to 5464bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out. 5465bdf1fe4eSJoe Hershberger 5466170ab110SJoe Hershberger 5467f07771ccSwdenkCommand Line Parsing: 5468f07771ccSwdenk===================== 5469f07771ccSwdenk 5470f07771ccSwdenkThere are two different command line parsers available with U-Boot: 54717152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 5472f07771ccSwdenk 5473f07771ccSwdenkOld, simple command line parser: 5474f07771ccSwdenk-------------------------------- 5475f07771ccSwdenk 5476f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 5477f07771ccSwdenk- several commands on one line, separated by ';' 5478fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 5479f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 5480f07771ccSwdenk for example: 5481fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 5482f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 5483f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 5484f07771ccSwdenk 5485f07771ccSwdenkHush shell: 5486f07771ccSwdenk----------- 5487f07771ccSwdenk 5488f07771ccSwdenk- similar to Bourne shell, with control structures like 5489f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 5490f07771ccSwdenk until...do...done, ... 5491f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 5492f07771ccSwdenk commands) and local shell variables (through standard shell syntax 5493f07771ccSwdenk "name=value"); only environment variables can be used with "run" 5494f07771ccSwdenk command 5495f07771ccSwdenk 5496f07771ccSwdenkGeneral rules: 5497f07771ccSwdenk-------------- 5498f07771ccSwdenk 5499f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 5500f07771ccSwdenk command) contains several commands separated by semicolon, and 5501f07771ccSwdenk one of these commands fails, then the remaining commands will be 5502f07771ccSwdenk executed anyway. 5503f07771ccSwdenk 5504f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 550511ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 5506f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 5507f07771ccSwdenk variables are not executed. 5508f07771ccSwdenk 5509c609719bSwdenkNote for Redundant Ethernet Interfaces: 5510c609719bSwdenk======================================= 5511c609719bSwdenk 551211ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 5513c609719bSwdenksuch configurations and is capable of automatic selection of a 55147152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 5515c609719bSwdenk 5516c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 5517c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5518c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 5519c609719bSwdenk 5520c609719bSwdenkIf the network interface stores some valid MAC address (for instance 5521c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 5522c609719bSwdenkding setting in the environment; if the corresponding environment 5523c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 5524c609719bSwdenk 5525c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 5526c609719bSwdenk environment, the SROM's address is used. 5527c609719bSwdenk 5528c609719bSwdenko If there is no valid address in the SROM, and a definition in the 5529c609719bSwdenk environment exists, then the value from the environment variable is 5530c609719bSwdenk used. 5531c609719bSwdenk 5532c609719bSwdenko If both the SROM and the environment contain a MAC address, and 5533c609719bSwdenk both addresses are the same, this MAC address is used. 5534c609719bSwdenk 5535c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 5536c609719bSwdenk addresses differ, the value from the environment is used and a 5537c609719bSwdenk warning is printed. 5538c609719bSwdenk 5539c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 5540bef1014bSJoe Hershberger is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case 5541bef1014bSJoe Hershberger a random, locally-assigned MAC is used. 5542c609719bSwdenk 5543ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5544ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 5545ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 5546ecee9324SBen WarrenThe naming convention is as follows: 5547ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5548c609719bSwdenk 5549c609719bSwdenkImage Formats: 5550c609719bSwdenk============== 5551c609719bSwdenk 55523310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 55533310c549SMarian Balakowiczimages in two formats: 55543310c549SMarian Balakowicz 55553310c549SMarian BalakowiczNew uImage format (FIT) 55563310c549SMarian Balakowicz----------------------- 55573310c549SMarian Balakowicz 55583310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 55593310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 55603310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 55613310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 55623310c549SMarian Balakowicz 55633310c549SMarian Balakowicz 55643310c549SMarian BalakowiczOld uImage format 55653310c549SMarian Balakowicz----------------- 55663310c549SMarian Balakowicz 55673310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 55683310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 55693310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 5570c609719bSwdenk 5571c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5572c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5573f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5574f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5575f5ed9e39SPeter Tyser INTEGRITY). 55767b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5577afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5578afc1ce82SMacpaul Lin Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5579c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 5580c609719bSwdenk* Load Address 5581c609719bSwdenk* Entry Point 5582c609719bSwdenk* Image Name 5583c609719bSwdenk* Image Timestamp 5584c609719bSwdenk 5585c609719bSwdenkThe header is marked by a special Magic Number, and both the header 5586c609719bSwdenkand the data portions of the image are secured against corruption by 5587c609719bSwdenkCRC32 checksums. 5588c609719bSwdenk 5589c609719bSwdenk 5590c609719bSwdenkLinux Support: 5591c609719bSwdenk============== 5592c609719bSwdenk 5593c609719bSwdenkAlthough U-Boot should support any OS or standalone application 55947152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 5595c609719bSwdenkU-Boot. 5596c609719bSwdenk 5597c609719bSwdenkU-Boot includes many features that so far have been part of some 5598c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 5599c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 5600c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 56017152b1d0Swdenkserves several purposes: 5602c609719bSwdenk 5603c609719bSwdenk- the same features can be used for other OS or standalone 5604c609719bSwdenk applications (for instance: using compressed images to reduce the 5605c609719bSwdenk Flash memory footprint) 5606c609719bSwdenk 5607c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 56087152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 5609c609719bSwdenk 5610c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 5611c609719bSwdenk images; of course this also means that different kernel images can 5612c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 5613c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 5614c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 5615c609719bSwdenk software is easier now. 5616c609719bSwdenk 5617c609719bSwdenk 5618c609719bSwdenkLinux HOWTO: 5619c609719bSwdenk============ 5620c609719bSwdenk 5621c609719bSwdenkPorting Linux to U-Boot based systems: 5622c609719bSwdenk--------------------------------------- 5623c609719bSwdenk 5624c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 5625c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 5626c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 5627c609719bSwdenkLinux :-). 5628c609719bSwdenk 5629a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5630c609719bSwdenk 5631c609719bSwdenkJust make sure your machine specific header file (for instance 5632c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 56331dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 56341dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 56356d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 5636c609719bSwdenk 56372eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers. 56382eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there 56392eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See 56402eb31b13SSimon Glassdoc/driver-model. 56412eb31b13SSimon Glass 5642c609719bSwdenk 5643c609719bSwdenkConfiguring the Linux kernel: 5644c609719bSwdenk----------------------------- 5645c609719bSwdenk 5646c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 5647c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 5648c609719bSwdenk 5649c609719bSwdenk 5650c609719bSwdenkBuilding a Linux Image: 5651c609719bSwdenk----------------------- 5652c609719bSwdenk 565324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 565424ee89b9Swdenknot used. If you use recent kernel source, a new build target 565524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 565624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 565724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 565824ee89b9Swdenk100% compatible format. 5659c609719bSwdenk 5660c609719bSwdenkExample: 5661c609719bSwdenk 5662ab584d67SHolger Freyther make TQM850L_defconfig 5663c609719bSwdenk make oldconfig 5664c609719bSwdenk make dep 566524ee89b9Swdenk make uImage 5666c609719bSwdenk 566724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 566824ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 566924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 5670c609719bSwdenk 567124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 567224ee89b9Swdenk 567324ee89b9Swdenk* convert the kernel into a raw binary image: 567424ee89b9Swdenk 567524ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 567624ee89b9Swdenk -R .note -R .comment \ 567724ee89b9Swdenk -S vmlinux linux.bin 567824ee89b9Swdenk 567924ee89b9Swdenk* compress the binary image: 568024ee89b9Swdenk 568124ee89b9Swdenk gzip -9 linux.bin 568224ee89b9Swdenk 568324ee89b9Swdenk* package compressed binary image for U-Boot: 568424ee89b9Swdenk 568524ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 568624ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 568724ee89b9Swdenk -d linux.bin.gz uImage 568824ee89b9Swdenk 568924ee89b9Swdenk 569024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 569124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 569224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 569324ee89b9Swdenkbyte header containing information about target architecture, 569424ee89b9Swdenkoperating system, image type, compression method, entry points, time 569524ee89b9Swdenkstamp, CRC32 checksums, etc. 569624ee89b9Swdenk 569724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 569824ee89b9Swdenkprint the header information, or to build new images. 5699c609719bSwdenk 5700c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 5701c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 5702c609719bSwdenkchecksum verification: 5703c609719bSwdenk 5704c609719bSwdenk tools/mkimage -l image 5705c609719bSwdenk -l ==> list image header information 5706c609719bSwdenk 5707c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 5708c609719bSwdenkfrom a "data file" which is used as image payload: 5709c609719bSwdenk 5710c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5711c609719bSwdenk -n name -d data_file image 5712c609719bSwdenk -A ==> set architecture to 'arch' 5713c609719bSwdenk -O ==> set operating system to 'os' 5714c609719bSwdenk -T ==> set image type to 'type' 5715c609719bSwdenk -C ==> set compression type 'comp' 5716c609719bSwdenk -a ==> set load address to 'addr' (hex) 5717c609719bSwdenk -e ==> set entry point to 'ep' (hex) 5718c609719bSwdenk -n ==> set image name to 'name' 5719c609719bSwdenk -d ==> use image data from 'datafile' 5720c609719bSwdenk 572169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 572269459791Swdenkaddress (0x00000000), but the entry point address depends on the 572369459791Swdenkkernel version: 5724c609719bSwdenk 5725c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 572624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 5727c609719bSwdenk 5728c609719bSwdenkSo a typical call to build a U-Boot image would read: 5729c609719bSwdenk 573024ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 573124ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5732a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 573324ee89b9Swdenk > examples/uImage.TQM850L 573424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5735c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5736c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5737c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5738c609719bSwdenk Load Address: 0x00000000 573924ee89b9Swdenk Entry Point: 0x00000000 5740c609719bSwdenk 5741c609719bSwdenkTo verify the contents of the image (or check for corruption): 5742c609719bSwdenk 574324ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 574424ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5745c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5746c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5747c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5748c609719bSwdenk Load Address: 0x00000000 574924ee89b9Swdenk Entry Point: 0x00000000 5750c609719bSwdenk 5751c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 5752c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 5753c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 5754c609719bSwdenkneed to be uncompressed: 5755c609719bSwdenk 5756a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 575724ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 575824ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5759a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 576024ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 576124ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 5762c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 5763c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 5764c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5765c609719bSwdenk Load Address: 0x00000000 576624ee89b9Swdenk Entry Point: 0x00000000 5767c609719bSwdenk 5768c609719bSwdenk 5769c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 5770c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 5771c609719bSwdenk 5772c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 5773c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 5774c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5775c609719bSwdenk Image Name: Simple Ramdisk Image 5776c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 5777c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5778c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5779c609719bSwdenk Load Address: 0x00000000 5780c609719bSwdenk Entry Point: 0x00000000 5781c609719bSwdenk 5782a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5783a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 5784a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 5785a804b5ceSGuilherme Maciel Ferreirafrom the image: 5786a804b5ceSGuilherme Maciel Ferreira 5787f41f5b7cSGuilherme Maciel Ferreira tools/dumpimage -i image -T type -p position data_file 5788f41f5b7cSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file' 5789f41f5b7cSGuilherme Maciel Ferreira -T ==> set image type to 'type' 5790f41f5b7cSGuilherme Maciel Ferreira -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' 5791a804b5ceSGuilherme Maciel Ferreira 5792c609719bSwdenk 5793c609719bSwdenkInstalling a Linux Image: 5794c609719bSwdenk------------------------- 5795c609719bSwdenk 5796c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 5797c609719bSwdenkyou must convert the image to S-Record format: 5798c609719bSwdenk 5799c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 5800c609719bSwdenk 5801c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 5802c609719bSwdenkimage header, so the resulting S-Record file will be relative to 5803c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 5804c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 5805c609719bSwdenkcommand. 5806c609719bSwdenk 5807c609719bSwdenkExample: install the image to address 0x40100000 (which on the 5808c609719bSwdenkTQM8xxL is in the first Flash bank): 5809c609719bSwdenk 5810c609719bSwdenk => erase 40100000 401FFFFF 5811c609719bSwdenk 5812c609719bSwdenk .......... done 5813c609719bSwdenk Erased 8 sectors 5814c609719bSwdenk 5815c609719bSwdenk => loads 40100000 5816c609719bSwdenk ## Ready for S-Record download ... 5817c609719bSwdenk ~>examples/image.srec 5818c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5819c609719bSwdenk ... 5820c609719bSwdenk 15989 15990 15991 15992 5821c609719bSwdenk [file transfer complete] 5822c609719bSwdenk [connected] 5823c609719bSwdenk ## Start Addr = 0x00000000 5824c609719bSwdenk 5825c609719bSwdenk 5826c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 5827c609719bSwdenkthis includes a checksum verification so you can be sure no data 5828c609719bSwdenkcorruption happened: 5829c609719bSwdenk 5830c609719bSwdenk => imi 40100000 5831c609719bSwdenk 5832c609719bSwdenk ## Checking Image at 40100000 ... 5833c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5834c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5835c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5836c609719bSwdenk Load Address: 00000000 5837c609719bSwdenk Entry Point: 0000000c 5838c609719bSwdenk Verifying Checksum ... OK 5839c609719bSwdenk 5840c609719bSwdenk 5841c609719bSwdenkBoot Linux: 5842c609719bSwdenk----------- 5843c609719bSwdenk 5844c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 5845c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 5846c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 5847c609719bSwdenkparameters. You can check and modify this variable using the 5848c609719bSwdenk"printenv" and "setenv" commands: 5849c609719bSwdenk 5850c609719bSwdenk 5851c609719bSwdenk => printenv bootargs 5852c609719bSwdenk bootargs=root=/dev/ram 5853c609719bSwdenk 5854c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5855c609719bSwdenk 5856c609719bSwdenk => printenv bootargs 5857c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5858c609719bSwdenk 5859c609719bSwdenk => bootm 40020000 5860c609719bSwdenk ## Booting Linux kernel at 40020000 ... 5861c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 5862c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5863c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 5864c609719bSwdenk Load Address: 00000000 5865c609719bSwdenk Entry Point: 0000000c 5866c609719bSwdenk Verifying Checksum ... OK 5867c609719bSwdenk Uncompressing Kernel Image ... OK 5868c609719bSwdenk 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 5869c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5870c609719bSwdenk time_init: decrementer frequency = 187500000/60 5871c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5872c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5873c609719bSwdenk ... 5874c609719bSwdenk 587511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 58767152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 5877c609719bSwdenkformat!) to the "bootm" command: 5878c609719bSwdenk 5879c609719bSwdenk => imi 40100000 40200000 5880c609719bSwdenk 5881c609719bSwdenk ## Checking Image at 40100000 ... 5882c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5883c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5884c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5885c609719bSwdenk Load Address: 00000000 5886c609719bSwdenk Entry Point: 0000000c 5887c609719bSwdenk Verifying Checksum ... OK 5888c609719bSwdenk 5889c609719bSwdenk ## Checking Image at 40200000 ... 5890c609719bSwdenk Image Name: Simple Ramdisk Image 5891c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5892c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5893c609719bSwdenk Load Address: 00000000 5894c609719bSwdenk Entry Point: 00000000 5895c609719bSwdenk Verifying Checksum ... OK 5896c609719bSwdenk 5897c609719bSwdenk => bootm 40100000 40200000 5898c609719bSwdenk ## Booting Linux kernel at 40100000 ... 5899c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 5900c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 5901c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 5902c609719bSwdenk Load Address: 00000000 5903c609719bSwdenk Entry Point: 0000000c 5904c609719bSwdenk Verifying Checksum ... OK 5905c609719bSwdenk Uncompressing Kernel Image ... OK 5906c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 5907c609719bSwdenk Image Name: Simple Ramdisk Image 5908c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5909c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 5910c609719bSwdenk Load Address: 00000000 5911c609719bSwdenk Entry Point: 00000000 5912c609719bSwdenk Verifying Checksum ... OK 5913c609719bSwdenk Loading Ramdisk ... OK 5914c609719bSwdenk 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 5915c609719bSwdenk Boot arguments: root=/dev/ram 5916c609719bSwdenk time_init: decrementer frequency = 187500000/60 5917c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 5918c609719bSwdenk ... 5919c609719bSwdenk RAMDISK: Compressed image found at block 0 5920c609719bSwdenk VFS: Mounted root (ext2 filesystem). 5921c609719bSwdenk 5922c609719bSwdenk bash# 5923c609719bSwdenk 59240267768eSMatthew McClintockBoot Linux and pass a flat device tree: 59250267768eSMatthew McClintock----------- 59260267768eSMatthew McClintock 59270267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 59280267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 59290267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 59300267768eSMatthew McClintockflat device tree: 59310267768eSMatthew McClintock 59320267768eSMatthew McClintock=> print oftaddr 59330267768eSMatthew McClintockoftaddr=0x300000 59340267768eSMatthew McClintock=> print oft 59350267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 59360267768eSMatthew McClintock=> tftp $oftaddr $oft 59370267768eSMatthew McClintockSpeed: 1000, full duplex 59380267768eSMatthew McClintockUsing TSEC0 device 59390267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 59400267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 59410267768eSMatthew McClintockLoad address: 0x300000 59420267768eSMatthew McClintockLoading: # 59430267768eSMatthew McClintockdone 59440267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 59450267768eSMatthew McClintock=> tftp $loadaddr $bootfile 59460267768eSMatthew McClintockSpeed: 1000, full duplex 59470267768eSMatthew McClintockUsing TSEC0 device 59480267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 59490267768eSMatthew McClintockFilename 'uImage'. 59500267768eSMatthew McClintockLoad address: 0x200000 59510267768eSMatthew McClintockLoading:############ 59520267768eSMatthew McClintockdone 59530267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 59540267768eSMatthew McClintock=> print loadaddr 59550267768eSMatthew McClintockloadaddr=200000 59560267768eSMatthew McClintock=> print oftaddr 59570267768eSMatthew McClintockoftaddr=0x300000 59580267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 59590267768eSMatthew McClintock## Booting image at 00200000 ... 59600267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 59610267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 59620267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 59630267768eSMatthew McClintock Load Address: 00000000 59640267768eSMatthew McClintock Entry Point: 00000000 59650267768eSMatthew McClintock Verifying Checksum ... OK 59660267768eSMatthew McClintock Uncompressing Kernel Image ... OK 59670267768eSMatthew McClintockBooting using flat device tree at 0x300000 59680267768eSMatthew McClintockUsing MPC85xx ADS machine description 59690267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 59700267768eSMatthew McClintock[snip] 59710267768eSMatthew McClintock 59720267768eSMatthew McClintock 59736069ff26SwdenkMore About U-Boot Image Types: 59746069ff26Swdenk------------------------------ 59756069ff26Swdenk 59766069ff26SwdenkU-Boot supports the following image types: 59776069ff26Swdenk 59786069ff26Swdenk "Standalone Programs" are directly runnable in the environment 59796069ff26Swdenk provided by U-Boot; it is expected that (if they behave 59806069ff26Swdenk well) you can continue to work in U-Boot after return from 59816069ff26Swdenk the Standalone Program. 59826069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 59836069ff26Swdenk will take over control completely. Usually these programs 59846069ff26Swdenk will install their own set of exception handlers, device 59856069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 59866069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 59876069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 59886069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 59896069ff26Swdenk being started. 59906069ff26Swdenk "Multi-File Images" contain several images, typically an OS 59916069ff26Swdenk (Linux) kernel image and one or more data images like 59926069ff26Swdenk RAMDisks. This construct is useful for instance when you want 59936069ff26Swdenk to boot over the network using BOOTP etc., where the boot 59946069ff26Swdenk server provides just a single image file, but you want to get 59956069ff26Swdenk for instance an OS kernel and a RAMDisk image. 59966069ff26Swdenk 59976069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 59986069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 59996069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 60006069ff26Swdenk Immediately after the terminating 0 follow the images, one by 60016069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 60026069ff26Swdenk a multiple of 4 bytes). 60036069ff26Swdenk 60046069ff26Swdenk "Firmware Images" are binary images containing firmware (like 60056069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 60066069ff26Swdenk flash memory. 60076069ff26Swdenk 60086069ff26Swdenk "Script files" are command sequences that will be executed by 60096069ff26Swdenk U-Boot's command interpreter; this feature is especially 60106069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 60116069ff26Swdenk as command interpreter. 60126069ff26Swdenk 601344f074c7SMarek VasutBooting the Linux zImage: 601444f074c7SMarek Vasut------------------------- 601544f074c7SMarek Vasut 601644f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 601744f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 601844f074c7SMarek Vasutas the syntax of "bootm" command. 601944f074c7SMarek Vasut 60208ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 6021017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 6022017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 6023017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 6024017e1f3fSMarek Vasut 6025c609719bSwdenk 6026c609719bSwdenkStandalone HOWTO: 6027c609719bSwdenk================= 6028c609719bSwdenk 6029c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 6030c609719bSwdenkrun "standalone" applications, which can use some resources of 6031c609719bSwdenkU-Boot like console I/O functions or interrupt services. 6032c609719bSwdenk 6033c609719bSwdenkTwo simple examples are included with the sources: 6034c609719bSwdenk 6035c609719bSwdenk"Hello World" Demo: 6036c609719bSwdenk------------------- 6037c609719bSwdenk 6038c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 6039c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 6040c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 6041c609719bSwdenklike that: 6042c609719bSwdenk 6043c609719bSwdenk => loads 6044c609719bSwdenk ## Ready for S-Record download ... 6045c609719bSwdenk ~>examples/hello_world.srec 6046c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 6047c609719bSwdenk [file transfer complete] 6048c609719bSwdenk [connected] 6049c609719bSwdenk ## Start Addr = 0x00040004 6050c609719bSwdenk 6051c609719bSwdenk => go 40004 Hello World! This is a test. 6052c609719bSwdenk ## Starting application at 0x00040004 ... 6053c609719bSwdenk Hello World 6054c609719bSwdenk argc = 7 6055c609719bSwdenk argv[0] = "40004" 6056c609719bSwdenk argv[1] = "Hello" 6057c609719bSwdenk argv[2] = "World!" 6058c609719bSwdenk argv[3] = "This" 6059c609719bSwdenk argv[4] = "is" 6060c609719bSwdenk argv[5] = "a" 6061c609719bSwdenk argv[6] = "test." 6062c609719bSwdenk argv[7] = "<NULL>" 6063c609719bSwdenk Hit any key to exit ... 6064c609719bSwdenk 6065c609719bSwdenk ## Application terminated, rc = 0x0 6066c609719bSwdenk 6067c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 6068c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 6069c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 6070c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 6071c609719bSwdenkcharacter, but this is just a demo program. The application can be 6072c609719bSwdenkcontrolled by the following keys: 6073c609719bSwdenk 6074c609719bSwdenk ? - print current values og the CPM Timer registers 6075c609719bSwdenk b - enable interrupts and start timer 6076c609719bSwdenk e - stop timer and disable interrupts 6077c609719bSwdenk q - quit application 6078c609719bSwdenk 6079c609719bSwdenk => loads 6080c609719bSwdenk ## Ready for S-Record download ... 6081c609719bSwdenk ~>examples/timer.srec 6082c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 6083c609719bSwdenk [file transfer complete] 6084c609719bSwdenk [connected] 6085c609719bSwdenk ## Start Addr = 0x00040004 6086c609719bSwdenk 6087c609719bSwdenk => go 40004 6088c609719bSwdenk ## Starting application at 0x00040004 ... 6089c609719bSwdenk TIMERS=0xfff00980 6090c609719bSwdenk Using timer 1 6091c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 6092c609719bSwdenk 6093c609719bSwdenkHit 'b': 6094c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 6095c609719bSwdenk Enabling timer 6096c609719bSwdenkHit '?': 6097c609719bSwdenk [q, b, e, ?] ........ 6098c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 6099c609719bSwdenkHit '?': 6100c609719bSwdenk [q, b, e, ?] . 6101c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 6102c609719bSwdenkHit '?': 6103c609719bSwdenk [q, b, e, ?] . 6104c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 6105c609719bSwdenkHit '?': 6106c609719bSwdenk [q, b, e, ?] . 6107c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 6108c609719bSwdenkHit 'e': 6109c609719bSwdenk [q, b, e, ?] ...Stopping timer 6110c609719bSwdenkHit 'q': 6111c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 6112c609719bSwdenk 6113c609719bSwdenk 611485ec0bccSwdenkMinicom warning: 611585ec0bccSwdenk================ 611685ec0bccSwdenk 61177152b1d0SwdenkOver time, many people have reported problems when trying to use the 611885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 611985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 6120f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 612185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 6122e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 6123e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 6124e53515a2SKarl O. Pincfor help with kermit. 6125e53515a2SKarl O. Pinc 612685ec0bccSwdenk 612752f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 612852f52c14Swdenkconfiguration to your "File transfer protocols" section: 612952f52c14Swdenk 613052f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 613152f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 613252f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 613352f52c14Swdenk 613452f52c14Swdenk 6135c609719bSwdenkNetBSD Notes: 6136c609719bSwdenk============= 6137c609719bSwdenk 6138c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 6139c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 6140c609719bSwdenk 6141c609719bSwdenkBuilding requires a cross environment; it is known to work on 6142c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 6143c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 6144c609719bSwdenkNote that the cross-powerpc package does not install include files; 6145c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 6146c609719bSwdenkmissing. This file has to be installed and patched manually: 6147c609719bSwdenk 6148c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 6149c609719bSwdenk # mkdir powerpc 6150c609719bSwdenk # ln -s powerpc machine 6151c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 6152c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 6153c609719bSwdenk 6154c609719bSwdenkNative builds *don't* work due to incompatibilities between native 6155c609719bSwdenkand U-Boot include files. 6156c609719bSwdenk 6157c609719bSwdenkBooting assumes that (the first part of) the image booted is a 6158c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 6159c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 6160c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 61612a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 6162c609719bSwdenk 6163c609719bSwdenk 6164c609719bSwdenkImplementation Internals: 6165c609719bSwdenk========================= 6166c609719bSwdenk 6167c609719bSwdenkThe following is not intended to be a complete description of every 6168c609719bSwdenkimplementation detail. However, it should help to understand the 6169c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 6170c609719bSwdenkhardware. 6171c609719bSwdenk 6172c609719bSwdenk 6173c609719bSwdenkInitial Stack, Global Data: 6174c609719bSwdenk--------------------------- 6175c609719bSwdenk 6176c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 6177c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 6178c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 6179c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 6180c609719bSwdenkis not initialized as zero. To be able to get a C environment working 6181c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 6182c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 6183c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 6184c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 6185c609719bSwdenklocked as (mis-) used as memory, etc. 6186c609719bSwdenk 61877152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 61880668236bSWolfgang Denk U-Boot mailing list: 618943d9616cSwdenk 619043d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 619143d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 619243d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 619343d9616cSwdenk ... 619443d9616cSwdenk 619543d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 619643d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 619743d9616cSwdenk require any physical RAM backing up the cache. The cleverness 619843d9616cSwdenk is that the cache is being used as a temporary supply of 619943d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 620011ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 620143d9616cSwdenk can see how this works by studying the cache architecture and 620243d9616cSwdenk operation in the architecture and processor-specific manuals. 620343d9616cSwdenk 620443d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 620543d9616cSwdenk is another option for the system designer to use as an 620611ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 620743d9616cSwdenk option should work for you. Using CS 4 should be fine if your 620843d9616cSwdenk board designers haven't used it for something that would 620943d9616cSwdenk cause you grief during the initial boot! It is frequently not 621043d9616cSwdenk used. 621143d9616cSwdenk 62126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 621343d9616cSwdenk with your processor/board/system design. The default value 621443d9616cSwdenk you will find in any recent u-boot distribution in 62158a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 621643d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 621743d9616cSwdenk it above 400_0000. Just make sure your board has no resources 621843d9616cSwdenk that are supposed to respond to that address! That code in 621943d9616cSwdenk start.S has been around a while and should work as is when 622043d9616cSwdenk you get the config right. 622143d9616cSwdenk 622243d9616cSwdenk -Chris Hallinan 622343d9616cSwdenk DS4.COM, Inc. 622443d9616cSwdenk 6225c609719bSwdenkIt is essential to remember this, since it has some impact on the C 6226c609719bSwdenkcode for the initialization procedures: 6227c609719bSwdenk 6228c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 6229c609719bSwdenk to write it. 6230c609719bSwdenk 6231b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized 6232c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 62337152b1d0Swdenk zation is performed later (when relocating to RAM). 6234c609719bSwdenk 6235c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 6236c609719bSwdenk that. 6237c609719bSwdenk 6238c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 6239b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it 6240c609719bSwdenkturned out that the implementation of U-Boot can be greatly 6241c609719bSwdenksimplified by making a global data structure (gd_t) available to all 6242c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 6243c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 6244c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 6245c609719bSwdenkplace a pointer (gd) to the global data into a register which we 6246c609719bSwdenkreserve for this purpose. 6247c609719bSwdenk 62487152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 6249c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 6250c609719bSwdenkGCC's implementation. 6251c609719bSwdenk 6252c609719bSwdenkFor PowerPC, the following registers have specific use: 6253c609719bSwdenk R1: stack pointer 6254e7670f6cSWolfgang Denk R2: reserved for system use 6255c609719bSwdenk R3-R4: parameter passing and return values 6256c609719bSwdenk R5-R10: parameter passing 6257c609719bSwdenk R13: small data area pointer 6258c609719bSwdenk R30: GOT pointer 6259c609719bSwdenk R31: frame pointer 6260c609719bSwdenk 6261e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 6262e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 6263e6bee808SJoakim Tjernlund going back and forth between asm and C) 6264c609719bSwdenk 6265e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 6266c609719bSwdenk 6267c609719bSwdenk Note: on PPC, we could use a static initializer (since the 6268c609719bSwdenk address of the global data structure is known at compile time), 6269c609719bSwdenk but it turned out that reserving a register results in somewhat 6270c609719bSwdenk smaller code - although the code savings are not that big (on 6271c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 6272c609719bSwdenk 624 text + 127 data). 6273c609719bSwdenk 6274c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here: 62754c58eb55SMike Frysinger http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 62764c58eb55SMike Frysinger 6277c4db335cSRobin Getz ==> U-Boot will use P3 to hold a pointer to the global data 62784c58eb55SMike Frysinger 6279c609719bSwdenkOn ARM, the following registers are used: 6280c609719bSwdenk 6281c609719bSwdenk R0: function argument word/integer result 6282c609719bSwdenk R1-R3: function argument word 628312eba1b4SJeroen Hofstee R9: platform specific 628412eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 6285c609719bSwdenk R11: argument (frame) pointer 6286c609719bSwdenk R12: temporary workspace 6287c609719bSwdenk R13: stack pointer 6288c609719bSwdenk R14: link register 6289c609719bSwdenk R15: program counter 6290c609719bSwdenk 629112eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 629212eba1b4SJeroen Hofstee 629312eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 6294c609719bSwdenk 62950df01fd3SThomas ChouOn Nios II, the ABI is documented here: 62960df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 62970df01fd3SThomas Chou 62980df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 62990df01fd3SThomas Chou 63000df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 63010df01fd3SThomas Chou to access small data sections, so gp is free. 63020df01fd3SThomas Chou 6303afc1ce82SMacpaul LinOn NDS32, the following registers are used: 6304afc1ce82SMacpaul Lin 6305afc1ce82SMacpaul Lin R0-R1: argument/return 6306afc1ce82SMacpaul Lin R2-R5: argument 6307afc1ce82SMacpaul Lin R15: temporary register for assembler 6308afc1ce82SMacpaul Lin R16: trampoline register 6309afc1ce82SMacpaul Lin R28: frame pointer (FP) 6310afc1ce82SMacpaul Lin R29: global pointer (GP) 6311afc1ce82SMacpaul Lin R30: link register (LP) 6312afc1ce82SMacpaul Lin R31: stack pointer (SP) 6313afc1ce82SMacpaul Lin PC: program counter (PC) 6314afc1ce82SMacpaul Lin 6315afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 6316afc1ce82SMacpaul Lin 6317d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 6318d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 6319c609719bSwdenk 6320c609719bSwdenkMemory Management: 6321c609719bSwdenk------------------ 6322c609719bSwdenk 6323c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 6324c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 6325c609719bSwdenk 6326c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 6327c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 6328c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 6329c609719bSwdenkphysical memory banks. 6330c609719bSwdenk 6331c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 6332c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 6333c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 6334c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 63356d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 6336c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 6337c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 6338c609719bSwdenk 6339c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 6340c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 6341c609719bSwdenk 6342c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 6343c609719bSwdenkthis: 6344c609719bSwdenk 6345c609719bSwdenk 0x0000 0000 Exception Vector code 6346c609719bSwdenk : 6347c609719bSwdenk 0x0000 1FFF 6348c609719bSwdenk 0x0000 2000 Free for Application Use 6349c609719bSwdenk : 6350c609719bSwdenk : 6351c609719bSwdenk 6352c609719bSwdenk : 6353c609719bSwdenk : 6354c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 6355c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 6356c609719bSwdenk 0x00FC 0000 Malloc Arena 6357c609719bSwdenk : 6358c609719bSwdenk 0x00FD FFFF 6359c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 6360c609719bSwdenk ... eventually: LCD or video framebuffer 6361c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 6362c609719bSwdenk 0x00FF FFFF [End of RAM] 6363c609719bSwdenk 6364c609719bSwdenk 6365c609719bSwdenkSystem Initialization: 6366c609719bSwdenk---------------------- 6367c609719bSwdenk 6368c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 636911ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 6370c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory. 63717152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 6372c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 6373c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 6374c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked 6375c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core, 6376c609719bSwdenkthe caches and the SIU. 6377c609719bSwdenk 6378c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 6379c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 6380c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 6381c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 6382c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 6383c609719bSwdenksimple memory test is run that determines the size of the SDRAM 6384c609719bSwdenkbanks. 6385c609719bSwdenk 6386c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 63877152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 6388c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 6389c609719bSwdenk0x00000000, with any additional banks following immediately to create 6390c609719bSwdenkcontiguous memory starting from 0. 6391c609719bSwdenk 6392c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 6393c609719bSwdenkand allocates memory for use by malloc() and for the global Board 6394c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 6395c609719bSwdenkpages, and the final stack is set up. 6396c609719bSwdenk 6397c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 6398c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 6399c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 6400c609719bSwdenknew address in RAM. 6401c609719bSwdenk 6402c609719bSwdenk 6403c609719bSwdenkU-Boot Porting Guide: 6404c609719bSwdenk---------------------- 6405c609719bSwdenk 6406c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 64076aff3115Swdenklist, October 2002] 6408c609719bSwdenk 6409c609719bSwdenk 6410c609719bSwdenkint main(int argc, char *argv[]) 6411c609719bSwdenk{ 6412c609719bSwdenk sighandler_t no_more_time; 6413c609719bSwdenk 6414c609719bSwdenk signal(SIGALRM, no_more_time); 6415c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 6416c609719bSwdenk 6417c609719bSwdenk if (available_money > available_manpower) { 64186c3fef28SJerry Van Baren Pay consultant to port U-Boot; 6419c609719bSwdenk return 0; 6420c609719bSwdenk } 6421c609719bSwdenk 6422c609719bSwdenk Download latest U-Boot source; 6423c609719bSwdenk 64240668236bSWolfgang Denk Subscribe to u-boot mailing list; 64256aff3115Swdenk 64266c3fef28SJerry Van Baren if (clueless) 6427c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 6428c609719bSwdenk 6429c609719bSwdenk while (learning) { 6430c609719bSwdenk Read the README file in the top level directory; 64317cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 64326c3fef28SJerry Van Baren Read applicable doc/*.README; 6433c609719bSwdenk Read the source, Luke; 64346c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 6435c609719bSwdenk } 6436c609719bSwdenk 64376c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 64386c3fef28SJerry Van Baren Buy a BDI3000; 64396c3fef28SJerry Van Baren else 6440c609719bSwdenk Add a lot of aggravation and time; 6441c609719bSwdenk 64426c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 64436c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 64446c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 64456c3fef28SJerry Van Baren } else { 6446c609719bSwdenk Create your own board support subdirectory; 64476c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 64486c3fef28SJerry Van Baren } 64496c3fef28SJerry Van Baren Edit new board/<myboard> files 64506c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 6451c609719bSwdenk 64526c3fef28SJerry Van Baren while (!accepted) { 6453c609719bSwdenk while (!running) { 6454c609719bSwdenk do { 6455c609719bSwdenk Add / modify source code; 6456c609719bSwdenk } until (compiles); 6457c609719bSwdenk Debug; 6458c609719bSwdenk if (clueless) 6459c609719bSwdenk email("Hi, I am having problems..."); 6460c609719bSwdenk } 64616c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 64626c3fef28SJerry Van Baren if (reasonable critiques) 64636c3fef28SJerry Van Baren Incorporate improvements from email list code review; 64646c3fef28SJerry Van Baren else 64656c3fef28SJerry Van Baren Defend code as written; 64666c3fef28SJerry Van Baren } 6467c609719bSwdenk 6468c609719bSwdenk return 0; 6469c609719bSwdenk} 6470c609719bSwdenk 6471c609719bSwdenkvoid no_more_time (int sig) 6472c609719bSwdenk{ 6473c609719bSwdenk hire_a_guru(); 6474c609719bSwdenk} 6475c609719bSwdenk 6476c609719bSwdenk 6477c609719bSwdenkCoding Standards: 6478c609719bSwdenk----------------- 6479c609719bSwdenk 6480c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 64812c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script 64827ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory. 6483c609719bSwdenk 64842c051651SDetlev ZundelSource files originating from a different project (for example the 64852c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 6486b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those 64872c051651SDetlev Zundelsources. 64882c051651SDetlev Zundel 64892c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 64902c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 64912c051651SDetlev Zundelin your code. 6492c609719bSwdenk 6493c178d3daSwdenkPlease also stick to the following formatting rules: 6494180d3f74Swdenk- remove any trailing white space 64957ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 6496180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 64977ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 6498180d3f74Swdenk- do not add trailing empty lines to source files 6499180d3f74Swdenk 6500c609719bSwdenkSubmissions which do not conform to the standards may be returned 6501c609719bSwdenkwith a request to reformat the changes. 6502c609719bSwdenk 6503c609719bSwdenk 6504c609719bSwdenkSubmitting Patches: 6505c609719bSwdenk------------------- 6506c609719bSwdenk 6507c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 6508c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 6509c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 6510c609719bSwdenk 65110d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 6512218ca724SWolfgang Denk 65130668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 65140668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot 65150668236bSWolfgang Denk 6516c609719bSwdenkWhen you send a patch, please include the following information with 6517c609719bSwdenkit: 6518c609719bSwdenk 6519c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 6520c609719bSwdenk this bug. Please try to include a way of demonstrating that the 6521c609719bSwdenk patch actually fixes something. 6522c609719bSwdenk 6523c609719bSwdenk* For new features: a description of the feature and your 6524c609719bSwdenk implementation. 6525c609719bSwdenk 6526c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 6527c609719bSwdenk 65287207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your 65297207b366SRobert P. J. Day information and associated file and directory references. 6530c609719bSwdenk 653127af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 653227af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 6533c609719bSwdenk 6534c609719bSwdenk* If your patch adds new configuration options, don't forget to 6535c609719bSwdenk document these in the README file. 6536c609719bSwdenk 6537218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 6538218ca724SWolfgang Denk recommended) you can easily generate the patch using the 65397ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 6540218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 6541218ca724SWolfgang Denk with some other mail clients. 6542c609719bSwdenk 6543218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 6544218ca724SWolfgang Denk diff does not support these options, then get the latest version of 6545218ca724SWolfgang Denk GNU diff. 65466dff5529Swdenk 6547218ca724SWolfgang Denk The current directory when running this command shall be the parent 6548218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 6549218ca724SWolfgang Denk your patch includes sufficient directory information for the 6550218ca724SWolfgang Denk affected files). 6551218ca724SWolfgang Denk 6552218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 6553218ca724SWolfgang Denk and compressed attachments must not be used. 6554c609719bSwdenk 655552f52c14Swdenk* If one logical set of modifications affects or creates several 655652f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 655752f52c14Swdenk 655852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 655952f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 656052f52c14Swdenk 656152f52c14Swdenk 6562c609719bSwdenkNotes: 6563c609719bSwdenk 6564c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched 6565c609719bSwdenk source tree and make sure that no errors or warnings are reported 6566c609719bSwdenk for any of the boards. 6567c609719bSwdenk 6568c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 6569c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 6570c609719bSwdenk returned with a request to re-formatting / split it. 6571c609719bSwdenk 6572c609719bSwdenk* If you modify existing code, make sure that your new code does not 6573c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 6574c609719bSwdenk When adding new features, these should compile conditionally only 6575c609719bSwdenk (using #ifdef), and the resulting code with the new feature 6576c609719bSwdenk disabled must not need more memory than the old code without your 6577c609719bSwdenk modification. 657890dc6704Swdenk 65790668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 65800668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 65810668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 65820668236bSWolfgang Denk bigger than the size limit should be avoided. 6583