183d290c5STom Rini# SPDX-License-Identifier: GPL-2.0+ 2c609719bSwdenk# 3eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013 4c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 5c609719bSwdenk 6c609719bSwdenkSummary: 7c609719bSwdenk======== 8c609719bSwdenk 924ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for 10e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other 11e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to 12e86e5a07Swdenkinitialize and test the hardware or to download and run application 13e86e5a07Swdenkcode. 14c609719bSwdenk 15c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of 1624ee89b9Swdenkthe source code originate in the Linux source tree, we have some 1724ee89b9Swdenkheader files in common, and special provision has been made to 18c609719bSwdenksupport booting of Linux images. 19c609719bSwdenk 20c609719bSwdenkSome attention has been paid to make this software easily 21c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are 22c609719bSwdenkimplemented with the same call interface, so that it's very easy to 23c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used 24c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can 25c609719bSwdenkload and run it dynamically. 26c609719bSwdenk 27c609719bSwdenk 28c609719bSwdenkStatus: 29c609719bSwdenk======= 30c609719bSwdenk 31c609719bSwdenkIn general, all boards for which a configuration option exists in the 32c609719bSwdenkMakefile have been tested to some extent and can be considered 33c609719bSwdenk"working". In fact, many of them are used in production systems. 34c609719bSwdenk 357207b366SRobert P. J. DayIn case of problems see the CHANGELOG file to find out who contributed 367207b366SRobert P. J. Daythe specific port. In addition, there are various MAINTAINERS files 377207b366SRobert P. J. Dayscattered throughout the U-Boot source identifying the people or 387207b366SRobert P. J. Daycompanies responsible for various boards and subsystems. 39c609719bSwdenk 407207b366SRobert P. J. DayNote: As of August, 2010, there is no longer a CHANGELOG file in the 417207b366SRobert P. J. Dayactual U-Boot source tree; however, it can be created dynamically 427207b366SRobert P. J. Dayfrom the Git log using: 43adb9d851SRobert P. J. Day 44adb9d851SRobert P. J. Day make CHANGELOG 45adb9d851SRobert P. J. Day 46c609719bSwdenk 47c609719bSwdenkWhere to get help: 48c609719bSwdenk================== 49c609719bSwdenk 50c609719bSwdenkIn case you have questions about, problems with or contributions for 517207b366SRobert P. J. DayU-Boot, you should send a message to the U-Boot mailing list at 520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic 530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's. 540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and 550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot 56c609719bSwdenk 57c609719bSwdenk 58218ca724SWolfgang DenkWhere to get source code: 59218ca724SWolfgang Denk========================= 60218ca724SWolfgang Denk 617207b366SRobert P. J. DayThe U-Boot source code is maintained in the Git repository at 62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at 63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 64218ca724SWolfgang Denk 65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of 6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also 67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 68218ca724SWolfgang Denkdirectory. 69218ca724SWolfgang Denk 70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from 71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/ 72218ca724SWolfgang Denk 73218ca724SWolfgang Denk 74c609719bSwdenkWhere we come from: 75c609719bSwdenk=================== 76c609719bSwdenk 77c609719bSwdenk- start from 8xxrom sources 7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 79c609719bSwdenk- clean up code 80c609719bSwdenk- make it easier to add custom boards 81c609719bSwdenk- make it possible to add other [PowerPC] CPUs 82c609719bSwdenk- extend functions, especially: 83c609719bSwdenk * Provide extended interface to Linux boot loader 84c609719bSwdenk * S-Record download 85c609719bSwdenk * network boot 8611ccc33fSMarcel Ziswiler * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot) 88c609719bSwdenk- add other CPU families (starting with ARM) 8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot) 900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot 9124ee89b9Swdenk 9224ee89b9Swdenk 9324ee89b9SwdenkNames and Spelling: 9424ee89b9Swdenk=================== 9524ee89b9Swdenk 9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling 9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments 9824ee89b9Swdenkin source files etc.). Example: 9924ee89b9Swdenk 10024ee89b9Swdenk This is the README file for the U-Boot project. 10124ee89b9Swdenk 10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples: 10324ee89b9Swdenk 10424ee89b9Swdenk include/asm-ppc/u-boot.h 10524ee89b9Swdenk 10624ee89b9Swdenk #include <asm/u-boot.h> 10724ee89b9Swdenk 10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on 10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example: 11024ee89b9Swdenk 11124ee89b9Swdenk U_BOOT_VERSION u_boot_logo 11224ee89b9Swdenk IH_OS_U_BOOT u_boot_hush_start 113c609719bSwdenk 114c609719bSwdenk 11593f19cc0SwdenkVersioning: 11693f19cc0Swdenk=========== 11793f19cc0Swdenk 118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases 119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning 120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by 121360d883aSThomas Webernames consisting of the calendar year and month of the release date. 122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix 123360d883aSThomas Weberreleases in "stable" maintenance trees. 12493f19cc0Swdenk 125360d883aSThomas WeberExamples: 126360d883aSThomas Weber U-Boot v2009.11 - Release November 2009 127360d883aSThomas Weber U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 1280de21ecbSJelle van der Waa U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release 12993f19cc0Swdenk 13093f19cc0Swdenk 131c609719bSwdenkDirectory Hierarchy: 132c609719bSwdenk==================== 133c609719bSwdenk 1348d321b81SPeter Tyser/arch Architecture specific files 1356eae68e4SMasahiro Yamada /arc Files generic to ARC architecture 1368d321b81SPeter Tyser /arm Files generic to ARM architecture 1378d321b81SPeter Tyser /m68k Files generic to m68k architecture 1388d321b81SPeter Tyser /microblaze Files generic to microblaze architecture 1398d321b81SPeter Tyser /mips Files generic to MIPS architecture 140afc1ce82SMacpaul Lin /nds32 Files generic to NDS32 architecture 1418d321b81SPeter Tyser /nios2 Files generic to Altera NIOS2 architecture 14233c7731bSRobert P. J. Day /openrisc Files generic to OpenRISC architecture 143a47a12beSStefan Roese /powerpc Files generic to PowerPC architecture 1443fafced7SRick Chen /riscv Files generic to RISC-V architecture 1457207b366SRobert P. J. Day /sandbox Files generic to HW-independent "sandbox" 1468d321b81SPeter Tyser /sh Files generic to SH architecture 14733c7731bSRobert P. J. Day /x86 Files generic to x86 architecture 1488d321b81SPeter Tyser/api Machine/arch independent API for external apps 1498d321b81SPeter Tyser/board Board dependent files 150740f7e5cSXu Ziyuan/cmd U-Boot commands functions 1518d321b81SPeter Tyser/common Misc architecture independent functions 1527207b366SRobert P. J. Day/configs Board default configuration files 1538d321b81SPeter Tyser/disk Code for disk drive partition handling 1548d321b81SPeter Tyser/doc Documentation (don't expect too much) 1558d321b81SPeter Tyser/drivers Commonly used device drivers 15633c7731bSRobert P. J. Day/dts Contains Makefile for building internal U-Boot fdt. 1578d321b81SPeter Tyser/examples Example code for standalone applications, etc. 1588d321b81SPeter Tyser/fs Filesystem code (cramfs, ext2, jffs2, etc.) 1598d321b81SPeter Tyser/include Header Files 1607207b366SRobert P. J. Day/lib Library routines generic to all architectures 1617207b366SRobert P. J. Day/Licenses Various license files 1628d321b81SPeter Tyser/net Networking code 1638d321b81SPeter Tyser/post Power On Self Test 1647207b366SRobert P. J. Day/scripts Various build scripts and Makefiles 1657207b366SRobert P. J. Day/test Various unit test files 1668d321b81SPeter Tyser/tools Tools to build S-Record or U-Boot images, etc. 167c609719bSwdenk 168c609719bSwdenkSoftware Configuration: 169c609719bSwdenk======================= 170c609719bSwdenk 171c609719bSwdenkConfiguration is usually done using C preprocessor defines; the 172c609719bSwdenkrationale behind that is to avoid dead code whenever possible. 173c609719bSwdenk 174c609719bSwdenkThere are two classes of configuration variables: 175c609719bSwdenk 176c609719bSwdenk* Configuration _OPTIONS_: 177c609719bSwdenk These are selectable by the user and have names beginning with 178c609719bSwdenk "CONFIG_". 179c609719bSwdenk 180c609719bSwdenk* Configuration _SETTINGS_: 181c609719bSwdenk These depend on the hardware etc. and should not be meddled with if 182c609719bSwdenk you don't know what you're doing; they have names beginning with 1836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD "CONFIG_SYS_". 184c609719bSwdenk 1857207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating 1867207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently, 1877207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel, 1887207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your 1897207b366SRobert P. J. Daybuild. 190c609719bSwdenk 191c609719bSwdenk 192c609719bSwdenkSelection of Processor Architecture and Board Type: 193c609719bSwdenk--------------------------------------------------- 194c609719bSwdenk 195c609719bSwdenkFor all supported boards there are ready-to-use default 196ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig". 197c609719bSwdenk 198c609719bSwdenkExample: For a TQM823L module type: 199c609719bSwdenk 200c609719bSwdenk cd u-boot 201ab584d67SHolger Freyther make TQM823L_defconfig 202c609719bSwdenk 2037207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board 2047207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file 2057207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards. 206c609719bSwdenk 20775b3c3aaSSimon GlassSandbox Environment: 20875b3c3aaSSimon Glass-------------------- 20975b3c3aaSSimon Glass 21075b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox' 21175b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture- 21275b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to 21375b3c3aaSSimon Glassrun some of U-Boot's tests. 21475b3c3aaSSimon Glass 2156b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details. 21675b3c3aaSSimon Glass 21775b3c3aaSSimon Glass 218db910353SSimon GlassBoard Initialisation Flow: 219db910353SSimon Glass-------------------------- 220db910353SSimon Glass 221db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both 2227207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules). 223db910353SSimon Glass 2247207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in 2257207b366SRobert P. J. Daymore detail later in this file. 2267207b366SRobert P. J. Day 2277207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names 2287207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures 2297207b366SRobert P. J. Daymay not conform to this. At least most ARM boards which use 2307207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this. 2317207b366SRobert P. J. Day 2327207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly 2337207b366SRobert P. J. DayCPU-specific) start.S file, such as: 2347207b366SRobert P. J. Day 2357207b366SRobert P. J. Day - arch/arm/cpu/armv7/start.S 2367207b366SRobert P. J. Day - arch/powerpc/cpu/mpc83xx/start.S 2377207b366SRobert P. J. Day - arch/mips/cpu/start.S 2387207b366SRobert P. J. Day 2397207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and 2407207b366SRobert P. J. Daylimitations of each of these functions are described below. 241db910353SSimon Glass 242db910353SSimon Glasslowlevel_init(): 243db910353SSimon Glass - purpose: essential init to permit execution to reach board_init_f() 244db910353SSimon Glass - no global_data or BSS 245db910353SSimon Glass - there is no stack (ARMv7 may have one but it will soon be removed) 246db910353SSimon Glass - must not set up SDRAM or use console 247db910353SSimon Glass - must only do the bare minimum to allow execution to continue to 248db910353SSimon Glass board_init_f() 249db910353SSimon Glass - this is almost never needed 250db910353SSimon Glass - return normally from this function 251db910353SSimon Glass 252db910353SSimon Glassboard_init_f(): 253db910353SSimon Glass - purpose: set up the machine ready for running board_init_r(): 254db910353SSimon Glass i.e. SDRAM and serial UART 255db910353SSimon Glass - global_data is available 256db910353SSimon Glass - stack is in SRAM 257db910353SSimon Glass - BSS is not available, so you cannot use global/static variables, 258db910353SSimon Glass only stack variables and global_data 259db910353SSimon Glass 260db910353SSimon Glass Non-SPL-specific notes: 261db910353SSimon Glass - dram_init() is called to set up DRAM. If already done in SPL this 262db910353SSimon Glass can do nothing 263db910353SSimon Glass 264db910353SSimon Glass SPL-specific notes: 265db910353SSimon Glass - you can override the entire board_init_f() function with your own 266db910353SSimon Glass version as needed. 267db910353SSimon Glass - preloader_console_init() can be called here in extremis 268db910353SSimon Glass - should set up SDRAM, and anything needed to make the UART work 269db910353SSimon Glass - these is no need to clear BSS, it will be done by crt0.S 270db910353SSimon Glass - must return normally from this function (don't call board_init_r() 271db910353SSimon Glass directly) 272db910353SSimon Glass 273db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at 274db910353SSimon Glassthis point the stack and global_data are relocated to below 275db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of 276db910353SSimon Glassmemory. 277db910353SSimon Glass 278db910353SSimon Glassboard_init_r(): 279db910353SSimon Glass - purpose: main execution, common code 280db910353SSimon Glass - global_data is available 281db910353SSimon Glass - SDRAM is available 282db910353SSimon Glass - BSS is available, all static/global variables can be used 283db910353SSimon Glass - execution eventually continues to main_loop() 284db910353SSimon Glass 285db910353SSimon Glass Non-SPL-specific notes: 286db910353SSimon Glass - U-Boot is relocated to the top of memory and is now running from 287db910353SSimon Glass there. 288db910353SSimon Glass 289db910353SSimon Glass SPL-specific notes: 290db910353SSimon Glass - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and 291db910353SSimon Glass CONFIG_SPL_STACK_R_ADDR points into SDRAM 292db910353SSimon Glass - preloader_console_init() can be called here - typically this is 2930680f1b1SLey Foon Tan done by selecting CONFIG_SPL_BOARD_INIT and then supplying a 294db910353SSimon Glass spl_board_init() function containing this call 295db910353SSimon Glass - loads U-Boot or (in falcon mode) Linux 296db910353SSimon Glass 297db910353SSimon Glass 298db910353SSimon Glass 299c609719bSwdenkConfiguration Options: 300c609719bSwdenk---------------------- 301c609719bSwdenk 302c609719bSwdenkConfiguration depends on the combination of board and CPU type; all 303c609719bSwdenksuch information is kept in a configuration file 304c609719bSwdenk"include/configs/<board_name>.h". 305c609719bSwdenk 306c609719bSwdenkExample: For a TQM823L module, all configuration settings are in 307c609719bSwdenk"include/configs/TQM823L.h". 308c609719bSwdenk 309c609719bSwdenk 3107f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux 3117f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to 3127f6c2cbcSwdenkbuild a config tool - later. 3137f6c2cbcSwdenk 31463b2316cSAshish Kumar- ARM Platform Bus Type(CCI): 31563b2316cSAshish Kumar CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which 31663b2316cSAshish Kumar provides full cache coherency between two clusters of multi-core 31763b2316cSAshish Kumar CPUs and I/O coherency for devices and I/O masters 31863b2316cSAshish Kumar 31963b2316cSAshish Kumar CONFIG_SYS_FSL_HAS_CCI400 32063b2316cSAshish Kumar 32163b2316cSAshish Kumar Defined For SoC that has cache coherent interconnect 32263b2316cSAshish Kumar CCN-400 3237f6c2cbcSwdenk 324c055cee1SAshish Kumar CONFIG_SYS_FSL_HAS_CCN504 325c055cee1SAshish Kumar 326c055cee1SAshish Kumar Defined for SoC that has cache coherent interconnect CCN-504 327c055cee1SAshish Kumar 328c609719bSwdenkThe following options need to be configured: 329c609719bSwdenk 3302628114eSKim Phillips- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 331c609719bSwdenk 3322628114eSKim Phillips- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 3336ccec449SWolfgang Denk 33466412c63SKumar Gala- 85xx CPU Options: 335ffd06e02SYork Sun CONFIG_SYS_PPC64 336ffd06e02SYork Sun 337ffd06e02SYork Sun Specifies that the core is a 64-bit PowerPC implementation (implements 338ffd06e02SYork Sun the "64" category of the Power ISA). This is necessary for ePAPR 339ffd06e02SYork Sun compliance, among other possible reasons. 340ffd06e02SYork Sun 34166412c63SKumar Gala CONFIG_SYS_FSL_TBCLK_DIV 34266412c63SKumar Gala 34366412c63SKumar Gala Defines the core time base clock divider ratio compared to the 34466412c63SKumar Gala system clock. On most PQ3 devices this is 8, on newer QorIQ 34566412c63SKumar Gala devices it can be 16 or 32. The ratio varies from SoC to Soc. 34666412c63SKumar Gala 3478f29084aSKumar Gala CONFIG_SYS_FSL_PCIE_COMPAT 3488f29084aSKumar Gala 3498f29084aSKumar Gala Defines the string to utilize when trying to match PCIe device 3508f29084aSKumar Gala tree nodes for the given platform. 3518f29084aSKumar Gala 35233eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510 35333eee330SScott Wood 35433eee330SScott Wood Enables a workaround for erratum A004510. If set, 35533eee330SScott Wood then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 35633eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 35733eee330SScott Wood 35833eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 35933eee330SScott Wood CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 36033eee330SScott Wood 36133eee330SScott Wood Defines one or two SoC revisions (low 8 bits of SVR) 36233eee330SScott Wood for which the A004510 workaround should be applied. 36333eee330SScott Wood 36433eee330SScott Wood The rest of SVR is either not relevant to the decision 36533eee330SScott Wood of whether the erratum is present (e.g. p2040 versus 36633eee330SScott Wood p2041) or is implied by the build target, which controls 36733eee330SScott Wood whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 36833eee330SScott Wood 36933eee330SScott Wood See Freescale App Note 4493 for more information about 37033eee330SScott Wood this erratum. 37133eee330SScott Wood 37274fa22edSPrabhakar Kushwaha CONFIG_A003399_NOR_WORKAROUND 37374fa22edSPrabhakar Kushwaha Enables a workaround for IFC erratum A003399. It is only 374b445bbb4SJeremiah Mahler required during NOR boot. 37574fa22edSPrabhakar Kushwaha 3769f074e67SPrabhakar Kushwaha CONFIG_A008044_WORKAROUND 3779f074e67SPrabhakar Kushwaha Enables a workaround for T1040/T1042 erratum A008044. It is only 378b445bbb4SJeremiah Mahler required during NAND boot and valid for Rev 1.0 SoC revision 3799f074e67SPrabhakar Kushwaha 38033eee330SScott Wood CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 38133eee330SScott Wood 38233eee330SScott Wood This is the value to write into CCSR offset 0x18600 38333eee330SScott Wood according to the A004510 workaround. 38433eee330SScott Wood 38564501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_DDR_ADDR 38664501c66SPriyanka Jain This value denotes start offset of DDR memory which is 38764501c66SPriyanka Jain connected exclusively to the DSP cores. 38864501c66SPriyanka Jain 389765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_M2_RAM_ADDR 390765b0bdbSPriyanka Jain This value denotes start offset of M2 memory 391765b0bdbSPriyanka Jain which is directly connected to the DSP core. 392765b0bdbSPriyanka Jain 39364501c66SPriyanka Jain CONFIG_SYS_FSL_DSP_M3_RAM_ADDR 39464501c66SPriyanka Jain This value denotes start offset of M3 memory which is directly 39564501c66SPriyanka Jain connected to the DSP core. 39664501c66SPriyanka Jain 397765b0bdbSPriyanka Jain CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT 398765b0bdbSPriyanka Jain This value denotes start offset of DSP CCSR space. 399765b0bdbSPriyanka Jain 400b135991aSPriyanka Jain CONFIG_SYS_FSL_SINGLE_SOURCE_CLK 401b135991aSPriyanka Jain Single Source Clock is clocking mode present in some of FSL SoC's. 402b135991aSPriyanka Jain In this mode, a single differential clock is used to supply 403b135991aSPriyanka Jain clocks to the sysclock, ddrclock and usbclock. 404b135991aSPriyanka Jain 405fb4a2409SAneesh Bansal CONFIG_SYS_CPC_REINIT_F 406fb4a2409SAneesh Bansal This CONFIG is defined when the CPC is configured as SRAM at the 407a187559eSBin Meng time of U-Boot entry and is required to be re-initialized. 408fb4a2409SAneesh Bansal 409aade2004STang Yuantian CONFIG_DEEP_SLEEP 410b445bbb4SJeremiah Mahler Indicates this SoC supports deep sleep feature. If deep sleep is 411aade2004STang Yuantian supported, core will start to execute uboot when wakes up. 412aade2004STang Yuantian 4136cb461b4SDaniel Schwierzeck- Generic CPU options: 4146cb461b4SDaniel Schwierzeck CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 4156cb461b4SDaniel Schwierzeck 4166cb461b4SDaniel Schwierzeck Defines the endianess of the CPU. Implementation of those 4176cb461b4SDaniel Schwierzeck values is arch specific. 4186cb461b4SDaniel Schwierzeck 4195614e71bSYork Sun CONFIG_SYS_FSL_DDR 4205614e71bSYork Sun Freescale DDR driver in use. This type of DDR controller is 4215614e71bSYork Sun found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core 4225614e71bSYork Sun SoCs. 4235614e71bSYork Sun 4245614e71bSYork Sun CONFIG_SYS_FSL_DDR_ADDR 4255614e71bSYork Sun Freescale DDR memory-mapped register base. 4265614e71bSYork Sun 4275614e71bSYork Sun CONFIG_SYS_FSL_DDR_EMU 4285614e71bSYork Sun Specify emulator support for DDR. Some DDR features such as 4295614e71bSYork Sun deskew training are not available. 4305614e71bSYork Sun 4315614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN1 4325614e71bSYork Sun Freescale DDR1 controller. 4335614e71bSYork Sun 4345614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN2 4355614e71bSYork Sun Freescale DDR2 controller. 4365614e71bSYork Sun 4375614e71bSYork Sun CONFIG_SYS_FSL_DDRC_GEN3 4385614e71bSYork Sun Freescale DDR3 controller. 4395614e71bSYork Sun 44034e026f9SYork Sun CONFIG_SYS_FSL_DDRC_GEN4 44134e026f9SYork Sun Freescale DDR4 controller. 44234e026f9SYork Sun 4439ac4ffbdSYork Sun CONFIG_SYS_FSL_DDRC_ARM_GEN3 4449ac4ffbdSYork Sun Freescale DDR3 controller for ARM-based SoCs. 4459ac4ffbdSYork Sun 4465614e71bSYork Sun CONFIG_SYS_FSL_DDR1 4475614e71bSYork Sun Board config to use DDR1. It can be enabled for SoCs with 4485614e71bSYork Sun Freescale DDR1 or DDR2 controllers, depending on the board 4495614e71bSYork Sun implemetation. 4505614e71bSYork Sun 4515614e71bSYork Sun CONFIG_SYS_FSL_DDR2 45262a3b7ddSRobert P. J. Day Board config to use DDR2. It can be enabled for SoCs with 4535614e71bSYork Sun Freescale DDR2 or DDR3 controllers, depending on the board 4545614e71bSYork Sun implementation. 4555614e71bSYork Sun 4565614e71bSYork Sun CONFIG_SYS_FSL_DDR3 4575614e71bSYork Sun Board config to use DDR3. It can be enabled for SoCs with 45834e026f9SYork Sun Freescale DDR3 or DDR3L controllers. 45934e026f9SYork Sun 46034e026f9SYork Sun CONFIG_SYS_FSL_DDR3L 46134e026f9SYork Sun Board config to use DDR3L. It can be enabled for SoCs with 46234e026f9SYork Sun DDR3L controllers. 46334e026f9SYork Sun 46434e026f9SYork Sun CONFIG_SYS_FSL_DDR4 46534e026f9SYork Sun Board config to use DDR4. It can be enabled for SoCs with 46634e026f9SYork Sun DDR4 controllers. 4675614e71bSYork Sun 4681b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_BE 4691b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Big Endian 4701b4175d6SPrabhakar Kushwaha 4711b4175d6SPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_LE 4721b4175d6SPrabhakar Kushwaha Defines the IFC controller register space as Little Endian 4731b4175d6SPrabhakar Kushwaha 4741c40707eSPrabhakar Kushwaha CONFIG_SYS_FSL_IFC_CLK_DIV 4751c40707eSPrabhakar Kushwaha Defines divider of platform clock(clock input to IFC controller). 4761c40707eSPrabhakar Kushwaha 477add63f94SPrabhakar Kushwaha CONFIG_SYS_FSL_LBC_CLK_DIV 478add63f94SPrabhakar Kushwaha Defines divider of platform clock(clock input to eLBC controller). 479add63f94SPrabhakar Kushwaha 480690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_PBI 481690e4258SPrabhakar Kushwaha It enables addition of RCW (Power on reset configuration) in built image. 482690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 483690e4258SPrabhakar Kushwaha 484690e4258SPrabhakar Kushwaha CONFIG_SYS_FSL_PBL_RCW 485690e4258SPrabhakar Kushwaha It adds PBI(pre-boot instructions) commands in u-boot build image. 486690e4258SPrabhakar Kushwaha PBI commands can be used to configure SoC before it starts the execution. 487690e4258SPrabhakar Kushwaha Please refer doc/README.pblimage for more details 488690e4258SPrabhakar Kushwaha 48989ad7be8SPrabhakar Kushwaha CONFIG_SPL_FSL_PBL 49089ad7be8SPrabhakar Kushwaha It adds a target to create boot binary having SPL binary in PBI format 49189ad7be8SPrabhakar Kushwaha concatenated with u-boot binary. 49289ad7be8SPrabhakar Kushwaha 4934e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_BE 4944e5b1bd0SYork Sun Defines the DDR controller register space as Big Endian 4954e5b1bd0SYork Sun 4964e5b1bd0SYork Sun CONFIG_SYS_FSL_DDR_LE 4974e5b1bd0SYork Sun Defines the DDR controller register space as Little Endian 4984e5b1bd0SYork Sun 4996b9e309aSYork Sun CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY 5006b9e309aSYork Sun Physical address from the view of DDR controllers. It is the 5016b9e309aSYork Sun same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But 5026b9e309aSYork Sun it could be different for ARM SoCs. 5036b9e309aSYork Sun 5046b1e1254SYork Sun CONFIG_SYS_FSL_DDR_INTLV_256B 5056b1e1254SYork Sun DDR controller interleaving on 256-byte. This is a special 5066b1e1254SYork Sun interleaving mode, handled by Dickens for Freescale layerscape 5076b1e1254SYork Sun SoCs with ARM core. 5086b1e1254SYork Sun 5091d71efbbSYork Sun CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS 5101d71efbbSYork Sun Number of controllers used as main memory. 5111d71efbbSYork Sun 5121d71efbbSYork Sun CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS 5131d71efbbSYork Sun Number of controllers used for other than main memory. 5141d71efbbSYork Sun 51544937214SPrabhakar Kushwaha CONFIG_SYS_FSL_HAS_DP_DDR 51644937214SPrabhakar Kushwaha Defines the SoC has DP-DDR used for DPAA. 51744937214SPrabhakar Kushwaha 518028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_BE 519028dbb8dSRuchika Gupta Defines the SEC controller register space as Big Endian 520028dbb8dSRuchika Gupta 521028dbb8dSRuchika Gupta CONFIG_SYS_FSL_SEC_LE 522028dbb8dSRuchika Gupta Defines the SEC controller register space as Little Endian 523028dbb8dSRuchika Gupta 52492bbd64eSDaniel Schwierzeck- MIPS CPU options: 52592bbd64eSDaniel Schwierzeck CONFIG_SYS_INIT_SP_OFFSET 52692bbd64eSDaniel Schwierzeck 52792bbd64eSDaniel Schwierzeck Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 52892bbd64eSDaniel Schwierzeck pointer. This is needed for the temporary stack before 52992bbd64eSDaniel Schwierzeck relocation. 53092bbd64eSDaniel Schwierzeck 53192bbd64eSDaniel Schwierzeck CONFIG_SYS_MIPS_CACHE_MODE 53292bbd64eSDaniel Schwierzeck 53392bbd64eSDaniel Schwierzeck Cache operation mode for the MIPS CPU. 53492bbd64eSDaniel Schwierzeck See also arch/mips/include/asm/mipsregs.h. 53592bbd64eSDaniel Schwierzeck Possible values are: 53692bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NO_WA 53792bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_WA 53892bbd64eSDaniel Schwierzeck CONF_CM_UNCACHED 53992bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_NONCOHERENT 54092bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CE 54192bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_COW 54292bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_CUW 54392bbd64eSDaniel Schwierzeck CONF_CM_CACHABLE_ACCELERATED 54492bbd64eSDaniel Schwierzeck 54592bbd64eSDaniel Schwierzeck CONFIG_SYS_XWAY_EBU_BOOTCFG 54692bbd64eSDaniel Schwierzeck 54792bbd64eSDaniel Schwierzeck Special option for Lantiq XWAY SoCs for booting from NOR flash. 54892bbd64eSDaniel Schwierzeck See also arch/mips/cpu/mips32/start.S. 54992bbd64eSDaniel Schwierzeck 55092bbd64eSDaniel Schwierzeck CONFIG_XWAY_SWAP_BYTES 55192bbd64eSDaniel Schwierzeck 55292bbd64eSDaniel Schwierzeck Enable compilation of tools/xway-swap-bytes needed for Lantiq 55392bbd64eSDaniel Schwierzeck XWAY SoCs for booting from NOR flash. The U-Boot image needs to 55492bbd64eSDaniel Schwierzeck be swapped if a flash programmer is used. 55592bbd64eSDaniel Schwierzeck 556b67d8816SChristian Riesch- ARM options: 557b67d8816SChristian Riesch CONFIG_SYS_EXCEPTION_VECTORS_HIGH 558b67d8816SChristian Riesch 559b67d8816SChristian Riesch Select high exception vectors of the ARM core, e.g., do not 560b67d8816SChristian Riesch clear the V bit of the c1 register of CP15. 561b67d8816SChristian Riesch 562207774b2SYork Sun COUNTER_FREQUENCY 563207774b2SYork Sun Generic timer clock source frequency. 564207774b2SYork Sun 565207774b2SYork Sun COUNTER_FREQUENCY_REAL 566207774b2SYork Sun Generic timer clock source frequency if the real clock is 567207774b2SYork Sun different from COUNTER_FREQUENCY, and can only be determined 568207774b2SYork Sun at run time. 569207774b2SYork Sun 57073c38934SStephen Warren- Tegra SoC options: 57173c38934SStephen Warren CONFIG_TEGRA_SUPPORT_NON_SECURE 57273c38934SStephen Warren 57373c38934SStephen Warren Support executing U-Boot in non-secure (NS) mode. Certain 57473c38934SStephen Warren impossible actions will be skipped if the CPU is in NS mode, 57573c38934SStephen Warren such as ARM architectural timer initialization. 57673c38934SStephen Warren 5775da627a4Swdenk- Linux Kernel Interface: 578c609719bSwdenk CONFIG_CLOCKS_IN_MHZ 579c609719bSwdenk 580c609719bSwdenk U-Boot stores all clock information in Hz 581c609719bSwdenk internally. For binary compatibility with older Linux 582c609719bSwdenk kernels (which expect the clocks passed in the 583c609719bSwdenk bd_info data to be in MHz) the environment variable 584c609719bSwdenk "clocks_in_mhz" can be defined so that U-Boot 585c609719bSwdenk converts clock data to MHZ before passing it to the 586c609719bSwdenk Linux kernel. 587c609719bSwdenk When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 588c609719bSwdenk "clocks_in_mhz=1" is automatically included in the 589c609719bSwdenk default environment. 590c609719bSwdenk 5915da627a4Swdenk CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 5925da627a4Swdenk 593b445bbb4SJeremiah Mahler When transferring memsize parameter to Linux, some versions 5945da627a4Swdenk expect it to be in bytes, others in MB. 5955da627a4Swdenk Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 5965da627a4Swdenk 597fec6d9eeSGerald Van Baren CONFIG_OF_LIBFDT 598f57f70aaSWolfgang Denk 599f57f70aaSWolfgang Denk New kernel versions are expecting firmware settings to be 600213bf8c8SGerald Van Baren passed using flattened device trees (based on open firmware 601213bf8c8SGerald Van Baren concepts). 602213bf8c8SGerald Van Baren 603213bf8c8SGerald Van Baren CONFIG_OF_LIBFDT 604213bf8c8SGerald Van Baren * New libfdt-based support 605213bf8c8SGerald Van Baren * Adds the "fdt" command 6063bb342fcSKim Phillips * The bootm command automatically updates the fdt 607213bf8c8SGerald Van Baren 608f57f70aaSWolfgang Denk OF_TBCLK - The timebase frequency. 609c2871f03SKumar Gala OF_STDOUT_PATH - The path to the console device 610f57f70aaSWolfgang Denk 61111ccc33fSMarcel Ziswiler boards with QUICC Engines require OF_QE to set UCC MAC 61211ccc33fSMarcel Ziswiler addresses 6133bb342fcSKim Phillips 6144e253137SKumar Gala CONFIG_OF_BOARD_SETUP 6154e253137SKumar Gala 6164e253137SKumar Gala Board code has addition modification that it wants to make 6174e253137SKumar Gala to the flat device tree before handing it off to the kernel 6186705d81eSwdenk 619c654b517SSimon Glass CONFIG_OF_SYSTEM_SETUP 620c654b517SSimon Glass 621c654b517SSimon Glass Other code has addition modification that it wants to make 622c654b517SSimon Glass to the flat device tree before handing it off to the kernel. 623c654b517SSimon Glass This causes ft_system_setup() to be called before booting 624c654b517SSimon Glass the kernel. 625c654b517SSimon Glass 6263887c3fbSHeiko Schocher CONFIG_OF_IDE_FIXUP 6273887c3fbSHeiko Schocher 6283887c3fbSHeiko Schocher U-Boot can detect if an IDE device is present or not. 6293887c3fbSHeiko Schocher If not, and this new config option is activated, U-Boot 6303887c3fbSHeiko Schocher removes the ATA node from the DTS before booting Linux, 6313887c3fbSHeiko Schocher so the Linux IDE driver does not probe the device and 6323887c3fbSHeiko Schocher crash. This is needed for buggy hardware (uc101) where 6333887c3fbSHeiko Schocher no pull down resistor is connected to the signal IDE5V_DD7. 6343887c3fbSHeiko Schocher 6357eb29398SIgor Grinberg CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 6367eb29398SIgor Grinberg 6377eb29398SIgor Grinberg This setting is mandatory for all boards that have only one 6387eb29398SIgor Grinberg machine type and must be used to specify the machine type 6397eb29398SIgor Grinberg number as it appears in the ARM machine registry 6407eb29398SIgor Grinberg (see http://www.arm.linux.org.uk/developer/machines/). 6417eb29398SIgor Grinberg Only boards that have multiple machine types supported 6427eb29398SIgor Grinberg in a single configuration file and the machine type is 6437eb29398SIgor Grinberg runtime discoverable, do not have to use this setting. 6447eb29398SIgor Grinberg 6450b2f4ecaSNiklaus Giger- vxWorks boot parameters: 6460b2f4ecaSNiklaus Giger 6470b2f4ecaSNiklaus Giger bootvx constructs a valid bootline using the following 6489e98b7e3SBin Meng environments variables: bootdev, bootfile, ipaddr, netmask, 6499e98b7e3SBin Meng serverip, gatewayip, hostname, othbootargs. 6500b2f4ecaSNiklaus Giger It loads the vxWorks image pointed bootfile. 6510b2f4ecaSNiklaus Giger 6520b2f4ecaSNiklaus Giger Note: If a "bootargs" environment is defined, it will overwride 6530b2f4ecaSNiklaus Giger the defaults discussed just above. 6540b2f4ecaSNiklaus Giger 6552c451f78SAneesh V- Cache Configuration: 6562c451f78SAneesh V CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 6572c451f78SAneesh V CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 6582c451f78SAneesh V CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 6592c451f78SAneesh V 66093bc2193SAneesh V- Cache Configuration for ARM: 66193bc2193SAneesh V CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 66293bc2193SAneesh V controller 66393bc2193SAneesh V CONFIG_SYS_PL310_BASE - Physical base address of PL310 66493bc2193SAneesh V controller register space 66593bc2193SAneesh V 6666705d81eSwdenk- Serial Ports: 66748d0192fSAndreas Engel CONFIG_PL010_SERIAL 6686705d81eSwdenk 6696705d81eSwdenk Define this if you want support for Amba PrimeCell PL010 UARTs. 6706705d81eSwdenk 67148d0192fSAndreas Engel CONFIG_PL011_SERIAL 6726705d81eSwdenk 6736705d81eSwdenk Define this if you want support for Amba PrimeCell PL011 UARTs. 6746705d81eSwdenk 6756705d81eSwdenk CONFIG_PL011_CLOCK 6766705d81eSwdenk 6776705d81eSwdenk If you have Amba PrimeCell PL011 UARTs, set this variable to 6786705d81eSwdenk the clock speed of the UARTs. 6796705d81eSwdenk 6806705d81eSwdenk CONFIG_PL01x_PORTS 6816705d81eSwdenk 6826705d81eSwdenk If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 6836705d81eSwdenk define this to a list of base addresses for each (supported) 6846705d81eSwdenk port. See e.g. include/configs/versatile.h 6856705d81eSwdenk 686d57dee57SKaricheri, Muralidharan CONFIG_SERIAL_HW_FLOW_CONTROL 687d57dee57SKaricheri, Muralidharan 688d57dee57SKaricheri, Muralidharan Define this variable to enable hw flow control in serial driver. 689d57dee57SKaricheri, Muralidharan Current user of this option is drivers/serial/nsl16550.c driver 6906705d81eSwdenk 691c609719bSwdenk- Console Baudrate: 692c609719bSwdenk CONFIG_BAUDRATE - in bps 693c609719bSwdenk Select one of the baudrates listed in 6946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 695c609719bSwdenk 696c609719bSwdenk- Autoboot Command: 697c609719bSwdenk CONFIG_BOOTCOMMAND 698c609719bSwdenk Only needed when CONFIG_BOOTDELAY is enabled; 699c609719bSwdenk define a command string that is automatically executed 700c609719bSwdenk when no character is read on the console interface 701c609719bSwdenk within "Boot Delay" after reset. 702c609719bSwdenk 703c609719bSwdenk CONFIG_RAMBOOT and CONFIG_NFSBOOT 704c609719bSwdenk The value of these goes into the environment as 705c609719bSwdenk "ramboot" and "nfsboot" respectively, and can be used 706c609719bSwdenk as a convenience, when switching between booting from 70711ccc33fSMarcel Ziswiler RAM and NFS. 708c609719bSwdenk 709c609719bSwdenk- Pre-Boot Commands: 710c609719bSwdenk CONFIG_PREBOOT 711c609719bSwdenk 712c609719bSwdenk When this option is #defined, the existence of the 713c609719bSwdenk environment variable "preboot" will be checked 714c609719bSwdenk immediately before starting the CONFIG_BOOTDELAY 715c609719bSwdenk countdown and/or running the auto-boot command resp. 716c609719bSwdenk entering interactive mode. 717c609719bSwdenk 718c609719bSwdenk This feature is especially useful when "preboot" is 719c609719bSwdenk automatically generated or modified. For an example 720c609719bSwdenk see the LWMON board specific code: here "preboot" is 721c609719bSwdenk modified when the user holds down a certain 722c609719bSwdenk combination of keys on the (special) keyboard when 723c609719bSwdenk booting the systems 724c609719bSwdenk 725c609719bSwdenk- Serial Download Echo Mode: 726c609719bSwdenk CONFIG_LOADS_ECHO 727c609719bSwdenk If defined to 1, all characters received during a 728c609719bSwdenk serial download (using the "loads" command) are 729c609719bSwdenk echoed back. This might be needed by some terminal 730c609719bSwdenk emulations (like "cu"), but may as well just take 731c609719bSwdenk time on others. This setting #define's the initial 732c609719bSwdenk value of the "loads_echo" environment variable. 733c609719bSwdenk 734602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 735c609719bSwdenk CONFIG_KGDB_BAUDRATE 736c609719bSwdenk Select one of the baudrates listed in 7376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BAUDRATE_TABLE, see below. 738c609719bSwdenk 739302a6487SSimon Glass- Removal of commands 740302a6487SSimon Glass If no commands are needed to boot, you can disable 741302a6487SSimon Glass CONFIG_CMDLINE to remove them. In this case, the command line 742302a6487SSimon Glass will not be available, and when U-Boot wants to execute the 743302a6487SSimon Glass boot command (on start-up) it will call board_run_command() 744302a6487SSimon Glass instead. This can reduce image size significantly for very 745302a6487SSimon Glass simple boot procedures. 746302a6487SSimon Glass 747a5ecbe62SWolfgang Denk- Regular expression support: 748a5ecbe62SWolfgang Denk CONFIG_REGEX 749a5ecbe62SWolfgang Denk If this variable is defined, U-Boot is linked against 750a5ecbe62SWolfgang Denk the SLRE (Super Light Regular Expression) library, 751a5ecbe62SWolfgang Denk which adds regex support to some commands, as for 752a5ecbe62SWolfgang Denk example "env grep" and "setexpr". 753a5ecbe62SWolfgang Denk 75445ba8077SSimon Glass- Device tree: 75545ba8077SSimon Glass CONFIG_OF_CONTROL 75645ba8077SSimon Glass If this variable is defined, U-Boot will use a device tree 75745ba8077SSimon Glass to configure its devices, instead of relying on statically 75845ba8077SSimon Glass compiled #defines in the board file. This option is 75945ba8077SSimon Glass experimental and only available on a few boards. The device 76045ba8077SSimon Glass tree is available in the global data as gd->fdt_blob. 76145ba8077SSimon Glass 7622c0f79e4SSimon Glass U-Boot needs to get its device tree from somewhere. This can 76382f766d1SAlex Deymo be done using one of the three options below: 764bbb0b128SSimon Glass 765bbb0b128SSimon Glass CONFIG_OF_EMBED 766bbb0b128SSimon Glass If this variable is defined, U-Boot will embed a device tree 767bbb0b128SSimon Glass binary in its image. This device tree file should be in the 768bbb0b128SSimon Glass board directory and called <soc>-<board>.dts. The binary file 769bbb0b128SSimon Glass is then picked up in board_init_f() and made available through 770eb3eb602SNobuhiro Iwamatsu the global data structure as gd->fdt_blob. 77145ba8077SSimon Glass 7722c0f79e4SSimon Glass CONFIG_OF_SEPARATE 7732c0f79e4SSimon Glass If this variable is defined, U-Boot will build a device tree 7742c0f79e4SSimon Glass binary. It will be called u-boot.dtb. Architecture-specific 7752c0f79e4SSimon Glass code will locate it at run-time. Generally this works by: 7762c0f79e4SSimon Glass 7772c0f79e4SSimon Glass cat u-boot.bin u-boot.dtb >image.bin 7782c0f79e4SSimon Glass 7792c0f79e4SSimon Glass and in fact, U-Boot does this for you, creating a file called 7802c0f79e4SSimon Glass u-boot-dtb.bin which is useful in the common case. You can 7812c0f79e4SSimon Glass still use the individual files if you need something more 7822c0f79e4SSimon Glass exotic. 7832c0f79e4SSimon Glass 78482f766d1SAlex Deymo CONFIG_OF_BOARD 78582f766d1SAlex Deymo If this variable is defined, U-Boot will use the device tree 78682f766d1SAlex Deymo provided by the board at runtime instead of embedding one with 78782f766d1SAlex Deymo the image. Only boards defining board_fdt_blob_setup() support 78882f766d1SAlex Deymo this option (see include/fdtdec.h file). 78982f766d1SAlex Deymo 790c609719bSwdenk- Watchdog: 791c609719bSwdenk CONFIG_WATCHDOG 792c609719bSwdenk If this variable is defined, it enables watchdog 7936abe6fb6SDetlev Zundel support for the SoC. There must be support in the SoC 794907208c4SChristophe Leroy specific code for a watchdog. For the 8xx 795907208c4SChristophe Leroy CPUs, the SIU Watchdog feature is enabled in the SYPCR 796907208c4SChristophe Leroy register. When supported for a specific SoC is 797907208c4SChristophe Leroy available, then no further board specific code should 798907208c4SChristophe Leroy be needed to use it. 7996abe6fb6SDetlev Zundel 8006abe6fb6SDetlev Zundel CONFIG_HW_WATCHDOG 8016abe6fb6SDetlev Zundel When using a watchdog circuitry external to the used 8026abe6fb6SDetlev Zundel SoC, then define this variable and provide board 8036abe6fb6SDetlev Zundel specific code for the "hw_watchdog_reset" function. 804c609719bSwdenk 8057bae0d6fSHeiko Schocher CONFIG_AT91_HW_WDT_TIMEOUT 8067bae0d6fSHeiko Schocher specify the timeout in seconds. default 2 seconds. 8077bae0d6fSHeiko Schocher 808c609719bSwdenk- Real-Time Clock: 809c609719bSwdenk 810602ad3b3SJon Loeliger When CONFIG_CMD_DATE is selected, the type of the RTC 811c609719bSwdenk has to be selected, too. Define exactly one of the 812c609719bSwdenk following options: 813c609719bSwdenk 814c609719bSwdenk CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 8154e8b7544SFabio Estevam CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 816c609719bSwdenk CONFIG_RTC_MC146818 - use MC146818 RTC 8171cb8e980Swdenk CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 818c609719bSwdenk CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 8197f70e853Swdenk CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 820412921d2SMarkus Niebel CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC 8213bac3513Swdenk CONFIG_RTC_DS164x - use Dallas DS164x RTC 8229536dfccSTor Krill CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 8234c0d4c3bSwdenk CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 8242bd3cab3SChris Packham CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 82571d19f30SHeiko Schocher CONFIG_SYS_RV3029_TCR - enable trickle charger on 82671d19f30SHeiko Schocher RV3029 RTC. 827c609719bSwdenk 828b37c7e5eSwdenk Note that if the RTC uses I2C, then the I2C interface 829b37c7e5eSwdenk must also be configured. See I2C Support, below. 830b37c7e5eSwdenk 831e92739d3SPeter Tyser- GPIO Support: 832e92739d3SPeter Tyser CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 833e92739d3SPeter Tyser 8345dec49caSChris Packham The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 8355dec49caSChris Packham chip-ngpio pairs that tell the PCA953X driver the number of 8365dec49caSChris Packham pins supported by a particular chip. 8375dec49caSChris Packham 838e92739d3SPeter Tyser Note that if the GPIO device uses I2C, then the I2C interface 839e92739d3SPeter Tyser must also be configured. See I2C Support, below. 840e92739d3SPeter Tyser 841aa53233aSSimon Glass- I/O tracing: 842aa53233aSSimon Glass When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O 843aa53233aSSimon Glass accesses and can checksum them or write a list of them out 844aa53233aSSimon Glass to memory. See the 'iotrace' command for details. This is 845aa53233aSSimon Glass useful for testing device drivers since it can confirm that 846aa53233aSSimon Glass the driver behaves the same way before and after a code 847aa53233aSSimon Glass change. Currently this is supported on sandbox and arm. To 848aa53233aSSimon Glass add support for your architecture, add '#include <iotrace.h>' 849aa53233aSSimon Glass to the bottom of arch/<arch>/include/asm/io.h and test. 850aa53233aSSimon Glass 851aa53233aSSimon Glass Example output from the 'iotrace stats' command is below. 852aa53233aSSimon Glass Note that if the trace buffer is exhausted, the checksum will 853aa53233aSSimon Glass still continue to operate. 854aa53233aSSimon Glass 855aa53233aSSimon Glass iotrace is enabled 856aa53233aSSimon Glass Start: 10000000 (buffer start address) 857aa53233aSSimon Glass Size: 00010000 (buffer size) 858aa53233aSSimon Glass Offset: 00000120 (current buffer offset) 859aa53233aSSimon Glass Output: 10000120 (start + offset) 860aa53233aSSimon Glass Count: 00000018 (number of trace records) 861aa53233aSSimon Glass CRC32: 9526fb66 (CRC32 of all trace records) 862aa53233aSSimon Glass 863c609719bSwdenk- Timestamp Support: 864c609719bSwdenk 865c609719bSwdenk When CONFIG_TIMESTAMP is selected, the timestamp 866c609719bSwdenk (date and time) of an image is printed by image 867c609719bSwdenk commands like bootm or iminfo. This option is 868602ad3b3SJon Loeliger automatically enabled when you select CONFIG_CMD_DATE . 869c609719bSwdenk 870923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported: 871923c46f9SKarl O. Pinc Zero or more of the following: 872923c46f9SKarl O. Pinc CONFIG_MAC_PARTITION Apple's MacOS partition table. 873923c46f9SKarl O. Pinc CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 874923c46f9SKarl O. Pinc CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 875923c46f9SKarl O. Pinc bootloader. Note 2TB partition limit; see 876923c46f9SKarl O. Pinc disk/part_efi.c 877923c46f9SKarl O. Pinc CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 878c609719bSwdenk 879fc843a02SSimon Glass If IDE or SCSI support is enabled (CONFIG_IDE or 880c649e3c9SSimon Glass CONFIG_SCSI) you must configure support for at 881923c46f9SKarl O. Pinc least one non-MTD partition type as well. 882c609719bSwdenk 883c609719bSwdenk- IDE Reset method: 8844d13cbadSwdenk CONFIG_IDE_RESET_ROUTINE - this is defined in several 8854d13cbadSwdenk board configurations files but used nowhere! 886c609719bSwdenk 8874d13cbadSwdenk CONFIG_IDE_RESET - is this is defined, IDE Reset will 8884d13cbadSwdenk be performed by calling the function 8894d13cbadSwdenk ide_set_reset(int reset) 8904d13cbadSwdenk which has to be defined in a board specific file 891c609719bSwdenk 892c609719bSwdenk- ATAPI Support: 893c609719bSwdenk CONFIG_ATAPI 894c609719bSwdenk 895c609719bSwdenk Set this to enable ATAPI support. 896c609719bSwdenk 897c40b2956Swdenk- LBA48 Support 898c40b2956Swdenk CONFIG_LBA48 899c40b2956Swdenk 900c40b2956Swdenk Set this to enable support for disks larger than 137GB 9014b142febSHeiko Schocher Also look at CONFIG_SYS_64BIT_LBA. 902c40b2956Swdenk Whithout these , LBA48 support uses 32bit variables and will 'only' 903c40b2956Swdenk support disks up to 2.1TB. 904c40b2956Swdenk 9056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_64BIT_LBA: 906c40b2956Swdenk When enabled, makes the IDE subsystem use 64bit sector addresses. 907c40b2956Swdenk Default is 32bit. 908c40b2956Swdenk 909c609719bSwdenk- SCSI Support: 9106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 9116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 9126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 913c609719bSwdenk maximum numbers of LUNs, SCSI ID's and target 914c609719bSwdenk devices. 915c609719bSwdenk 916447c031bSStefan Reinauer The environment variable 'scsidevs' is set to the number of 917447c031bSStefan Reinauer SCSI devices found during the last scan. 918447c031bSStefan Reinauer 919c609719bSwdenk- NETWORK Support (PCI): 920682011ffSwdenk CONFIG_E1000 921ce5207e1SKyle Moffett Support for Intel 8254x/8257x gigabit chips. 922ce5207e1SKyle Moffett 923ce5207e1SKyle Moffett CONFIG_E1000_SPI 924ce5207e1SKyle Moffett Utility code for direct access to the SPI bus on Intel 8257x. 925ce5207e1SKyle Moffett This does not do anything useful unless you set at least one 926ce5207e1SKyle Moffett of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 927ce5207e1SKyle Moffett 928ce5207e1SKyle Moffett CONFIG_E1000_SPI_GENERIC 929ce5207e1SKyle Moffett Allow generic access to the SPI bus on the Intel 8257x, for 930ce5207e1SKyle Moffett example with the "sspi" command. 931ce5207e1SKyle Moffett 932c609719bSwdenk CONFIG_EEPRO100 933c609719bSwdenk Support for Intel 82557/82559/82559ER chips. 93411ccc33fSMarcel Ziswiler Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 935c609719bSwdenk write routine for first time initialisation. 936c609719bSwdenk 937c609719bSwdenk CONFIG_TULIP 938c609719bSwdenk Support for Digital 2114x chips. 939c609719bSwdenk Optional CONFIG_TULIP_SELECT_MEDIA for board specific 940c609719bSwdenk modem chip initialisation (KS8761/QS6611). 941c609719bSwdenk 942c609719bSwdenk CONFIG_NATSEMI 943c609719bSwdenk Support for National dp83815 chips. 944c609719bSwdenk 945c609719bSwdenk CONFIG_NS8382X 946c609719bSwdenk Support for National dp8382[01] gigabit chips. 947c609719bSwdenk 94845219c46Swdenk- NETWORK Support (other): 94945219c46Swdenk 950c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC 951c041e9d2SJens Scharsig Support for AT91RM9200 EMAC. 952c041e9d2SJens Scharsig 953c041e9d2SJens Scharsig CONFIG_RMII 954c041e9d2SJens Scharsig Define this to use reduced MII inteface 955c041e9d2SJens Scharsig 956c041e9d2SJens Scharsig CONFIG_DRIVER_AT91EMAC_QUIET 957c041e9d2SJens Scharsig If this defined, the driver is quiet. 958c041e9d2SJens Scharsig The driver doen't show link status messages. 959c041e9d2SJens Scharsig 960efdd7319SRob Herring CONFIG_CALXEDA_XGMAC 961efdd7319SRob Herring Support for the Calxeda XGMAC device 962efdd7319SRob Herring 9633bb46d23SAshok CONFIG_LAN91C96 96445219c46Swdenk Support for SMSC's LAN91C96 chips. 96545219c46Swdenk 96645219c46Swdenk CONFIG_LAN91C96_USE_32_BIT 96745219c46Swdenk Define this to enable 32 bit addressing 96845219c46Swdenk 9693bb46d23SAshok CONFIG_SMC91111 970f39748aeSwdenk Support for SMSC's LAN91C111 chip 971f39748aeSwdenk 972f39748aeSwdenk CONFIG_SMC91111_BASE 973f39748aeSwdenk Define this to hold the physical address 974f39748aeSwdenk of the device (I/O space) 975f39748aeSwdenk 976f39748aeSwdenk CONFIG_SMC_USE_32_BIT 977f39748aeSwdenk Define this if data bus is 32 bits 978f39748aeSwdenk 979f39748aeSwdenk CONFIG_SMC_USE_IOFUNCS 980f39748aeSwdenk Define this to use i/o functions instead of macros 981f39748aeSwdenk (some hardware wont work with macros) 982f39748aeSwdenk 983dc02badaSHeiko Schocher CONFIG_DRIVER_TI_EMAC 984dc02badaSHeiko Schocher Support for davinci emac 985dc02badaSHeiko Schocher 986dc02badaSHeiko Schocher CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 987dc02badaSHeiko Schocher Define this if you have more then 3 PHYs. 988dc02badaSHeiko Schocher 989b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100 990b3dbf4a5SMacpaul Lin Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 991b3dbf4a5SMacpaul Lin 992b3dbf4a5SMacpaul Lin CONFIG_FTGMAC100_EGIGA 993b3dbf4a5SMacpaul Lin Define this to use GE link update with gigabit PHY. 994b3dbf4a5SMacpaul Lin Define this if FTGMAC100 is connected to gigabit PHY. 995b3dbf4a5SMacpaul Lin If your system has 10/100 PHY only, it might not occur 996b3dbf4a5SMacpaul Lin wrong behavior. Because PHY usually return timeout or 997b3dbf4a5SMacpaul Lin useless data when polling gigabit status and gigabit 998b3dbf4a5SMacpaul Lin control registers. This behavior won't affect the 999b3dbf4a5SMacpaul Lin correctnessof 10/100 link speed update. 1000b3dbf4a5SMacpaul Lin 10013d0075faSYoshihiro Shimoda CONFIG_SH_ETHER 10023d0075faSYoshihiro Shimoda Support for Renesas on-chip Ethernet controller 10033d0075faSYoshihiro Shimoda 10043d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_USE_PORT 10053d0075faSYoshihiro Shimoda Define the number of ports to be used 10063d0075faSYoshihiro Shimoda 10073d0075faSYoshihiro Shimoda CONFIG_SH_ETHER_PHY_ADDR 10083d0075faSYoshihiro Shimoda Define the ETH PHY's address 10093d0075faSYoshihiro Shimoda 101068260aabSYoshihiro Shimoda CONFIG_SH_ETHER_CACHE_WRITEBACK 101168260aabSYoshihiro Shimoda If this option is set, the driver enables cache flush. 101268260aabSYoshihiro Shimoda 1013b2f97cf2SHeiko Schocher- PWM Support: 1014b2f97cf2SHeiko Schocher CONFIG_PWM_IMX 10155052e819SRobert P. J. Day Support for PWM module on the imx6. 1016b2f97cf2SHeiko Schocher 10175e124724SVadim Bendebury- TPM Support: 101890899cc0SChe-liang Chiou CONFIG_TPM 101990899cc0SChe-liang Chiou Support TPM devices. 102090899cc0SChe-liang Chiou 10210766ad2fSChristophe Ricard CONFIG_TPM_TIS_INFINEON 10220766ad2fSChristophe Ricard Support for Infineon i2c bus TPM devices. Only one device 10231b393db5STom Wai-Hong Tam per system is supported at this time. 10241b393db5STom Wai-Hong Tam 10251b393db5STom Wai-Hong Tam CONFIG_TPM_TIS_I2C_BURST_LIMITATION 10261b393db5STom Wai-Hong Tam Define the burst count bytes upper limit 10271b393db5STom Wai-Hong Tam 10283aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24 10293aa74088SChristophe Ricard Support for STMicroelectronics TPM devices. Requires DM_TPM support. 10303aa74088SChristophe Ricard 10313aa74088SChristophe Ricard CONFIG_TPM_ST33ZP24_I2C 10323aa74088SChristophe Ricard Support for STMicroelectronics ST33ZP24 I2C devices. 10333aa74088SChristophe Ricard Requires TPM_ST33ZP24 and I2C. 10343aa74088SChristophe Ricard 1035b75fdc11SChristophe Ricard CONFIG_TPM_ST33ZP24_SPI 1036b75fdc11SChristophe Ricard Support for STMicroelectronics ST33ZP24 SPI devices. 1037b75fdc11SChristophe Ricard Requires TPM_ST33ZP24 and SPI. 1038b75fdc11SChristophe Ricard 1039c01939c7SDirk Eibach CONFIG_TPM_ATMEL_TWI 1040c01939c7SDirk Eibach Support for Atmel TWI TPM device. Requires I2C support. 1041c01939c7SDirk Eibach 104290899cc0SChe-liang Chiou CONFIG_TPM_TIS_LPC 10435e124724SVadim Bendebury Support for generic parallel port TPM devices. Only one device 10445e124724SVadim Bendebury per system is supported at this time. 10455e124724SVadim Bendebury 10465e124724SVadim Bendebury CONFIG_TPM_TIS_BASE_ADDRESS 10475e124724SVadim Bendebury Base address where the generic TPM device is mapped 10485e124724SVadim Bendebury to. Contemporary x86 systems usually map it at 10495e124724SVadim Bendebury 0xfed40000. 10505e124724SVadim Bendebury 1051be6c1529SReinhard Pfau CONFIG_TPM 1052be6c1529SReinhard Pfau Define this to enable the TPM support library which provides 1053be6c1529SReinhard Pfau functional interfaces to some TPM commands. 1054be6c1529SReinhard Pfau Requires support for a TPM device. 1055be6c1529SReinhard Pfau 1056be6c1529SReinhard Pfau CONFIG_TPM_AUTH_SESSIONS 1057be6c1529SReinhard Pfau Define this to enable authorized functions in the TPM library. 1058be6c1529SReinhard Pfau Requires CONFIG_TPM and CONFIG_SHA1. 1059be6c1529SReinhard Pfau 1060c609719bSwdenk- USB Support: 1061c609719bSwdenk At the moment only the UHCI host controller is 1062064b55cfSHeiko Schocher supported (PIP405, MIP405); define 1063c609719bSwdenk CONFIG_USB_UHCI to enable it. 1064c609719bSwdenk define CONFIG_USB_KEYBOARD to enable the USB Keyboard 106530d56faeSwdenk and define CONFIG_USB_STORAGE to enable the USB 1066c609719bSwdenk storage devices. 1067c609719bSwdenk Note: 1068c609719bSwdenk Supported are USB Keyboards and USB Floppy drives 1069c609719bSwdenk (TEAC FD-05PUB). 10704d13cbadSwdenk 10719ab4ce22SSimon Glass CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 10729ab4ce22SSimon Glass txfilltuning field in the EHCI controller on reset. 10739ab4ce22SSimon Glass 10746e9e0626SOleksandr Tymoshenko CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2 10756e9e0626SOleksandr Tymoshenko HW module registers. 10766e9e0626SOleksandr Tymoshenko 107716c8d5e7SWolfgang Denk- USB Device: 107816c8d5e7SWolfgang Denk Define the below if you wish to use the USB console. 107916c8d5e7SWolfgang Denk Once firmware is rebuilt from a serial console issue the 108016c8d5e7SWolfgang Denk command "setenv stdin usbtty; setenv stdout usbtty" and 108111ccc33fSMarcel Ziswiler attach your USB cable. The Unix command "dmesg" should print 108216c8d5e7SWolfgang Denk it has found a new device. The environment variable usbtty 108316c8d5e7SWolfgang Denk can be set to gserial or cdc_acm to enable your device to 108416c8d5e7SWolfgang Denk appear to a USB host as a Linux gserial device or a 108516c8d5e7SWolfgang Denk Common Device Class Abstract Control Model serial device. 108616c8d5e7SWolfgang Denk If you select usbtty = gserial you should be able to enumerate 108716c8d5e7SWolfgang Denk a Linux host by 108816c8d5e7SWolfgang Denk # modprobe usbserial vendor=0xVendorID product=0xProductID 108916c8d5e7SWolfgang Denk else if using cdc_acm, simply setting the environment 109016c8d5e7SWolfgang Denk variable usbtty to be cdc_acm should suffice. The following 109116c8d5e7SWolfgang Denk might be defined in YourBoardName.h 109216c8d5e7SWolfgang Denk 109316c8d5e7SWolfgang Denk CONFIG_USB_DEVICE 109416c8d5e7SWolfgang Denk Define this to build a UDC device 109516c8d5e7SWolfgang Denk 109616c8d5e7SWolfgang Denk CONFIG_USB_TTY 109716c8d5e7SWolfgang Denk Define this to have a tty type of device available to 109816c8d5e7SWolfgang Denk talk to the UDC device 109916c8d5e7SWolfgang Denk 1100f9da0f89SVipin KUMAR CONFIG_USBD_HS 1101f9da0f89SVipin KUMAR Define this to enable the high speed support for usb 1102f9da0f89SVipin KUMAR device and usbtty. If this feature is enabled, a routine 1103f9da0f89SVipin KUMAR int is_usbd_high_speed(void) 1104f9da0f89SVipin KUMAR also needs to be defined by the driver to dynamically poll 1105f9da0f89SVipin KUMAR whether the enumeration has succeded at high speed or full 1106f9da0f89SVipin KUMAR speed. 1107f9da0f89SVipin KUMAR 11086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_CONSOLE_IS_IN_ENV 110916c8d5e7SWolfgang Denk Define this if you want stdin, stdout &/or stderr to 111016c8d5e7SWolfgang Denk be set to usbtty. 111116c8d5e7SWolfgang Denk 111216c8d5e7SWolfgang Denk If you have a USB-IF assigned VendorID then you may wish to 111316c8d5e7SWolfgang Denk define your own vendor specific values either in BoardName.h 111416c8d5e7SWolfgang Denk or directly in usbd_vendor_info.h. If you don't define 111516c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 111616c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 111716c8d5e7SWolfgang Denk should pretend to be a Linux device to it's target host. 111816c8d5e7SWolfgang Denk 111916c8d5e7SWolfgang Denk CONFIG_USBD_MANUFACTURER 112016c8d5e7SWolfgang Denk Define this string as the name of your company for 112116c8d5e7SWolfgang Denk - CONFIG_USBD_MANUFACTURER "my company" 112216c8d5e7SWolfgang Denk 112316c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCT_NAME 112416c8d5e7SWolfgang Denk Define this string as the name of your product 112516c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCT_NAME "acme usb device" 112616c8d5e7SWolfgang Denk 112716c8d5e7SWolfgang Denk CONFIG_USBD_VENDORID 112816c8d5e7SWolfgang Denk Define this as your assigned Vendor ID from the USB 112916c8d5e7SWolfgang Denk Implementors Forum. This *must* be a genuine Vendor ID 113016c8d5e7SWolfgang Denk to avoid polluting the USB namespace. 113116c8d5e7SWolfgang Denk - CONFIG_USBD_VENDORID 0xFFFF 113216c8d5e7SWolfgang Denk 113316c8d5e7SWolfgang Denk CONFIG_USBD_PRODUCTID 113416c8d5e7SWolfgang Denk Define this as the unique Product ID 113516c8d5e7SWolfgang Denk for your device 113616c8d5e7SWolfgang Denk - CONFIG_USBD_PRODUCTID 0xFFFF 1137c609719bSwdenk 1138d70a560fSIgor Grinberg- ULPI Layer Support: 1139d70a560fSIgor Grinberg The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1140d70a560fSIgor Grinberg the generic ULPI layer. The generic layer accesses the ULPI PHY 1141d70a560fSIgor Grinberg via the platform viewport, so you need both the genric layer and 1142d70a560fSIgor Grinberg the viewport enabled. Currently only Chipidea/ARC based 1143d70a560fSIgor Grinberg viewport is supported. 1144d70a560fSIgor Grinberg To enable the ULPI layer support, define CONFIG_USB_ULPI and 1145d70a560fSIgor Grinberg CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 11466d365ea0SLucas Stach If your ULPI phy needs a different reference clock than the 11476d365ea0SLucas Stach standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 11486d365ea0SLucas Stach the appropriate value in Hz. 1149c609719bSwdenk 1150c609719bSwdenk- MMC Support: 1151c609719bSwdenk The MMC controller on the Intel PXA is supported. To 1152c609719bSwdenk enable this define CONFIG_MMC. The MMC can be 1153c609719bSwdenk accessed from the boot prompt by mapping the device 1154c609719bSwdenk to physical memory similar to flash. Command line is 1155602ad3b3SJon Loeliger enabled with CONFIG_CMD_MMC. The MMC driver also works with 1156602ad3b3SJon Loeliger the FAT fs. This is enabled with CONFIG_CMD_FAT. 1157c609719bSwdenk 1158afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF 1159afb35666SYoshihiro Shimoda Support for Renesas on-chip MMCIF controller 1160afb35666SYoshihiro Shimoda 1161afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_ADDR 1162afb35666SYoshihiro Shimoda Define the base address of MMCIF registers 1163afb35666SYoshihiro Shimoda 1164afb35666SYoshihiro Shimoda CONFIG_SH_MMCIF_CLK 1165afb35666SYoshihiro Shimoda Define the clock frequency for MMCIF 1166afb35666SYoshihiro Shimoda 11671fd93c6eSPierre Aubert CONFIG_SUPPORT_EMMC_BOOT 11681fd93c6eSPierre Aubert Enable some additional features of the eMMC boot partitions. 11691fd93c6eSPierre Aubert 1170b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support: 1171bb4059a5SMarek Vasut CONFIG_DFU_OVER_USB 1172b3ba6e94STom Rini This enables the USB portion of the DFU USB class 1173b3ba6e94STom Rini 1174b3ba6e94STom Rini CONFIG_DFU_MMC 1175b3ba6e94STom Rini This enables support for exposing (e)MMC devices via DFU. 1176b3ba6e94STom Rini 1177c6631764SPantelis Antoniou CONFIG_DFU_NAND 1178c6631764SPantelis Antoniou This enables support for exposing NAND devices via DFU. 1179c6631764SPantelis Antoniou 1180a9479f04SAfzal Mohammed CONFIG_DFU_RAM 1181a9479f04SAfzal Mohammed This enables support for exposing RAM via DFU. 1182a9479f04SAfzal Mohammed Note: DFU spec refer to non-volatile memory usage, but 1183a9479f04SAfzal Mohammed allow usages beyond the scope of spec - here RAM usage, 1184a9479f04SAfzal Mohammed one that would help mostly the developer. 1185a9479f04SAfzal Mohammed 1186e7e75c70SHeiko Schocher CONFIG_SYS_DFU_DATA_BUF_SIZE 1187e7e75c70SHeiko Schocher Dfu transfer uses a buffer before writing data to the 1188e7e75c70SHeiko Schocher raw storage device. Make the size (in bytes) of this buffer 1189e7e75c70SHeiko Schocher configurable. The size of this buffer is also configurable 1190e7e75c70SHeiko Schocher through the "dfu_bufsiz" environment variable. 1191e7e75c70SHeiko Schocher 1192ea2453d5SPantelis Antoniou CONFIG_SYS_DFU_MAX_FILE_SIZE 1193ea2453d5SPantelis Antoniou When updating files rather than the raw storage device, 1194ea2453d5SPantelis Antoniou we use a static buffer to copy the file into and then write 1195ea2453d5SPantelis Antoniou the buffer once we've been given the whole file. Define 1196ea2453d5SPantelis Antoniou this to the maximum filesize (in bytes) for the buffer. 1197ea2453d5SPantelis Antoniou Default is 4 MiB if undefined. 1198ea2453d5SPantelis Antoniou 1199001a8319SHeiko Schocher DFU_DEFAULT_POLL_TIMEOUT 1200001a8319SHeiko Schocher Poll timeout [ms], is the timeout a device can send to the 1201001a8319SHeiko Schocher host. The host must wait for this timeout before sending 1202001a8319SHeiko Schocher a subsequent DFU_GET_STATUS request to the device. 1203001a8319SHeiko Schocher 1204001a8319SHeiko Schocher DFU_MANIFEST_POLL_TIMEOUT 1205001a8319SHeiko Schocher Poll timeout [ms], which the device sends to the host when 1206001a8319SHeiko Schocher entering dfuMANIFEST state. Host waits this timeout, before 1207001a8319SHeiko Schocher sending again an USB request to the device. 1208001a8319SHeiko Schocher 12096705d81eSwdenk- Journaling Flash filesystem support: 1210b2482dffSSimon Glass CONFIG_JFFS2_NAND 12116705d81eSwdenk Define these for a default partition on a NAND device 12126705d81eSwdenk 12136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_SECTOR, 12146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 12156705d81eSwdenk Define these for a default partition on a NOR device 12166705d81eSwdenk 1217c609719bSwdenk- Keyboard Support: 121839f615edSSimon Glass See Kconfig help for available keyboard drivers. 121939f615edSSimon Glass 122039f615edSSimon Glass CONFIG_KEYBOARD 122139f615edSSimon Glass 122239f615edSSimon Glass Define this to enable a custom keyboard support. 122339f615edSSimon Glass This simply calls drv_keyboard_init() which must be 122439f615edSSimon Glass defined in your board-specific files. This option is deprecated 122539f615edSSimon Glass and is only used by novena. For new boards, use driver model 122639f615edSSimon Glass instead. 1227c609719bSwdenk 1228c609719bSwdenk- Video support: 12297d3053fbSTimur Tabi CONFIG_FSL_DIU_FB 12307d3053fbSTimur Tabi Enable the Freescale DIU video driver. Reference boards for 12317d3053fbSTimur Tabi SOCs that have a DIU should define this macro to enable DIU 12327d3053fbSTimur Tabi support, and should also define these other macros: 12337d3053fbSTimur Tabi 12347d3053fbSTimur Tabi CONFIG_SYS_DIU_ADDR 12357d3053fbSTimur Tabi CONFIG_VIDEO 12367d3053fbSTimur Tabi CONFIG_CFB_CONSOLE 12377d3053fbSTimur Tabi CONFIG_VIDEO_SW_CURSOR 12387d3053fbSTimur Tabi CONFIG_VGA_AS_SINGLE_DEVICE 12397d3053fbSTimur Tabi CONFIG_VIDEO_LOGO 12407d3053fbSTimur Tabi CONFIG_VIDEO_BMP_LOGO 12417d3053fbSTimur Tabi 1242ba8e76bdSTimur Tabi The DIU driver will look for the 'video-mode' environment 1243ba8e76bdSTimur Tabi variable, and if defined, enable the DIU as a console during 12448eca9439SFabio Estevam boot. See the documentation file doc/README.video for a 1245ba8e76bdSTimur Tabi description of this variable. 12467d3053fbSTimur Tabi 1247c609719bSwdenk- LCD Support: CONFIG_LCD 1248c609719bSwdenk 1249c609719bSwdenk Define this to enable LCD support (for output to LCD 1250c609719bSwdenk display); also select one of the supported displays 1251c609719bSwdenk by defining one of these: 1252c609719bSwdenk 125339cf4804SStelian Pop CONFIG_ATMEL_LCD: 125439cf4804SStelian Pop 125539cf4804SStelian Pop HITACHI TX09D70VM1CCA, 3.5", 240x320. 125639cf4804SStelian Pop 1257fd3103bbSwdenk CONFIG_NEC_NL6448AC33: 1258c609719bSwdenk 1259fd3103bbSwdenk NEC NL6448AC33-18. Active, color, single scan. 1260c609719bSwdenk 1261fd3103bbSwdenk CONFIG_NEC_NL6448BC20 1262c609719bSwdenk 1263fd3103bbSwdenk NEC NL6448BC20-08. 6.5", 640x480. 1264fd3103bbSwdenk Active, color, single scan. 1265fd3103bbSwdenk 1266fd3103bbSwdenk CONFIG_NEC_NL6448BC33_54 1267fd3103bbSwdenk 1268fd3103bbSwdenk NEC NL6448BC33-54. 10.4", 640x480. 1269c609719bSwdenk Active, color, single scan. 1270c609719bSwdenk 1271c609719bSwdenk CONFIG_SHARP_16x9 1272c609719bSwdenk 1273c609719bSwdenk Sharp 320x240. Active, color, single scan. 1274c609719bSwdenk It isn't 16x9, and I am not sure what it is. 1275c609719bSwdenk 1276c609719bSwdenk CONFIG_SHARP_LQ64D341 1277c609719bSwdenk 1278c609719bSwdenk Sharp LQ64D341 display, 640x480. 1279c609719bSwdenk Active, color, single scan. 1280c609719bSwdenk 1281c609719bSwdenk CONFIG_HLD1045 1282c609719bSwdenk 1283c609719bSwdenk HLD1045 display, 640x480. 1284c609719bSwdenk Active, color, single scan. 1285c609719bSwdenk 1286c609719bSwdenk CONFIG_OPTREX_BW 1287c609719bSwdenk 1288c609719bSwdenk Optrex CBL50840-2 NF-FW 99 22 M5 1289c609719bSwdenk or 1290c609719bSwdenk Hitachi LMG6912RPFC-00T 1291c609719bSwdenk or 1292c609719bSwdenk Hitachi SP14Q002 1293c609719bSwdenk 1294c609719bSwdenk 320x240. Black & white. 1295c609719bSwdenk 1296676d319eSSimon Glass CONFIG_LCD_ALIGNMENT 1297676d319eSSimon Glass 1298b445bbb4SJeremiah Mahler Normally the LCD is page-aligned (typically 4KB). If this is 1299676d319eSSimon Glass defined then the LCD will be aligned to this value instead. 1300676d319eSSimon Glass For ARM it is sometimes useful to use MMU_SECTION_SIZE 1301676d319eSSimon Glass here, since it is cheaper to change data cache settings on 1302676d319eSSimon Glass a per-section basis. 1303676d319eSSimon Glass 1304676d319eSSimon Glass 1305604c7d4aSHannes Petermaier CONFIG_LCD_ROTATION 1306604c7d4aSHannes Petermaier 1307604c7d4aSHannes Petermaier Sometimes, for example if the display is mounted in portrait 1308604c7d4aSHannes Petermaier mode or even if it's mounted landscape but rotated by 180degree, 1309604c7d4aSHannes Petermaier we need to rotate our content of the display relative to the 1310604c7d4aSHannes Petermaier framebuffer, so that user can read the messages which are 1311604c7d4aSHannes Petermaier printed out. 1312604c7d4aSHannes Petermaier Once CONFIG_LCD_ROTATION is defined, the lcd_console will be 1313604c7d4aSHannes Petermaier initialized with a given rotation from "vl_rot" out of 1314604c7d4aSHannes Petermaier "vidinfo_t" which is provided by the board specific code. 1315604c7d4aSHannes Petermaier The value for vl_rot is coded as following (matching to 1316604c7d4aSHannes Petermaier fbcon=rotate:<n> linux-kernel commandline): 1317604c7d4aSHannes Petermaier 0 = no rotation respectively 0 degree 1318604c7d4aSHannes Petermaier 1 = 90 degree rotation 1319604c7d4aSHannes Petermaier 2 = 180 degree rotation 1320604c7d4aSHannes Petermaier 3 = 270 degree rotation 1321604c7d4aSHannes Petermaier 1322604c7d4aSHannes Petermaier If CONFIG_LCD_ROTATION is not defined, the console will be 1323604c7d4aSHannes Petermaier initialized with 0degree rotation. 1324604c7d4aSHannes Petermaier 132545d7f525STom Wai-Hong Tam CONFIG_LCD_BMP_RLE8 132645d7f525STom Wai-Hong Tam 132745d7f525STom Wai-Hong Tam Support drawing of RLE8-compressed bitmaps on the LCD. 132845d7f525STom Wai-Hong Tam 1329735987c5STom Wai-Hong Tam CONFIG_I2C_EDID 1330735987c5STom Wai-Hong Tam 1331735987c5STom Wai-Hong Tam Enables an 'i2c edid' command which can read EDID 1332735987c5STom Wai-Hong Tam information over I2C from an attached LCD display. 1333735987c5STom Wai-Hong Tam 13347152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN 1335d791b1dcSwdenk 1336d791b1dcSwdenk If this option is set, the environment is checked for 1337d791b1dcSwdenk a variable "splashimage". If found, the usual display 1338d791b1dcSwdenk of logo, copyright and system information on the LCD 1339e94d2cd9Swdenk is suppressed and the BMP image at the address 1340d791b1dcSwdenk specified in "splashimage" is loaded instead. The 1341d791b1dcSwdenk console is redirected to the "nulldev", too. This 1342d791b1dcSwdenk allows for a "silent" boot where a splash screen is 1343d791b1dcSwdenk loaded very quickly after power-on. 1344d791b1dcSwdenk 1345c0880485SNikita Kiryanov CONFIG_SPLASHIMAGE_GUARD 1346c0880485SNikita Kiryanov 1347c0880485SNikita Kiryanov If this option is set, then U-Boot will prevent the environment 1348c0880485SNikita Kiryanov variable "splashimage" from being set to a problematic address 1349ab5645f1SFabio Estevam (see doc/README.displaying-bmps). 1350c0880485SNikita Kiryanov This option is useful for targets where, due to alignment 1351c0880485SNikita Kiryanov restrictions, an improperly aligned BMP image will cause a data 1352c0880485SNikita Kiryanov abort. If you think you will not have problems with unaligned 1353c0880485SNikita Kiryanov accesses (for example because your toolchain prevents them) 1354c0880485SNikita Kiryanov there is no need to set this option. 1355c0880485SNikita Kiryanov 13561ca298ceSMatthias Weisser CONFIG_SPLASH_SCREEN_ALIGN 13571ca298ceSMatthias Weisser 13581ca298ceSMatthias Weisser If this option is set the splash image can be freely positioned 13591ca298ceSMatthias Weisser on the screen. Environment variable "splashpos" specifies the 13601ca298ceSMatthias Weisser position as "x,y". If a positive number is given it is used as 13611ca298ceSMatthias Weisser number of pixel from left/top. If a negative number is given it 13621ca298ceSMatthias Weisser is used as number of pixel from right/bottom. You can also 13631ca298ceSMatthias Weisser specify 'm' for centering the image. 13641ca298ceSMatthias Weisser 13651ca298ceSMatthias Weisser Example: 13661ca298ceSMatthias Weisser setenv splashpos m,m 13671ca298ceSMatthias Weisser => image at center of screen 13681ca298ceSMatthias Weisser 13691ca298ceSMatthias Weisser setenv splashpos 30,20 13701ca298ceSMatthias Weisser => image at x = 30 and y = 20 13711ca298ceSMatthias Weisser 13721ca298ceSMatthias Weisser setenv splashpos -10,m 13731ca298ceSMatthias Weisser => vertically centered image 13741ca298ceSMatthias Weisser at x = dspWidth - bmpWidth - 9 13751ca298ceSMatthias Weisser 137698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 137798f4a3dfSStefan Roese 137898f4a3dfSStefan Roese If this option is set, additionally to standard BMP 137998f4a3dfSStefan Roese images, gzipped BMP images can be displayed via the 138098f4a3dfSStefan Roese splashscreen support or the bmp command. 138198f4a3dfSStefan Roese 1382d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1383d5011762SAnatolij Gustschin 1384d5011762SAnatolij Gustschin If this option is set, 8-bit RLE compressed BMP images 1385d5011762SAnatolij Gustschin can be displayed via the splashscreen support or the 1386d5011762SAnatolij Gustschin bmp command. 1387d5011762SAnatolij Gustschin 1388c29fdfc1Swdenk- Compression support: 13898ef70478SKees Cook CONFIG_GZIP 13908ef70478SKees Cook 13918ef70478SKees Cook Enabled by default to support gzip compressed images. 13928ef70478SKees Cook 1393c29fdfc1Swdenk CONFIG_BZIP2 1394c29fdfc1Swdenk 1395c29fdfc1Swdenk If this option is set, support for bzip2 compressed 1396c29fdfc1Swdenk images is included. If not, only uncompressed and gzip 1397c29fdfc1Swdenk compressed images are supported. 1398c29fdfc1Swdenk 1399c29fdfc1Swdenk NOTE: the bzip2 algorithm requires a lot of RAM, so 14006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1401c29fdfc1Swdenk be at least 4MB. 1402d791b1dcSwdenk 140317ea1177Swdenk- MII/PHY support: 140417ea1177Swdenk CONFIG_PHY_CLOCK_FREQ (ppc4xx) 140517ea1177Swdenk 140617ea1177Swdenk The clock frequency of the MII bus 140717ea1177Swdenk 140817ea1177Swdenk CONFIG_PHY_RESET_DELAY 140917ea1177Swdenk 141017ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 141117ea1177Swdenk reset before any MII register access is possible. 141217ea1177Swdenk For such PHY, set this option to the usec delay 141317ea1177Swdenk required. (minimum 300usec for LXT971A) 141417ea1177Swdenk 141517ea1177Swdenk CONFIG_PHY_CMD_DELAY (ppc4xx) 141617ea1177Swdenk 141717ea1177Swdenk Some PHY like Intel LXT971A need extra delay after 141817ea1177Swdenk command issued before MII status register can be read 141917ea1177Swdenk 1420c609719bSwdenk- IP address: 1421c609719bSwdenk CONFIG_IPADDR 1422c609719bSwdenk 1423c609719bSwdenk Define a default value for the IP address to use for 142411ccc33fSMarcel Ziswiler the default Ethernet interface, in case this is not 1425c609719bSwdenk determined through e.g. bootp. 14261ebcd654SWolfgang Denk (Environment variable "ipaddr") 1427c609719bSwdenk 1428c609719bSwdenk- Server IP address: 1429c609719bSwdenk CONFIG_SERVERIP 1430c609719bSwdenk 1431c609719bSwdenk Defines a default value for the IP address of a TFTP 1432c609719bSwdenk server to contact when using the "tftboot" command. 14331ebcd654SWolfgang Denk (Environment variable "serverip") 1434c609719bSwdenk 143597cfe861SRobin Getz CONFIG_KEEP_SERVERADDR 143697cfe861SRobin Getz 143797cfe861SRobin Getz Keeps the server's MAC address, in the env 'serveraddr' 143897cfe861SRobin Getz for passing to bootargs (like Linux's netconsole option) 143997cfe861SRobin Getz 14401ebcd654SWolfgang Denk- Gateway IP address: 14411ebcd654SWolfgang Denk CONFIG_GATEWAYIP 14421ebcd654SWolfgang Denk 14431ebcd654SWolfgang Denk Defines a default value for the IP address of the 14441ebcd654SWolfgang Denk default router where packets to other networks are 14451ebcd654SWolfgang Denk sent to. 14461ebcd654SWolfgang Denk (Environment variable "gatewayip") 14471ebcd654SWolfgang Denk 14481ebcd654SWolfgang Denk- Subnet mask: 14491ebcd654SWolfgang Denk CONFIG_NETMASK 14501ebcd654SWolfgang Denk 14511ebcd654SWolfgang Denk Defines a default value for the subnet mask (or 14521ebcd654SWolfgang Denk routing prefix) which is used to determine if an IP 14531ebcd654SWolfgang Denk address belongs to the local subnet or needs to be 14541ebcd654SWolfgang Denk forwarded through a router. 14551ebcd654SWolfgang Denk (Environment variable "netmask") 14561ebcd654SWolfgang Denk 145753a5c424SDavid Updegraff- Multicast TFTP Mode: 145853a5c424SDavid Updegraff CONFIG_MCAST_TFTP 145953a5c424SDavid Updegraff 146053a5c424SDavid Updegraff Defines whether you want to support multicast TFTP as per 146153a5c424SDavid Updegraff rfc-2090; for example to work with atftp. Lets lots of targets 146211ccc33fSMarcel Ziswiler tftp down the same boot image concurrently. Note: the Ethernet 146353a5c424SDavid Updegraff driver in use must provide a function: mcast() to join/leave a 146453a5c424SDavid Updegraff multicast group. 146553a5c424SDavid Updegraff 1466c609719bSwdenk- BOOTP Recovery Mode: 1467c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY 1468c609719bSwdenk 1469c609719bSwdenk If you have many targets in a network that try to 1470c609719bSwdenk boot using BOOTP, you may want to avoid that all 1471c609719bSwdenk systems send out BOOTP requests at precisely the same 1472c609719bSwdenk moment (which would happen for instance at recovery 1473c609719bSwdenk from a power failure, when all systems will try to 1474c609719bSwdenk boot, thus flooding the BOOTP server. Defining 1475c609719bSwdenk CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1476c609719bSwdenk inserted before sending out BOOTP requests. The 14776c33c785SWolfgang Denk following delays are inserted then: 1478c609719bSwdenk 1479c609719bSwdenk 1st BOOTP request: delay 0 ... 1 sec 1480c609719bSwdenk 2nd BOOTP request: delay 0 ... 2 sec 1481c609719bSwdenk 3rd BOOTP request: delay 0 ... 4 sec 1482c609719bSwdenk 4th and following 1483c609719bSwdenk BOOTP requests: delay 0 ... 8 sec 1484c609719bSwdenk 148592ac8accSThierry Reding CONFIG_BOOTP_ID_CACHE_SIZE 148692ac8accSThierry Reding 148792ac8accSThierry Reding BOOTP packets are uniquely identified using a 32-bit ID. The 148892ac8accSThierry Reding server will copy the ID from client requests to responses and 148992ac8accSThierry Reding U-Boot will use this to determine if it is the destination of 149092ac8accSThierry Reding an incoming response. Some servers will check that addresses 149192ac8accSThierry Reding aren't in use before handing them out (usually using an ARP 149292ac8accSThierry Reding ping) and therefore take up to a few hundred milliseconds to 149392ac8accSThierry Reding respond. Network congestion may also influence the time it 149492ac8accSThierry Reding takes for a response to make it back to the client. If that 149592ac8accSThierry Reding time is too long, U-Boot will retransmit requests. In order 149692ac8accSThierry Reding to allow earlier responses to still be accepted after these 149792ac8accSThierry Reding retransmissions, U-Boot's BOOTP client keeps a small cache of 149892ac8accSThierry Reding IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this 149992ac8accSThierry Reding cache. The default is to keep IDs for up to four outstanding 150092ac8accSThierry Reding requests. Increasing this will allow U-Boot to accept offers 150192ac8accSThierry Reding from a BOOTP client in networks with unusually high latency. 150292ac8accSThierry Reding 1503fe389a82Sstroese- DHCP Advanced Options: 15041fe80d79SJon Loeliger You can fine tune the DHCP functionality by defining 15051fe80d79SJon Loeliger CONFIG_BOOTP_* symbols: 1506fe389a82Sstroese 15071fe80d79SJon Loeliger CONFIG_BOOTP_NISDOMAIN 15081fe80d79SJon Loeliger CONFIG_BOOTP_BOOTFILESIZE 15091fe80d79SJon Loeliger CONFIG_BOOTP_SEND_HOSTNAME 15101fe80d79SJon Loeliger CONFIG_BOOTP_NTPSERVER 15111fe80d79SJon Loeliger CONFIG_BOOTP_TIMEOFFSET 15121fe80d79SJon Loeliger CONFIG_BOOTP_VENDOREX 15132c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL 1514fe389a82Sstroese 15155d110f0aSWilson Callan CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 15165d110f0aSWilson Callan environment variable, not the BOOTP server. 1517fe389a82Sstroese 15182c00e099SJoe Hershberger CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 15192c00e099SJoe Hershberger after the configured retry count, the call will fail 15202c00e099SJoe Hershberger instead of starting over. This can be used to fail over 15212c00e099SJoe Hershberger to Link-local IP address configuration if the DHCP server 15222c00e099SJoe Hershberger is not available. 15232c00e099SJoe Hershberger 1524fe389a82Sstroese CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1525fe389a82Sstroese to do a dynamic update of a DNS server. To do this, they 1526fe389a82Sstroese need the hostname of the DHCP requester. 15275d110f0aSWilson Callan If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 15281fe80d79SJon Loeliger of the "hostname" environment variable is passed as 15291fe80d79SJon Loeliger option 12 to the DHCP server. 1530fe389a82Sstroese 1531d9a2f416SAras Vaichas CONFIG_BOOTP_DHCP_REQUEST_DELAY 1532d9a2f416SAras Vaichas 1533d9a2f416SAras Vaichas A 32bit value in microseconds for a delay between 1534d9a2f416SAras Vaichas receiving a "DHCP Offer" and sending the "DHCP Request". 1535d9a2f416SAras Vaichas This fixes a problem with certain DHCP servers that don't 1536d9a2f416SAras Vaichas respond 100% of the time to a "DHCP request". E.g. On an 1537d9a2f416SAras Vaichas AT91RM9200 processor running at 180MHz, this delay needed 1538d9a2f416SAras Vaichas to be *at least* 15,000 usec before a Windows Server 2003 1539d9a2f416SAras Vaichas DHCP server would reply 100% of the time. I recommend at 1540d9a2f416SAras Vaichas least 50,000 usec to be safe. The alternative is to hope 1541d9a2f416SAras Vaichas that one of the retries will be successful but note that 1542d9a2f416SAras Vaichas the DHCP timeout and retry process takes a longer than 1543d9a2f416SAras Vaichas this delay. 1544d9a2f416SAras Vaichas 1545d22c338eSJoe Hershberger - Link-local IP address negotiation: 1546d22c338eSJoe Hershberger Negotiate with other link-local clients on the local network 1547d22c338eSJoe Hershberger for an address that doesn't require explicit configuration. 1548d22c338eSJoe Hershberger This is especially useful if a DHCP server cannot be guaranteed 1549d22c338eSJoe Hershberger to exist in all environments that the device must operate. 1550d22c338eSJoe Hershberger 1551d22c338eSJoe Hershberger See doc/README.link-local for more information. 1552d22c338eSJoe Hershberger 155324acb83dSPrabhakar Kushwaha - MAC address from environment variables 155424acb83dSPrabhakar Kushwaha 155524acb83dSPrabhakar Kushwaha FDT_SEQ_MACADDR_FROM_ENV 155624acb83dSPrabhakar Kushwaha 155724acb83dSPrabhakar Kushwaha Fix-up device tree with MAC addresses fetched sequentially from 155824acb83dSPrabhakar Kushwaha environment variables. This config work on assumption that 155924acb83dSPrabhakar Kushwaha non-usable ethernet node of device-tree are either not present 156024acb83dSPrabhakar Kushwaha or their status has been marked as "disabled". 156124acb83dSPrabhakar Kushwaha 1562a3d991bdSwdenk - CDP Options: 1563a3d991bdSwdenk CONFIG_CDP_DEVICE_ID 1564a3d991bdSwdenk 1565a3d991bdSwdenk The device id used in CDP trigger frames. 1566a3d991bdSwdenk 1567a3d991bdSwdenk CONFIG_CDP_DEVICE_ID_PREFIX 1568a3d991bdSwdenk 1569a3d991bdSwdenk A two character string which is prefixed to the MAC address 1570a3d991bdSwdenk of the device. 1571a3d991bdSwdenk 1572a3d991bdSwdenk CONFIG_CDP_PORT_ID 1573a3d991bdSwdenk 1574a3d991bdSwdenk A printf format string which contains the ascii name of 1575a3d991bdSwdenk the port. Normally is set to "eth%d" which sets 157611ccc33fSMarcel Ziswiler eth0 for the first Ethernet, eth1 for the second etc. 1577a3d991bdSwdenk 1578a3d991bdSwdenk CONFIG_CDP_CAPABILITIES 1579a3d991bdSwdenk 1580a3d991bdSwdenk A 32bit integer which indicates the device capabilities; 1581a3d991bdSwdenk 0x00000010 for a normal host which does not forwards. 1582a3d991bdSwdenk 1583a3d991bdSwdenk CONFIG_CDP_VERSION 1584a3d991bdSwdenk 1585a3d991bdSwdenk An ascii string containing the version of the software. 1586a3d991bdSwdenk 1587a3d991bdSwdenk CONFIG_CDP_PLATFORM 1588a3d991bdSwdenk 1589a3d991bdSwdenk An ascii string containing the name of the platform. 1590a3d991bdSwdenk 1591a3d991bdSwdenk CONFIG_CDP_TRIGGER 1592a3d991bdSwdenk 1593a3d991bdSwdenk A 32bit integer sent on the trigger. 1594a3d991bdSwdenk 1595a3d991bdSwdenk CONFIG_CDP_POWER_CONSUMPTION 1596a3d991bdSwdenk 1597a3d991bdSwdenk A 16bit integer containing the power consumption of the 1598a3d991bdSwdenk device in .1 of milliwatts. 1599a3d991bdSwdenk 1600a3d991bdSwdenk CONFIG_CDP_APPLIANCE_VLAN_TYPE 1601a3d991bdSwdenk 1602a3d991bdSwdenk A byte containing the id of the VLAN. 1603a3d991bdSwdenk 160479267eddSUri Mashiach- Status LED: CONFIG_LED_STATUS 1605c609719bSwdenk 1606c609719bSwdenk Several configurations allow to display the current 1607c609719bSwdenk status using a LED. For instance, the LED will blink 1608c609719bSwdenk fast while running U-Boot code, stop blinking as 1609c609719bSwdenk soon as a reply to a BOOTP request was received, and 1610c609719bSwdenk start blinking slow once the Linux kernel is running 1611c609719bSwdenk (supported by a status LED driver in the Linux 161279267eddSUri Mashiach kernel). Defining CONFIG_LED_STATUS enables this 1613c609719bSwdenk feature in U-Boot. 1614c609719bSwdenk 16151df7bbbaSIgor Grinberg Additional options: 16161df7bbbaSIgor Grinberg 161779267eddSUri Mashiach CONFIG_LED_STATUS_GPIO 16181df7bbbaSIgor Grinberg The status LED can be connected to a GPIO pin. 16191df7bbbaSIgor Grinberg In such cases, the gpio_led driver can be used as a 162079267eddSUri Mashiach status LED backend implementation. Define CONFIG_LED_STATUS_GPIO 16211df7bbbaSIgor Grinberg to include the gpio_led driver in the U-Boot binary. 16221df7bbbaSIgor Grinberg 16239dfdcdfeSIgor Grinberg CONFIG_GPIO_LED_INVERTED_TABLE 16249dfdcdfeSIgor Grinberg Some GPIO connected LEDs may have inverted polarity in which 16259dfdcdfeSIgor Grinberg case the GPIO high value corresponds to LED off state and 16269dfdcdfeSIgor Grinberg GPIO low value corresponds to LED on state. 16279dfdcdfeSIgor Grinberg In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 16289dfdcdfeSIgor Grinberg with a list of GPIO LEDs that have inverted polarity. 16299dfdcdfeSIgor Grinberg 16303f4978c7SHeiko Schocher- I2C Support: CONFIG_SYS_I2C 1631c609719bSwdenk 16323f4978c7SHeiko Schocher This enable the NEW i2c subsystem, and will allow you to use 16333f4978c7SHeiko Schocher i2c commands at the u-boot command line (as long as you set 16343f4978c7SHeiko Schocher CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 16353f4978c7SHeiko Schocher based realtime clock chips or other i2c devices. See 16363f4978c7SHeiko Schocher common/cmd_i2c.c for a description of the command line 16373f4978c7SHeiko Schocher interface. 16383f4978c7SHeiko Schocher 16393f4978c7SHeiko Schocher ported i2c driver to the new framework: 1640ea818dbbSHeiko Schocher - drivers/i2c/soft_i2c.c: 1641ea818dbbSHeiko Schocher - activate first bus with CONFIG_SYS_I2C_SOFT define 1642ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 1643ea818dbbSHeiko Schocher for defining speed and slave address 1644ea818dbbSHeiko Schocher - activate second bus with I2C_SOFT_DECLARATIONS2 define 1645ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 1646ea818dbbSHeiko Schocher for defining speed and slave address 1647ea818dbbSHeiko Schocher - activate third bus with I2C_SOFT_DECLARATIONS3 define 1648ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 1649ea818dbbSHeiko Schocher for defining speed and slave address 1650ea818dbbSHeiko Schocher - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 1651ea818dbbSHeiko Schocher CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 1652ea818dbbSHeiko Schocher for defining speed and slave address 16533f4978c7SHeiko Schocher 165400f792e0SHeiko Schocher - drivers/i2c/fsl_i2c.c: 165500f792e0SHeiko Schocher - activate i2c driver with CONFIG_SYS_I2C_FSL 165600f792e0SHeiko Schocher define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 165700f792e0SHeiko Schocher offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 165800f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 165900f792e0SHeiko Schocher bus. 166000f792e0SHeiko Schocher - If your board supports a second fsl i2c bus, define 166100f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 166200f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SPEED for the speed and 166300f792e0SHeiko Schocher CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 166400f792e0SHeiko Schocher second bus. 166500f792e0SHeiko Schocher 16661f2ba722SSimon Glass - drivers/i2c/tegra_i2c.c: 16671f2ba722SSimon Glass - activate this driver with CONFIG_SYS_I2C_TEGRA 16681f2ba722SSimon Glass - This driver adds 4 i2c buses with a fix speed from 16691f2ba722SSimon Glass 100000 and the slave addr 0! 16701f2ba722SSimon Glass 1671880540deSDirk Eibach - drivers/i2c/ppc4xx_i2c.c 1672880540deSDirk Eibach - activate this driver with CONFIG_SYS_I2C_PPC4XX 1673880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 1674880540deSDirk Eibach - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 1675880540deSDirk Eibach 1676fac96408Strem - drivers/i2c/i2c_mxc.c 1677fac96408Strem - activate this driver with CONFIG_SYS_I2C_MXC 167803544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1 167903544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2 168003544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3 168103544c66SAlbert ARIBAUD \\(3ADEV\\) - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4 1682fac96408Strem - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 1683fac96408Strem - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 1684fac96408Strem - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 1685fac96408Strem - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 1686fac96408Strem - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 1687fac96408Strem - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 168803544c66SAlbert ARIBAUD \\(3ADEV\\) - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED 168903544c66SAlbert ARIBAUD \\(3ADEV\\) - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE 1690b445bbb4SJeremiah Mahler If those defines are not set, default value is 100000 1691fac96408Strem for speed, and 0 for slave. 1692fac96408Strem 16931086bfa9SNobuhiro Iwamatsu - drivers/i2c/rcar_i2c.c: 16941086bfa9SNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_RCAR 16951086bfa9SNobuhiro Iwamatsu - This driver adds 4 i2c buses 16961086bfa9SNobuhiro Iwamatsu 16971086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 16981086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 16991086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 17001086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 17011086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 17021086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 17031086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 17041086bfa9SNobuhiro Iwamatsu - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 17051086bfa9SNobuhiro Iwamatsu - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 17061086bfa9SNobuhiro Iwamatsu 17072035d77dSNobuhiro Iwamatsu - drivers/i2c/sh_i2c.c: 17082035d77dSNobuhiro Iwamatsu - activate this driver with CONFIG_SYS_I2C_SH 17092035d77dSNobuhiro Iwamatsu - This driver adds from 2 to 5 i2c buses 17102035d77dSNobuhiro Iwamatsu 17112035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 17122035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 17132035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 17142035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 17152035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 17162035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 17172035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 17182035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 17192035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 17202035d77dSNobuhiro Iwamatsu - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 1721b445bbb4SJeremiah Mahler - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses 17222035d77dSNobuhiro Iwamatsu 17236789e84eSHeiko Schocher - drivers/i2c/omap24xx_i2c.c 17246789e84eSHeiko Schocher - activate this driver with CONFIG_SYS_I2C_OMAP24XX 17256789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 17266789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 17276789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 17286789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 17296789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 17306789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 17316789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 17326789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 17336789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 17346789e84eSHeiko Schocher - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 17356789e84eSHeiko Schocher 17360bdffe71SHeiko Schocher - drivers/i2c/zynq_i2c.c 17370bdffe71SHeiko Schocher - activate this driver with CONFIG_SYS_I2C_ZYNQ 17380bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 17390bdffe71SHeiko Schocher - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 17400bdffe71SHeiko Schocher 1741e717fc6dSNaveen Krishna Ch - drivers/i2c/s3c24x0_i2c.c: 1742e717fc6dSNaveen Krishna Ch - activate this driver with CONFIG_SYS_I2C_S3C24X0 1743e717fc6dSNaveen Krishna Ch - This driver adds i2c buses (11 for Exynos5250, Exynos5420 1744e717fc6dSNaveen Krishna Ch 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 1745e717fc6dSNaveen Krishna Ch with a fix speed from 100000 and the slave addr 0! 1746e717fc6dSNaveen Krishna Ch 1747b46226bdSDirk Eibach - drivers/i2c/ihs_i2c.c 1748b46226bdSDirk Eibach - activate this driver with CONFIG_SYS_I2C_IHS 1749b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0 1750b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0 1751b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0 1752b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1 1753b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1 1754b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1 1755b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2 1756b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2 1757b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2 1758b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3 1759b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3 1760b46226bdSDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3 1761071be896SDirk Eibach - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL 1762071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1 1763071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1 1764071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1 1765071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1 1766071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1 1767071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1 1768071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1 1769071be896SDirk Eibach - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1 1770b46226bdSDirk Eibach 17713f4978c7SHeiko Schocher additional defines: 17723f4978c7SHeiko Schocher 17733f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES 1774945a18e6SSimon Glass Hold the number of i2c buses you want to use. 17753f4978c7SHeiko Schocher 17763f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS 17773f4978c7SHeiko Schocher define this, if you don't use i2c muxes on your hardware. 17783f4978c7SHeiko Schocher if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 17793f4978c7SHeiko Schocher omit this define. 17803f4978c7SHeiko Schocher 17813f4978c7SHeiko Schocher CONFIG_SYS_I2C_MAX_HOPS 17823f4978c7SHeiko Schocher define how many muxes are maximal consecutively connected 17833f4978c7SHeiko Schocher on one i2c bus. If you not use i2c muxes, omit this 17843f4978c7SHeiko Schocher define. 17853f4978c7SHeiko Schocher 17863f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES 1787b445bbb4SJeremiah Mahler hold a list of buses you want to use, only used if 17883f4978c7SHeiko Schocher CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 17893f4978c7SHeiko Schocher a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 17903f4978c7SHeiko Schocher CONFIG_SYS_NUM_I2C_BUSES = 9: 17913f4978c7SHeiko Schocher 17923f4978c7SHeiko Schocher CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 17933f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 17943f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 17953f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 17963f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 17973f4978c7SHeiko Schocher {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 17983f4978c7SHeiko Schocher {1, {I2C_NULL_HOP}}, \ 17993f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 18003f4978c7SHeiko Schocher {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 18013f4978c7SHeiko Schocher } 18023f4978c7SHeiko Schocher 18033f4978c7SHeiko Schocher which defines 18043f4978c7SHeiko Schocher bus 0 on adapter 0 without a mux 1805ea818dbbSHeiko Schocher bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 1806ea818dbbSHeiko Schocher bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 1807ea818dbbSHeiko Schocher bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 1808ea818dbbSHeiko Schocher bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 1809ea818dbbSHeiko Schocher bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 18103f4978c7SHeiko Schocher bus 6 on adapter 1 without a mux 1811ea818dbbSHeiko Schocher bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 1812ea818dbbSHeiko Schocher bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 18133f4978c7SHeiko Schocher 18143f4978c7SHeiko Schocher If you do not have i2c muxes on your board, omit this define. 18153f4978c7SHeiko Schocher 1816ce3b5d69SSimon Glass- Legacy I2C Support: 1817ea818dbbSHeiko Schocher If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 1818b37c7e5eSwdenk then the following macros need to be defined (examples are 1819b37c7e5eSwdenk from include/configs/lwmon.h): 1820c609719bSwdenk 1821c609719bSwdenk I2C_INIT 1822c609719bSwdenk 1823b37c7e5eSwdenk (Optional). Any commands necessary to enable the I2C 1824c609719bSwdenk controller or configure ports. 1825c609719bSwdenk 1826b37c7e5eSwdenk eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1827b37c7e5eSwdenk 1828c609719bSwdenk I2C_ACTIVE 1829c609719bSwdenk 1830c609719bSwdenk The code necessary to make the I2C data line active 1831c609719bSwdenk (driven). If the data line is open collector, this 1832c609719bSwdenk define can be null. 1833c609719bSwdenk 1834b37c7e5eSwdenk eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1835b37c7e5eSwdenk 1836c609719bSwdenk I2C_TRISTATE 1837c609719bSwdenk 1838c609719bSwdenk The code necessary to make the I2C data line tri-stated 1839c609719bSwdenk (inactive). If the data line is open collector, this 1840c609719bSwdenk define can be null. 1841c609719bSwdenk 1842b37c7e5eSwdenk eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1843b37c7e5eSwdenk 1844c609719bSwdenk I2C_READ 1845c609719bSwdenk 1846472d5460SYork Sun Code that returns true if the I2C data line is high, 1847472d5460SYork Sun false if it is low. 1848c609719bSwdenk 1849b37c7e5eSwdenk eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1850b37c7e5eSwdenk 1851c609719bSwdenk I2C_SDA(bit) 1852c609719bSwdenk 1853472d5460SYork Sun If <bit> is true, sets the I2C data line high. If it 1854472d5460SYork Sun is false, it clears it (low). 1855c609719bSwdenk 1856b37c7e5eSwdenk eg: #define I2C_SDA(bit) \ 1857b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1858b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SDA 1859b37c7e5eSwdenk 1860c609719bSwdenk I2C_SCL(bit) 1861c609719bSwdenk 1862472d5460SYork Sun If <bit> is true, sets the I2C clock line high. If it 1863472d5460SYork Sun is false, it clears it (low). 1864c609719bSwdenk 1865b37c7e5eSwdenk eg: #define I2C_SCL(bit) \ 1866b37c7e5eSwdenk if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1867b37c7e5eSwdenk else immr->im_cpm.cp_pbdat &= ~PB_SCL 1868b37c7e5eSwdenk 1869c609719bSwdenk I2C_DELAY 1870c609719bSwdenk 1871c609719bSwdenk This delay is invoked four times per clock cycle so this 1872c609719bSwdenk controls the rate of data transfer. The data rate thus 1873b37c7e5eSwdenk is 1 / (I2C_DELAY * 4). Often defined to be something 1874b37c7e5eSwdenk like: 1875b37c7e5eSwdenk 1876b37c7e5eSwdenk #define I2C_DELAY udelay(2) 1877c609719bSwdenk 1878793b5726SMike Frysinger CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1879793b5726SMike Frysinger 1880793b5726SMike Frysinger If your arch supports the generic GPIO framework (asm/gpio.h), 1881793b5726SMike Frysinger then you may alternatively define the two GPIOs that are to be 1882793b5726SMike Frysinger used as SCL / SDA. Any of the previous I2C_xxx macros will 1883793b5726SMike Frysinger have GPIO-based defaults assigned to them as appropriate. 1884793b5726SMike Frysinger 1885793b5726SMike Frysinger You should define these to the GPIO value as given directly to 1886793b5726SMike Frysinger the generic GPIO functions. 1887793b5726SMike Frysinger 18886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_INIT_BOARD 188947cd00faSwdenk 189047cd00faSwdenk When a board is reset during an i2c bus transfer 189147cd00faSwdenk chips might think that the current transfer is still 189247cd00faSwdenk in progress. On some boards it is possible to access 189347cd00faSwdenk the i2c SCLK line directly, either by using the 189447cd00faSwdenk processor pin as a GPIO or by having a second pin 189547cd00faSwdenk connected to the bus. If this option is defined a 189647cd00faSwdenk custom i2c_init_board() routine in boards/xxx/board.c 189747cd00faSwdenk is run early in the boot sequence. 189847cd00faSwdenk 1899bb99ad6dSBen Warren CONFIG_I2C_MULTI_BUS 1900bb99ad6dSBen Warren 1901bb99ad6dSBen Warren This option allows the use of multiple I2C buses, each of which 1902bb99ad6dSBen Warren must have a controller. At any point in time, only one bus is 1903bb99ad6dSBen Warren active. To switch to a different bus, use the 'i2c dev' command. 1904bb99ad6dSBen Warren Note that bus numbering is zero-based. 1905bb99ad6dSBen Warren 19066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_I2C_NOPROBES 1907bb99ad6dSBen Warren 1908bb99ad6dSBen Warren This option specifies a list of I2C devices that will be skipped 19090f89c54bSPeter Tyser when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 19100f89c54bSPeter Tyser is set, specify a list of bus-device pairs. Otherwise, specify 19110f89c54bSPeter Tyser a 1D array of device addresses 1912bb99ad6dSBen Warren 1913bb99ad6dSBen Warren e.g. 1914bb99ad6dSBen Warren #undef CONFIG_I2C_MULTI_BUS 19156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1916bb99ad6dSBen Warren 1917bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on a board with one I2C bus 1918bb99ad6dSBen Warren 1919bb99ad6dSBen Warren #define CONFIG_I2C_MULTI_BUS 1920945a18e6SSimon Glass #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1921bb99ad6dSBen Warren 1922bb99ad6dSBen Warren will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1923bb99ad6dSBen Warren 19246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_SPD_BUS_NUM 1925be5e6181STimur Tabi 1926be5e6181STimur Tabi If defined, then this indicates the I2C bus number for DDR SPD. 1927be5e6181STimur Tabi If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1928be5e6181STimur Tabi 19296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_RTC_BUS_NUM 19300dc018ecSStefan Roese 19310dc018ecSStefan Roese If defined, then this indicates the I2C bus number for the RTC. 19320dc018ecSStefan Roese If not defined, then U-Boot assumes that RTC is on I2C bus 0. 19330dc018ecSStefan Roese 19342ac6985aSAndrew Dyer CONFIG_SOFT_I2C_READ_REPEATED_START 19352ac6985aSAndrew Dyer 19362ac6985aSAndrew Dyer defining this will force the i2c_read() function in 19372ac6985aSAndrew Dyer the soft_i2c driver to perform an I2C repeated start 19382ac6985aSAndrew Dyer between writing the address pointer and reading the 19392ac6985aSAndrew Dyer data. If this define is omitted the default behaviour 19402ac6985aSAndrew Dyer of doing a stop-start sequence will be used. Most I2C 19412ac6985aSAndrew Dyer devices can use either method, but some require one or 19422ac6985aSAndrew Dyer the other. 1943be5e6181STimur Tabi 1944c609719bSwdenk- SPI Support: CONFIG_SPI 1945c609719bSwdenk 1946c609719bSwdenk Enables SPI driver (so far only tested with 1947c609719bSwdenk SPI EEPROM, also an instance works with Crystal A/D and 1948c609719bSwdenk D/As on the SACSng board) 1949c609719bSwdenk 1950c609719bSwdenk CONFIG_SOFT_SPI 1951c609719bSwdenk 1952c609719bSwdenk Enables a software (bit-bang) SPI driver rather than 1953c609719bSwdenk using hardware support. This is a general purpose 1954c609719bSwdenk driver that only requires three general I/O port pins 1955c609719bSwdenk (two outputs, one input) to function. If this is 1956c609719bSwdenk defined, the board configuration must define several 1957c609719bSwdenk SPI configuration items (port pins to use, etc). For 1958c609719bSwdenk an example, see include/configs/sacsng.h. 1959c609719bSwdenk 196004a9e118SBen Warren CONFIG_HARD_SPI 196104a9e118SBen Warren 196204a9e118SBen Warren Enables a hardware SPI driver for general-purpose reads 196304a9e118SBen Warren and writes. As with CONFIG_SOFT_SPI, the board configuration 196404a9e118SBen Warren must define a list of chip-select function pointers. 196504a9e118SBen Warren Currently supported on some MPC8xxx processors. For an 196604a9e118SBen Warren example, see include/configs/mpc8349emds.h. 196704a9e118SBen Warren 1968f659b573SHeiko Schocher CONFIG_SYS_SPI_MXC_WAIT 1969f659b573SHeiko Schocher Timeout for waiting until spi transfer completed. 1970f659b573SHeiko Schocher default: (CONFIG_SYS_HZ/100) /* 10 ms */ 1971f659b573SHeiko Schocher 19720133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA 19730133502eSMatthias Fuchs 19740133502eSMatthias Fuchs Enables FPGA subsystem. 19750133502eSMatthias Fuchs 19760133502eSMatthias Fuchs CONFIG_FPGA_<vendor> 19770133502eSMatthias Fuchs 19780133502eSMatthias Fuchs Enables support for specific chip vendors. 19790133502eSMatthias Fuchs (ALTERA, XILINX) 19800133502eSMatthias Fuchs 19810133502eSMatthias Fuchs CONFIG_FPGA_<family> 19820133502eSMatthias Fuchs 19830133502eSMatthias Fuchs Enables support for FPGA family. 19840133502eSMatthias Fuchs (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 19850133502eSMatthias Fuchs 19860133502eSMatthias Fuchs CONFIG_FPGA_COUNT 1987c609719bSwdenk 1988c609719bSwdenk Specify the number of FPGA devices to support. 1989c609719bSwdenk 19906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_PROG_FEEDBACK 1991c609719bSwdenk 1992c609719bSwdenk Enable printing of hash marks during FPGA configuration. 1993c609719bSwdenk 19946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_BUSY 1995c609719bSwdenk 1996c609719bSwdenk Enable checks on FPGA configuration interface busy 1997c609719bSwdenk status by the configuration function. This option 1998c609719bSwdenk will require a board or device specific function to 1999c609719bSwdenk be written. 2000c609719bSwdenk 2001c609719bSwdenk CONFIG_FPGA_DELAY 2002c609719bSwdenk 2003c609719bSwdenk If defined, a function that provides delays in the FPGA 2004c609719bSwdenk configuration driver. 2005c609719bSwdenk 20066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_CTRLC 2007c609719bSwdenk Allow Control-C to interrupt FPGA configuration 2008c609719bSwdenk 20096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_CHECK_ERROR 2010c609719bSwdenk 2011c609719bSwdenk Check for configuration errors during FPGA bitfile 2012c609719bSwdenk loading. For example, abort during Virtex II 2013c609719bSwdenk configuration if the INIT_B line goes low (which 2014c609719bSwdenk indicated a CRC error). 2015c609719bSwdenk 20166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_INIT 2017c609719bSwdenk 2018b445bbb4SJeremiah Mahler Maximum time to wait for the INIT_B line to de-assert 2019b445bbb4SJeremiah Mahler after PROB_B has been de-asserted during a Virtex II 2020c609719bSwdenk FPGA configuration sequence. The default time is 500 202111ccc33fSMarcel Ziswiler ms. 2022c609719bSwdenk 20236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_BUSY 2024c609719bSwdenk 2025b445bbb4SJeremiah Mahler Maximum time to wait for BUSY to de-assert during 202611ccc33fSMarcel Ziswiler Virtex II FPGA configuration. The default is 5 ms. 2027c609719bSwdenk 20286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FPGA_WAIT_CONFIG 2029c609719bSwdenk 2030c609719bSwdenk Time to wait after FPGA configuration. The default is 203111ccc33fSMarcel Ziswiler 200 ms. 2032c609719bSwdenk 2033c609719bSwdenk- Configuration Management: 2034b2b8a696SStefan Roese CONFIG_BUILD_TARGET 2035b2b8a696SStefan Roese 2036b2b8a696SStefan Roese Some SoCs need special image types (e.g. U-Boot binary 2037b2b8a696SStefan Roese with a special header) as build targets. By defining 2038b2b8a696SStefan Roese CONFIG_BUILD_TARGET in the SoC / board header, this 2039b2b8a696SStefan Roese special image will be automatically built upon calling 20406de80f21SSimon Glass make / buildman. 2041b2b8a696SStefan Roese 2042c609719bSwdenk CONFIG_IDENT_STRING 2043c609719bSwdenk 2044c609719bSwdenk If defined, this string will be added to the U-Boot 2045c609719bSwdenk version information (U_BOOT_VERSION) 2046c609719bSwdenk 2047c609719bSwdenk- Vendor Parameter Protection: 2048c609719bSwdenk 2049c609719bSwdenk U-Boot considers the values of the environment 2050c609719bSwdenk variables "serial#" (Board Serial Number) and 20517152b1d0Swdenk "ethaddr" (Ethernet Address) to be parameters that 2052c609719bSwdenk are set once by the board vendor / manufacturer, and 2053c609719bSwdenk protects these variables from casual modification by 2054c609719bSwdenk the user. Once set, these variables are read-only, 2055c609719bSwdenk and write or delete attempts are rejected. You can 205611ccc33fSMarcel Ziswiler change this behaviour: 2057c609719bSwdenk 2058c609719bSwdenk If CONFIG_ENV_OVERWRITE is #defined in your config 2059c609719bSwdenk file, the write protection for vendor parameters is 206047cd00faSwdenk completely disabled. Anybody can change or delete 2061c609719bSwdenk these parameters. 2062c609719bSwdenk 206392ac5208SJoe Hershberger Alternatively, if you define _both_ an ethaddr in the 206492ac5208SJoe Hershberger default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 206511ccc33fSMarcel Ziswiler Ethernet address is installed in the environment, 2066c609719bSwdenk which can be changed exactly ONCE by the user. [The 2067c609719bSwdenk serial# is unaffected by this, i. e. it remains 2068c609719bSwdenk read-only.] 2069c609719bSwdenk 20702598090bSJoe Hershberger The same can be accomplished in a more flexible way 20712598090bSJoe Hershberger for any variable by configuring the type of access 20722598090bSJoe Hershberger to allow for those variables in the ".flags" variable 20732598090bSJoe Hershberger or define CONFIG_ENV_FLAGS_LIST_STATIC. 20742598090bSJoe Hershberger 2075c609719bSwdenk- Protected RAM: 2076c609719bSwdenk CONFIG_PRAM 2077c609719bSwdenk 2078c609719bSwdenk Define this variable to enable the reservation of 2079c609719bSwdenk "protected RAM", i. e. RAM which is not overwritten 2080c609719bSwdenk by U-Boot. Define CONFIG_PRAM to hold the number of 2081c609719bSwdenk kB you want to reserve for pRAM. You can overwrite 2082c609719bSwdenk this default value by defining an environment 2083c609719bSwdenk variable "pram" to the number of kB you want to 2084c609719bSwdenk reserve. Note that the board info structure will 2085c609719bSwdenk still show the full amount of RAM. If pRAM is 2086c609719bSwdenk reserved, a new environment variable "mem" will 2087c609719bSwdenk automatically be defined to hold the amount of 2088c609719bSwdenk remaining RAM in a form that can be passed as boot 2089c609719bSwdenk argument to Linux, for instance like that: 2090c609719bSwdenk 2091fe126d8bSWolfgang Denk setenv bootargs ... mem=\${mem} 2092c609719bSwdenk saveenv 2093c609719bSwdenk 2094c609719bSwdenk This way you can tell Linux not to use this memory, 2095c609719bSwdenk either, which results in a memory region that will 2096c609719bSwdenk not be affected by reboots. 2097c609719bSwdenk 2098c609719bSwdenk *WARNING* If your board configuration uses automatic 2099c609719bSwdenk detection of the RAM size, you must make sure that 2100c609719bSwdenk this memory test is non-destructive. So far, the 2101c609719bSwdenk following board configurations are known to be 2102c609719bSwdenk "pRAM-clean": 2103c609719bSwdenk 21045b8e76c3SHeiko Schocher IVMS8, IVML24, SPD8xx, 21051b0757ecSWolfgang Denk HERMES, IP860, RPXlite, LWMON, 21062eb48ff7SHeiko Schocher FLAGADM 2107c609719bSwdenk 210840fef049SGabe Black- Access to physical memory region (> 4GB) 210940fef049SGabe Black Some basic support is provided for operations on memory not 211040fef049SGabe Black normally accessible to U-Boot - e.g. some architectures 211140fef049SGabe Black support access to more than 4GB of memory on 32-bit 211240fef049SGabe Black machines using physical address extension or similar. 211340fef049SGabe Black Define CONFIG_PHYSMEM to access this basic support, which 211440fef049SGabe Black currently only supports clearing the memory. 211540fef049SGabe Black 2116c609719bSwdenk- Error Recovery: 2117c609719bSwdenk CONFIG_NET_RETRY_COUNT 2118c609719bSwdenk 2119c609719bSwdenk This variable defines the number of retries for 2120c609719bSwdenk network operations like ARP, RARP, TFTP, or BOOTP 2121c609719bSwdenk before giving up the operation. If not defined, a 2122c609719bSwdenk default value of 5 is used. 2123c609719bSwdenk 212440cb90eeSGuennadi Liakhovetski CONFIG_ARP_TIMEOUT 212540cb90eeSGuennadi Liakhovetski 212640cb90eeSGuennadi Liakhovetski Timeout waiting for an ARP reply in milliseconds. 212740cb90eeSGuennadi Liakhovetski 212848a3e999STetsuyuki Kobayashi CONFIG_NFS_TIMEOUT 212948a3e999STetsuyuki Kobayashi 213048a3e999STetsuyuki Kobayashi Timeout in milliseconds used in NFS protocol. 213148a3e999STetsuyuki Kobayashi If you encounter "ERROR: Cannot umount" in nfs command, 213248a3e999STetsuyuki Kobayashi try longer timeout such as 213348a3e999STetsuyuki Kobayashi #define CONFIG_NFS_TIMEOUT 10000UL 213448a3e999STetsuyuki Kobayashi 2135c609719bSwdenk- Command Interpreter: 21366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PROMPT_HUSH_PS2 2137c609719bSwdenk 2138c609719bSwdenk This defines the secondary prompt string, which is 2139c609719bSwdenk printed when the command interpreter needs more input 2140c609719bSwdenk to complete a command. Usually "> ". 2141c609719bSwdenk 2142c609719bSwdenk Note: 2143c609719bSwdenk 2144c609719bSwdenk In the current implementation, the local variables 2145c609719bSwdenk space and global environment variables space are 2146c609719bSwdenk separated. Local variables are those you define by 21473b57fe0aSwdenk simply typing `name=value'. To access a local 2148c609719bSwdenk variable later on, you have write `$name' or 21493b57fe0aSwdenk `${name}'; to execute the contents of a variable 21503b57fe0aSwdenk directly type `$name' at the command prompt. 2151c609719bSwdenk 2152c609719bSwdenk Global environment variables are those you use 2153c609719bSwdenk setenv/printenv to work with. To run a command stored 2154c609719bSwdenk in such a variable, you need to use the run command, 2155c609719bSwdenk and you must not use the '$' sign to access them. 2156c609719bSwdenk 2157c609719bSwdenk To store commands and special characters in a 2158c609719bSwdenk variable, please use double quotation marks 2159c609719bSwdenk surrounding the whole text of the variable, instead 2160c609719bSwdenk of the backslashes before semicolons and special 2161c609719bSwdenk symbols. 2162c609719bSwdenk 2163b445bbb4SJeremiah Mahler- Command Line Editing and History: 2164f3b267b3SMarek Vasut CONFIG_CMDLINE_PS_SUPPORT 2165f3b267b3SMarek Vasut 2166f3b267b3SMarek Vasut Enable support for changing the command prompt string 2167f3b267b3SMarek Vasut at run-time. Only static string is supported so far. 2168f3b267b3SMarek Vasut The string is obtained from environment variables PS1 2169f3b267b3SMarek Vasut and PS2. 2170f3b267b3SMarek Vasut 2171a8c7c708Swdenk- Default Environment: 2172c609719bSwdenk CONFIG_EXTRA_ENV_SETTINGS 2173c609719bSwdenk 2174c609719bSwdenk Define this to contain any number of null terminated 2175c609719bSwdenk strings (variable = value pairs) that will be part of 21767152b1d0Swdenk the default environment compiled into the boot image. 21772262cfeeSwdenk 2178c609719bSwdenk For example, place something like this in your 2179c609719bSwdenk board's config file: 2180c609719bSwdenk 2181c609719bSwdenk #define CONFIG_EXTRA_ENV_SETTINGS \ 2182c609719bSwdenk "myvar1=value1\0" \ 2183c609719bSwdenk "myvar2=value2\0" 2184c609719bSwdenk 2185c609719bSwdenk Warning: This method is based on knowledge about the 2186c609719bSwdenk internal format how the environment is stored by the 21872262cfeeSwdenk U-Boot code. This is NOT an official, exported 2188c609719bSwdenk interface! Although it is unlikely that this format 21897152b1d0Swdenk will change soon, there is no guarantee either. 2190c609719bSwdenk You better know what you are doing here. 2191c609719bSwdenk 2192c609719bSwdenk Note: overly (ab)use of the default environment is 2193c609719bSwdenk discouraged. Make sure to check other ways to preset 219474de7aefSWolfgang Denk the environment like the "source" command or the 2195c609719bSwdenk boot command first. 2196c609719bSwdenk 219706fd8538SSimon Glass CONFIG_DELAY_ENVIRONMENT 219806fd8538SSimon Glass 219906fd8538SSimon Glass Normally the environment is loaded when the board is 2200b445bbb4SJeremiah Mahler initialised so that it is available to U-Boot. This inhibits 220106fd8538SSimon Glass that so that the environment is not available until 220206fd8538SSimon Glass explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 220306fd8538SSimon Glass this is instead controlled by the value of 220406fd8538SSimon Glass /config/load-environment. 220506fd8538SSimon Glass 2206f61ec45eSEric Nelson- Serial Flash support 220700fd59ddSSimon Glass Usage requires an initial 'sf probe' to define the serial 2208f61ec45eSEric Nelson flash parameters, followed by read/write/erase/update 2209f61ec45eSEric Nelson commands. 2210f61ec45eSEric Nelson 2211f61ec45eSEric Nelson The following defaults may be provided by the platform 2212f61ec45eSEric Nelson to handle the common case when only a single serial 2213f61ec45eSEric Nelson flash is present on the system. 2214f61ec45eSEric Nelson 2215f61ec45eSEric Nelson CONFIG_SF_DEFAULT_BUS Bus identifier 2216f61ec45eSEric Nelson CONFIG_SF_DEFAULT_CS Chip-select 2217f61ec45eSEric Nelson CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2218f61ec45eSEric Nelson CONFIG_SF_DEFAULT_SPEED in Hz 2219f61ec45eSEric Nelson 22203f85ce27Swdenk 2221ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port: 2222ecb0ccd9SWolfgang Denk CONFIG_TFTP_PORT 2223ecb0ccd9SWolfgang Denk 222428cb9375SWolfgang Denk If this is defined, the environment variable tftpsrcp 2225ecb0ccd9SWolfgang Denk is used to supply the TFTP UDP source port value. 222628cb9375SWolfgang Denk If tftpsrcp isn't defined, the normal pseudo-random port 2227ecb0ccd9SWolfgang Denk number generator is used. 2228ecb0ccd9SWolfgang Denk 222928cb9375SWolfgang Denk Also, the environment variable tftpdstp is used to supply 223028cb9375SWolfgang Denk the TFTP UDP destination port value. If tftpdstp isn't 223128cb9375SWolfgang Denk defined, the normal port 69 is used. 223228cb9375SWolfgang Denk 223328cb9375SWolfgang Denk The purpose for tftpsrcp is to allow a TFTP server to 2234ecb0ccd9SWolfgang Denk blindly start the TFTP transfer using the pre-configured 2235ecb0ccd9SWolfgang Denk target IP address and UDP port. This has the effect of 2236ecb0ccd9SWolfgang Denk "punching through" the (Windows XP) firewall, allowing 2237ecb0ccd9SWolfgang Denk the remainder of the TFTP transfer to proceed normally. 2238ecb0ccd9SWolfgang Denk A better solution is to properly configure the firewall, 2239ecb0ccd9SWolfgang Denk but sometimes that is not allowed. 2240ecb0ccd9SWolfgang Denk 2241a8c7c708Swdenk- Show boot progress: 2242c609719bSwdenk CONFIG_SHOW_BOOT_PROGRESS 2243c609719bSwdenk 2244c609719bSwdenk Defining this option allows to add some board- 2245c609719bSwdenk specific code (calling a user-provided function 2246c609719bSwdenk "show_boot_progress(int)") that enables you to show 2247c609719bSwdenk the system's boot progress on some display (for 2248c609719bSwdenk example, some LED's) on your board. At the moment, 2249c609719bSwdenk the following checkpoints are implemented: 2250c609719bSwdenk 225194fd1316SSimon Glass 22521372cce2SMarian BalakowiczLegacy uImage format: 22531372cce2SMarian Balakowicz 2254c609719bSwdenk Arg Where When 2255c609719bSwdenk 1 common/cmd_bootm.c before attempting to boot an image 2256c609719bSwdenk -1 common/cmd_bootm.c Image header has bad magic number 2257c609719bSwdenk 2 common/cmd_bootm.c Image header has correct magic number 2258c609719bSwdenk -2 common/cmd_bootm.c Image header has bad checksum 2259c609719bSwdenk 3 common/cmd_bootm.c Image header has correct checksum 2260c609719bSwdenk -3 common/cmd_bootm.c Image data has bad checksum 2261c609719bSwdenk 4 common/cmd_bootm.c Image data has correct checksum 2262c609719bSwdenk -4 common/cmd_bootm.c Image is for unsupported architecture 2263c609719bSwdenk 5 common/cmd_bootm.c Architecture check OK 22641372cce2SMarian Balakowicz -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2265c609719bSwdenk 6 common/cmd_bootm.c Image Type check OK 2266c609719bSwdenk -6 common/cmd_bootm.c gunzip uncompression error 2267c609719bSwdenk -7 common/cmd_bootm.c Unimplemented compression type 2268c609719bSwdenk 7 common/cmd_bootm.c Uncompression OK 22691372cce2SMarian Balakowicz 8 common/cmd_bootm.c No uncompress/copy overwrite error 2270c609719bSwdenk -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 22711372cce2SMarian Balakowicz 22721372cce2SMarian Balakowicz 9 common/image.c Start initial ramdisk verification 22731372cce2SMarian Balakowicz -10 common/image.c Ramdisk header has bad magic number 22741372cce2SMarian Balakowicz -11 common/image.c Ramdisk header has bad checksum 22751372cce2SMarian Balakowicz 10 common/image.c Ramdisk header is OK 22761372cce2SMarian Balakowicz -12 common/image.c Ramdisk data has bad checksum 22771372cce2SMarian Balakowicz 11 common/image.c Ramdisk data has correct checksum 22781372cce2SMarian Balakowicz 12 common/image.c Ramdisk verification complete, start loading 227911ccc33fSMarcel Ziswiler -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 22801372cce2SMarian Balakowicz 13 common/image.c Start multifile image verification 22811372cce2SMarian Balakowicz 14 common/image.c No initial ramdisk, no multifile, continue. 22821372cce2SMarian Balakowicz 2283ea0364f1SPeter Tyser 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2284c609719bSwdenk 2285a47a12beSStefan Roese -30 arch/powerpc/lib/board.c Fatal error, hang the system 228663e73c9aSwdenk -31 post/post.c POST test failed, detected by post_output_backlog() 228763e73c9aSwdenk -32 post/post.c POST test failed, detected by post_run_single() 228863e73c9aSwdenk 2289566a494fSHeiko Schocher 34 common/cmd_doc.c before loading a Image from a DOC device 2290566a494fSHeiko Schocher -35 common/cmd_doc.c Bad usage of "doc" command 2291566a494fSHeiko Schocher 35 common/cmd_doc.c correct usage of "doc" command 2292566a494fSHeiko Schocher -36 common/cmd_doc.c No boot device 2293566a494fSHeiko Schocher 36 common/cmd_doc.c correct boot device 2294566a494fSHeiko Schocher -37 common/cmd_doc.c Unknown Chip ID on boot device 2295566a494fSHeiko Schocher 37 common/cmd_doc.c correct chip ID found, device available 2296566a494fSHeiko Schocher -38 common/cmd_doc.c Read Error on boot device 2297566a494fSHeiko Schocher 38 common/cmd_doc.c reading Image header from DOC device OK 2298566a494fSHeiko Schocher -39 common/cmd_doc.c Image header has bad magic number 2299566a494fSHeiko Schocher 39 common/cmd_doc.c Image header has correct magic number 2300566a494fSHeiko Schocher -40 common/cmd_doc.c Error reading Image from DOC device 2301566a494fSHeiko Schocher 40 common/cmd_doc.c Image header has correct magic number 2302566a494fSHeiko Schocher 41 common/cmd_ide.c before loading a Image from a IDE device 2303566a494fSHeiko Schocher -42 common/cmd_ide.c Bad usage of "ide" command 2304566a494fSHeiko Schocher 42 common/cmd_ide.c correct usage of "ide" command 2305566a494fSHeiko Schocher -43 common/cmd_ide.c No boot device 2306566a494fSHeiko Schocher 43 common/cmd_ide.c boot device found 2307566a494fSHeiko Schocher -44 common/cmd_ide.c Device not available 2308566a494fSHeiko Schocher 44 common/cmd_ide.c Device available 2309566a494fSHeiko Schocher -45 common/cmd_ide.c wrong partition selected 2310566a494fSHeiko Schocher 45 common/cmd_ide.c partition selected 2311566a494fSHeiko Schocher -46 common/cmd_ide.c Unknown partition table 2312566a494fSHeiko Schocher 46 common/cmd_ide.c valid partition table found 2313566a494fSHeiko Schocher -47 common/cmd_ide.c Invalid partition type 2314566a494fSHeiko Schocher 47 common/cmd_ide.c correct partition type 2315566a494fSHeiko Schocher -48 common/cmd_ide.c Error reading Image Header on boot device 2316566a494fSHeiko Schocher 48 common/cmd_ide.c reading Image Header from IDE device OK 2317566a494fSHeiko Schocher -49 common/cmd_ide.c Image header has bad magic number 2318566a494fSHeiko Schocher 49 common/cmd_ide.c Image header has correct magic number 2319566a494fSHeiko Schocher -50 common/cmd_ide.c Image header has bad checksum 2320566a494fSHeiko Schocher 50 common/cmd_ide.c Image header has correct checksum 2321566a494fSHeiko Schocher -51 common/cmd_ide.c Error reading Image from IDE device 2322566a494fSHeiko Schocher 51 common/cmd_ide.c reading Image from IDE device OK 2323566a494fSHeiko Schocher 52 common/cmd_nand.c before loading a Image from a NAND device 2324566a494fSHeiko Schocher -53 common/cmd_nand.c Bad usage of "nand" command 2325566a494fSHeiko Schocher 53 common/cmd_nand.c correct usage of "nand" command 2326566a494fSHeiko Schocher -54 common/cmd_nand.c No boot device 2327566a494fSHeiko Schocher 54 common/cmd_nand.c boot device found 2328566a494fSHeiko Schocher -55 common/cmd_nand.c Unknown Chip ID on boot device 2329566a494fSHeiko Schocher 55 common/cmd_nand.c correct chip ID found, device available 2330566a494fSHeiko Schocher -56 common/cmd_nand.c Error reading Image Header on boot device 2331566a494fSHeiko Schocher 56 common/cmd_nand.c reading Image Header from NAND device OK 2332566a494fSHeiko Schocher -57 common/cmd_nand.c Image header has bad magic number 2333566a494fSHeiko Schocher 57 common/cmd_nand.c Image header has correct magic number 2334566a494fSHeiko Schocher -58 common/cmd_nand.c Error reading Image from NAND device 2335566a494fSHeiko Schocher 58 common/cmd_nand.c reading Image from NAND device OK 2336c609719bSwdenk 2337566a494fSHeiko Schocher -60 common/env_common.c Environment has a bad CRC, using default 2338c609719bSwdenk 2339566a494fSHeiko Schocher 64 net/eth.c starting with Ethernet configuration. 2340566a494fSHeiko Schocher -64 net/eth.c no Ethernet found. 2341566a494fSHeiko Schocher 65 net/eth.c Ethernet found. 2342206c60cbSwdenk 2343566a494fSHeiko Schocher -80 common/cmd_net.c usage wrong 2344bc0571fcSJoe Hershberger 80 common/cmd_net.c before calling net_loop() 2345bc0571fcSJoe Hershberger -81 common/cmd_net.c some error in net_loop() occurred 2346bc0571fcSJoe Hershberger 81 common/cmd_net.c net_loop() back without error 2347566a494fSHeiko Schocher -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2348566a494fSHeiko Schocher 82 common/cmd_net.c trying automatic boot 234974de7aefSWolfgang Denk 83 common/cmd_net.c running "source" command 235074de7aefSWolfgang Denk -83 common/cmd_net.c some error in automatic boot or "source" command 2351566a494fSHeiko Schocher 84 common/cmd_net.c end without errors 2352c609719bSwdenk 23531372cce2SMarian BalakowiczFIT uImage format: 23541372cce2SMarian Balakowicz 23551372cce2SMarian Balakowicz Arg Where When 23561372cce2SMarian Balakowicz 100 common/cmd_bootm.c Kernel FIT Image has correct format 23571372cce2SMarian Balakowicz -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 23581372cce2SMarian Balakowicz 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 23591372cce2SMarian Balakowicz -101 common/cmd_bootm.c Can't get configuration for kernel subimage 23601372cce2SMarian Balakowicz 102 common/cmd_bootm.c Kernel unit name specified 23611372cce2SMarian Balakowicz -103 common/cmd_bootm.c Can't get kernel subimage node offset 2362f773bea8SMarian Balakowicz 103 common/cmd_bootm.c Found configuration node 23631372cce2SMarian Balakowicz 104 common/cmd_bootm.c Got kernel subimage node offset 23641372cce2SMarian Balakowicz -104 common/cmd_bootm.c Kernel subimage hash verification failed 23651372cce2SMarian Balakowicz 105 common/cmd_bootm.c Kernel subimage hash verification OK 23661372cce2SMarian Balakowicz -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 23671372cce2SMarian Balakowicz 106 common/cmd_bootm.c Architecture check OK 236811ccc33fSMarcel Ziswiler -106 common/cmd_bootm.c Kernel subimage has wrong type 236911ccc33fSMarcel Ziswiler 107 common/cmd_bootm.c Kernel subimage type OK 23701372cce2SMarian Balakowicz -107 common/cmd_bootm.c Can't get kernel subimage data/size 23711372cce2SMarian Balakowicz 108 common/cmd_bootm.c Got kernel subimage data/size 23721372cce2SMarian Balakowicz -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 23731372cce2SMarian Balakowicz -109 common/cmd_bootm.c Can't get kernel subimage type 23741372cce2SMarian Balakowicz -110 common/cmd_bootm.c Can't get kernel subimage comp 23751372cce2SMarian Balakowicz -111 common/cmd_bootm.c Can't get kernel subimage os 23761372cce2SMarian Balakowicz -112 common/cmd_bootm.c Can't get kernel subimage load address 23771372cce2SMarian Balakowicz -113 common/cmd_bootm.c Image uncompress/copy overwrite error 23781372cce2SMarian Balakowicz 23791372cce2SMarian Balakowicz 120 common/image.c Start initial ramdisk verification 23801372cce2SMarian Balakowicz -120 common/image.c Ramdisk FIT image has incorrect format 23811372cce2SMarian Balakowicz 121 common/image.c Ramdisk FIT image has correct format 238211ccc33fSMarcel Ziswiler 122 common/image.c No ramdisk subimage unit name, using configuration 23831372cce2SMarian Balakowicz -122 common/image.c Can't get configuration for ramdisk subimage 23841372cce2SMarian Balakowicz 123 common/image.c Ramdisk unit name specified 23851372cce2SMarian Balakowicz -124 common/image.c Can't get ramdisk subimage node offset 23861372cce2SMarian Balakowicz 125 common/image.c Got ramdisk subimage node offset 23871372cce2SMarian Balakowicz -125 common/image.c Ramdisk subimage hash verification failed 23881372cce2SMarian Balakowicz 126 common/image.c Ramdisk subimage hash verification OK 23891372cce2SMarian Balakowicz -126 common/image.c Ramdisk subimage for unsupported architecture 23901372cce2SMarian Balakowicz 127 common/image.c Architecture check OK 23911372cce2SMarian Balakowicz -127 common/image.c Can't get ramdisk subimage data/size 23921372cce2SMarian Balakowicz 128 common/image.c Got ramdisk subimage data/size 23931372cce2SMarian Balakowicz 129 common/image.c Can't get ramdisk load address 23941372cce2SMarian Balakowicz -129 common/image.c Got ramdisk load address 23951372cce2SMarian Balakowicz 239611ccc33fSMarcel Ziswiler -130 common/cmd_doc.c Incorrect FIT image format 23971372cce2SMarian Balakowicz 131 common/cmd_doc.c FIT image format OK 23981372cce2SMarian Balakowicz 239911ccc33fSMarcel Ziswiler -140 common/cmd_ide.c Incorrect FIT image format 24001372cce2SMarian Balakowicz 141 common/cmd_ide.c FIT image format OK 24011372cce2SMarian Balakowicz 240211ccc33fSMarcel Ziswiler -150 common/cmd_nand.c Incorrect FIT image format 24031372cce2SMarian Balakowicz 151 common/cmd_nand.c FIT image format OK 24041372cce2SMarian Balakowicz 24054cf2609bSWolfgang Denk- Standalone program support: 24064cf2609bSWolfgang Denk CONFIG_STANDALONE_LOAD_ADDR 24074cf2609bSWolfgang Denk 24086feff899SWolfgang Denk This option defines a board specific value for the 24096feff899SWolfgang Denk address where standalone program gets loaded, thus 24106feff899SWolfgang Denk overwriting the architecture dependent default 24114cf2609bSWolfgang Denk settings. 24124cf2609bSWolfgang Denk 24134cf2609bSWolfgang Denk- Frame Buffer Address: 24144cf2609bSWolfgang Denk CONFIG_FB_ADDR 24154cf2609bSWolfgang Denk 24164cf2609bSWolfgang Denk Define CONFIG_FB_ADDR if you want to use specific 241744a53b57SWolfgang Denk address for frame buffer. This is typically the case 241844a53b57SWolfgang Denk when using a graphics controller has separate video 241944a53b57SWolfgang Denk memory. U-Boot will then place the frame buffer at 242044a53b57SWolfgang Denk the given address instead of dynamically reserving it 242144a53b57SWolfgang Denk in system RAM by calling lcd_setmem(), which grabs 242244a53b57SWolfgang Denk the memory for the frame buffer depending on the 242344a53b57SWolfgang Denk configured panel size. 24244cf2609bSWolfgang Denk 24254cf2609bSWolfgang Denk Please see board_init_f function. 24264cf2609bSWolfgang Denk 2427cccfc2abSDetlev Zundel- Automatic software updates via TFTP server 2428cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP 2429cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_CNT_MAX 2430cccfc2abSDetlev Zundel CONFIG_UPDATE_TFTP_MSEC_MAX 2431cccfc2abSDetlev Zundel 2432cccfc2abSDetlev Zundel These options enable and control the auto-update feature; 2433cccfc2abSDetlev Zundel for a more detailed description refer to doc/README.update. 2434cccfc2abSDetlev Zundel 2435cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support) 2436cccfc2abSDetlev Zundel CONFIG_MTD_DEVICE 2437cccfc2abSDetlev Zundel 2438cccfc2abSDetlev Zundel Adds the MTD device infrastructure from the Linux kernel. 2439cccfc2abSDetlev Zundel Needed for mtdparts command support. 2440cccfc2abSDetlev Zundel 2441cccfc2abSDetlev Zundel CONFIG_MTD_PARTITIONS 2442cccfc2abSDetlev Zundel 2443cccfc2abSDetlev Zundel Adds the MTD partitioning infrastructure from the Linux 2444cccfc2abSDetlev Zundel kernel. Needed for UBI support. 2445cccfc2abSDetlev Zundel 244670c219cdSJoe Hershberger- UBI support 2447ff94bc40SHeiko Schocher CONFIG_MTD_UBI_WL_THRESHOLD 2448ff94bc40SHeiko Schocher This parameter defines the maximum difference between the highest 2449ff94bc40SHeiko Schocher erase counter value and the lowest erase counter value of eraseblocks 2450ff94bc40SHeiko Schocher of UBI devices. When this threshold is exceeded, UBI starts performing 2451ff94bc40SHeiko Schocher wear leveling by means of moving data from eraseblock with low erase 2452ff94bc40SHeiko Schocher counter to eraseblocks with high erase counter. 2453ff94bc40SHeiko Schocher 2454ff94bc40SHeiko Schocher The default value should be OK for SLC NAND flashes, NOR flashes and 2455ff94bc40SHeiko Schocher other flashes which have eraseblock life-cycle 100000 or more. 2456ff94bc40SHeiko Schocher However, in case of MLC NAND flashes which typically have eraseblock 2457ff94bc40SHeiko Schocher life-cycle less than 10000, the threshold should be lessened (e.g., 2458ff94bc40SHeiko Schocher to 128 or 256, although it does not have to be power of 2). 2459ff94bc40SHeiko Schocher 2460ff94bc40SHeiko Schocher default: 4096 2461ff94bc40SHeiko Schocher 2462ff94bc40SHeiko Schocher CONFIG_MTD_UBI_BEB_LIMIT 2463ff94bc40SHeiko Schocher This option specifies the maximum bad physical eraseblocks UBI 2464ff94bc40SHeiko Schocher expects on the MTD device (per 1024 eraseblocks). If the 2465ff94bc40SHeiko Schocher underlying flash does not admit of bad eraseblocks (e.g. NOR 2466ff94bc40SHeiko Schocher flash), this value is ignored. 2467ff94bc40SHeiko Schocher 2468ff94bc40SHeiko Schocher NAND datasheets often specify the minimum and maximum NVM 2469ff94bc40SHeiko Schocher (Number of Valid Blocks) for the flashes' endurance lifetime. 2470ff94bc40SHeiko Schocher The maximum expected bad eraseblocks per 1024 eraseblocks 2471ff94bc40SHeiko Schocher then can be calculated as "1024 * (1 - MinNVB / MaxNVB)", 2472ff94bc40SHeiko Schocher which gives 20 for most NANDs (MaxNVB is basically the total 2473ff94bc40SHeiko Schocher count of eraseblocks on the chip). 2474ff94bc40SHeiko Schocher 2475ff94bc40SHeiko Schocher To put it differently, if this value is 20, UBI will try to 2476ff94bc40SHeiko Schocher reserve about 1.9% of physical eraseblocks for bad blocks 2477ff94bc40SHeiko Schocher handling. And that will be 1.9% of eraseblocks on the entire 2478ff94bc40SHeiko Schocher NAND chip, not just the MTD partition UBI attaches. This means 2479ff94bc40SHeiko Schocher that if you have, say, a NAND flash chip admits maximum 40 bad 2480ff94bc40SHeiko Schocher eraseblocks, and it is split on two MTD partitions of the same 2481ff94bc40SHeiko Schocher size, UBI will reserve 40 eraseblocks when attaching a 2482ff94bc40SHeiko Schocher partition. 2483ff94bc40SHeiko Schocher 2484ff94bc40SHeiko Schocher default: 20 2485ff94bc40SHeiko Schocher 2486ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP 2487ff94bc40SHeiko Schocher Fastmap is a mechanism which allows attaching an UBI device 2488ff94bc40SHeiko Schocher in nearly constant time. Instead of scanning the whole MTD device it 2489ff94bc40SHeiko Schocher only has to locate a checkpoint (called fastmap) on the device. 2490ff94bc40SHeiko Schocher The on-flash fastmap contains all information needed to attach 2491ff94bc40SHeiko Schocher the device. Using fastmap makes only sense on large devices where 2492ff94bc40SHeiko Schocher attaching by scanning takes long. UBI will not automatically install 2493ff94bc40SHeiko Schocher a fastmap on old images, but you can set the UBI parameter 2494ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note 2495ff94bc40SHeiko Schocher that fastmap-enabled images are still usable with UBI implementations 2496ff94bc40SHeiko Schocher without fastmap support. On typical flash devices the whole fastmap 2497ff94bc40SHeiko Schocher fits into one PEB. UBI will reserve PEBs to hold two fastmaps. 2498ff94bc40SHeiko Schocher 2499ff94bc40SHeiko Schocher CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT 2500ff94bc40SHeiko Schocher Set this parameter to enable fastmap automatically on images 2501ff94bc40SHeiko Schocher without a fastmap. 2502ff94bc40SHeiko Schocher default: 0 2503ff94bc40SHeiko Schocher 25040195a7bbSHeiko Schocher CONFIG_MTD_UBI_FM_DEBUG 25050195a7bbSHeiko Schocher Enable UBI fastmap debug 25060195a7bbSHeiko Schocher default: 0 25070195a7bbSHeiko Schocher 25086a11cf48SDaniel Schwierzeck- SPL framework 25096a11cf48SDaniel Schwierzeck CONFIG_SPL 25106a11cf48SDaniel Schwierzeck Enable building of SPL globally. 25116a11cf48SDaniel Schwierzeck 251295579793STom Rini CONFIG_SPL_LDSCRIPT 251395579793STom Rini LDSCRIPT for linking the SPL binary. 251495579793STom Rini 25156ebc3461SAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT 25166ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL, BSS included. 25176ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory 25186ebc3461SAlbert ARIBAUD used by SPL from _start to __bss_end does not exceed it. 25198960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 25206ebc3461SAlbert ARIBAUD must not be both defined at the same time. 25216ebc3461SAlbert ARIBAUD 252295579793STom Rini CONFIG_SPL_MAX_SIZE 25236ebc3461SAlbert ARIBAUD Maximum size of the SPL image (text, data, rodata, and 25246ebc3461SAlbert ARIBAUD linker lists sections), BSS excluded. 25256ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual size does 25266ebc3461SAlbert ARIBAUD not exceed it. 252795579793STom Rini 25286a11cf48SDaniel Schwierzeck CONFIG_SPL_TEXT_BASE 25296a11cf48SDaniel Schwierzeck TEXT_BASE for linking the SPL binary. 25306a11cf48SDaniel Schwierzeck 253194a45bb1SScott Wood CONFIG_SPL_RELOC_TEXT_BASE 253294a45bb1SScott Wood Address to relocate to. If unspecified, this is equal to 253394a45bb1SScott Wood CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 253494a45bb1SScott Wood 253595579793STom Rini CONFIG_SPL_BSS_START_ADDR 253695579793STom Rini Link address for the BSS within the SPL binary. 253795579793STom Rini 253895579793STom Rini CONFIG_SPL_BSS_MAX_SIZE 25396ebc3461SAlbert ARIBAUD Maximum size in memory allocated to the SPL BSS. 25406ebc3461SAlbert ARIBAUD When defined, the linker checks that the actual memory used 25416ebc3461SAlbert ARIBAUD by SPL from __bss_start to __bss_end does not exceed it. 25428960af8bSAlbert ARIBAUD CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 25436ebc3461SAlbert ARIBAUD must not be both defined at the same time. 254495579793STom Rini 254595579793STom Rini CONFIG_SPL_STACK 254695579793STom Rini Adress of the start of the stack SPL will use 254795579793STom Rini 25488c80eb3bSAlbert ARIBAUD \(3ADEV\) CONFIG_SPL_PANIC_ON_RAW_IMAGE 25498c80eb3bSAlbert ARIBAUD \(3ADEV\) When defined, SPL will panic() if the image it has 25508c80eb3bSAlbert ARIBAUD \(3ADEV\) loaded does not have a signature. 25518c80eb3bSAlbert ARIBAUD \(3ADEV\) Defining this is useful when code which loads images 25528c80eb3bSAlbert ARIBAUD \(3ADEV\) in SPL cannot guarantee that absolutely all read errors 25538c80eb3bSAlbert ARIBAUD \(3ADEV\) will be caught. 25548c80eb3bSAlbert ARIBAUD \(3ADEV\) An example is the LPC32XX MLC NAND driver, which will 25558c80eb3bSAlbert ARIBAUD \(3ADEV\) consider that a completely unreadable NAND block is bad, 25568c80eb3bSAlbert ARIBAUD \(3ADEV\) and thus should be skipped silently. 25578c80eb3bSAlbert ARIBAUD \(3ADEV\) 255894a45bb1SScott Wood CONFIG_SPL_RELOC_STACK 255994a45bb1SScott Wood Adress of the start of the stack SPL will use after 256094a45bb1SScott Wood relocation. If unspecified, this is equal to 256194a45bb1SScott Wood CONFIG_SPL_STACK. 256294a45bb1SScott Wood 256395579793STom Rini CONFIG_SYS_SPL_MALLOC_START 256495579793STom Rini Starting address of the malloc pool used in SPL. 25659ac4fc82SFabio Estevam When this option is set the full malloc is used in SPL and 25669ac4fc82SFabio Estevam it is set up by spl_init() and before that, the simple malloc() 25679ac4fc82SFabio Estevam can be used if CONFIG_SYS_MALLOC_F is defined. 256895579793STom Rini 256995579793STom Rini CONFIG_SYS_SPL_MALLOC_SIZE 257095579793STom Rini The size of the malloc pool used in SPL. 25716a11cf48SDaniel Schwierzeck 25729607faf2STom Rini CONFIG_SPL_OS_BOOT 25739607faf2STom Rini Enable booting directly to an OS from SPL. 25749607faf2STom Rini See also: doc/README.falcon 25759607faf2STom Rini 2576861a86f4STom Rini CONFIG_SPL_DISPLAY_PRINT 2577861a86f4STom Rini For ARM, enable an optional function to print more information 2578861a86f4STom Rini about the running system. 2579861a86f4STom Rini 25804b919725SScott Wood CONFIG_SPL_INIT_MINIMAL 25814b919725SScott Wood Arch init code should be built for a very small image 25824b919725SScott Wood 2583b97300b6SPaul Kocialkowski CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION 2584b97300b6SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 2585b97300b6SPaul Kocialkowski used in raw mode 2586b97300b6SPaul Kocialkowski 25872b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 25882b75b0adSPeter Korsgaard Sector to load kernel uImage from when MMC is being 25892b75b0adSPeter Korsgaard used in raw mode (for Falcon mode) 25902b75b0adSPeter Korsgaard 25912b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 25922b75b0adSPeter Korsgaard CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 25932b75b0adSPeter Korsgaard Sector and number of sectors to load kernel argument 25942b75b0adSPeter Korsgaard parameters from when MMC is being used in raw mode 25952b75b0adSPeter Korsgaard (for falcon mode) 25962b75b0adSPeter Korsgaard 2597e2ccdf89SPaul Kocialkowski CONFIG_SYS_MMCSD_FS_BOOT_PARTITION 2598e2ccdf89SPaul Kocialkowski Partition on the MMC to load U-Boot from when the MMC is being 2599e2ccdf89SPaul Kocialkowski used in fs mode 2600e2ccdf89SPaul Kocialkowski 2601fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_PAYLOAD_NAME 2602fae81c72SGuillaume GARDET Filename to read to load U-Boot when reading from filesystem 2603fae81c72SGuillaume GARDET 2604fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_KERNEL_NAME 26057ad2cc79SPeter Korsgaard Filename to read to load kernel uImage when reading 2606fae81c72SGuillaume GARDET from filesystem (for Falcon mode) 26077ad2cc79SPeter Korsgaard 2608fae81c72SGuillaume GARDET CONFIG_SPL_FS_LOAD_ARGS_NAME 26097ad2cc79SPeter Korsgaard Filename to read to load kernel argument parameters 2610fae81c72SGuillaume GARDET when reading from filesystem (for Falcon mode) 26117ad2cc79SPeter Korsgaard 261206f60ae3SScott Wood CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 261306f60ae3SScott Wood Set this for NAND SPL on PPC mpc83xx targets, so that 261406f60ae3SScott Wood start.S waits for the rest of the SPL to load before 261506f60ae3SScott Wood continuing (the hardware starts execution after just 261606f60ae3SScott Wood loading the first page rather than the full 4K). 261706f60ae3SScott Wood 2618651fcf60SPrabhakar Kushwaha CONFIG_SPL_SKIP_RELOCATE 2619651fcf60SPrabhakar Kushwaha Avoid SPL relocation 2620651fcf60SPrabhakar Kushwaha 26216f2f01b9SScott Wood CONFIG_SPL_NAND_BASE 26226f2f01b9SScott Wood Include nand_base.c in the SPL. Requires 26236f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS. 26246f2f01b9SScott Wood 26256f2f01b9SScott Wood CONFIG_SPL_NAND_DRIVERS 26266f2f01b9SScott Wood SPL uses normal NAND drivers, not minimal drivers. 26276f2f01b9SScott Wood 2628*15e207faSJörg Krause CONFIG_SPL_NAND_IDENT 2629*15e207faSJörg Krause SPL uses the chip ID list to identify the NAND flash. 2630*15e207faSJörg Krause Requires CONFIG_SPL_NAND_BASE. 2631*15e207faSJörg Krause 26326f2f01b9SScott Wood CONFIG_SPL_NAND_ECC 26336f2f01b9SScott Wood Include standard software ECC in the SPL 26346f2f01b9SScott Wood 263595579793STom Rini CONFIG_SPL_NAND_SIMPLE 26367d4b7955SScott Wood Support for NAND boot using simple NAND drivers that 26377d4b7955SScott Wood expose the cmd_ctrl() interface. 263895579793STom Rini 26396f4e7d3cSThomas Gleixner CONFIG_SPL_UBI 26406f4e7d3cSThomas Gleixner Support for a lightweight UBI (fastmap) scanner and 26416f4e7d3cSThomas Gleixner loader 26426f4e7d3cSThomas Gleixner 26430c3117b1SHeiko Schocher CONFIG_SPL_NAND_RAW_ONLY 26440c3117b1SHeiko Schocher Support to boot only raw u-boot.bin images. Use this only 26450c3117b1SHeiko Schocher if you need to save space. 26460c3117b1SHeiko Schocher 26477c8eea59SYing Zhang CONFIG_SPL_COMMON_INIT_DDR 26487c8eea59SYing Zhang Set for common ddr init with serial presence detect in 26497c8eea59SYing Zhang SPL binary. 26507c8eea59SYing Zhang 265195579793STom Rini CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 265295579793STom Rini CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 265395579793STom Rini CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 265495579793STom Rini CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 265595579793STom Rini CONFIG_SYS_NAND_ECCBYTES 265695579793STom Rini Defines the size and behavior of the NAND that SPL uses 26577d4b7955SScott Wood to read U-Boot 265895579793STom Rini 2659fbe76ae4SPrabhakar Kushwaha CONFIG_SPL_NAND_BOOT 2660fbe76ae4SPrabhakar Kushwaha Add support NAND boot 2661fbe76ae4SPrabhakar Kushwaha 266295579793STom Rini CONFIG_SYS_NAND_U_BOOT_OFFS 26637d4b7955SScott Wood Location in NAND to read U-Boot from 26647d4b7955SScott Wood 26657d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_DST 26667d4b7955SScott Wood Location in memory to load U-Boot to 26677d4b7955SScott Wood 26687d4b7955SScott Wood CONFIG_SYS_NAND_U_BOOT_SIZE 26697d4b7955SScott Wood Size of image to load 267095579793STom Rini 267195579793STom Rini CONFIG_SYS_NAND_U_BOOT_START 26727d4b7955SScott Wood Entry point in loaded image to jump to 267395579793STom Rini 267495579793STom Rini CONFIG_SYS_NAND_HW_ECC_OOBFIRST 267595579793STom Rini Define this if you need to first read the OOB and then the 2676b445bbb4SJeremiah Mahler data. This is used, for example, on davinci platforms. 267795579793STom Rini 2678c57b953dSPavel Machek CONFIG_SPL_RAM_DEVICE 2679c57b953dSPavel Machek Support for running image already present in ram, in SPL binary 2680c57b953dSPavel Machek 268174752baaSScott Wood CONFIG_SPL_PAD_TO 26826113d3f2SBenoît Thébaudeau Image offset to which the SPL should be padded before appending 26836113d3f2SBenoît Thébaudeau the SPL payload. By default, this is defined as 26846113d3f2SBenoît Thébaudeau CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 26856113d3f2SBenoît Thébaudeau CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 26866113d3f2SBenoît Thébaudeau payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 268774752baaSScott Wood 2688ca2fca22SScott Wood CONFIG_SPL_TARGET 2689ca2fca22SScott Wood Final target image containing SPL and payload. Some SPLs 2690ca2fca22SScott Wood use an arch-specific makefile fragment instead, for 2691ca2fca22SScott Wood example if more than one image needs to be produced. 2692ca2fca22SScott Wood 2693b527b9c6SMarek Vasut CONFIG_SPL_FIT_PRINT 269487ebee39SSimon Glass Printing information about a FIT image adds quite a bit of 269587ebee39SSimon Glass code to SPL. So this is normally disabled in SPL. Use this 269687ebee39SSimon Glass option to re-enable it. This will affect the output of the 269787ebee39SSimon Glass bootm command when booting a FIT image. 269887ebee39SSimon Glass 26993aa29de0SYing Zhang- TPL framework 27003aa29de0SYing Zhang CONFIG_TPL 27013aa29de0SYing Zhang Enable building of TPL globally. 27023aa29de0SYing Zhang 27033aa29de0SYing Zhang CONFIG_TPL_PAD_TO 27043aa29de0SYing Zhang Image offset to which the TPL should be padded before appending 27053aa29de0SYing Zhang the TPL payload. By default, this is defined as 27063aa29de0SYing Zhang CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 27073aa29de0SYing Zhang CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 27083aa29de0SYing Zhang payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 27093aa29de0SYing Zhang 2710a8c7c708Swdenk- Interrupt support (PPC): 2711a8c7c708Swdenk 2712a8c7c708Swdenk There are common interrupt_init() and timer_interrupt() 2713a8c7c708Swdenk for all PPC archs. interrupt_init() calls interrupt_init_cpu() 271411ccc33fSMarcel Ziswiler for CPU specific initialization. interrupt_init_cpu() 2715a8c7c708Swdenk should set decrementer_count to appropriate value. If 271611ccc33fSMarcel Ziswiler CPU resets decrementer automatically after interrupt 2717a8c7c708Swdenk (ppc4xx) it should set decrementer_count to zero. 271811ccc33fSMarcel Ziswiler timer_interrupt() calls timer_interrupt_cpu() for CPU 2719a8c7c708Swdenk specific handling. If board has watchdog / status_led 2720a8c7c708Swdenk / other_activity_monitor it works automatically from 2721a8c7c708Swdenk general timer_interrupt(). 2722a8c7c708Swdenk 2723c609719bSwdenk 27249660e442SHelmut RaigerBoard initialization settings: 27259660e442SHelmut Raiger------------------------------ 27269660e442SHelmut Raiger 27279660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions 27289660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup 27299660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the 27309660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is 27319660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c 27329660e442SHelmut Raigertypically in board_init_f() and board_init_r(). 27339660e442SHelmut Raiger 27349660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 27359660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 27369660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init() 27379660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 2738c609719bSwdenk 2739c609719bSwdenkConfiguration Settings: 2740c609719bSwdenk----------------------- 2741c609719bSwdenk 27424d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 27434d1fd7f1SYork Sun Optionally it can be defined to support 64-bit memory commands. 27444d1fd7f1SYork Sun 27456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2746c609719bSwdenk undefine this when you're short of memory. 2747c609719bSwdenk 27482fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 27492fb2604dSPeter Tyser width of the commands listed in the 'help' command output. 27502fb2604dSPeter Tyser 27516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2752c609719bSwdenk prompt for user input. 2753c609719bSwdenk 27546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2755c609719bSwdenk 27566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE: Buffer size for Console output 2757c609719bSwdenk 27586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2759c609719bSwdenk 27606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2761c609719bSwdenk the application (usually a Linux kernel) when it is 2762c609719bSwdenk booted 2763c609719bSwdenk 27646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE: 2765c609719bSwdenk List of legal baudrate settings for this board. 2766c609719bSwdenk 27676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2768c609719bSwdenk Begin and End addresses of the area used by the 2769c609719bSwdenk simple memory test. 2770c609719bSwdenk 27716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH: 27725f535fe1Swdenk Scratch address used by the alternate memory test 27735f535fe1Swdenk You only need to set this if address zero isn't writeable 27745f535fe1Swdenk 2775e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE 2776e61a7534SYork Sun Only implemented for ARMv8 for now. 2777e8149522SYork Sun If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory 2778e8149522SYork Sun is substracted from total RAM and won't be reported to OS. 2779e8149522SYork Sun This memory can be used as secure memory. A variable 2780e61a7534SYork Sun gd->arch.secure_ram is used to track the location. In systems 2781e8149522SYork Sun the RAM base is not zero, or RAM is divided into banks, 2782e8149522SYork Sun this variable needs to be recalcuated to get the address. 2783e8149522SYork Sun 2784aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE: 27856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 278614f73ca6SStefan Roese this specified memory area will get subtracted from the top 278711ccc33fSMarcel Ziswiler (end) of RAM and won't get "touched" at all by U-Boot. By 278814f73ca6SStefan Roese fixing up gd->ram_size the Linux kernel should gets passed 278914f73ca6SStefan Roese the now "corrected" memory size and won't touch it either. 279014f73ca6SStefan Roese This should work for arch/ppc and arch/powerpc. Only Linux 27915e12e75dSStefan Roese board ports in arch/powerpc with bootwrapper support that 279214f73ca6SStefan Roese recalculate the memory size from the SDRAM controller setup 27935e12e75dSStefan Roese will have to get fixed in Linux additionally. 279414f73ca6SStefan Roese 279514f73ca6SStefan Roese This option can be used as a workaround for the 440EPx/GRx 279614f73ca6SStefan Roese CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 279714f73ca6SStefan Roese be touched. 279814f73ca6SStefan Roese 279914f73ca6SStefan Roese WARNING: Please make sure that this value is a multiple of 280014f73ca6SStefan Roese the Linux page size (normally 4k). If this is not the case, 280114f73ca6SStefan Roese then the end address of the Linux memory will be located at a 280214f73ca6SStefan Roese non page size aligned address and this could cause major 280314f73ca6SStefan Roese problems. 280414f73ca6SStefan Roese 28056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE: 2806c609719bSwdenk Enable temporary baudrate change while serial download 2807c609719bSwdenk 28086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE: 2809c609719bSwdenk Physical start address of SDRAM. _Must_ be 0 here. 2810c609719bSwdenk 28116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE: 2812c609719bSwdenk Physical start address of Flash memory. 2813c609719bSwdenk 28146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE: 2815c609719bSwdenk Physical start address of boot monitor code (set by 2816c609719bSwdenk make config files to be same as the text base address 281714d0a02aSWolfgang Denk (CONFIG_SYS_TEXT_BASE) used when linking) - same as 28186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FLASH_BASE when booting from flash. 2819c609719bSwdenk 28206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN: 28213b57fe0aSwdenk Size of memory reserved for monitor code, used to 28223b57fe0aSwdenk determine _at_compile_time_ (!) if the environment is 28233b57fe0aSwdenk embedded within the U-Boot image, or in a separate 28243b57fe0aSwdenk flash sector. 2825c609719bSwdenk 28266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN: 2827c609719bSwdenk Size of DRAM reserved for malloc() use. 2828c609719bSwdenk 2829d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN 2830d59476b6SSimon Glass Size of the malloc() pool for use before relocation. If 2831d59476b6SSimon Glass this is defined, then a very simple malloc() implementation 2832d59476b6SSimon Glass will become available before relocation. The address is just 2833d59476b6SSimon Glass below the global data, and the stack is moved down to make 2834d59476b6SSimon Glass space. 2835d59476b6SSimon Glass 2836d59476b6SSimon Glass This feature allocates regions with increasing addresses 2837d59476b6SSimon Glass within the region. calloc() is supported, but realloc() 2838d59476b6SSimon Glass is not available. free() is supported but does nothing. 2839b445bbb4SJeremiah Mahler The memory will be freed (or in fact just forgotten) when 2840d59476b6SSimon Glass U-Boot relocates itself. 2841d59476b6SSimon Glass 284238687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE 284338687ae6SSimon Glass Provides a simple and small malloc() and calloc() for those 284438687ae6SSimon Glass boards which do not use the full malloc in SPL (which is 284538687ae6SSimon Glass enabled with CONFIG_SYS_SPL_MALLOC_START). 284638687ae6SSimon Glass 28471dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY: 28481dfdd9baSThierry Reding Size of non-cached memory area. This area of memory will be 28491dfdd9baSThierry Reding typically located right below the malloc() area and mapped 28501dfdd9baSThierry Reding uncached in the MMU. This is useful for drivers that would 28511dfdd9baSThierry Reding otherwise require a lot of explicit cache maintenance. For 28521dfdd9baSThierry Reding some drivers it's also impossible to properly maintain the 28531dfdd9baSThierry Reding cache. For example if the regions that need to be flushed 28541dfdd9baSThierry Reding are not a multiple of the cache-line size, *and* padding 28551dfdd9baSThierry Reding cannot be allocated between the regions to align them (i.e. 28561dfdd9baSThierry Reding if the HW requires a contiguous array of regions, and the 28571dfdd9baSThierry Reding size of each region is not cache-aligned), then a flush of 28581dfdd9baSThierry Reding one region may result in overwriting data that hardware has 28591dfdd9baSThierry Reding written to another region in the same cache-line. This can 28601dfdd9baSThierry Reding happen for example in network drivers where descriptors for 28611dfdd9baSThierry Reding buffers are typically smaller than the CPU cache-line (e.g. 28621dfdd9baSThierry Reding 16 bytes vs. 32 or 64 bytes). 28631dfdd9baSThierry Reding 28641dfdd9baSThierry Reding Non-cached memory is only supported on 32-bit ARM at present. 28651dfdd9baSThierry Reding 28666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN: 286715940c9aSStefan Roese Normally compressed uImages are limited to an 286815940c9aSStefan Roese uncompressed size of 8 MBytes. If this is not enough, 28696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD you can define CONFIG_SYS_BOOTM_LEN in your board config file 287015940c9aSStefan Roese to adjust this setting to your needs. 2871c609719bSwdenk 28726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ: 2873c609719bSwdenk Maximum size of memory mapped by the startup code of 2874c609719bSwdenk the Linux kernel; all data that must be processed by 28757d721e34SBartlomiej Sieka the Linux kernel (bd_info, boot arguments, FDT blob if 28767d721e34SBartlomiej Sieka used) must be put below this limit, unless "bootm_low" 28771bce2aebSRobert P. J. Day environment variable is defined and non-zero. In such case 28787d721e34SBartlomiej Sieka all data for the Linux kernel must be between "bootm_low" 2879c3624e6eSGrant Likely and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 2880c3624e6eSGrant Likely variable "bootm_mapsize" will override the value of 2881c3624e6eSGrant Likely CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 2882c3624e6eSGrant Likely then the value in "bootm_size" will be used instead. 2883c609719bSwdenk 2884fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2885fca43cc8SJohn Rigby Enable initrd_high functionality. If defined then the 2886fca43cc8SJohn Rigby initrd_high feature is enabled and the bootm ramdisk subcommand 2887fca43cc8SJohn Rigby is enabled. 2888fca43cc8SJohn Rigby 2889fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE: 2890fca43cc8SJohn Rigby Enables allocating and saving kernel cmdline in space between 2891fca43cc8SJohn Rigby "bootm_low" and "bootm_low" + BOOTMAPSZ. 2892fca43cc8SJohn Rigby 2893fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD: 2894fca43cc8SJohn Rigby Enables allocating and saving a kernel copy of the bd_info in 2895fca43cc8SJohn Rigby space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2896fca43cc8SJohn Rigby 28976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS: 2898c609719bSwdenk Max number of Flash memory banks 2899c609719bSwdenk 29006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT: 2901c609719bSwdenk Max number of sectors on a Flash chip 2902c609719bSwdenk 29036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT: 2904c609719bSwdenk Timeout for Flash erase operations (in ms) 2905c609719bSwdenk 29066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT: 2907c609719bSwdenk Timeout for Flash write operations (in ms) 2908c609719bSwdenk 29096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT 29108564acf9Swdenk Timeout for Flash set sector lock bit operation (in ms) 29118564acf9Swdenk 29126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT 29138564acf9Swdenk Timeout for Flash clear lock bits operation (in ms) 29148564acf9Swdenk 29156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION 29168564acf9Swdenk If defined, hardware flash sectors protection is used 29178564acf9Swdenk instead of U-Boot software protection. 29188564acf9Swdenk 29196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP: 2920c609719bSwdenk 2921c609719bSwdenk Enable TFTP transfers directly to flash memory; 2922c609719bSwdenk without this option such a download has to be 2923c609719bSwdenk performed in two steps: (1) download to RAM, and (2) 2924c609719bSwdenk copy from RAM to flash. 2925c609719bSwdenk 2926c609719bSwdenk The two-step approach is usually more reliable, since 2927c609719bSwdenk you can check if the download worked before you erase 292811ccc33fSMarcel Ziswiler the flash, but in some situations (when system RAM is 292911ccc33fSMarcel Ziswiler too limited to allow for a temporary copy of the 2930c609719bSwdenk downloaded image) this option may be very useful. 2931c609719bSwdenk 29326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI: 2933c609719bSwdenk Define if the flash driver uses extra elements in the 29345653fc33Swdenk common flash structure for storing flash geometry. 29355653fc33Swdenk 293600b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER 29375653fc33Swdenk This option also enables the building of the cfi_flash driver 29385653fc33Swdenk in the drivers directory 293953cf9435Sstroese 294091809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD 294191809ed5SPiotr Ziecik This option enables the building of the cfi_mtd driver 294291809ed5SPiotr Ziecik in the drivers directory. The driver exports CFI flash 294391809ed5SPiotr Ziecik to the MTD layer. 294491809ed5SPiotr Ziecik 29456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 294696ef831fSGuennadi Liakhovetski Use buffered writes to flash. 294796ef831fSGuennadi Liakhovetski 294896ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N 294996ef831fSGuennadi Liakhovetski s29ws-n MirrorBit flash has non-standard addresses for buffered 295096ef831fSGuennadi Liakhovetski write commands. 295196ef831fSGuennadi Liakhovetski 29526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST 29535568e613SStefan Roese If this option is defined, the common CFI flash doesn't 29545568e613SStefan Roese print it's warning upon not recognized FLASH banks. This 29555568e613SStefan Roese is useful, if some of the configured banks are only 29565568e613SStefan Roese optionally available. 29575568e613SStefan Roese 29589a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS 29599a042e9cSJerry Van Baren If defined (must be an integer), print out countdown 29609a042e9cSJerry Van Baren digits and dots. Recommended value: 45 (9..1) for 80 29619a042e9cSJerry Van Baren column displays, 15 (3..1) for 40 column displays. 29629a042e9cSJerry Van Baren 2963352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY 2964352ef3f1SStefan Roese If defined, the content of the flash (destination) is compared 2965352ef3f1SStefan Roese against the source after the write operation. An error message 2966352ef3f1SStefan Roese will be printed when the contents are not identical. 2967352ef3f1SStefan Roese Please note that this option is useless in nearly all cases, 2968352ef3f1SStefan Roese since such flash programming errors usually are detected earlier 2969352ef3f1SStefan Roese while unprotecting/erasing/programming. Please only enable 2970352ef3f1SStefan Roese this option if you really know what you are doing. 2971352ef3f1SStefan Roese 29726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER: 297311ccc33fSMarcel Ziswiler Defines the number of Ethernet receive buffers. On some 297411ccc33fSMarcel Ziswiler Ethernet controllers it is recommended to set this value 297553cf9435Sstroese to 8 or even higher (EEPRO100 or 405 EMAC), since all 297653cf9435Sstroese buffers can be full shortly after enabling the interface 297711ccc33fSMarcel Ziswiler on high Ethernet traffic. 297853cf9435Sstroese Defaults to 4 if not defined. 2979c609719bSwdenk 2980ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES 2981ea882bafSWolfgang Denk 2982ea882bafSWolfgang Denk Maximum number of entries in the hash table that is used 2983ea882bafSWolfgang Denk internally to store the environment settings. The default 2984ea882bafSWolfgang Denk setting is supposed to be generous and should work in most 2985ea882bafSWolfgang Denk cases. This setting can be used to tune behaviour; see 2986ea882bafSWolfgang Denk lib/hashtable.c for details. 2987ea882bafSWolfgang Denk 29882598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT 29892598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC 29901bce2aebSRobert P. J. Day Enable validation of the values given to environment variables when 29912598090bSJoe Hershberger calling env set. Variables can be restricted to only decimal, 29922598090bSJoe Hershberger hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 29932598090bSJoe Hershberger the variables can also be restricted to IP address or MAC address. 29942598090bSJoe Hershberger 29952598090bSJoe Hershberger The format of the list is: 29962598090bSJoe Hershberger type_attribute = [s|d|x|b|i|m] 2997b445bbb4SJeremiah Mahler access_attribute = [a|r|o|c] 2998b445bbb4SJeremiah Mahler attributes = type_attribute[access_attribute] 29992598090bSJoe Hershberger entry = variable_name[:attributes] 30002598090bSJoe Hershberger list = entry[,list] 30012598090bSJoe Hershberger 30022598090bSJoe Hershberger The type attributes are: 30032598090bSJoe Hershberger s - String (default) 30042598090bSJoe Hershberger d - Decimal 30052598090bSJoe Hershberger x - Hexadecimal 30062598090bSJoe Hershberger b - Boolean ([1yYtT|0nNfF]) 30072598090bSJoe Hershberger i - IP address 30082598090bSJoe Hershberger m - MAC address 30092598090bSJoe Hershberger 3010267541f7SJoe Hershberger The access attributes are: 3011267541f7SJoe Hershberger a - Any (default) 3012267541f7SJoe Hershberger r - Read-only 3013267541f7SJoe Hershberger o - Write-once 3014267541f7SJoe Hershberger c - Change-default 3015267541f7SJoe Hershberger 30162598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_DEFAULT 30172598090bSJoe Hershberger Define this to a list (string) to define the ".flags" 3018b445bbb4SJeremiah Mahler environment variable in the default or embedded environment. 30192598090bSJoe Hershberger 30202598090bSJoe Hershberger - CONFIG_ENV_FLAGS_LIST_STATIC 30212598090bSJoe Hershberger Define this to a list (string) to define validation that 30222598090bSJoe Hershberger should be done if an entry is not found in the ".flags" 30232598090bSJoe Hershberger environment variable. To override a setting in the static 30242598090bSJoe Hershberger list, simply add an entry for the same variable name to the 30252598090bSJoe Hershberger ".flags" variable. 30262598090bSJoe Hershberger 3027bdf1fe4eSJoe Hershberger If CONFIG_REGEX is defined, the variable_name above is evaluated as a 3028bdf1fe4eSJoe Hershberger regular expression. This allows multiple variables to define the same 3029bdf1fe4eSJoe Hershberger flags without explicitly listing them for each variable. 3030bdf1fe4eSJoe Hershberger 3031267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE 3032267541f7SJoe Hershberger If defined, don't allow the -f switch to env set override variable 3033267541f7SJoe Hershberger access flags. 3034267541f7SJoe Hershberger 30350d296cc2SGabe Black- CONFIG_USE_STDINT 30360d296cc2SGabe Black If stdint.h is available with your toolchain you can define this 30370d296cc2SGabe Black option to enable it. You can provide option 'USE_STDINT=1' when 30380d296cc2SGabe Black building U-Boot to enable this. 30390d296cc2SGabe Black 3040c609719bSwdenkThe following definitions that deal with the placement and management 3041c609719bSwdenkof environment data (variable area); in general, we support the 3042c609719bSwdenkfollowing configurations: 3043c609719bSwdenk 3044c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC: 3045c3eb3fe4SMike Frysinger 3046c3eb3fe4SMike Frysinger Builds up envcrc with the target environment so that external utils 3047c3eb3fe4SMike Frysinger may easily extract it and embed it in final U-Boot images. 3048c3eb3fe4SMike Frysinger 3049c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early 3050b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the 305111ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or 3052c609719bSwdenkU-Boot will hang. 3053c609719bSwdenk 3054c609719bSwdenkPlease note that even with NVRAM we still use a copy of the 3055c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to 3056c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv" 3057c609719bSwdenkto save the current settings. 3058c609719bSwdenk 30590a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use 30600a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the 3061fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link, 3062fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface. 30630a85a9e7SLiu Gang 3064b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST 3065b74ab737SGuennadi Liakhovetski 3066b74ab737SGuennadi Liakhovetski Defines address in RAM to which the nand_spl code should copy the 3067b74ab737SGuennadi Liakhovetski environment. If redundant environment is used, it will be copied to 3068b74ab737SGuennadi Liakhovetski CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3069b74ab737SGuennadi Liakhovetski 3070e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor 3071c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been 307200caae6dSSimon Glasscreated; also, when using EEPROM you will have to use env_get_f() 3073c609719bSwdenkuntil then to read environment variables. 3074c609719bSwdenk 307585ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor 307685ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working 307785ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is 307885ec0bccSwdenknecessary, because the first environment variable we need is the 307985ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't 308085ec0bccSwdenkhave any device yet where we could complain.] 3081c609719bSwdenk 3082c609719bSwdenkNote: once the monitor has been relocated, then it will complain if 3083c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you 308485ec0bccSwdenkuse the "saveenv" command to store a valid environment. 3085c609719bSwdenk 30866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3087fc3e2165Swdenk Echo the inverted Ethernet link state to the fault LED. 3088fc3e2165Swdenk 30896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3090fc3e2165Swdenk also needs to be defined. 3091fc3e2165Swdenk 30926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR: 3093fc3e2165Swdenk MII address of the PHY to check for the Ethernet link state. 3094c609719bSwdenk 3095f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS: 3096f5675aa5SRon Madrid Define this if you desire to only have use of the NS16550_init 3097f5675aa5SRon Madrid and NS16550_putc functions for the serial driver located at 3098f5675aa5SRon Madrid drivers/serial/ns16550.c. This option is useful for saving 3099f5675aa5SRon Madrid space for already greatly restricted images, including but not 3100f5675aa5SRon Madrid limited to NAND_SPL configurations. 3101f5675aa5SRon Madrid 3102b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO 3103b2b92f53SSimon Glass Display information about the board that U-Boot is running on 3104b2b92f53SSimon Glass when U-Boot starts up. The board function checkboard() is called 3105b2b92f53SSimon Glass to do this. 3106b2b92f53SSimon Glass 3107e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE 3108e2e3e2b1SSimon Glass Similar to the previous option, but display this information 3109e2e3e2b1SSimon Glass later, once stdio is running and output goes to the LCD, if 3110e2e3e2b1SSimon Glass present. 3111e2e3e2b1SSimon Glass 3112feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT: 3113feb85801SSascha Silbe Maximum size of the U-Boot image. When defined, the 3114feb85801SSascha Silbe build system checks that the actual size does not 3115feb85801SSascha Silbe exceed it. 3116feb85801SSascha Silbe 3117c609719bSwdenkLow Level (hardware related) configuration options: 3118dc7c9a1aSwdenk--------------------------------------------------- 3119c609719bSwdenk 31206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE: 3121c609719bSwdenk Cache Line Size of the CPU. 3122c609719bSwdenk 3123e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT: 3124e46fedfeSTimur Tabi Default (power-on reset) physical address of CCSR on Freescale 3125e46fedfeSTimur Tabi PowerPC SOCs. 3126e46fedfeSTimur Tabi 3127e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR: 3128e46fedfeSTimur Tabi Virtual address of CCSR. On a 32-bit build, this is typically 3129e46fedfeSTimur Tabi the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3130e46fedfeSTimur Tabi 3131e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS: 3132e46fedfeSTimur Tabi Physical address of CCSR. CCSR can be relocated to a new 3133e46fedfeSTimur Tabi physical address, if desired. In this case, this macro should 3134e46fedfeSTimur Tabi be set to that address. Otherwise, it should be set to the 3135e46fedfeSTimur Tabi same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3136e46fedfeSTimur Tabi is typically relocated on 36-bit builds. It is recommended 3137e46fedfeSTimur Tabi that this macro be defined via the _HIGH and _LOW macros: 3138e46fedfeSTimur Tabi 3139e46fedfeSTimur Tabi #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3140e46fedfeSTimur Tabi * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3141e46fedfeSTimur Tabi 3142e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3143e46fedfeSTimur Tabi Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3144e46fedfeSTimur Tabi either 0 (32-bit build) or 0xF (36-bit build). This macro is 3145e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3146e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3147e46fedfeSTimur Tabi 3148e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3149e46fedfeSTimur Tabi Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3150e46fedfeSTimur Tabi used in assembly code, so it must not contain typecasts or 3151e46fedfeSTimur Tabi integer size suffixes (e.g. "ULL"). 3152e46fedfeSTimur Tabi 3153e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3154e46fedfeSTimur Tabi If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3155e46fedfeSTimur Tabi forced to a value that ensures that CCSR is not relocated. 3156e46fedfeSTimur Tabi 31577f6c2cbcSwdenk- Floppy Disk Support: 31586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER 31597f6c2cbcSwdenk 31607f6c2cbcSwdenk the default drive number (default value 0) 31617f6c2cbcSwdenk 31626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_STRIDE 31637f6c2cbcSwdenk 316411ccc33fSMarcel Ziswiler defines the spacing between FDC chipset registers 31657f6c2cbcSwdenk (default value 1) 31667f6c2cbcSwdenk 31676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_ISA_IO_OFFSET 31687f6c2cbcSwdenk 31697f6c2cbcSwdenk defines the offset of register from address. It 31707f6c2cbcSwdenk depends on which part of the data bus is connected to 317111ccc33fSMarcel Ziswiler the FDC chipset. (default value 0) 31727f6c2cbcSwdenk 31736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 31746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 31757f6c2cbcSwdenk default value. 31767f6c2cbcSwdenk 31776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD if CONFIG_SYS_FDC_HW_INIT is defined, then the function 31787f6c2cbcSwdenk fdc_hw_init() is called at the beginning of the FDC 31797f6c2cbcSwdenk setup. fdc_hw_init() must be provided by the board 3180b445bbb4SJeremiah Mahler source code. It is used to make hardware-dependent 31817f6c2cbcSwdenk initializations. 31827f6c2cbcSwdenk 31830abddf82SMacpaul Lin- CONFIG_IDE_AHB: 31840abddf82SMacpaul Lin Most IDE controllers were designed to be connected with PCI 31850abddf82SMacpaul Lin interface. Only few of them were designed for AHB interface. 31860abddf82SMacpaul Lin When software is doing ATA command and data transfer to 31870abddf82SMacpaul Lin IDE devices through IDE-AHB controller, some additional 31880abddf82SMacpaul Lin registers accessing to these kind of IDE-AHB controller 3189b445bbb4SJeremiah Mahler is required. 31900abddf82SMacpaul Lin 31916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 319225d6712aSwdenk DO NOT CHANGE unless you know exactly what you're 3193907208c4SChristophe Leroy doing! (11-4) [MPC8xx systems only] 3194c609719bSwdenk 31956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR: 3196c609719bSwdenk 31977152b1d0Swdenk Start address of memory area that can be used for 3198c609719bSwdenk initial data and stack; please note that this must be 3199c609719bSwdenk writable memory that is working WITHOUT special 3200c609719bSwdenk initialization, i. e. you CANNOT use normal RAM which 3201c609719bSwdenk will become available only after programming the 3202c609719bSwdenk memory controller and running certain initialization 3203c609719bSwdenk sequences. 3204c609719bSwdenk 3205c609719bSwdenk U-Boot uses the following memory types: 3206907208c4SChristophe Leroy - MPC8xx: IMMR (internal memory of the CPU) 3207c609719bSwdenk 32086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET: 3209c609719bSwdenk 3210c609719bSwdenk Offset of the initial data structure in the memory 32116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 32126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3213c609719bSwdenk data is located at the end of the available space 3214553f0982SWolfgang Denk (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 3215acd51f9dSSimon Glass GENERATED_GBL_DATA_SIZE), and the initial stack is just 32166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 32176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_GBL_DATA_OFFSET) downward. 3218c609719bSwdenk 3219c609719bSwdenk Note: 3220c609719bSwdenk On the MPC824X (or other systems that use the data 3221c609719bSwdenk cache for initial memory) the address chosen for 32226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3223c609719bSwdenk point to an otherwise UNUSED address space between 3224c609719bSwdenk the top of RAM and the start of the PCI space. 3225c609719bSwdenk 32266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3227c609719bSwdenk 32286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM: 3229c609719bSwdenk SDRAM timing 3230c609719bSwdenk 32316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA: 3232c609719bSwdenk periodic timer for refresh 3233c609719bSwdenk 32346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 32356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 32366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 32376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BR1_PRELIM: 3238c609719bSwdenk Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3239c609719bSwdenk 3240c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 32416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 32426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3243c609719bSwdenk Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3244c609719bSwdenk 324569fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY 3246b445bbb4SJeremiah Mahler Only scan through and get the devices on the buses. 324769fd2d3bSAndrew Sharp Don't do any setup work, presumably because someone or 324869fd2d3bSAndrew Sharp something has already done it, and we don't need to do it 324969fd2d3bSAndrew Sharp a second time. Useful for platforms that are pre-booted 325069fd2d3bSAndrew Sharp by coreboot or similar. 325169fd2d3bSAndrew Sharp 3252842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE: 3253842033e6SGabor Juhos Enable support for indirect PCI bridges. 3254842033e6SGabor Juhos 3255a09b9b68SKumar Gala- CONFIG_SYS_SRIO: 3256a09b9b68SKumar Gala Chip has SRIO or not 3257a09b9b68SKumar Gala 3258a09b9b68SKumar Gala- CONFIG_SRIO1: 3259a09b9b68SKumar Gala Board has SRIO 1 port available 3260a09b9b68SKumar Gala 3261a09b9b68SKumar Gala- CONFIG_SRIO2: 3262a09b9b68SKumar Gala Board has SRIO 2 port available 3263a09b9b68SKumar Gala 3264c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER 3265c8b28152SLiu Gang Board can support master function for Boot from SRIO and PCIE 3266c8b28152SLiu Gang 3267a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT: 3268a09b9b68SKumar Gala Virtual Address of SRIO port 'n' memory region 3269a09b9b68SKumar Gala 3270a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS: 3271a09b9b68SKumar Gala Physical Address of SRIO port 'n' memory region 3272a09b9b68SKumar Gala 3273a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE: 3274a09b9b68SKumar Gala Size of SRIO port 'n' memory region 3275a09b9b68SKumar Gala 327666bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT 327766bd1846SFabio Estevam Defined to tell the NAND controller that the NAND chip is using 327866bd1846SFabio Estevam a 16 bit bus. 327966bd1846SFabio Estevam Not all NAND drivers use this symbol. 3280a430e916SFabio Estevam Example of drivers that use it: 328166bd1846SFabio Estevam - drivers/mtd/nand/ndfc.c 3282a430e916SFabio Estevam - drivers/mtd/nand/mxc_nand.c 3283eced4626SAlex Waterman 3284eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG 3285eced4626SAlex Waterman Sets the EBC0_CFG register for the NDFC. If not defined 3286eced4626SAlex Waterman a default value will be used. 3287eced4626SAlex Waterman 3288bb99ad6dSBen Warren- CONFIG_SPD_EEPROM 3289218ca724SWolfgang Denk Get DDR timing information from an I2C EEPROM. Common 3290218ca724SWolfgang Denk with pluggable memory modules such as SODIMMs 3291218ca724SWolfgang Denk 3292bb99ad6dSBen Warren SPD_EEPROM_ADDRESS 3293bb99ad6dSBen Warren I2C address of the SPD EEPROM 3294bb99ad6dSBen Warren 32956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM 3296218ca724SWolfgang Denk If SPD EEPROM is on an I2C bus other than the first 3297218ca724SWolfgang Denk one, specify here. Note that the value must resolve 3298218ca724SWolfgang Denk to something your driver can deal with. 3299bb99ad6dSBen Warren 33001b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING 33011b3e3c4fSYork Sun Get DDR timing information from other than SPD. Common with 33021b3e3c4fSYork Sun soldered DDR chips onboard without SPD. DDR raw timing 33031b3e3c4fSYork Sun parameters are extracted from datasheet and hard-coded into 33041b3e3c4fSYork Sun header files or board specific files. 33051b3e3c4fSYork Sun 33066f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE 33076f5e1dc5SYork Sun Enable interactive DDR debugging. See doc/README.fsl-ddr. 33086f5e1dc5SYork Sun 3309e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH 3310e32d59a2SYork Sun Enable sync of refresh for multiple controllers. 3311e32d59a2SYork Sun 33124516ff81SYork Sun- CONFIG_FSL_DDR_BIST 33134516ff81SYork Sun Enable built-in memory test for Freescale DDR controllers. 33144516ff81SYork Sun 33156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0 3316218ca724SWolfgang Denk Only for 83xx systems. If specified, then DDR should 3317218ca724SWolfgang Denk be configured using CS0 and CS1 instead of CS2 and CS3. 33182ad6b513STimur Tabi 3319c26e454dSwdenk- CONFIG_RMII 3320c26e454dSwdenk Enable RMII mode for all FECs. 3321c26e454dSwdenk Note that this is a global option, we can't 3322c26e454dSwdenk have one FEC in standard MII mode and another in RMII mode. 3323c26e454dSwdenk 33245cf91d6bSwdenk- CONFIG_CRC32_VERIFY 33255cf91d6bSwdenk Add a verify option to the crc32 command. 33265cf91d6bSwdenk The syntax is: 33275cf91d6bSwdenk 33285cf91d6bSwdenk => crc32 -v <address> <count> <crc32> 33295cf91d6bSwdenk 33305cf91d6bSwdenk Where address/count indicate a memory area 33315cf91d6bSwdenk and crc32 is the correct crc32 which the 33325cf91d6bSwdenk area should have. 33335cf91d6bSwdenk 333456523f12Swdenk- CONFIG_LOOPW 333556523f12Swdenk Add the "loopw" memory command. This only takes effect if 3336493f420eSSimon Glass the memory commands are activated globally (CONFIG_CMD_MEMORY). 333756523f12Swdenk 33387b466641Sstroese- CONFIG_MX_CYCLIC 33397b466641Sstroese Add the "mdc" and "mwc" memory commands. These are cyclic 33407b466641Sstroese "md/mw" commands. 33417b466641Sstroese Examples: 33427b466641Sstroese 33437b466641Sstroese => mdc.b 10 4 500 33447b466641Sstroese This command will print 4 bytes (10,11,12,13) each 500 ms. 33457b466641Sstroese 33467b466641Sstroese => mwc.l 100 12345678 10 33477b466641Sstroese This command will write 12345678 to address 100 all 10 ms. 33487b466641Sstroese 33497b466641Sstroese This only takes effect if the memory commands are activated 3350493f420eSSimon Glass globally (CONFIG_CMD_MEMORY). 33517b466641Sstroese 33528aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT 33533fafced7SRick Chen [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain 3354e03f3169SWolfgang Denk low level initializations (like setting up the memory 3355e03f3169SWolfgang Denk controller) are omitted and/or U-Boot does not 3356e03f3169SWolfgang Denk relocate itself into RAM. 33578aa1a2d1Swdenk 3358e03f3169SWolfgang Denk Normally this variable MUST NOT be defined. The only 3359e03f3169SWolfgang Denk exception is when U-Boot is loaded (to RAM) by some 3360e03f3169SWolfgang Denk other boot loader or by a debugger which performs 3361e03f3169SWolfgang Denk these initializations itself. 33628aa1a2d1Swdenk 3363b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY 3364b5bd0982SSimon Glass [ARM926EJ-S only] This allows just the call to lowlevel_init() 336590211f77Syeongjun Kim to be skipped. The normal CP15 init (such as enabling the 3366b5bd0982SSimon Glass instruction cache) is still performed. 3367b5bd0982SSimon Glass 3368401bb30bSAneesh V- CONFIG_SPL_BUILD 3369df81238bSMagnus Lilja Modifies the behaviour of start.S when compiling a loader 3370df81238bSMagnus Lilja that is executed before the actual U-Boot. E.g. when 3371df81238bSMagnus Lilja compiling a NAND SPL. 3372400558b5Swdenk 33733aa29de0SYing Zhang- CONFIG_TPL_BUILD 33743aa29de0SYing Zhang Modifies the behaviour of start.S when compiling a loader 33753aa29de0SYing Zhang that is executed after the SPL and before the actual U-Boot. 33763aa29de0SYing Zhang It is loaded by the SPL. 33773aa29de0SYing Zhang 33785df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC 33795df572f0SYing Zhang Only for 85xx systems. If this variable is specified, the section 33805df572f0SYing Zhang .resetvec is not kept and the section .bootpg is placed in the 33815df572f0SYing Zhang previous 4k of the .text section. 33825df572f0SYing Zhang 33834213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM 33844213fc29SSimon Glass Generally U-Boot (and in particular the md command) uses 33854213fc29SSimon Glass effective address. It is therefore not necessary to regard 33864213fc29SSimon Glass U-Boot address as virtual addresses that need to be translated 33874213fc29SSimon Glass to physical addresses. However, sandbox requires this, since 33884213fc29SSimon Glass it maintains its own little RAM buffer which contains all 33894213fc29SSimon Glass addressable memory. This option causes some memory accesses 33904213fc29SSimon Glass to be mapped through map_sysmem() / unmap_sysmem(). 33914213fc29SSimon Glass 3392588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR 3393588a13f7SSimon Glass If defined, the x86 reset vector code is included. This is not 3394588a13f7SSimon Glass needed when U-Boot is running from Coreboot. 3395b16f521aSGabe Black 3396999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 3397999d7d32SKaricheri, Muralidharan Option to disable subpage write in NAND driver 3398999d7d32SKaricheri, Muralidharan driver that uses this: 3399999d7d32SKaricheri, Muralidharan drivers/mtd/nand/davinci_nand.c 3400999d7d32SKaricheri, Muralidharan 3401f2717b47STimur TabiFreescale QE/FMAN Firmware Support: 3402f2717b47STimur Tabi----------------------------------- 3403f2717b47STimur Tabi 3404f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 3405f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format. 3406f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros 3407f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address 3408f2717b47STimur Tabiwithin that device. 3409f2717b47STimur Tabi 3410dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR 3411dcf1d774SZhao Qiang The address in the storage device where the FMAN microcode is located. The 3412dcf1d774SZhao Qiang meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3413dcf1d774SZhao Qiang is also specified. 3414dcf1d774SZhao Qiang 3415dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR 3416dcf1d774SZhao Qiang The address in the storage device where the QE microcode is located. The 3417f2717b47STimur Tabi meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3418f2717b47STimur Tabi is also specified. 3419f2717b47STimur Tabi 3420f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH 3421f2717b47STimur Tabi The maximum possible size of the firmware. The firmware binary format 3422f2717b47STimur Tabi has a field that specifies the actual size of the firmware, but it 3423f2717b47STimur Tabi might not be possible to read any part of the firmware unless some 3424f2717b47STimur Tabi local storage is allocated to hold the entire firmware first. 3425f2717b47STimur Tabi 3426f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR 3427f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NOR flash, mapped as 3428f2717b47STimur Tabi normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 3429f2717b47STimur Tabi virtual address in NOR flash. 3430f2717b47STimur Tabi 3431f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND 3432f2717b47STimur Tabi Specifies that QE/FMAN firmware is located in NAND flash. 3433f2717b47STimur Tabi CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 3434f2717b47STimur Tabi 3435f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC 3436f2717b47STimur Tabi Specifies that QE/FMAN firmware is located on the primary SD/MMC 3437f2717b47STimur Tabi device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3438f2717b47STimur Tabi 3439292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 3440292dc6c5SLiu Gang Specifies that QE/FMAN firmware is located in the remote (master) 3441292dc6c5SLiu Gang memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 3442fc54c7faSLiu Gang can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 3443fc54c7faSLiu Gang window->master inbound window->master LAW->the ucode address in 3444fc54c7faSLiu Gang master's memory space. 3445f2717b47STimur Tabi 3446b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support: 3447b940ca64SJ. German Rivera--------------------------------------------------------- 3448b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of 3449b940ca64SJ. German Rivera"firmware". 3450b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros 3451b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address 3452b940ca64SJ. German Riverawithin that device. 3453b940ca64SJ. German Rivera 3454b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET 3455b940ca64SJ. German Rivera Enable the MC driver for Layerscape SoCs. 3456b940ca64SJ. German Rivera 34575c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support: 34585c055089SPrabhakar Kushwaha------------------------------------------- 34595c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of 34605c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom. 34615c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting. 34625c055089SPrabhakar Kushwaha 3463c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN 3464c0492141SYork Sun Define alignment of reserved memory MC requires 34655c055089SPrabhakar Kushwaha 3466f3f431a7SPaul KocialkowskiReproducible builds 3467f3f431a7SPaul Kocialkowski------------------- 3468f3f431a7SPaul Kocialkowski 3469f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build 3470f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value. 3471f3f431a7SPaul Kocialkowski 3472f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable. 3473f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration 3474f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot. 3475f3f431a7SPaul Kocialkowski 3476f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC. 3477f3f431a7SPaul Kocialkowski 3478c609719bSwdenkBuilding the Software: 3479c609719bSwdenk====================== 3480c609719bSwdenk 3481218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments 3482218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support 3483218ca724SWolfgang Denkall possibly existing versions of cross development tools in all 3484218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we 3485218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3486218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot. 3487c609719bSwdenk 3488218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you 3489218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case, 3490218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell. 3491218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are 3492218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter: 3493c609719bSwdenk 3494218ca724SWolfgang Denk $ CROSS_COMPILE=ppc_4xx- 3495218ca724SWolfgang Denk $ export CROSS_COMPILE 3496c609719bSwdenk 34972f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in 34982f8d396bSPeter Tyser the tools directory you can use the MinGW toolchain 34992f8d396bSPeter Tyser (http://www.mingw.org). Set your HOST tools to the MinGW 35002f8d396bSPeter Tyser toolchain and execute 'make tools'. For example: 35012f8d396bSPeter Tyser 35022f8d396bSPeter Tyser $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 35032f8d396bSPeter Tyser 35042f8d396bSPeter Tyser Binaries such as tools/mkimage.exe will be created which can 35052f8d396bSPeter Tyser be executed on computers running Windows. 35062f8d396bSPeter Tyser 3507c609719bSwdenkU-Boot is intended to be simple to build. After installing the 3508c609719bSwdenksources you must configure U-Boot for one specific board type. This 3509c609719bSwdenkis done by typing: 3510c609719bSwdenk 3511ab584d67SHolger Freyther make NAME_defconfig 3512c609719bSwdenk 3513ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu- 35144d675ae6SMichael Jonesrations; see boards.cfg for supported names. 351554387ac9Swdenk 3516c609719bSwdenkNote: for some board special configuration names may exist; check if 3517c609719bSwdenk additional information is available from the board vendor; for 35182729af9dSwdenk instance, the TQM823L systems are available without (standard) 35192729af9dSwdenk or with LCD support. You can select such additional "features" 352011ccc33fSMarcel Ziswiler when choosing the configuration, i. e. 3521c609719bSwdenk 3522ab584d67SHolger Freyther make TQM823L_defconfig 35232729af9dSwdenk - will configure for a plain TQM823L, i. e. no LCD support 3524c609719bSwdenk 3525ab584d67SHolger Freyther make TQM823L_LCD_defconfig 3526c609719bSwdenk - will configure for a TQM823L with U-Boot console on LCD 3527c609719bSwdenk 3528c609719bSwdenk etc. 3529c609719bSwdenk 3530c609719bSwdenk 3531c609719bSwdenkFinally, type "make all", and you should get some working U-Boot 35327152b1d0Swdenkimages ready for download to / installation on your system: 3533c609719bSwdenk 3534c609719bSwdenk- "u-boot.bin" is a raw binary image 3535c609719bSwdenk- "u-boot" is an image in ELF binary format 3536c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format 3537c609719bSwdenk 3538baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved 3539baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change 3540baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory: 3541baf31249SMarian Balakowicz 3542baf31249SMarian Balakowicz1. Add O= to the make command line invocations: 3543baf31249SMarian Balakowicz 3544baf31249SMarian Balakowicz make O=/tmp/build distclean 3545ab584d67SHolger Freyther make O=/tmp/build NAME_defconfig 3546baf31249SMarian Balakowicz make O=/tmp/build all 3547baf31249SMarian Balakowicz 3548adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location: 3549baf31249SMarian Balakowicz 3550adbba996STimo Ketola export KBUILD_OUTPUT=/tmp/build 3551baf31249SMarian Balakowicz make distclean 3552ab584d67SHolger Freyther make NAME_defconfig 3553baf31249SMarian Balakowicz make all 3554baf31249SMarian Balakowicz 3555adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment 3556baf31249SMarian Balakowiczvariable. 3557baf31249SMarian Balakowicz 3558215bb1c1SDaniel SchwierzeckUser specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by 3559215bb1c1SDaniel Schwierzecksetting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS. 3560215bb1c1SDaniel SchwierzeckFor example to treat all compiler warnings as errors: 3561215bb1c1SDaniel Schwierzeck 3562215bb1c1SDaniel Schwierzeck make KCFLAGS=-Werror 3563c609719bSwdenk 3564c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so 3565c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of 3566c609719bSwdenknative "make". 3567c609719bSwdenk 3568c609719bSwdenk 3569c609719bSwdenkIf the system board that you have is not listed, then you will need 3570c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these 3571c609719bSwdenksteps: 3572c609719bSwdenk 35733c1496cdSPhil Sutter1. Create a new directory to hold your board specific code. Add any 357485ec0bccSwdenk files you need. In your board directory, you will need at least 35753c1496cdSPhil Sutter the "Makefile" and a "<board>.c". 35763c1496cdSPhil Sutter2. Create a new configuration file "include/configs/<board>.h" for 35773c1496cdSPhil Sutter your board. 3578c609719bSwdenk3. If you're porting U-Boot to a new CPU, then also create a new 3579c609719bSwdenk directory to hold your CPU specific code. Add any files you need. 3580ab584d67SHolger Freyther4. Run "make <board>_defconfig" with your new name. 3581c609719bSwdenk5. Type "make", and you should get a working "u-boot.srec" file 3582c609719bSwdenk to be installed on your target system. 358385ec0bccSwdenk6. Debug and solve any problems that might arise. 3584c609719bSwdenk [Of course, this last step is much harder than it sounds.] 3585c609719bSwdenk 3586c609719bSwdenk 3587c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.: 3588c609719bSwdenk============================================================== 3589c609719bSwdenk 3590c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board 3591c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to 3592c609719bSwdenkprovide feedback to the other developers. The feedback normally takes 3593c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest 3594218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources. 3595c609719bSwdenk 3596c609719bSwdenkBut before you submit such a patch, please verify that your modifi- 3597c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of 3598c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so, 35996de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will 36006de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this 36016de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H' 36026de80f21SSimon Glassfor documentation. 3603baf31249SMarian Balakowicz 3604baf31249SMarian Balakowicz 3605c609719bSwdenkSee also "U-Boot Porting Guide" below. 3606c609719bSwdenk 3607c609719bSwdenk 3608c609719bSwdenkMonitor Commands - Overview: 3609c609719bSwdenk============================ 3610c609719bSwdenk 3611c609719bSwdenkgo - start application at address 'addr' 3612c609719bSwdenkrun - run commands in an environment variable 3613c609719bSwdenkbootm - boot application image from memory 3614c609719bSwdenkbootp - boot image via network using BootP/TFTP protocol 361544f074c7SMarek Vasutbootz - boot zImage from memory 3616c609719bSwdenktftpboot- boot image via network using TFTP protocol 3617c609719bSwdenk and env variables "ipaddr" and "serverip" 3618c609719bSwdenk (and eventually "gatewayip") 36191fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol 3620c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol 3621c609719bSwdenkdiskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3622c609719bSwdenkloads - load S-Record file over serial line 3623c609719bSwdenkloadb - load binary file over serial line (kermit mode) 3624c609719bSwdenkmd - memory display 3625c609719bSwdenkmm - memory modify (auto-incrementing) 3626c609719bSwdenknm - memory modify (constant address) 3627c609719bSwdenkmw - memory write (fill) 3628c609719bSwdenkcp - memory copy 3629c609719bSwdenkcmp - memory compare 3630c609719bSwdenkcrc32 - checksum calculation 36310f89c54bSPeter Tyseri2c - I2C sub-system 3632c609719bSwdenksspi - SPI utility commands 3633c609719bSwdenkbase - print or set address offset 3634c609719bSwdenkprintenv- print environment variables 3635c609719bSwdenksetenv - set environment variables 3636c609719bSwdenksaveenv - save environment variables to persistent storage 3637c609719bSwdenkprotect - enable or disable FLASH write protection 3638c609719bSwdenkerase - erase FLASH memory 3639c609719bSwdenkflinfo - print FLASH memory information 364010635afaSKarl O. Pincnand - NAND memory operations (see doc/README.nand) 3641c609719bSwdenkbdinfo - print Board Info structure 3642c609719bSwdenkiminfo - print header information for application image 3643c609719bSwdenkconinfo - print console devices and informations 3644c609719bSwdenkide - IDE sub-system 3645c609719bSwdenkloop - infinite loop on address range 364656523f12Swdenkloopw - infinite write loop on address range 3647c609719bSwdenkmtest - simple RAM test 3648c609719bSwdenkicache - enable or disable instruction cache 3649c609719bSwdenkdcache - enable or disable data cache 3650c609719bSwdenkreset - Perform RESET of the CPU 3651c609719bSwdenkecho - echo args to console 3652c609719bSwdenkversion - print monitor version 3653c609719bSwdenkhelp - print online help 3654c609719bSwdenk? - alias for 'help' 3655c609719bSwdenk 3656c609719bSwdenk 3657c609719bSwdenkMonitor Commands - Detailed Description: 3658c609719bSwdenk======================================== 3659c609719bSwdenk 3660c609719bSwdenkTODO. 3661c609719bSwdenk 3662c609719bSwdenkFor now: just type "help <command>". 3663c609719bSwdenk 3664c609719bSwdenk 3665c609719bSwdenkEnvironment Variables: 3666c609719bSwdenk====================== 3667c609719bSwdenk 3668c609719bSwdenkU-Boot supports user configuration using Environment Variables which 3669c609719bSwdenkcan be made persistent by saving to Flash memory. 3670c609719bSwdenk 3671c609719bSwdenkEnvironment Variables are set using "setenv", printed using 3672c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv" 3673c609719bSwdenkwithout a value can be used to delete a variable from the 3674c609719bSwdenkenvironment. As long as you don't save the environment you are 3675c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the 3676c609719bSwdenkenvironment is erased by accident, a default environment is provided. 3677c609719bSwdenk 3678c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables. 3679c96f86eeSWolfgang Denk 3680c96f86eeSWolfgang DenkList of environment variables (most likely not complete): 3681c609719bSwdenk 3682c609719bSwdenk baudrate - see CONFIG_BAUDRATE 3683c609719bSwdenk 3684c609719bSwdenk bootdelay - see CONFIG_BOOTDELAY 3685c609719bSwdenk 3686c609719bSwdenk bootcmd - see CONFIG_BOOTCOMMAND 3687c609719bSwdenk 3688c609719bSwdenk bootargs - Boot arguments when booting an RTOS image 3689c609719bSwdenk 3690c609719bSwdenk bootfile - Name of the image to load with TFTP 3691c609719bSwdenk 36927d721e34SBartlomiej Sieka bootm_low - Memory range available for image processing in the bootm 36937d721e34SBartlomiej Sieka command can be restricted. This variable is given as 36947d721e34SBartlomiej Sieka a hexadecimal number and defines lowest address allowed 36957d721e34SBartlomiej Sieka for use by the bootm command. See also "bootm_size" 36967d721e34SBartlomiej Sieka environment variable. Address defined by "bootm_low" is 36977d721e34SBartlomiej Sieka also the base of the initial memory mapping for the Linux 3698c3624e6eSGrant Likely kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3699c3624e6eSGrant Likely bootm_mapsize. 3700c3624e6eSGrant Likely 3701c3624e6eSGrant Likely bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3702c3624e6eSGrant Likely This variable is given as a hexadecimal number and it 3703c3624e6eSGrant Likely defines the size of the memory region starting at base 3704c3624e6eSGrant Likely address bootm_low that is accessible by the Linux kernel 3705c3624e6eSGrant Likely during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3706c3624e6eSGrant Likely as the default value if it is defined, and bootm_size is 3707c3624e6eSGrant Likely used otherwise. 37087d721e34SBartlomiej Sieka 37097d721e34SBartlomiej Sieka bootm_size - Memory range available for image processing in the bootm 37107d721e34SBartlomiej Sieka command can be restricted. This variable is given as 37117d721e34SBartlomiej Sieka a hexadecimal number and defines the size of the region 37127d721e34SBartlomiej Sieka allowed for use by the bootm command. See also "bootm_low" 37137d721e34SBartlomiej Sieka environment variable. 37147d721e34SBartlomiej Sieka 37154bae9090SBartlomiej Sieka updatefile - Location of the software update file on a TFTP server, used 37164bae9090SBartlomiej Sieka by the automatic software update feature. Please refer to 37174bae9090SBartlomiej Sieka documentation in doc/README.update for more details. 37184bae9090SBartlomiej Sieka 3719c609719bSwdenk autoload - if set to "no" (any string beginning with 'n'), 3720c609719bSwdenk "bootp" will just load perform a lookup of the 3721c609719bSwdenk configuration from the BOOTP server, but not try to 3722c609719bSwdenk load any image using TFTP 3723c609719bSwdenk 3724c609719bSwdenk autostart - if set to "yes", an image loaded using the "bootp", 3725c609719bSwdenk "rarpboot", "tftpboot" or "diskboot" commands will 3726c609719bSwdenk be automatically started (by internally calling 3727c609719bSwdenk "bootm") 3728c609719bSwdenk 37294a6fd34bSwdenk If set to "no", a standalone image passed to the 37304a6fd34bSwdenk "bootm" command will be copied to the load address 37314a6fd34bSwdenk (and eventually uncompressed), but NOT be started. 37324a6fd34bSwdenk This can be used to load and uncompress arbitrary 37334a6fd34bSwdenk data. 37344a6fd34bSwdenk 3735a28afca5SDavid A. Long fdt_high - if set this restricts the maximum address that the 3736a28afca5SDavid A. Long flattened device tree will be copied into upon boot. 3737fa34f6b2SShawn Guo For example, if you have a system with 1 GB memory 3738fa34f6b2SShawn Guo at physical address 0x10000000, while Linux kernel 3739fa34f6b2SShawn Guo only recognizes the first 704 MB as low memory, you 3740fa34f6b2SShawn Guo may need to set fdt_high as 0x3C000000 to have the 3741fa34f6b2SShawn Guo device tree blob be copied to the maximum address 3742fa34f6b2SShawn Guo of the 704 MB low memory, so that Linux kernel can 3743fa34f6b2SShawn Guo access it during the boot procedure. 3744fa34f6b2SShawn Guo 3745a28afca5SDavid A. Long If this is set to the special value 0xFFFFFFFF then 3746a28afca5SDavid A. Long the fdt will not be copied at all on boot. For this 3747a28afca5SDavid A. Long to work it must reside in writable memory, have 3748a28afca5SDavid A. Long sufficient padding on the end of it for u-boot to 3749a28afca5SDavid A. Long add the information it needs into it, and the memory 3750a28afca5SDavid A. Long must be accessible by the kernel. 3751a28afca5SDavid A. Long 3752eea63e05SSimon Glass fdtcontroladdr- if set this is the address of the control flattened 3753eea63e05SSimon Glass device tree used by U-Boot when CONFIG_OF_CONTROL is 3754eea63e05SSimon Glass defined. 3755eea63e05SSimon Glass 375617ea1177Swdenk i2cfast - (PPC405GP|PPC405EP only) 375717ea1177Swdenk if set to 'y' configures Linux I2C driver for fast 375817ea1177Swdenk mode (400kHZ). This environment variable is used in 375917ea1177Swdenk initialization code. So, for changes to be effective 376017ea1177Swdenk it must be saved and board must be reset. 376117ea1177Swdenk 3762c609719bSwdenk initrd_high - restrict positioning of initrd images: 3763c609719bSwdenk If this variable is not set, initrd images will be 3764c609719bSwdenk copied to the highest possible address in RAM; this 3765c609719bSwdenk is usually what you want since it allows for 3766c609719bSwdenk maximum initrd size. If for some reason you want to 3767c609719bSwdenk make sure that the initrd image is loaded below the 37686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3769c609719bSwdenk variable to a value of "no" or "off" or "0". 3770c609719bSwdenk Alternatively, you can set it to a maximum upper 3771c609719bSwdenk address to use (U-Boot will still check that it 3772c609719bSwdenk does not overwrite the U-Boot stack and data). 3773c609719bSwdenk 3774c609719bSwdenk For instance, when you have a system with 16 MB 37757152b1d0Swdenk RAM, and want to reserve 4 MB from use by Linux, 3776c609719bSwdenk you can do this by adding "mem=12M" to the value of 3777c609719bSwdenk the "bootargs" variable. However, now you must make 37787152b1d0Swdenk sure that the initrd image is placed in the first 3779c609719bSwdenk 12 MB as well - this can be done with 3780c609719bSwdenk 3781c609719bSwdenk setenv initrd_high 00c00000 3782c609719bSwdenk 378338b99261Swdenk If you set initrd_high to 0xFFFFFFFF, this is an 378438b99261Swdenk indication to U-Boot that all addresses are legal 378538b99261Swdenk for the Linux kernel, including addresses in flash 378638b99261Swdenk memory. In this case U-Boot will NOT COPY the 378738b99261Swdenk ramdisk at all. This may be useful to reduce the 378838b99261Swdenk boot time on your system, but requires that this 378938b99261Swdenk feature is supported by your Linux kernel. 379038b99261Swdenk 3791c609719bSwdenk ipaddr - IP address; needed for tftpboot command 3792c609719bSwdenk 3793c609719bSwdenk loadaddr - Default load address for commands like "bootp", 3794dc7c9a1aSwdenk "rarpboot", "tftpboot", "loadb" or "diskboot" 3795c609719bSwdenk 3796c609719bSwdenk loads_echo - see CONFIG_LOADS_ECHO 3797c609719bSwdenk 3798c609719bSwdenk serverip - TFTP server IP address; needed for tftpboot command 3799c609719bSwdenk 3800c609719bSwdenk bootretry - see CONFIG_BOOT_RETRY_TIME 3801c609719bSwdenk 3802c609719bSwdenk bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3803c609719bSwdenk 3804c609719bSwdenk bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3805c609719bSwdenk 3806e2a53458SMike Frysinger ethprime - controls which interface is used first. 3807a3d991bdSwdenk 3808e2a53458SMike Frysinger ethact - controls which interface is currently active. 3809e2a53458SMike Frysinger For example you can do the following 3810a3d991bdSwdenk 381148690d80SHeiko Schocher => setenv ethact FEC 381248690d80SHeiko Schocher => ping 192.168.0.1 # traffic sent on FEC 381348690d80SHeiko Schocher => setenv ethact SCC 381448690d80SHeiko Schocher => ping 10.0.0.1 # traffic sent on SCC 3815a3d991bdSwdenk 3816e1692577SMatthias Fuchs ethrotate - When set to "no" U-Boot does not go through all 3817e1692577SMatthias Fuchs available network interfaces. 3818e1692577SMatthias Fuchs It just stays at the currently selected interface. 3819e1692577SMatthias Fuchs 3820a3d991bdSwdenk netretry - When set to "no" each network operation will 3821a3d991bdSwdenk either succeed or fail without retrying. 38226e592385Swdenk When set to "once" the network operation will 38236e592385Swdenk fail when all the available network interfaces 38246e592385Swdenk are tried once without success. 3825a3d991bdSwdenk Useful on scripts which control the retry operation 3826a3d991bdSwdenk themselves. 3827a3d991bdSwdenk 3828b4e2f89dSJean-Christophe PLAGNIOL-VILLARD npe_ucode - set load address for the NPE microcode 3829a1cf027aSJean-Christophe PLAGNIOL-VILLARD 3830b445bbb4SJeremiah Mahler silent_linux - If set then Linux will be told to boot silently, by 38318d51aacdSSimon Glass changing the console to be empty. If "yes" it will be 38328d51aacdSSimon Glass made silent. If "no" it will not be made silent. If 38338d51aacdSSimon Glass unset, then it will be made silent if the U-Boot console 38348d51aacdSSimon Glass is silent. 38358d51aacdSSimon Glass 3836f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpsrcp - If this is set, the value is used for TFTP's 3837ecb0ccd9SWolfgang Denk UDP source port. 3838ecb0ccd9SWolfgang Denk 3839f5fb7346SAlbert ARIBAUD \(3ADEV\) tftpdstp - If this is set, the value is used for TFTP's UDP 384028cb9375SWolfgang Denk destination port instead of the Well Know Port 69. 384128cb9375SWolfgang Denk 3842c96f86eeSWolfgang Denk tftpblocksize - Block size to use for TFTP transfers; if not set, 3843c96f86eeSWolfgang Denk we use the TFTP server's default block size 3844c96f86eeSWolfgang Denk 3845c96f86eeSWolfgang Denk tftptimeout - Retransmission timeout for TFTP packets (in milli- 3846c96f86eeSWolfgang Denk seconds, minimum value is 1000 = 1 second). Defines 3847c96f86eeSWolfgang Denk when a packet is considered to be lost so it has to 3848c96f86eeSWolfgang Denk be retransmitted. The default is 5000 = 5 seconds. 3849c96f86eeSWolfgang Denk Lowering this value may make downloads succeed 3850c96f86eeSWolfgang Denk faster in networks with high packet loss rates or 3851c96f86eeSWolfgang Denk with unreliable TFTP servers. 3852c96f86eeSWolfgang Denk 3853f5fb7346SAlbert ARIBAUD \(3ADEV\) tftptimeoutcountmax - maximum count of TFTP timeouts (no 3854f5fb7346SAlbert ARIBAUD \(3ADEV\) unit, minimum value = 0). Defines how many timeouts 3855f5fb7346SAlbert ARIBAUD \(3ADEV\) can happen during a single file transfer before that 3856f5fb7346SAlbert ARIBAUD \(3ADEV\) transfer is aborted. The default is 10, and 0 means 3857f5fb7346SAlbert ARIBAUD \(3ADEV\) 'no timeouts allowed'. Increasing this value may help 3858f5fb7346SAlbert ARIBAUD \(3ADEV\) downloads succeed with high packet loss rates, or with 3859f5fb7346SAlbert ARIBAUD \(3ADEV\) unreliable TFTP servers or client hardware. 3860f5fb7346SAlbert ARIBAUD \(3ADEV\) 3861a3d991bdSwdenk vlan - When set to a value < 4095 the traffic over 386211ccc33fSMarcel Ziswiler Ethernet is encapsulated/received over 802.1q 3863a3d991bdSwdenk VLAN tagged frames. 3864c609719bSwdenk 386550768f5bSAlexandre Messier bootpretryperiod - Period during which BOOTP/DHCP sends retries. 386650768f5bSAlexandre Messier Unsigned value, in milliseconds. If not set, the period will 386750768f5bSAlexandre Messier be either the default (28000), or a value based on 386850768f5bSAlexandre Messier CONFIG_NET_RETRY_COUNT, if defined. This value has 386950768f5bSAlexandre Messier precedence over the valu based on CONFIG_NET_RETRY_COUNT. 387050768f5bSAlexandre Messier 3871dc0b7b0eSJason HobbsThe following image location variables contain the location of images 3872dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is 3873dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment 3874dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP 3875dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be 3876dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR 3877dc0b7b0eSJason Hobbsflash or offset in NAND flash. 3878dc0b7b0eSJason Hobbs 3879dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some 3880aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some 3881dc0b7b0eSJason Hobbsboards use these variables for other purposes. 3882dc0b7b0eSJason Hobbs 3883dc0b7b0eSJason HobbsImage File Name RAM Address Flash Location 3884dc0b7b0eSJason Hobbs----- --------- ----------- -------------- 3885dc0b7b0eSJason Hobbsu-boot u-boot u-boot_addr_r u-boot_addr 3886dc0b7b0eSJason HobbsLinux kernel bootfile kernel_addr_r kernel_addr 3887dc0b7b0eSJason Hobbsdevice tree blob fdtfile fdt_addr_r fdt_addr 3888dc0b7b0eSJason Hobbsramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 3889dc0b7b0eSJason Hobbs 3890c609719bSwdenkThe following environment variables may be used and automatically 3891c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"), 3892c609719bSwdenkdepending the information provided by your boot server: 3893c609719bSwdenk 3894c609719bSwdenk bootfile - see above 3895c609719bSwdenk dnsip - IP address of your Domain Name Server 3896fe389a82Sstroese dnsip2 - IP address of your secondary Domain Name Server 3897c609719bSwdenk gatewayip - IP address of the Gateway (Router) to use 3898c609719bSwdenk hostname - Target hostname 3899c609719bSwdenk ipaddr - see above 3900c609719bSwdenk netmask - Subnet Mask 3901c609719bSwdenk rootpath - Pathname of the root filesystem on the NFS server 3902c609719bSwdenk serverip - see above 3903c609719bSwdenk 3904c609719bSwdenk 3905c609719bSwdenkThere are two special Environment Variables: 3906c609719bSwdenk 3907c609719bSwdenk serial# - contains hardware identification information such 3908c609719bSwdenk as type string and/or serial number 3909c609719bSwdenk ethaddr - Ethernet address 3910c609719bSwdenk 3911c609719bSwdenkThese variables can be set only once (usually during manufacturing of 3912c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables 3913c609719bSwdenkonce they have been set once. 3914c609719bSwdenk 3915c609719bSwdenk 3916c1551ea8SstroeseFurther special Environment Variables: 3917c1551ea8Sstroese 3918c1551ea8Sstroese ver - Contains the U-Boot version string as printed 3919c1551ea8Sstroese with the "version" command. This variable is 3920c1551ea8Sstroese readonly (see CONFIG_VERSION_VARIABLE). 3921c1551ea8Sstroese 3922c1551ea8Sstroese 3923c609719bSwdenkPlease note that changes to some configuration parameters may take 3924c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-). 3925c609719bSwdenk 3926c609719bSwdenk 3927170ab110SJoe HershbergerCallback functions for environment variables: 3928170ab110SJoe Hershberger--------------------------------------------- 3929170ab110SJoe Hershberger 3930170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change 3931b445bbb4SJeremiah Mahlerwhen their values are changed. This functionality allows functions to 3932170ab110SJoe Hershbergerbe associated with arbitrary variables. On creation, overwrite, or 3933170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side 3934170ab110SJoe Hershbergereffect to happen or for the change to be rejected. 3935170ab110SJoe Hershberger 3936170ab110SJoe HershbergerThe callbacks are named and associated with a function using the 3937170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code. 3938170ab110SJoe Hershberger 3939170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways. The 3940170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 3941170ab110SJoe Hershbergerin the board configuration to a string that defines a list of 3942170ab110SJoe Hershbergerassociations. The list must be in the following format: 3943170ab110SJoe Hershberger 3944170ab110SJoe Hershberger entry = variable_name[:callback_name] 3945170ab110SJoe Hershberger list = entry[,list] 3946170ab110SJoe Hershberger 3947170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted. 3948170ab110SJoe HershbergerSpaces are also allowed anywhere in the list. 3949170ab110SJoe Hershberger 3950170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable 3951170ab110SJoe Hershbergerwith the same list format above. Any association in ".callbacks" will 3952170ab110SJoe Hershbergeroverride any association in the static list. You can define 3953170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 3954b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment. 3955170ab110SJoe Hershberger 3956bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a 3957bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to 3958bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out. 3959bdf1fe4eSJoe Hershberger 3960170ab110SJoe Hershberger 3961f07771ccSwdenkCommand Line Parsing: 3962f07771ccSwdenk===================== 3963f07771ccSwdenk 3964f07771ccSwdenkThere are two different command line parsers available with U-Boot: 39657152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell: 3966f07771ccSwdenk 3967f07771ccSwdenkOld, simple command line parser: 3968f07771ccSwdenk-------------------------------- 3969f07771ccSwdenk 3970f07771ccSwdenk- supports environment variables (through setenv / saveenv commands) 3971f07771ccSwdenk- several commands on one line, separated by ';' 3972fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax 3973f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\', 3974f07771ccSwdenk for example: 3975fe126d8bSWolfgang Denk setenv bootcmd bootm \${address} 3976f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example: 3977f07771ccSwdenk setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3978f07771ccSwdenk 3979f07771ccSwdenkHush shell: 3980f07771ccSwdenk----------- 3981f07771ccSwdenk 3982f07771ccSwdenk- similar to Bourne shell, with control structures like 3983f07771ccSwdenk if...then...else...fi, for...do...done; while...do...done, 3984f07771ccSwdenk until...do...done, ... 3985f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv 3986f07771ccSwdenk commands) and local shell variables (through standard shell syntax 3987f07771ccSwdenk "name=value"); only environment variables can be used with "run" 3988f07771ccSwdenk command 3989f07771ccSwdenk 3990f07771ccSwdenkGeneral rules: 3991f07771ccSwdenk-------------- 3992f07771ccSwdenk 3993f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run" 3994f07771ccSwdenk command) contains several commands separated by semicolon, and 3995f07771ccSwdenk one of these commands fails, then the remaining commands will be 3996f07771ccSwdenk executed anyway. 3997f07771ccSwdenk 3998f07771ccSwdenk(2) If you execute several variables with one call to run (i. e. 399911ccc33fSMarcel Ziswiler calling run with a list of variables as arguments), any failing 4000f07771ccSwdenk command will cause "run" to terminate, i. e. the remaining 4001f07771ccSwdenk variables are not executed. 4002f07771ccSwdenk 4003c609719bSwdenkNote for Redundant Ethernet Interfaces: 4004c609719bSwdenk======================================= 4005c609719bSwdenk 400611ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports 4007c609719bSwdenksuch configurations and is capable of automatic selection of a 40087152b1d0Swdenk"working" interface when needed. MAC assignment works as follows: 4009c609719bSwdenk 4010c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding 4011c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4012c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ... 4013c609719bSwdenk 4014c609719bSwdenkIf the network interface stores some valid MAC address (for instance 4015c609719bSwdenkin SROM), this is used as default address if there is NO correspon- 4016c609719bSwdenkding setting in the environment; if the corresponding environment 4017c609719bSwdenkvariable is set, this overrides the settings in the card; that means: 4018c609719bSwdenk 4019c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the 4020c609719bSwdenk environment, the SROM's address is used. 4021c609719bSwdenk 4022c609719bSwdenko If there is no valid address in the SROM, and a definition in the 4023c609719bSwdenk environment exists, then the value from the environment variable is 4024c609719bSwdenk used. 4025c609719bSwdenk 4026c609719bSwdenko If both the SROM and the environment contain a MAC address, and 4027c609719bSwdenk both addresses are the same, this MAC address is used. 4028c609719bSwdenk 4029c609719bSwdenko If both the SROM and the environment contain a MAC address, and the 4030c609719bSwdenk addresses differ, the value from the environment is used and a 4031c609719bSwdenk warning is printed. 4032c609719bSwdenk 4033c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error 4034bef1014bSJoe Hershberger is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case 4035bef1014bSJoe Hershberger a random, locally-assigned MAC is used. 4036c609719bSwdenk 4037ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4038ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process. This 4039ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable. 4040ecee9324SBen WarrenThe naming convention is as follows: 4041ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4042c609719bSwdenk 4043c609719bSwdenkImage Formats: 4044c609719bSwdenk============== 4045c609719bSwdenk 40463310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on) 40473310c549SMarian Balakowiczimages in two formats: 40483310c549SMarian Balakowicz 40493310c549SMarian BalakowiczNew uImage format (FIT) 40503310c549SMarian Balakowicz----------------------- 40513310c549SMarian Balakowicz 40523310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar 40533310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple 40543310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by 40553310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 40563310c549SMarian Balakowicz 40573310c549SMarian Balakowicz 40583310c549SMarian BalakowiczOld uImage format 40593310c549SMarian Balakowicz----------------- 40603310c549SMarian Balakowicz 40613310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything, 40623310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for 40633310c549SMarian Balakowiczdetails; basically, the header defines the following image properties: 4064c609719bSwdenk 4065c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 4066c609719bSwdenk 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 4067f5ed9e39SPeter Tyser LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 4068f5ed9e39SPeter Tyser Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 4069f5ed9e39SPeter Tyser INTEGRITY). 4070daab59acSAndy Shevchenko* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86, 4071afc1ce82SMacpaul Lin IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 4072daab59acSAndy Shevchenko Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC). 4073c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2) 4074c609719bSwdenk* Load Address 4075c609719bSwdenk* Entry Point 4076c609719bSwdenk* Image Name 4077c609719bSwdenk* Image Timestamp 4078c609719bSwdenk 4079c609719bSwdenkThe header is marked by a special Magic Number, and both the header 4080c609719bSwdenkand the data portions of the image are secured against corruption by 4081c609719bSwdenkCRC32 checksums. 4082c609719bSwdenk 4083c609719bSwdenk 4084c609719bSwdenkLinux Support: 4085c609719bSwdenk============== 4086c609719bSwdenk 4087c609719bSwdenkAlthough U-Boot should support any OS or standalone application 40887152b1d0Swdenkeasily, the main focus has always been on Linux during the design of 4089c609719bSwdenkU-Boot. 4090c609719bSwdenk 4091c609719bSwdenkU-Boot includes many features that so far have been part of some 4092c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any 4093c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image; 4094c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation 40957152b1d0Swdenkserves several purposes: 4096c609719bSwdenk 4097c609719bSwdenk- the same features can be used for other OS or standalone 4098c609719bSwdenk applications (for instance: using compressed images to reduce the 4099c609719bSwdenk Flash memory footprint) 4100c609719bSwdenk 4101c609719bSwdenk- it becomes much easier to port new Linux kernel versions because 41027152b1d0Swdenk lots of low-level, hardware dependent stuff are done by U-Boot 4103c609719bSwdenk 4104c609719bSwdenk- the same Linux kernel image can now be used with different "initrd" 4105c609719bSwdenk images; of course this also means that different kernel images can 4106c609719bSwdenk be run with the same "initrd". This makes testing easier (you don't 4107c609719bSwdenk have to build a new "zImage.initrd" Linux image when you just 4108c609719bSwdenk change a file in your "initrd"). Also, a field-upgrade of the 4109c609719bSwdenk software is easier now. 4110c609719bSwdenk 4111c609719bSwdenk 4112c609719bSwdenkLinux HOWTO: 4113c609719bSwdenk============ 4114c609719bSwdenk 4115c609719bSwdenkPorting Linux to U-Boot based systems: 4116c609719bSwdenk--------------------------------------- 4117c609719bSwdenk 4118c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to 4119c609719bSwdenkconfigure the Linux device drivers for use with your target hardware 4120c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to 4121c609719bSwdenkLinux :-). 4122c609719bSwdenk 4123a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4124c609719bSwdenk 4125c609719bSwdenkJust make sure your machine specific header file (for instance 4126c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board 41271dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h, 41281dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value 41296d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR. 4130c609719bSwdenk 41312eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers. 41322eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there 41332eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See 41342eb31b13SSimon Glassdoc/driver-model. 41352eb31b13SSimon Glass 4136c609719bSwdenk 4137c609719bSwdenkConfiguring the Linux kernel: 4138c609719bSwdenk----------------------------- 4139c609719bSwdenk 4140c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root 4141c609719bSwdenkdevice (initial ramdisk, NFS) for your target system. 4142c609719bSwdenk 4143c609719bSwdenk 4144c609719bSwdenkBuilding a Linux Image: 4145c609719bSwdenk----------------------- 4146c609719bSwdenk 414724ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are 414824ee89b9Swdenknot used. If you use recent kernel source, a new build target 414924ee89b9Swdenk"uImage" will exist which automatically builds an image usable by 415024ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target, 415124ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a 415224ee89b9Swdenk100% compatible format. 4153c609719bSwdenk 4154c609719bSwdenkExample: 4155c609719bSwdenk 4156ab584d67SHolger Freyther make TQM850L_defconfig 4157c609719bSwdenk make oldconfig 4158c609719bSwdenk make dep 415924ee89b9Swdenk make uImage 4160c609719bSwdenk 416124ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to 416224ee89b9Swdenkencapsulate a compressed Linux kernel image with header information, 416324ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing: 4164c609719bSwdenk 416524ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format): 416624ee89b9Swdenk 416724ee89b9Swdenk* convert the kernel into a raw binary image: 416824ee89b9Swdenk 416924ee89b9Swdenk ${CROSS_COMPILE}-objcopy -O binary \ 417024ee89b9Swdenk -R .note -R .comment \ 417124ee89b9Swdenk -S vmlinux linux.bin 417224ee89b9Swdenk 417324ee89b9Swdenk* compress the binary image: 417424ee89b9Swdenk 417524ee89b9Swdenk gzip -9 linux.bin 417624ee89b9Swdenk 417724ee89b9Swdenk* package compressed binary image for U-Boot: 417824ee89b9Swdenk 417924ee89b9Swdenk mkimage -A ppc -O linux -T kernel -C gzip \ 418024ee89b9Swdenk -a 0 -e 0 -n "Linux Kernel Image" \ 418124ee89b9Swdenk -d linux.bin.gz uImage 418224ee89b9Swdenk 418324ee89b9Swdenk 418424ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use 418524ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or 418624ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64 418724ee89b9Swdenkbyte header containing information about target architecture, 418824ee89b9Swdenkoperating system, image type, compression method, entry points, time 418924ee89b9Swdenkstamp, CRC32 checksums, etc. 419024ee89b9Swdenk 419124ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and 419224ee89b9Swdenkprint the header information, or to build new images. 4193c609719bSwdenk 4194c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information 4195c609719bSwdenkcontained in the header of an existing U-Boot image; this includes 4196c609719bSwdenkchecksum verification: 4197c609719bSwdenk 4198c609719bSwdenk tools/mkimage -l image 4199c609719bSwdenk -l ==> list image header information 4200c609719bSwdenk 4201c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image 4202c609719bSwdenkfrom a "data file" which is used as image payload: 4203c609719bSwdenk 4204c609719bSwdenk tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4205c609719bSwdenk -n name -d data_file image 4206c609719bSwdenk -A ==> set architecture to 'arch' 4207c609719bSwdenk -O ==> set operating system to 'os' 4208c609719bSwdenk -T ==> set image type to 'type' 4209c609719bSwdenk -C ==> set compression type 'comp' 4210c609719bSwdenk -a ==> set load address to 'addr' (hex) 4211c609719bSwdenk -e ==> set entry point to 'ep' (hex) 4212c609719bSwdenk -n ==> set image name to 'name' 4213c609719bSwdenk -d ==> use image data from 'datafile' 4214c609719bSwdenk 421569459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load 421669459791Swdenkaddress (0x00000000), but the entry point address depends on the 421769459791Swdenkkernel version: 4218c609719bSwdenk 4219c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C, 422024ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000. 4221c609719bSwdenk 4222c609719bSwdenkSo a typical call to build a U-Boot image would read: 4223c609719bSwdenk 422424ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 422524ee89b9Swdenk > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4226a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 422724ee89b9Swdenk > examples/uImage.TQM850L 422824ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4229c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4230c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4231c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4232c609719bSwdenk Load Address: 0x00000000 423324ee89b9Swdenk Entry Point: 0x00000000 4234c609719bSwdenk 4235c609719bSwdenkTo verify the contents of the image (or check for corruption): 4236c609719bSwdenk 423724ee89b9Swdenk -> tools/mkimage -l examples/uImage.TQM850L 423824ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4239c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4240c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4241c609719bSwdenk Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4242c609719bSwdenk Load Address: 0x00000000 424324ee89b9Swdenk Entry Point: 0x00000000 4244c609719bSwdenk 4245c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade 4246c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this 4247c609719bSwdenkneeds more space in Flash, but boots much faster since it does not 4248c609719bSwdenkneed to be uncompressed: 4249c609719bSwdenk 4250a47a12beSStefan Roese -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 425124ee89b9Swdenk -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 425224ee89b9Swdenk > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4253a47a12beSStefan Roese > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 425424ee89b9Swdenk > examples/uImage.TQM850L-uncompressed 425524ee89b9Swdenk Image Name: 2.4.4 kernel for TQM850L 4256c609719bSwdenk Created: Wed Jul 19 02:34:59 2000 4257c609719bSwdenk Image Type: PowerPC Linux Kernel Image (uncompressed) 4258c609719bSwdenk Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4259c609719bSwdenk Load Address: 0x00000000 426024ee89b9Swdenk Entry Point: 0x00000000 4261c609719bSwdenk 4262c609719bSwdenk 4263c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file 4264c609719bSwdenkwhen your kernel is intended to use an initial ramdisk: 4265c609719bSwdenk 4266c609719bSwdenk -> tools/mkimage -n 'Simple Ramdisk Image' \ 4267c609719bSwdenk > -A ppc -O linux -T ramdisk -C gzip \ 4268c609719bSwdenk > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4269c609719bSwdenk Image Name: Simple Ramdisk Image 4270c609719bSwdenk Created: Wed Jan 12 14:01:50 2000 4271c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4272c609719bSwdenk Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4273c609719bSwdenk Load Address: 0x00000000 4274c609719bSwdenk Entry Point: 0x00000000 4275c609719bSwdenk 4276a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 4277a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d" 4278a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file" 4279a804b5ceSGuilherme Maciel Ferreirafrom the image: 4280a804b5ceSGuilherme Maciel Ferreira 4281f41f5b7cSGuilherme Maciel Ferreira tools/dumpimage -i image -T type -p position data_file 4282f41f5b7cSGuilherme Maciel Ferreira -i ==> extract from the 'image' a specific 'data_file' 4283f41f5b7cSGuilherme Maciel Ferreira -T ==> set image type to 'type' 4284f41f5b7cSGuilherme Maciel Ferreira -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image' 4285a804b5ceSGuilherme Maciel Ferreira 4286c609719bSwdenk 4287c609719bSwdenkInstalling a Linux Image: 4288c609719bSwdenk------------------------- 4289c609719bSwdenk 4290c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface, 4291c609719bSwdenkyou must convert the image to S-Record format: 4292c609719bSwdenk 4293c609719bSwdenk objcopy -I binary -O srec examples/image examples/image.srec 4294c609719bSwdenk 4295c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot 4296c609719bSwdenkimage header, so the resulting S-Record file will be relative to 4297c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to 4298c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads' 4299c609719bSwdenkcommand. 4300c609719bSwdenk 4301c609719bSwdenkExample: install the image to address 0x40100000 (which on the 4302c609719bSwdenkTQM8xxL is in the first Flash bank): 4303c609719bSwdenk 4304c609719bSwdenk => erase 40100000 401FFFFF 4305c609719bSwdenk 4306c609719bSwdenk .......... done 4307c609719bSwdenk Erased 8 sectors 4308c609719bSwdenk 4309c609719bSwdenk => loads 40100000 4310c609719bSwdenk ## Ready for S-Record download ... 4311c609719bSwdenk ~>examples/image.srec 4312c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4313c609719bSwdenk ... 4314c609719bSwdenk 15989 15990 15991 15992 4315c609719bSwdenk [file transfer complete] 4316c609719bSwdenk [connected] 4317c609719bSwdenk ## Start Addr = 0x00000000 4318c609719bSwdenk 4319c609719bSwdenk 4320c609719bSwdenkYou can check the success of the download using the 'iminfo' command; 4321c609719bSwdenkthis includes a checksum verification so you can be sure no data 4322c609719bSwdenkcorruption happened: 4323c609719bSwdenk 4324c609719bSwdenk => imi 40100000 4325c609719bSwdenk 4326c609719bSwdenk ## Checking Image at 40100000 ... 4327c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4328c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4329c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4330c609719bSwdenk Load Address: 00000000 4331c609719bSwdenk Entry Point: 0000000c 4332c609719bSwdenk Verifying Checksum ... OK 4333c609719bSwdenk 4334c609719bSwdenk 4335c609719bSwdenkBoot Linux: 4336c609719bSwdenk----------- 4337c609719bSwdenk 4338c609719bSwdenkThe "bootm" command is used to boot an application that is stored in 4339c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents 4340c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as 4341c609719bSwdenkparameters. You can check and modify this variable using the 4342c609719bSwdenk"printenv" and "setenv" commands: 4343c609719bSwdenk 4344c609719bSwdenk 4345c609719bSwdenk => printenv bootargs 4346c609719bSwdenk bootargs=root=/dev/ram 4347c609719bSwdenk 4348c609719bSwdenk => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4349c609719bSwdenk 4350c609719bSwdenk => printenv bootargs 4351c609719bSwdenk bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4352c609719bSwdenk 4353c609719bSwdenk => bootm 40020000 4354c609719bSwdenk ## Booting Linux kernel at 40020000 ... 4355c609719bSwdenk Image Name: 2.2.13 for NFS on TQM850L 4356c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4357c609719bSwdenk Data Size: 381681 Bytes = 372 kB = 0 MB 4358c609719bSwdenk Load Address: 00000000 4359c609719bSwdenk Entry Point: 0000000c 4360c609719bSwdenk Verifying Checksum ... OK 4361c609719bSwdenk Uncompressing Kernel Image ... OK 4362c609719bSwdenk 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 4363c609719bSwdenk Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4364c609719bSwdenk time_init: decrementer frequency = 187500000/60 4365c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4366c609719bSwdenk Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4367c609719bSwdenk ... 4368c609719bSwdenk 436911ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass 43707152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT 4371c609719bSwdenkformat!) to the "bootm" command: 4372c609719bSwdenk 4373c609719bSwdenk => imi 40100000 40200000 4374c609719bSwdenk 4375c609719bSwdenk ## Checking Image at 40100000 ... 4376c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4377c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4378c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4379c609719bSwdenk Load Address: 00000000 4380c609719bSwdenk Entry Point: 0000000c 4381c609719bSwdenk Verifying Checksum ... OK 4382c609719bSwdenk 4383c609719bSwdenk ## Checking Image at 40200000 ... 4384c609719bSwdenk Image Name: Simple Ramdisk Image 4385c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4386c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4387c609719bSwdenk Load Address: 00000000 4388c609719bSwdenk Entry Point: 00000000 4389c609719bSwdenk Verifying Checksum ... OK 4390c609719bSwdenk 4391c609719bSwdenk => bootm 40100000 40200000 4392c609719bSwdenk ## Booting Linux kernel at 40100000 ... 4393c609719bSwdenk Image Name: 2.2.13 for initrd on TQM850L 4394c609719bSwdenk Image Type: PowerPC Linux Kernel Image (gzip compressed) 4395c609719bSwdenk Data Size: 335725 Bytes = 327 kB = 0 MB 4396c609719bSwdenk Load Address: 00000000 4397c609719bSwdenk Entry Point: 0000000c 4398c609719bSwdenk Verifying Checksum ... OK 4399c609719bSwdenk Uncompressing Kernel Image ... OK 4400c609719bSwdenk ## Loading RAMDisk Image at 40200000 ... 4401c609719bSwdenk Image Name: Simple Ramdisk Image 4402c609719bSwdenk Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4403c609719bSwdenk Data Size: 566530 Bytes = 553 kB = 0 MB 4404c609719bSwdenk Load Address: 00000000 4405c609719bSwdenk Entry Point: 00000000 4406c609719bSwdenk Verifying Checksum ... OK 4407c609719bSwdenk Loading Ramdisk ... OK 4408c609719bSwdenk 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 4409c609719bSwdenk Boot arguments: root=/dev/ram 4410c609719bSwdenk time_init: decrementer frequency = 187500000/60 4411c609719bSwdenk Calibrating delay loop... 49.77 BogoMIPS 4412c609719bSwdenk ... 4413c609719bSwdenk RAMDISK: Compressed image found at block 0 4414c609719bSwdenk VFS: Mounted root (ext2 filesystem). 4415c609719bSwdenk 4416c609719bSwdenk bash# 4417c609719bSwdenk 44180267768eSMatthew McClintockBoot Linux and pass a flat device tree: 44190267768eSMatthew McClintock----------- 44200267768eSMatthew McClintock 44210267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section 44220267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The 44230267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated 44240267768eSMatthew McClintockflat device tree: 44250267768eSMatthew McClintock 44260267768eSMatthew McClintock=> print oftaddr 44270267768eSMatthew McClintockoftaddr=0x300000 44280267768eSMatthew McClintock=> print oft 44290267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb 44300267768eSMatthew McClintock=> tftp $oftaddr $oft 44310267768eSMatthew McClintockSpeed: 1000, full duplex 44320267768eSMatthew McClintockUsing TSEC0 device 44330267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101 44340267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'. 44350267768eSMatthew McClintockLoad address: 0x300000 44360267768eSMatthew McClintockLoading: # 44370267768eSMatthew McClintockdone 44380267768eSMatthew McClintockBytes transferred = 4106 (100a hex) 44390267768eSMatthew McClintock=> tftp $loadaddr $bootfile 44400267768eSMatthew McClintockSpeed: 1000, full duplex 44410267768eSMatthew McClintockUsing TSEC0 device 44420267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2 44430267768eSMatthew McClintockFilename 'uImage'. 44440267768eSMatthew McClintockLoad address: 0x200000 44450267768eSMatthew McClintockLoading:############ 44460267768eSMatthew McClintockdone 44470267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex) 44480267768eSMatthew McClintock=> print loadaddr 44490267768eSMatthew McClintockloadaddr=200000 44500267768eSMatthew McClintock=> print oftaddr 44510267768eSMatthew McClintockoftaddr=0x300000 44520267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr 44530267768eSMatthew McClintock## Booting image at 00200000 ... 44540267768eSMatthew McClintock Image Name: Linux-2.6.17-dirty 44550267768eSMatthew McClintock Image Type: PowerPC Linux Kernel Image (gzip compressed) 44560267768eSMatthew McClintock Data Size: 1029343 Bytes = 1005.2 kB 44570267768eSMatthew McClintock Load Address: 00000000 44580267768eSMatthew McClintock Entry Point: 00000000 44590267768eSMatthew McClintock Verifying Checksum ... OK 44600267768eSMatthew McClintock Uncompressing Kernel Image ... OK 44610267768eSMatthew McClintockBooting using flat device tree at 0x300000 44620267768eSMatthew McClintockUsing MPC85xx ADS machine description 44630267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 44640267768eSMatthew McClintock[snip] 44650267768eSMatthew McClintock 44660267768eSMatthew McClintock 44676069ff26SwdenkMore About U-Boot Image Types: 44686069ff26Swdenk------------------------------ 44696069ff26Swdenk 44706069ff26SwdenkU-Boot supports the following image types: 44716069ff26Swdenk 44726069ff26Swdenk "Standalone Programs" are directly runnable in the environment 44736069ff26Swdenk provided by U-Boot; it is expected that (if they behave 44746069ff26Swdenk well) you can continue to work in U-Boot after return from 44756069ff26Swdenk the Standalone Program. 44766069ff26Swdenk "OS Kernel Images" are usually images of some Embedded OS which 44776069ff26Swdenk will take over control completely. Usually these programs 44786069ff26Swdenk will install their own set of exception handlers, device 44796069ff26Swdenk drivers, set up the MMU, etc. - this means, that you cannot 44806069ff26Swdenk expect to re-enter U-Boot except by resetting the CPU. 44816069ff26Swdenk "RAMDisk Images" are more or less just data blocks, and their 44826069ff26Swdenk parameters (address, size) are passed to an OS kernel that is 44836069ff26Swdenk being started. 44846069ff26Swdenk "Multi-File Images" contain several images, typically an OS 44856069ff26Swdenk (Linux) kernel image and one or more data images like 44866069ff26Swdenk RAMDisks. This construct is useful for instance when you want 44876069ff26Swdenk to boot over the network using BOOTP etc., where the boot 44886069ff26Swdenk server provides just a single image file, but you want to get 44896069ff26Swdenk for instance an OS kernel and a RAMDisk image. 44906069ff26Swdenk 44916069ff26Swdenk "Multi-File Images" start with a list of image sizes, each 44926069ff26Swdenk image size (in bytes) specified by an "uint32_t" in network 44936069ff26Swdenk byte order. This list is terminated by an "(uint32_t)0". 44946069ff26Swdenk Immediately after the terminating 0 follow the images, one by 44956069ff26Swdenk one, all aligned on "uint32_t" boundaries (size rounded up to 44966069ff26Swdenk a multiple of 4 bytes). 44976069ff26Swdenk 44986069ff26Swdenk "Firmware Images" are binary images containing firmware (like 44996069ff26Swdenk U-Boot or FPGA images) which usually will be programmed to 45006069ff26Swdenk flash memory. 45016069ff26Swdenk 45026069ff26Swdenk "Script files" are command sequences that will be executed by 45036069ff26Swdenk U-Boot's command interpreter; this feature is especially 45046069ff26Swdenk useful when you configure U-Boot to use a real shell (hush) 45056069ff26Swdenk as command interpreter. 45066069ff26Swdenk 450744f074c7SMarek VasutBooting the Linux zImage: 450844f074c7SMarek Vasut------------------------- 450944f074c7SMarek Vasut 451044f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done 451144f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same 451244f074c7SMarek Vasutas the syntax of "bootm" command. 451344f074c7SMarek Vasut 45148ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 4515017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the 4516017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following 4517017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>". 4518017e1f3fSMarek Vasut 4519c609719bSwdenk 4520c609719bSwdenkStandalone HOWTO: 4521c609719bSwdenk================= 4522c609719bSwdenk 4523c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and 4524c609719bSwdenkrun "standalone" applications, which can use some resources of 4525c609719bSwdenkU-Boot like console I/O functions or interrupt services. 4526c609719bSwdenk 4527c609719bSwdenkTwo simple examples are included with the sources: 4528c609719bSwdenk 4529c609719bSwdenk"Hello World" Demo: 4530c609719bSwdenk------------------- 4531c609719bSwdenk 4532c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo 4533c609719bSwdenkapplication; it is automatically compiled when you build U-Boot. 4534c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it 4535c609719bSwdenklike that: 4536c609719bSwdenk 4537c609719bSwdenk => loads 4538c609719bSwdenk ## Ready for S-Record download ... 4539c609719bSwdenk ~>examples/hello_world.srec 4540c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4541c609719bSwdenk [file transfer complete] 4542c609719bSwdenk [connected] 4543c609719bSwdenk ## Start Addr = 0x00040004 4544c609719bSwdenk 4545c609719bSwdenk => go 40004 Hello World! This is a test. 4546c609719bSwdenk ## Starting application at 0x00040004 ... 4547c609719bSwdenk Hello World 4548c609719bSwdenk argc = 7 4549c609719bSwdenk argv[0] = "40004" 4550c609719bSwdenk argv[1] = "Hello" 4551c609719bSwdenk argv[2] = "World!" 4552c609719bSwdenk argv[3] = "This" 4553c609719bSwdenk argv[4] = "is" 4554c609719bSwdenk argv[5] = "a" 4555c609719bSwdenk argv[6] = "test." 4556c609719bSwdenk argv[7] = "<NULL>" 4557c609719bSwdenk Hit any key to exit ... 4558c609719bSwdenk 4559c609719bSwdenk ## Application terminated, rc = 0x0 4560c609719bSwdenk 4561c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt 4562c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'. 4563c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second. 4564c609719bSwdenkThe interrupt service routine is trivial, just printing a '.' 4565c609719bSwdenkcharacter, but this is just a demo program. The application can be 4566c609719bSwdenkcontrolled by the following keys: 4567c609719bSwdenk 4568c609719bSwdenk ? - print current values og the CPM Timer registers 4569c609719bSwdenk b - enable interrupts and start timer 4570c609719bSwdenk e - stop timer and disable interrupts 4571c609719bSwdenk q - quit application 4572c609719bSwdenk 4573c609719bSwdenk => loads 4574c609719bSwdenk ## Ready for S-Record download ... 4575c609719bSwdenk ~>examples/timer.srec 4576c609719bSwdenk 1 2 3 4 5 6 7 8 9 10 11 ... 4577c609719bSwdenk [file transfer complete] 4578c609719bSwdenk [connected] 4579c609719bSwdenk ## Start Addr = 0x00040004 4580c609719bSwdenk 4581c609719bSwdenk => go 40004 4582c609719bSwdenk ## Starting application at 0x00040004 ... 4583c609719bSwdenk TIMERS=0xfff00980 4584c609719bSwdenk Using timer 1 4585c609719bSwdenk tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4586c609719bSwdenk 4587c609719bSwdenkHit 'b': 4588c609719bSwdenk [q, b, e, ?] Set interval 1000000 us 4589c609719bSwdenk Enabling timer 4590c609719bSwdenkHit '?': 4591c609719bSwdenk [q, b, e, ?] ........ 4592c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4593c609719bSwdenkHit '?': 4594c609719bSwdenk [q, b, e, ?] . 4595c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4596c609719bSwdenkHit '?': 4597c609719bSwdenk [q, b, e, ?] . 4598c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4599c609719bSwdenkHit '?': 4600c609719bSwdenk [q, b, e, ?] . 4601c609719bSwdenk tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4602c609719bSwdenkHit 'e': 4603c609719bSwdenk [q, b, e, ?] ...Stopping timer 4604c609719bSwdenkHit 'q': 4605c609719bSwdenk [q, b, e, ?] ## Application terminated, rc = 0x0 4606c609719bSwdenk 4607c609719bSwdenk 460885ec0bccSwdenkMinicom warning: 460985ec0bccSwdenk================ 461085ec0bccSwdenk 46117152b1d0SwdenkOver time, many people have reported problems when trying to use the 461285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd) 461385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under 4614f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and 461585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and 4616e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command). See 4617e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 4618e53515a2SKarl O. Pincfor help with kermit. 4619e53515a2SKarl O. Pinc 462085ec0bccSwdenk 462152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this 462252f52c14Swdenkconfiguration to your "File transfer protocols" section: 462352f52c14Swdenk 462452f52c14Swdenk Name Program Name U/D FullScr IO-Red. Multi 462552f52c14Swdenk X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 462652f52c14Swdenk Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 462752f52c14Swdenk 462852f52c14Swdenk 4629c609719bSwdenkNetBSD Notes: 4630c609719bSwdenk============= 4631c609719bSwdenk 4632c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host 4633c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx). 4634c609719bSwdenk 4635c609719bSwdenkBuilding requires a cross environment; it is known to work on 4636c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4637c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make). 4638c609719bSwdenkNote that the cross-powerpc package does not install include files; 4639c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is 4640c609719bSwdenkmissing. This file has to be installed and patched manually: 4641c609719bSwdenk 4642c609719bSwdenk # cd /usr/pkg/cross/powerpc-netbsd/include 4643c609719bSwdenk # mkdir powerpc 4644c609719bSwdenk # ln -s powerpc machine 4645c609719bSwdenk # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4646c609719bSwdenk # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4647c609719bSwdenk 4648c609719bSwdenkNative builds *don't* work due to incompatibilities between native 4649c609719bSwdenkand U-Boot include files. 4650c609719bSwdenk 4651c609719bSwdenkBooting assumes that (the first part of) the image booted is a 4652c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel 4653c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source 4654c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 46552a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4656c609719bSwdenk 4657c609719bSwdenk 4658c609719bSwdenkImplementation Internals: 4659c609719bSwdenk========================= 4660c609719bSwdenk 4661c609719bSwdenkThe following is not intended to be a complete description of every 4662c609719bSwdenkimplementation detail. However, it should help to understand the 4663c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom 4664c609719bSwdenkhardware. 4665c609719bSwdenk 4666c609719bSwdenk 4667c609719bSwdenkInitial Stack, Global Data: 4668c609719bSwdenk--------------------------- 4669c609719bSwdenk 4670c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot 4671c609719bSwdenkstarts running out of ROM (flash memory), usually without access to 4672c609719bSwdenksystem RAM (because the memory controller is not initialized yet). 4673c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS 4674c609719bSwdenkis not initialized as zero. To be able to get a C environment working 4675c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation 4676c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU 4677c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and 4678c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be 4679c609719bSwdenklocked as (mis-) used as memory, etc. 4680c609719bSwdenk 46817152b1d0Swdenk Chris Hallinan posted a good summary of these issues to the 46820668236bSWolfgang Denk U-Boot mailing list: 468343d9616cSwdenk 468443d9616cSwdenk Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 468543d9616cSwdenk From: "Chris Hallinan" <clh@net1plus.com> 468643d9616cSwdenk Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 468743d9616cSwdenk ... 468843d9616cSwdenk 468943d9616cSwdenk Correct me if I'm wrong, folks, but the way I understand it 469043d9616cSwdenk is this: Using DCACHE as initial RAM for Stack, etc, does not 469143d9616cSwdenk require any physical RAM backing up the cache. The cleverness 469243d9616cSwdenk is that the cache is being used as a temporary supply of 469343d9616cSwdenk necessary storage before the SDRAM controller is setup. It's 469411ccc33fSMarcel Ziswiler beyond the scope of this list to explain the details, but you 469543d9616cSwdenk can see how this works by studying the cache architecture and 469643d9616cSwdenk operation in the architecture and processor-specific manuals. 469743d9616cSwdenk 469843d9616cSwdenk OCM is On Chip Memory, which I believe the 405GP has 4K. It 469943d9616cSwdenk is another option for the system designer to use as an 470011ccc33fSMarcel Ziswiler initial stack/RAM area prior to SDRAM being available. Either 470143d9616cSwdenk option should work for you. Using CS 4 should be fine if your 470243d9616cSwdenk board designers haven't used it for something that would 470343d9616cSwdenk cause you grief during the initial boot! It is frequently not 470443d9616cSwdenk used. 470543d9616cSwdenk 47066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 470743d9616cSwdenk with your processor/board/system design. The default value 470843d9616cSwdenk you will find in any recent u-boot distribution in 47098a316c9bSStefan Roese walnut.h should work for you. I'd set it to a value larger 471043d9616cSwdenk than your SDRAM module. If you have a 64MB SDRAM module, set 471143d9616cSwdenk it above 400_0000. Just make sure your board has no resources 471243d9616cSwdenk that are supposed to respond to that address! That code in 471343d9616cSwdenk start.S has been around a while and should work as is when 471443d9616cSwdenk you get the config right. 471543d9616cSwdenk 471643d9616cSwdenk -Chris Hallinan 471743d9616cSwdenk DS4.COM, Inc. 471843d9616cSwdenk 4719c609719bSwdenkIt is essential to remember this, since it has some impact on the C 4720c609719bSwdenkcode for the initialization procedures: 4721c609719bSwdenk 4722c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt 4723c609719bSwdenk to write it. 4724c609719bSwdenk 4725b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized 4726c609719bSwdenk as zero data - BSS segment) at all - this is undefined, initiali- 47277152b1d0Swdenk zation is performed later (when relocating to RAM). 4728c609719bSwdenk 4729c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like 4730c609719bSwdenk that. 4731c609719bSwdenk 4732c609719bSwdenkHaving only the stack as writable memory limits means we cannot use 4733b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it 4734c609719bSwdenkturned out that the implementation of U-Boot can be greatly 4735c609719bSwdenksimplified by making a global data structure (gd_t) available to all 4736c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_ 4737c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of 4738c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we 4739c609719bSwdenkplace a pointer (gd) to the global data into a register which we 4740c609719bSwdenkreserve for this purpose. 4741c609719bSwdenk 47427152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the 4743c609719bSwdenkrelevant (E)ABI specifications for the current architecture, and by 4744c609719bSwdenkGCC's implementation. 4745c609719bSwdenk 4746c609719bSwdenkFor PowerPC, the following registers have specific use: 4747c609719bSwdenk R1: stack pointer 4748e7670f6cSWolfgang Denk R2: reserved for system use 4749c609719bSwdenk R3-R4: parameter passing and return values 4750c609719bSwdenk R5-R10: parameter passing 4751c609719bSwdenk R13: small data area pointer 4752c609719bSwdenk R30: GOT pointer 4753c609719bSwdenk R31: frame pointer 4754c609719bSwdenk 4755e6bee808SJoakim Tjernlund (U-Boot also uses R12 as internal GOT pointer. r12 4756e6bee808SJoakim Tjernlund is a volatile register so r12 needs to be reset when 4757e6bee808SJoakim Tjernlund going back and forth between asm and C) 4758c609719bSwdenk 4759e7670f6cSWolfgang Denk ==> U-Boot will use R2 to hold a pointer to the global data 4760c609719bSwdenk 4761c609719bSwdenk Note: on PPC, we could use a static initializer (since the 4762c609719bSwdenk address of the global data structure is known at compile time), 4763c609719bSwdenk but it turned out that reserving a register results in somewhat 4764c609719bSwdenk smaller code - although the code savings are not that big (on 4765c609719bSwdenk average for all boards 752 bytes for the whole U-Boot image, 4766c609719bSwdenk 624 text + 127 data). 4767c609719bSwdenk 4768c609719bSwdenkOn ARM, the following registers are used: 4769c609719bSwdenk 4770c609719bSwdenk R0: function argument word/integer result 4771c609719bSwdenk R1-R3: function argument word 477212eba1b4SJeroen Hofstee R9: platform specific 477312eba1b4SJeroen Hofstee R10: stack limit (used only if stack checking is enabled) 4774c609719bSwdenk R11: argument (frame) pointer 4775c609719bSwdenk R12: temporary workspace 4776c609719bSwdenk R13: stack pointer 4777c609719bSwdenk R14: link register 4778c609719bSwdenk R15: program counter 4779c609719bSwdenk 478012eba1b4SJeroen Hofstee ==> U-Boot will use R9 to hold a pointer to the global data 478112eba1b4SJeroen Hofstee 478212eba1b4SJeroen Hofstee Note: on ARM, only R_ARM_RELATIVE relocations are supported. 4783c609719bSwdenk 47840df01fd3SThomas ChouOn Nios II, the ABI is documented here: 47850df01fd3SThomas Chou http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 47860df01fd3SThomas Chou 47870df01fd3SThomas Chou ==> U-Boot will use gp to hold a pointer to the global data 47880df01fd3SThomas Chou 47890df01fd3SThomas Chou Note: on Nios II, we give "-G0" option to gcc and don't use gp 47900df01fd3SThomas Chou to access small data sections, so gp is free. 47910df01fd3SThomas Chou 4792afc1ce82SMacpaul LinOn NDS32, the following registers are used: 4793afc1ce82SMacpaul Lin 4794afc1ce82SMacpaul Lin R0-R1: argument/return 4795afc1ce82SMacpaul Lin R2-R5: argument 4796afc1ce82SMacpaul Lin R15: temporary register for assembler 4797afc1ce82SMacpaul Lin R16: trampoline register 4798afc1ce82SMacpaul Lin R28: frame pointer (FP) 4799afc1ce82SMacpaul Lin R29: global pointer (GP) 4800afc1ce82SMacpaul Lin R30: link register (LP) 4801afc1ce82SMacpaul Lin R31: stack pointer (SP) 4802afc1ce82SMacpaul Lin PC: program counter (PC) 4803afc1ce82SMacpaul Lin 4804afc1ce82SMacpaul Lin ==> U-Boot will use R10 to hold a pointer to the global data 4805afc1ce82SMacpaul Lin 4806d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4807d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much. 4808c609719bSwdenk 48093fafced7SRick ChenOn RISC-V, the following registers are used: 48103fafced7SRick Chen 48113fafced7SRick Chen x0: hard-wired zero (zero) 48123fafced7SRick Chen x1: return address (ra) 48133fafced7SRick Chen x2: stack pointer (sp) 48143fafced7SRick Chen x3: global pointer (gp) 48153fafced7SRick Chen x4: thread pointer (tp) 48163fafced7SRick Chen x5: link register (t0) 48173fafced7SRick Chen x8: frame pointer (fp) 48183fafced7SRick Chen x10-x11: arguments/return values (a0-1) 48193fafced7SRick Chen x12-x17: arguments (a2-7) 48203fafced7SRick Chen x28-31: temporaries (t3-6) 48213fafced7SRick Chen pc: program counter (pc) 48223fafced7SRick Chen 48233fafced7SRick Chen ==> U-Boot will use gp to hold a pointer to the global data 48243fafced7SRick Chen 4825c609719bSwdenkMemory Management: 4826c609719bSwdenk------------------ 4827c609719bSwdenk 4828c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the 4829c609719bSwdenkMMU is not used either for address mapping nor for memory protection. 4830c609719bSwdenk 4831c609719bSwdenkThe available memory is mapped to fixed addresses using the memory 4832c609719bSwdenkcontroller. In this process, a contiguous block is formed for each 4833c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several 4834c609719bSwdenkphysical memory banks. 4835c609719bSwdenk 4836c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on 4837c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4838c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself 4839c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some 48406d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4841c609719bSwdenkconfiguration setting]. Below that, a structure with global Board 4842c609719bSwdenkInfo data is placed, followed by the stack (growing downward). 4843c609719bSwdenk 4844c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB 4845c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF). 4846c609719bSwdenk 4847c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like 4848c609719bSwdenkthis: 4849c609719bSwdenk 4850c609719bSwdenk 0x0000 0000 Exception Vector code 4851c609719bSwdenk : 4852c609719bSwdenk 0x0000 1FFF 4853c609719bSwdenk 0x0000 2000 Free for Application Use 4854c609719bSwdenk : 4855c609719bSwdenk : 4856c609719bSwdenk 4857c609719bSwdenk : 4858c609719bSwdenk : 4859c609719bSwdenk 0x00FB FF20 Monitor Stack (Growing downward) 4860c609719bSwdenk 0x00FB FFAC Board Info Data and permanent copy of global data 4861c609719bSwdenk 0x00FC 0000 Malloc Arena 4862c609719bSwdenk : 4863c609719bSwdenk 0x00FD FFFF 4864c609719bSwdenk 0x00FE 0000 RAM Copy of Monitor Code 4865c609719bSwdenk ... eventually: LCD or video framebuffer 4866c609719bSwdenk ... eventually: pRAM (Protected RAM - unchanged by reset) 4867c609719bSwdenk 0x00FF FFFF [End of RAM] 4868c609719bSwdenk 4869c609719bSwdenk 4870c609719bSwdenkSystem Initialization: 4871c609719bSwdenk---------------------- 4872c609719bSwdenk 4873c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point 487411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset 4875c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory. 48767152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address. 4877c609719bSwdenkTo be able to implement the initialization code in C, a (small!) 4878c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs 48792eb48ff7SHeiko Schocherwhich provide such a feature like), or in a locked part of the data 48802eb48ff7SHeiko Schochercache. After that, U-Boot initializes the CPU core, the caches and 48812eb48ff7SHeiko Schocherthe SIU. 4882c609719bSwdenk 4883c609719bSwdenkNext, all (potentially) available memory banks are mapped using a 4884c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries 4885c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4886c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4887c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a 4888c609719bSwdenksimple memory test is run that determines the size of the SDRAM 4889c609719bSwdenkbanks. 4890c609719bSwdenk 4891c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of 48927152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first 4893c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address 4894c609719bSwdenk0x00000000, with any additional banks following immediately to create 4895c609719bSwdenkcontiguous memory starting from 0. 4896c609719bSwdenk 4897c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area 4898c609719bSwdenkand allocates memory for use by malloc() and for the global Board 4899c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM 4900c609719bSwdenkpages, and the final stack is set up. 4901c609719bSwdenk 4902c609719bSwdenkOnly after this relocation will you have a "normal" C environment; 4903c609719bSwdenkuntil that you are restricted in several ways, mostly because you are 4904c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a 4905c609719bSwdenknew address in RAM. 4906c609719bSwdenk 4907c609719bSwdenk 4908c609719bSwdenkU-Boot Porting Guide: 4909c609719bSwdenk---------------------- 4910c609719bSwdenk 4911c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 49126aff3115Swdenklist, October 2002] 4913c609719bSwdenk 4914c609719bSwdenk 4915c609719bSwdenkint main(int argc, char *argv[]) 4916c609719bSwdenk{ 4917c609719bSwdenk sighandler_t no_more_time; 4918c609719bSwdenk 4919c609719bSwdenk signal(SIGALRM, no_more_time); 4920c609719bSwdenk alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4921c609719bSwdenk 4922c609719bSwdenk if (available_money > available_manpower) { 49236c3fef28SJerry Van Baren Pay consultant to port U-Boot; 4924c609719bSwdenk return 0; 4925c609719bSwdenk } 4926c609719bSwdenk 4927c609719bSwdenk Download latest U-Boot source; 4928c609719bSwdenk 49290668236bSWolfgang Denk Subscribe to u-boot mailing list; 49306aff3115Swdenk 49316c3fef28SJerry Van Baren if (clueless) 4932c609719bSwdenk email("Hi, I am new to U-Boot, how do I get started?"); 4933c609719bSwdenk 4934c609719bSwdenk while (learning) { 4935c609719bSwdenk Read the README file in the top level directory; 49367cb22f97Swdenk Read http://www.denx.de/twiki/bin/view/DULG/Manual; 49376c3fef28SJerry Van Baren Read applicable doc/*.README; 4938c609719bSwdenk Read the source, Luke; 49396c3fef28SJerry Van Baren /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4940c609719bSwdenk } 4941c609719bSwdenk 49426c3fef28SJerry Van Baren if (available_money > toLocalCurrency ($2500)) 49436c3fef28SJerry Van Baren Buy a BDI3000; 49446c3fef28SJerry Van Baren else 4945c609719bSwdenk Add a lot of aggravation and time; 4946c609719bSwdenk 49476c3fef28SJerry Van Baren if (a similar board exists) { /* hopefully... */ 49486c3fef28SJerry Van Baren cp -a board/<similar> board/<myboard> 49496c3fef28SJerry Van Baren cp include/configs/<similar>.h include/configs/<myboard>.h 49506c3fef28SJerry Van Baren } else { 4951c609719bSwdenk Create your own board support subdirectory; 49526c3fef28SJerry Van Baren Create your own board include/configs/<myboard>.h file; 49536c3fef28SJerry Van Baren } 49546c3fef28SJerry Van Baren Edit new board/<myboard> files 49556c3fef28SJerry Van Baren Edit new include/configs/<myboard>.h 4956c609719bSwdenk 49576c3fef28SJerry Van Baren while (!accepted) { 4958c609719bSwdenk while (!running) { 4959c609719bSwdenk do { 4960c609719bSwdenk Add / modify source code; 4961c609719bSwdenk } until (compiles); 4962c609719bSwdenk Debug; 4963c609719bSwdenk if (clueless) 4964c609719bSwdenk email("Hi, I am having problems..."); 4965c609719bSwdenk } 49666c3fef28SJerry Van Baren Send patch file to the U-Boot email list; 49676c3fef28SJerry Van Baren if (reasonable critiques) 49686c3fef28SJerry Van Baren Incorporate improvements from email list code review; 49696c3fef28SJerry Van Baren else 49706c3fef28SJerry Van Baren Defend code as written; 49716c3fef28SJerry Van Baren } 4972c609719bSwdenk 4973c609719bSwdenk return 0; 4974c609719bSwdenk} 4975c609719bSwdenk 4976c609719bSwdenkvoid no_more_time (int sig) 4977c609719bSwdenk{ 4978c609719bSwdenk hire_a_guru(); 4979c609719bSwdenk} 4980c609719bSwdenk 4981c609719bSwdenk 4982c609719bSwdenkCoding Standards: 4983c609719bSwdenk----------------- 4984c609719bSwdenk 4985c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel 4986659208daSBaruch Siachcoding style; see the kernel coding style guide at 4987659208daSBaruch Siachhttps://www.kernel.org/doc/html/latest/process/coding-style.html, and the 4988659208daSBaruch Siachscript "scripts/Lindent" in your Linux kernel source directory. 4989c609719bSwdenk 49902c051651SDetlev ZundelSource files originating from a different project (for example the 49912c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not 4992b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those 49932c051651SDetlev Zundelsources. 49942c051651SDetlev Zundel 49952c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in 49962c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//) 49972c051651SDetlev Zundelin your code. 4998c609719bSwdenk 4999c178d3daSwdenkPlease also stick to the following formatting rules: 5000180d3f74Swdenk- remove any trailing white space 50017ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces 5002180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds 50037ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files 5004180d3f74Swdenk- do not add trailing empty lines to source files 5005180d3f74Swdenk 5006c609719bSwdenkSubmissions which do not conform to the standards may be returned 5007c609719bSwdenkwith a request to reformat the changes. 5008c609719bSwdenk 5009c609719bSwdenk 5010c609719bSwdenkSubmitting Patches: 5011c609719bSwdenk------------------- 5012c609719bSwdenk 5013c609719bSwdenkSince the number of patches for U-Boot is growing, we need to 5014c609719bSwdenkestablish some rules. Submissions which do not conform to these rules 5015c609719bSwdenkmay be rejected, even when they contain important and valuable stuff. 5016c609719bSwdenk 50170d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details. 5018218ca724SWolfgang Denk 50190668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 50201dade18eSS. Lockwood-Childssee https://lists.denx.de/listinfo/u-boot 50210668236bSWolfgang Denk 5022c609719bSwdenkWhen you send a patch, please include the following information with 5023c609719bSwdenkit: 5024c609719bSwdenk 5025c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes 5026c609719bSwdenk this bug. Please try to include a way of demonstrating that the 5027c609719bSwdenk patch actually fixes something. 5028c609719bSwdenk 5029c609719bSwdenk* For new features: a description of the feature and your 5030c609719bSwdenk implementation. 5031c609719bSwdenk 5032c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch) 5033c609719bSwdenk 50347207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your 50357207b366SRobert P. J. Day information and associated file and directory references. 5036c609719bSwdenk 503727af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a 503827af930eSAlbert ARIBAUD maintainer e-mail address to the boards.cfg file, too. 5039c609719bSwdenk 5040c609719bSwdenk* If your patch adds new configuration options, don't forget to 5041c609719bSwdenk document these in the README file. 5042c609719bSwdenk 5043218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly* 5044218ca724SWolfgang Denk recommended) you can easily generate the patch using the 50457ca9296eSWolfgang Denk "git format-patch". If you then use "git send-email" to send it to 5046218ca724SWolfgang Denk the U-Boot mailing list, you will avoid most of the common problems 5047218ca724SWolfgang Denk with some other mail clients. 5048c609719bSwdenk 5049218ca724SWolfgang Denk If you cannot use git, use "diff -purN OLD NEW". If your version of 5050218ca724SWolfgang Denk diff does not support these options, then get the latest version of 5051218ca724SWolfgang Denk GNU diff. 50526dff5529Swdenk 5053218ca724SWolfgang Denk The current directory when running this command shall be the parent 5054218ca724SWolfgang Denk directory of the U-Boot source tree (i. e. please make sure that 5055218ca724SWolfgang Denk your patch includes sufficient directory information for the 5056218ca724SWolfgang Denk affected files). 5057218ca724SWolfgang Denk 5058218ca724SWolfgang Denk We prefer patches as plain text. MIME attachments are discouraged, 5059218ca724SWolfgang Denk and compressed attachments must not be used. 5060c609719bSwdenk 506152f52c14Swdenk* If one logical set of modifications affects or creates several 506252f52c14Swdenk files, all these changes shall be submitted in a SINGLE patch file. 506352f52c14Swdenk 506452f52c14Swdenk* Changesets that contain different, unrelated modifications shall be 506552f52c14Swdenk submitted as SEPARATE patches, one patch per changeset. 506652f52c14Swdenk 506752f52c14Swdenk 5068c609719bSwdenkNotes: 5069c609719bSwdenk 50706de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched 5071c609719bSwdenk source tree and make sure that no errors or warnings are reported 5072c609719bSwdenk for any of the boards. 5073c609719bSwdenk 5074c609719bSwdenk* Keep your modifications to the necessary minimum: A patch 5075c609719bSwdenk containing several unrelated changes or arbitrary reformats will be 5076c609719bSwdenk returned with a request to re-formatting / split it. 5077c609719bSwdenk 5078c609719bSwdenk* If you modify existing code, make sure that your new code does not 5079c609719bSwdenk add to the memory footprint of the code ;-) Small is beautiful! 5080c609719bSwdenk When adding new features, these should compile conditionally only 5081c609719bSwdenk (using #ifdef), and the resulting code with the new feature 5082c609719bSwdenk disabled must not need more memory than the old code without your 5083c609719bSwdenk modification. 508490dc6704Swdenk 50850668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the 50860668236bSWolfgang Denk u-boot mailing list. Bigger patches will be moderated. If they are 50870668236bSWolfgang Denk reasonable and not too big, they will be acknowledged. But patches 50880668236bSWolfgang Denk bigger than the size limit should be avoided. 5089